[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阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容