[zebra源碼]JdbcFilter過濾器和SPI擴展

一、 JdbcFilter 過濾器

zebra 定義了 JdbcFilter 過濾器, 它包含的方法覆蓋了 zebra 執行生命周期的各個環節(如各層數據源的初始化/刷新、分組連接的獲取/關閉、sql的執行 等); 那么就方便在各個環節進行監控上報等操作了

public interface JdbcFilter {
    int DEFAULT_ORDER = 0;

    int MAX_ORDER = Integer.MAX_VALUE;

    int MIN_ORDER = Integer.MIN_VALUE;

    /**
     * filter ordering <br>
     * filter_with_order_3_start filter_with_order_2_start
     * filter_with_order_1_start targer_start filter_with_order_1_finish
     * filter_with_order_2_finish filter_with_order_3_finish
     *
     * @return the order of execute
     */
    int getOrder();

    /**
     * init filter
     */
    void init();

    /** GroupDataSource Filter **/
    void initGroupDataSource(GroupDataSource source, JdbcFilter chain);

    void refreshGroupDataSource(GroupDataSource source, String propertiesName, JdbcFilter chain);

    GroupConnection getGroupConnection(GroupDataSource source, JdbcFilter chain) throws SQLException;

    FailOverDataSource.FindMasterDataSourceResult findMasterFailOverDataSource(
            FailOverDataSource.MasterDataSourceMonitor source, JdbcFilter chain);

    void closeGroupConnection(GroupConnection source, JdbcFilter chain) throws SQLException;

    void closeGroupDataSource(GroupDataSource source, JdbcFilter chain) throws SQLException;

    void switchFailOverDataSource(FailOverDataSource source, JdbcFilter chain);

    /** SingleDataSource Filter **/
    DataSource initSingleDataSource(SingleDataSource source, JdbcFilter chain);

    SingleConnection getSingleConnection(SingleDataSource source, JdbcFilter chain) throws SQLException;

    String processSQL(DataSourceConfig dsConfig, SQLProcessContext ctx, JdbcFilter chain) throws SQLException;

    <T> T executeSingleStatement(SingleStatement source, SingleConnection conn, String sql, List<String> batchedSql,
            boolean isBatched, boolean autoCommit, Object params, JdbcFilter chain) throws SQLException;

    void closeSingleConnection(SingleConnection source, JdbcFilter chain) throws SQLException;

    void closeSingleDataSource(SingleDataSource source, JdbcFilter chain) throws SQLException;

    void closeSingleResultSet(SingleResultSet source, JdbcFilter chain) throws SQLException;

    /** ShardDataSource Filter **/
    void initShardDataSource(ShardDataSource source, JdbcFilter chain);

    ResultSet executeShardQuery(ShardStatement source, String sql, JdbcFilter chain) throws SQLException;

    int executeShardUpdate(ShardStatement source, String sql, int autoGeneratedKeys, int[] columnIndexes,
            String[] columnNames, JdbcFilter chain) throws SQLException;

    void shardRouting(RouterResult rr, JdbcFilter chain) throws SQLException;

    void shardMerge(ShardResultSet rs, JdbcFilter chain) throws SQLException;

    void configChanged(PropertyChangeEvent evt, JdbcFilter chain);
}

都是些 void 的無害方法,在zebra數據源、配置及sql代理執行過程的各個點,會執行 JdbcFilter 的對應方法;如在GroupDataSource 初始化的時候,會調用 JdbcFilter#initGroupDataSource 方法

JdbcFilter chain = new DefaultJdbcFilterChain(filters) {
      @Override
      public void initGroupDataSource(GroupDataSource source, JdbcFilter chain) {
          if (index < filters.size()) {
              filters.get(index++).initGroupDataSource(source, chain);
          } else {
              // 開始初始化
              source.initInternal();
          }
      }
  };

zebra 里邊的 JdbcFilter 由 DefaultFilterManager 類負責管理,只要是實現了 JdbcFilter 接口的類就會被它通過類加載的方式加載到, 多個filter的執行是加入到責任鏈 DefaultJdbcFilterChain 里執行的

自帶的 JdbcFilter有

  • CatFilter上報監控信息到cat
  • WallFilter 流控

如何擴展 Filter?

  1. 實現Filter接口 一般繼承DefaultJdbcFilter 即可,Zebra默認提供wallFilter和CatFilter,開發者可以進行參考

    public class WallFilter extends DefaultJdbcFilter

  2. 注冊 Filter

Filter的類加載文件放置在 META-INF/zebra-filter.properties 目錄下,格式為

  • 文件名:zebra.filter.${filterName}=類路徑
  • 內容: zebra.filter.wall=com.dianping.zebra.filter.wall.WallFilter

二、SPI擴展

ZebraSpi擴展說明

zebra 的 SPI 注解

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Spi {
    String name() default "";

    Scope scope() default Scope.SINGLETON;
}

它針對的是 配置獲取方式 ConfigService

自定義的 ConfigService Spi 類加載文件可以放置在 META-INF/services/com.dianping.zebra.config.ConfigService 文件中 進行注冊,如

com.dianping.zebra.config.ZookeeperConfigService

com.dianping.zebra.config.PropertyConfigService

如 zk 配置的定義:

@Spi(name = "zookeeper", scope = Scope.SINGLETON)
public class ZookeeperConfigService implements ConfigService

他們會被 ExtensionLoader 加載并創建對象,用于配置拉取

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,702評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,143評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,553評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,620評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,416評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,940評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,024評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,170評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,709評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,597評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,784評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,291評論 5 357
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,029評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,407評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,663評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,403評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,746評論 2 370

推薦閱讀更多精彩內容