sentinel中的扩展

为什么优秀的框架总是提供用户扩展的能力？

我想这是因为业务逻辑是千变万化的，框架中能抽象的只是部分的公共逻辑，在应用接入框架时，难免需要做一些本地化调整。框架一般通过接口（interface）的形式来提供扩展（用户通过实现这些接口来获得某些能力或完成某些逻辑），那么框架如何知道这些接口实现呢？

一般就两种方式：

• 用户告诉框架接口实现：通过框架提供的 SDK 注册对应的接口实现
• 框架自己来找接口实现：框架按照约定（SPI、包扫描等）方式来发现对应的接口实现

什么意思呢，我们以大名鼎鼎的 Spring 来举例：

// 通过注解 + 包扫描的方式来查找 WebMvcConfigurer 接口实现
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    private void addSpringMvcInterceptor(InterceptorRegistry registry) {
        SentinelWebMvcConfig config = new SentinelWebMvcConfig();
        // 通过 registry.addInterceptor 注册 Interceptor 接口实现
        registry.addInterceptor(new SentinelWebInterceptor(config)).addPathPatterns("/**");
    }

}

那么 Sentinel 中的扩展中有哪些呢？其又是如何感知到这些扩展实现呢？

sentinel spi

Java 中提供了 SPI（Service Provider Interface）机制来扩展、增强我们的应用。Sentinel 中定义了自己的 SPI 实现，用于加载对应接口实现。对应的 sentinel spi 实现代码：

class SpiLoader {
    public void load() {
        // 判断是否已经加载过
        if (!loaded.compareAndSet(false, true)) {
            return;
        }

        // 读取的文件全路径（包含类的全路径名称）
        // 如：/META-INF.services/com.alibaba.csp.sentinel.init.initFunc
        String fullFileName = SPI_FILE_PREFIX + service.getName();
        // 判断使用哪种 classLoader
        ClassLoader classLoader;
        // ...
        
        // 从当前 classPath 读取 jar 包中的 spi 文件
        Enumeration<URL> urls = null;
        try {
            urls = classLoader.getResources(fullFileName);
        } catch (IOException e) {
            fail("Error locating SPI configuration file,filename=" + fullFileName + ",classloader=" + classLoader, e);
        }
        // ...

        // 解析 spi 文件中的内容，并加载为 class
        while (urls.hasMoreElements()) {
            URL url = urls.nextElement();

            InputStream in = null;
            BufferedReader br = null;
            try {
                in = url.openStream();
                br = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8));
                String line;
                while ((line = br.readLine()) != null) {
                    // 忽略空行，忽略以 # 开始的注释 容
                    // ...

                    // 根据文本创建对应的 class
                    Class<S> clazz = null;
                    try {
                        clazz = (Class<S>) Class.forName(line, false, classLoader);
                    } catch (ClassNotFoundException e) {
                        fail("class " + line + " not found", e);
                    }

                    // 判断是否重复加载，class 是否为 service 类型子类
                    // ...
                    
                    // 读取 @Spi 注解属性
                    classList.add(clazz);
                    Spi spi = clazz.getAnnotation(Spi.class);
                    String aliasName = spi == null || "".equals(spi.value()) ? clazz.getName() : spi.value();
                    // ...
                }
            } catch (IOException e) {
                fail("error reading SPI configuration file[" + url + "]", e);
            } finally {
                closeResources(in, br);
            }
        }

        sortedClassList.addAll(classList);
        // 根据 class 中定义的 @Spi 注解 order 属性进行排序
        Collections.sort(sortedClassList, new Comparator<Class<? extends S>>() {
            @Override
            public int compare(Class<? extends S> o1, Class<? extends S> o2) {
                // ...
            }
        });
    }
}

核心的扩展接口如下：

接口注册

上述代码中， sentinel 实现了一套自己的 SPI 机制来加载依赖的接口，以保证框架正常的运行。

另外 sentinel 还提供了一些接口方便用户在特定时机去自定义自己的逻辑，我们可以通过接口注册的方式告知 sentinel 我们的接口实现。
核心的扩展接口信息如下：

使用方法很简单，一般通过对应 Registry 类的静态方法进行注册，我们以 ProcessorSlotEntryCallback 接口为例演示一下基础使用方法：

class Demo {
    public static void main(String[] args) {
        StatisticSlotCallbackRegistry.addEntryCallback("entryCb1", new ProcessorSlotEntryCallback<DefaultNode>() {
            @Override
            public void onPass(Context context, ResourceWrapper resourceWrapper, DefaultNode param, int count, Object... args) throws Exception {
                System.out.println("entry resource success : " + resourceWrapper.getName());
            }
            @Override
            public void onBlocked(BlockException ex, Context context, ResourceWrapper resourceWrapper, DefaultNode param, int count, Object... args) {
                System.out.println("entry resource blocked : " + resourceWrapper.getName());
            }
        });
    }
}

总结

在本章我们了解到在 sentinel 中注册扩展主要有两种方式：

1. 实现对应接口，在类上使用 @Spi 注解从而被 sentinel 扫描并注册
2. 实现对应接口，通过对应的 API 方法手动注册到 sentinel 中

文章编写不易，如有帮助，欢迎 star：github 地址、gitee 地址