sentinel中监听器的运用--规则管理

规则结构

类图关系

类关系图如下

Rule

将规则抽象成一个类, 规则与资源是紧密关联的, 也就是说规则作用于资源。因此, 我们需要将规则表示为一个类, 并包含一个获取资源的方法

这里采用接口的原因就是规则是一个抽象概念而非具体实现。所以我们将规则定义为接口, 让各个子类（如黑白名单规则、流量控制规则、熔断降级等规则）实现各自的逻辑

java 复制代码

public interface Rule {
    // 获取资源 name
    String getResource();
}

AbstractRule

规则通用的三个字段, 设置抽象类实现Rule接口, 对下述字段复用

规则id
资源名称
限制来源
- 限制来源指的是诸如黑名单值、白名单值等, 也就是说限制哪些来源访问

java 复制代码

// 实现规则 Rule 接口
public abstract class AbstractRule implements Rule {

    // 规则id
    private Long id;

    // 资源名称
    private String resource;

    // 限制来源, 多个用逗号隔开, 比如黑名单规则, 限制userId是1和3的访问, 那么就写setLimitApp(1,3)
    private String limitApp;

    @Override
    public String getResource() {
        return resource;
    }
}

为什么limitApp不使用 List<String>？

其实两者都是可行的, 你可以使用逗号分隔, 也可以使用 List<String>, 只要能满足需求即可

规则管理

PropertyListener接口

如何管理这些规则呢？比如如何感知到规则的变化？

sentinel采用的是监听器监听规则的变化, 这个监听器是PropertyListener

java 复制代码

/**
 * 当SentinelProperty.updateValue(Object) 需要通知监听器时, 此类保存回调方法
 * 这里的泛型T存储的是规则, 如 AuthorityRule、DegradeRule、FlowRule 等
 */
public interface PropertyListener<T> {

    /**
     * 规则变更时触发的方法
     * @param value 更新的value
     */
    void configUpdate(T value);

    /**
     * 首次加载规则时触发
     * @param value value加载的值
     */
    void configLoad(T value);
}

为什么使用泛型 T 而不是接口 Rule？我们 AuthorityRule、DegradeRule 等类不都是接口 Rule 的子类吗？

这里使用泛型 T 是因为此接口不仅服务于规则 Rule, 还服务于Sentinel的其他场景, 所以采用了泛型 T

因此, 会有很多具体的类去实现 PropertyListener<T>, 并传入具体的类型, 例如, FlowPropertyListener

java 复制代码

// com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager

public class FlowRuleManager {
    // 其他代码...
    // 这个是内布类, 实现 PropertyListener 接口, 并传入具体的类型 List<FlowRule>
    private static final class FlowPropertyListener implements PropertyListener<List<FlowRule>> {
        // 方法参数也是具体类型, 而不是泛型 T
        @Override
        public synchronized void configLoad(List<FlowRule> value) {
            // 做一些变更逻辑
        }
        // 方法参数也是具体类型, 而不是泛型 T
        @Override
        public synchronized void configUpdate(List<FlowRule> conf) {
            // 做首次初始化逻辑
        }
    }
    // 其他代码...
}

为什么类型是 List<FlowRule> 而不是FlowRule呢?

因为一个资源可以对应多个规则, 而不是简单的一个规则, 比如上线的流控规则, QPS是一种, 线程数又是一种, 一个资源多种策略, 一对多的关系, 所以采用List集合

PropertyListener<T>的实现类如下图

SentinelProperty接口

SentinelProperty 的类, 专门负责管理所有 PropertyListener<T> 子类的监听器

包含以下方法：

addListener(PropertyListener<T> listener)：添加监听器。
removeListener(PropertyListener<T> listener)：移除监听器。
updateValue(T newValue)：当规则配置发生变化时, 调用此方法进行通知

java 复制代码

public interface SentinelProperty<T> {
    // 添加监听器
    void addListener(PropertyListener<T> listener);
    // 移除监听器
    void removeListener(PropertyListener<T> listener);
    // 当配置发生变化时, 通过调用 SentinelProperty 的 updateValue 方法通知所有的监听器
    boolean updateValue(T newValue);
}

DynamicSentinelProperty

Sentinel 提供了一个默认的 SentinelProperty 实现：DynamicSentinelProperty

java 复制代码

// 实现 SentinelProperty 接口
public class DynamicSentinelProperty<T> implements SentinelProperty<T> {

    // 使用 `CopyOnWriteArraySet` 存储所有监听器 `PropertyListener` 子类, 确保线程安全和高性能
    protected Set<PropertyListener<T>> listeners = new CopyOnWriteArraySet<>();
    private T value = null;

    public DynamicSentinelProperty() {
    }

    public DynamicSentinelProperty(T value) {
        super();
        this.value = value;
    }

    // 添加监听器到集合
    @Override
    public void addListener(PropertyListener<T> listener) {
        listeners.add(listener);
        // 添加进来后就会初始化规则配置
        listener.configLoad(value);
    }

    // 移除监听器
    @Override
    public void removeListener(PropertyListener<T> listener) {
        listeners.remove(listener);
    }

    // 更新值
    @Override
    public boolean updateValue(T newValue) {
        // 如果值没变化, 直接返回
        if (isEqual(value, newValue)) {
            return false;
        }

        // 如果值发生了变化, 则告知每一个"观察者"
        value = newValue;
        for (PropertyListener<T> listener : listeners) {
            listener.configUpdate(newValue);
        }
        return true;
    }
}

监听器监听的是规则，而规则又是和资源绑定的，因此具体使用时，我们可以创建一个 Map<String resourceName, Set<Rule>> 这样的数据结构来保存资源和规则的关系

当规则首次初始化时调用 SentinelProperty#addListener() 方法注册监听器且进行初始化（初始化的过程就是将资源和规则绑定到 Map 当中）
当规则发生变更时，调用 SentinelProperty#updateValue() 方法将 Map 里的value进行变更

参考资料

通关 Sentinel 流量治理框架 - 编程界的小學生