Flink Redis Sink用法與支持過期時間的改進

Flink默認提供了很多開箱即用的連接器,比如與Kafka、RabbitMQ础淤、HDFS、ElasticSearch等對接的連接器电禀。還有一些不那么常用的連接器則由Apache Bahir項目(官網(wǎng)很簡陋,見這里)來提供笤休,其中就包含Redis Sink尖飞。這個項目的文檔有點缺乏,本文先記錄一下用法店雅。

引入如下Maven依賴政基。目前bahir-flink項目比較停滯,最新版本是1.1-SNAPSHOT底洗。

    <dependency>
      <groupId>org.apache.bahir</groupId>
      <artifactId>flink-connector-redis_${scala.bin.version}</artifactId>
      <version>${bahir.version}</version>
      <scope>compile</scope>
    </dependency>

以最常見的單機Redis情景來討論腋么,該插件提供的核心類有三個,分別是:

  • FlinkJedisPoolConfig類:Jedis連接池的相關參數(shù)亥揖;
  • RedisMapper接口:從用戶數(shù)據(jù)中提取鍵值,并構成Redis命令的映射器,需要用戶自己實現(xiàn)费变;
  • RedisSink類:根據(jù)構建好的FlinkJedisPoolConfig和RedisMapper將流數(shù)據(jù)寫入Redis摧扇。

先生成一個FlinkJedisPoolConfig實例。

    // 這個叫ParameterUtil的類是自己寫的挚歧,專門用來讀有占位符的屬性文件扛稽,看官勿誤會
    // 當然也可以直接寫明文,不過放在屬性文件里方便管理滑负,還能按Maven profile作區(qū)分
    Properties redisProps = ParameterUtil.getFromResourceFile("redis.properties");

    FlinkJedisPoolConfig jedisPoolConfig = new FlinkJedisPoolConfig.Builder()
      .setHost(redisProps.getProperty("redis.host"))
      .setPort(NumberUtils.createInteger(redisProps.getProperty("redis.port")))
      .setPassword(redisProps.getProperty("redis.pass", ""))
      .setDatabase(NumberUtils.createInteger(redisProps.getProperty("redis.db")))
      .build();

接下來就寫一個RedisMapper的實現(xiàn)類在张,它負責將窗口統(tǒng)計出來的PV和UV數(shù)據(jù)以JSON形式表示。一點都不難矮慕。

  public static final class RedisWindowPvUvMapper
    implements RedisMapper<WindowedPvUvResult> {
    // 被統(tǒng)計的對象類別帮匾,當參數(shù)傳進來
    private String itemType;

    public RedisStringMapper(String itemType) {
      this.itemType = itemType;
    }

    // 指定命令,這里要寫字符串痴鳄,所以是set
    @Override
    public RedisCommandDescription getCommandDescription() {
      return new RedisCommandDescription(RedisCommand.SET);
    }

    // 從POJO構造key
    @Override
    public String getKeyFromData(WindowedPvUvResult result) {
      StringBuilder builder = new StringBuilder("flink:log_pvuv:");
      builder.append(result.getWindowEnd());
      builder.append("_");
      builder.append(itemType);
      builder.append("_");
      builder.append(result.getItemId());
      return builder.toString();
    }

    // 從POJO構造value
    @Override
    public String getValueFromData(WindowedPvUvResult result) {
      return new JSONObject()
        .fluentPut("pv", result.getPv())
        .fluentPut("uv", result.getUv())
        .toJSONString();
    }
  }

最后就可以構造RedisSink了瘟斜。

dataStream.addSink(new RedisSink<>(jedisPoolConfig, new RedisWindowPvUvMapper("partner")));

這個Redis連接器簡單易用,但是有兩個地方差強人意:一是不支持設定key的過期時間(TTL)痪寻,二是不支持流水線(pipeline)螺句。在窗口比較稀疏、寫入量沒那么大的情況下橡类,流水線是可有可無的蛇尚,但過期時間還是很重要,所以下面要稍微改造一下顾画。

項目代碼clone到本地取劫,找到flink-connector-redis項目中的RedisCommand枚舉,加上setex命令亲雪。

SETEX(RedisDataType.STRING),

然后來到RedisCommandsContainer接口勇凭,它其中定義的都是具體的命令邏輯,加上setex()方法的定義义辕。

void setex(String key, int seconds, String value);

RedisCommandsContainer接口有兩個實現(xiàn)類:針對單機的RedisContainer和針對集群的RedisClusterContainer虾标,寫入setex()方法的具體實現(xiàn)。

    // RedisContainer.setex()
    @Override
    public void setex(final String key, final int seconds, final String value) {
        Jedis jedis = null;
        try {
            jedis = getInstance();
            jedis.setex(key, seconds, value);
        } catch (Exception e) {
            if (LOG.isErrorEnabled()) {
                LOG.error("Cannot send Redis message with command SETEX to key {} error message {}",
                  key, e.getMessage());
            }
            throw e;
        } finally {
            releaseInstance(jedis);
        }
    }

    // RedisClusterContainer.setex()
    @Override
    public void setex(final String key, final int seconds, final String value) {
        try {
            jedisCluster.setex(key, seconds, value);
        } catch (Exception e) {
            if (LOG.isErrorEnabled()) {
                LOG.error("Cannot send Redis message with command SETEX to key {} error message {}",
                  key, e.getMessage());
            }
            throw e;
        }
    }

有了方法的具體實現(xiàn)灌砖,那么如何接收TTL的參數(shù)呢璧函?回到上面提到過的RedisMapper接口,在其中加上一個獲取TTL秒數(shù)的方法聲明基显。為了方便蘸吓,還可以用default語法提供一個默認值。

     default int getExpireSeconds(T data) {
         return 0;
     }

萬事俱備只欠東風撩幽,來到RedisSink.invoke()方法(之前已經(jīng)講過库继,RichSinkFunction的子類必須實現(xiàn)這個方法)箩艺,加上我們之前寫的東西就可以了,如下宪萄。

    @Override
    public void invoke(IN input, Context context) throws Exception {
        String key = redisSinkMapper.getKeyFromData(input);
        String value = redisSinkMapper.getValueFromData(input);
        // 取得過期時間
        int expireSec = redisSinkMapper.getExpireSeconds(input);
        Optional<String> optAdditionalKey = redisSinkMapper.getAdditionalKey(input);

        switch (redisCommand) {
            case RPUSH:
                this.redisCommandsContainer.rpush(key, value);
                break;
            case LPUSH:
                this.redisCommandsContainer.lpush(key, value);
                break;
            case SADD:
                this.redisCommandsContainer.sadd(key, value);
                break;
            case SET:
                this.redisCommandsContainer.set(key, value);
                break;
            // 新寫的setex邏輯
            case SETEX:
                if (expireSec > 0) {
                    this.redisCommandsContainer.setex(key, expireSec, value);
                }
                break;
            case PFADD:
            // ...以下原樣艺谆,略去
        }
    }

用Maven重新構建、打包并發(fā)布到倉庫就可以用了拜英。在實際應用時静汤,如果需要設定TTL,用戶邏輯中的RedisMapper就可以這樣寫:

  public static final class RedisStringMapperWithTTL
    implements RedisMapper<WindowedPvUvResult> {
    @Override
    public RedisCommandDescription getCommandDescription() {
      return new RedisCommandDescription(RedisCommand.SETEX);
    }

    @Override
    public String getKeyFromData(WindowedPvUvResult result) {
      // ...
    }

    @Override
    public String getValueFromData(WindowedPvUvResult result) {
      // ...
    }

    @Override
    public int getExpireSeconds(WindowedPvUvResult data) {
      return 3 * 24 * 60 * 60;   // 3天
    }
  }
}

so easy~

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末居凶,一起剝皮案震驚了整個濱河市虫给,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌侠碧,老刑警劉巖抹估,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異舆床,居然都是意外死亡棋蚌,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門挨队,熙熙樓的掌柜王于貴愁眉苦臉地迎上來谷暮,“玉大人,你說我怎么就攤上這事盛垦∈遥” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵腾夯,是天一觀的道長颊埃。 經(jīng)常有香客問我,道長蝶俱,這世上最難降的妖魔是什么班利? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮榨呆,結果婚禮上罗标,老公的妹妹穿的比我還像新娘。我一直安慰自己积蜻,他們只是感情好闯割,可當我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著竿拆,像睡著了一般宙拉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上丙笋,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天谢澈,我揣著相機與錄音煌贴,去河邊找鬼。 笑死澳化,一個胖子當著我的面吹牛崔步,可吹牛的內(nèi)容都是我干的稳吮。 我是一名探鬼主播缎谷,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼灶似!你這毒婦竟也來了列林?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤酪惭,失蹤者是張志新(化名)和其女友劉穎希痴,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體春感,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡砌创,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了鲫懒。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片嫩实。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖窥岩,靈堂內(nèi)的尸體忽然破棺而出甲献,到底是詐尸還是另有隱情,我是刑警寧澤颂翼,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布晃洒,位于F島的核電站,受9級特大地震影響朦乏,放射性物質發(fā)生泄漏球及。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一呻疹、第九天 我趴在偏房一處隱蔽的房頂上張望吃引。 院中可真熱鬧,春花似錦诲宇、人聲如沸际歼。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽鹅心。三九已至,卻和暖如春纺荧,著一層夾襖步出監(jiān)牢的瞬間旭愧,已是汗流浹背颅筋。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留输枯,地道東北人议泵。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像桃熄,于是被迫代替她去往敵國和親先口。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容