flink自定义table source

一、概述

Flink User-defined Sources & Sinks 官方文档

flink 动态表是一个逻辑概念,动态表是table & sql api的核心概念,用于以统一的方式处理流、批数据。

以下是表连接器的一般架构

  1. Metadata

    执行create table声明表,这个操作不会修改外部系统的物理数据,元数据会表示为CatalogTable的一个实例

  2. Planning

    这一步是在表执行时和解析优化时,程序将CatalogTable解析为DynamicTableSource(对应select操作)或DynamicTableSink(对应insert操作)

    主要操作是编写DynamicTableSourceFactory和DynamicTableSinkFactory逻辑,验证with里面的参数是否正确,并将元数据CatalogTable转换为DynamicTableSource和DynamicTableSink。

    工厂类必须提供有效的工厂标识符(对应connector = 'xxxxxx' 的内容),让Java的spi发现并注册服务。spi机制可以参考这篇文章:https://www.cnblogs.com/lovesqcc/p/5229353.html

  3. Runtime

    逻辑规划完成后,规划器将从表连接器获取到runtime的实现类

二、自定义SourceConnector

下面实现一个简单的自定义source connector,主要目的是熟悉一遍开发流程。

自定义SourceConnector逻辑是根据配置的列(字符型),随机返回字段表达式里的任意字符。

  1. 首先实现DynamicTableSourceFactory类方法

    package com.github.knaufk.flink.test;
    
    import org.apache.flink.configuration.ConfigOption;
    import org.apache.flink.configuration.Configuration;
    import org.apache.flink.table.api.TableSchema;
    import org.apache.flink.table.api.ValidationException;
    import org.apache.flink.table.catalog.CatalogTable;
    import org.apache.flink.table.connector.source.DynamicTableSource;
    import org.apache.flink.table.factories.DynamicTableSourceFactory;
    import org.apache.flink.table.factories.FactoryUtil;
    import org.apache.flink.table.utils.TableSchemaUtils;
    
    import java.util.HashSet;
    import java.util.Set;
    
    import static org.apache.flink.configuration.ConfigOptions.key;
    
    public class XiaolongTableSourceFactory implements DynamicTableSourceFactory {
    
        private static final String IDENTIFIER = "xiaolong";
    
        private static final String FIELDS = "fields";
    
        private static final String EXPRESSION = "expression";
    
        private static final ConfigOption<Long> ROWS_PER_SECOND =
                key("rows-per-second")
                        .longType()
                        .defaultValue(1000L)
                        .withDescription("Rows per second to emit.");
    
        private static final ConfigOption<String> SPLIT_STR =
                key("split-str")
                        .stringType()
                        .defaultValue(",")
                        .withDescription("the delimited of string.");
    
    
        @Override
        public DynamicTableSource createDynamicTableSource(Context context) {
            CatalogTable catalogTable = context.getCatalogTable();
    
            // 获取with配置
            Configuration options = new Configuration();
            context.getCatalogTable().getOptions().forEach(options::setString);
    
            // 获取表定义
            TableSchema schema = TableSchemaUtils.getPhysicalSchema(catalogTable.getSchema());
            String[] fieldExpressions = new String[schema.getFieldCount()];
    
            Set<ConfigOption<?>> fieldOptions = new HashSet<>();
    
            for (int i = 0; i < fieldExpressions.length; i++) {
                String fieldName = schema.getFieldName(i).get();
                // 校验字段配置是否正确
                ConfigOption<String> filed =
                        key(FIELDS + "." + fieldName + "." + EXPRESSION).stringType().noDefaultValue();
                fieldExpressions[i] = validateFieldExpression(filed, options);
                fieldOptions.add(filed);
            }
            // 校验配置
            FactoryUtil.validateFactoryOptions(requiredOptions(), fieldOptions, options);
            return new XiaolongTableSource(fieldExpressions, options.get(ROWS_PER_SECOND), options.get(SPLIT_STR));
        }
    
        /**
         * @return
         * connector的标识
         */
        @Override
        public String factoryIdentifier() {
            return IDENTIFIER;
        }
    
        /**
         * 必须配置的参数,默认返回空集合
         * @return
         */
        @Override
        public Set<ConfigOption<?>> requiredOptions() {
            return new HashSet<>();
        }
    
        /**
         * 可额外配置的参数,默认返回空集合
         * @return
         */
        @Override
        public Set<ConfigOption<?>> optionalOptions() {
            Set<ConfigOption<?>> options = new HashSet<>();
            options.add(ROWS_PER_SECOND);
            options.add(SPLIT_STR);
            return options;
        }
    
        
        private String validateFieldExpression(ConfigOption<String> field, Configuration options) {
            String fieldExpression = options.get(field);
            if (fieldExpression == null) {
                throw new ValidationException(
                        "Every column needs a corresponding expression. No expression found for "
                                + field.key()
                                + ".");
            }
            return fieldExpression;
        }
    }
    
    
  2. 实现DynamicTableSource子类方法

    package com.github.knaufk.flink.test;
    
    import org.apache.flink.table.connector.ChangelogMode;
    import org.apache.flink.table.connector.source.DynamicTableSource;
    import org.apache.flink.table.connector.source.ScanTableSource;
    import org.apache.flink.table.connector.source.SourceFunctionProvider;
    
    
    public class XiaolongTableSource implements ScanTableSource {
    
        private String[] fieldExpression;
    
        private long numsPerSec;
    
        private String split;
    
        public XiaolongTableSource(String[] fieldExpression, long numsPerSec, String split) {
            this.fieldExpression = fieldExpression;
            this.numsPerSec = numsPerSec;
            this.split = split;
        }
    
    
        @Override
        public ChangelogMode getChangelogMode() {
            return ChangelogMode.insertOnly();
        }
    
        @Override
        public ScanRuntimeProvider getScanRuntimeProvider(ScanContext runtimeProviderContext) {
            return SourceFunctionProvider.of(new XiaolongSource(fieldExpression, numsPerSec, split), false);
        }
    
        @Override
        public DynamicTableSource copy() {
            return new XiaolongTableSource(fieldExpression, numsPerSec, split);
        }
    
        @Override
        public String asSummaryString() {
            return "XiaolongTableSource";
        }
    }
    
    
  3. 实现SourceFunction类方法

    这里可以自定义继承的SourceFunction方法和实现CheckpointedFunction方法实现Exactly-Once,这里只简单实现了RichSourceFunction

    package com.github.knaufk.flink.test;
    
    import org.apache.flink.configuration.Configuration;
    import org.apache.flink.shaded.guava18.com.google.common.collect.Lists;
    import org.apache.flink.streaming.api.functions.source.RichSourceFunction;
    import org.apache.flink.table.data.GenericRowData;
    import org.apache.flink.table.data.RowData;
    import org.apache.flink.table.data.StringData;
    
    import java.util.Arrays;
    import java.util.List;
    import java.util.Random;
    
    public class XiaolongSource extends RichSourceFunction<RowData> {
    
        private String[] fieldExpressions;
    
        private long numsPerSec;
    
        private volatile boolean cancelled;
    
        private String split;
    
        public XiaolongSource(String[] fieldExpressions, long numsPerSec, String split) {
            this.fieldExpressions = fieldExpressions;
            this.numsPerSec = numsPerSec;
            this.split = split;
        }
    
        @Override
        public void run(SourceContext<RowData> sourceContext) throws Exception {
            while (!cancelled) {
                for (long i = 0; i < numsPerSec; i++) {
                    RowData rowData = generateRow();
                    sourceContext.collect(rowData);
                }
                Thread.sleep(1000);
            }
        }
    
        @Override
        public void cancel() {
            cancelled = true;
        }
    
        @Override
        public void open(Configuration parameters) throws Exception {
            super.open(parameters);
        }
    
    
        private RowData generateRow() {
            GenericRowData row = new GenericRowData(fieldExpressions.length);
            for (int i = 0; i < fieldExpressions.length; i++) {
                String fieldExpression = fieldExpressions[i];
                List<String> result = Lists.newArrayList();
                result.addAll(Arrays.asList(fieldExpression.split(split)));
                Random random = new Random();
                String value = result.get(random.nextInt(result.size()));
                row.setField(i, StringData.fromString(value));
            }
            return row;
        }
    }
    
  4. 配置文件

    最后在META-INF/services/org.apache.flink.table.factories.Factory配置上自定义的source connector

    com.flink.test.XiaolongTableSourceFactory
    
  5. 打成jar包复制到flink lib目录下

三、环境搭建

这里用Zeppelin来做测试环境,具体的搭建过程可以查看文章:https://www.jianshu.com/p/091d2490a969

四、测试

1、表声明


2、执行查询,流数据会一直产生


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容