image.png
如上图所示，SOFABolt 整个配置管理分为五部分：
- 系统变量管理类：ConfigManager，配置多个实例共享的配置。
- 用户变量管理类：ConfigContainer，可以为多个实例配置不同的配置。
- 开关类：Switch，一些开关操作。
- 用户可配置实例类：ConfigurableInstance，包含 ConfigContainer 和 Switch 实例，RpcServer 和 RpcClient 都是其子类。
Rpc 独有的配置项和管理器：RpcConfig。
参数配置方式通常有两种，一种是系统变量的设置，这是一种全局的配置；另外一种，就是用户通过 api （例如，通过构造器参数）进行配置，这样可以为不同的实例的参数配置不同的值。所以在 Netty 的可配置类中，通常会提供系统变量配置和构造器配置两种参数配置，当然参数本身还有原始的默认值。最终参数配置的优先级是：
用户 api 配置变量（构造器参数变量）> 系统变量 > 原始的默认值
一、系统变量管理类
系统变量的设置通常由两种方式：
- java 进程启动参数添加 -Dxxx = yyy
- System.setProperty(String key, String value)
SOFABolt 通过 Configs 类配置了一系列的配置项的 key 及其默认值；通过 ConfigManager 进行配置项的获取。源码如下：
========================== Configs ==========================
/** TCP_NODELAY option */
public static final String TCP_NODELAY = "bolt.tcp.nodelay";
public static final String TCP_NODELAY_DEFAULT = "true";
======================= ConfigManager =======================
public static boolean tcp_nodelay() {
return getBool(Configs.TCP_NODELAY, Configs.TCP_NODELAY_DEFAULT);
}
public static boolean getBool(String key, String defaultValue) {
return Boolean.parseBoolean(System.getProperty(key, defaultValue));
}
二、用户变量管理类
- ConfigType 定义了是服务端还是客户端的配置：CLIENT_SIDE 和 SERVER_SIDE；
- ConfigItem 定义了配置项，目前只有两个：NETTY_BUFFER_LOW_WATER_MARK 和 NETTY_BUFFER_HIGH_WATER_MARK，Netty write buffer 的高低水位。
- ConfigContainer 定义了设置和获取用户配置项的接口；DefaultConfigContainer 对其进行了默认实现
疑问：关于 ConfigItem 的扩展，官方文档：“You can define new config items based on this if need.” 但是 ConfigItem 是 enum，是无法被继承的，应该怎样去扩展自己的配置呢？个人感觉 ConfigItem 和 Configs 有冗余的嫌疑，https://github.com/alipay/sofa-bolt/issues/101
三、开关类
- Switch 定义开关配置接口；
- GlobalSwitch 定义了全局开关项；
- ProtocolSwitch 定义了与协议相关的开关项，例如 CRC_SWITCH。
======================= GlobalSwitch =======================
// 重连
public static final int CONN_RECONNECT_SWITCH = 0;
// 监控连接
public static final int CONN_MONITOR_SWITCH = 1;
// 服务端启动连接管理器
public static final int SERVER_MANAGE_CONNECTION_SWITCH = 2;
// 服务端同步停止
public static final int SERVER_SYNC_STOP = 3;
/** user settings */
private BitSet userSettings = new BitSet();
/**
* Init with system default value
* if settings exist by system property then use system property at first;
* if no settings exist by system property then use default value in {@link com.alipay.remoting.config.Configs}
* All these settings can be overwrite by user api settings.
*/
public GlobalSwitch() {
if (ConfigManager.conn_reconnect_switch()) {
userSettings.set(CONN_RECONNECT_SWITCH);
} else {
userSettings.clear(CONN_RECONNECT_SWITCH);
}
if (ConfigManager.conn_monitor_switch()) {
userSettings.set(CONN_MONITOR_SWITCH);
} else {
userSettings.clear(CONN_MONITOR_SWITCH);
}
}
======================= ProtocolSwitch =======================
// switche index
public static final int CRC_SWITCH_INDEX = 0x000;
// default value
public static final boolean CRC_SWITCH_DEFAULT_VALUE = true;
/** protocol switches */
private BitSet bs = new BitSet();
开关是使用 BitSet 来实现的，BitSet简要原理：
BitSet默认底层数据结构是一个long[]数组，开始时长度为1，即只有long[0]，而一个long有64bit。
当BitSet.set(1)的时候，表示将long[0]的第二位设置为true，即0000 0000 ... 0010（64bit）,则long[0]==2；
当BitSet.get(1)的时候，第二位为1，则表示true；如果是0，则表示false；
当BitSet.set(64)的时候，表示设置第65位，此时long[0]已经不够用了，扩容处long[1]来，进行存储。
存储类似 {index:boolean} 键值对。
四、用户可配置实例类
NettyConfigure：提供了 Netty 配置的接口类；
ConfigurableInstance：提供了可配置实例的接口类；
AbstractConfigurableInstance：ConfigurableInstance 实现类，源码如下：
public class AbstractConfigurableInstance implements ConfigurableInstance {
private ConfigContainer configContainer = new DefaultConfigContainer();
private GlobalSwitch globalSwitch = new GlobalSwitch();
private ConfigType configType;
protected AbstractConfigurableInstance(ConfigType configType) {
this.configType = configType;
}
// public 方法，用户可以直接获取该实例进行操作
@Override
public ConfigContainer conf() {
return this.configContainer;
}
// public 方法，用户可以直接获取该实例进行操作
@Override
public GlobalSwitch switches() {
return this.globalSwitch;
}
@Override
public void initWriteBufferWaterMark(int low, int high) {
this.configContainer.set(configType, ConfigItem.NETTY_BUFFER_LOW_WATER_MARK, low);
this.configContainer.set(configType, ConfigItem.NETTY_BUFFER_HIGH_WATER_MARK, high);
}
@Override
public int netty_buffer_low_watermark() {
// 首先获取用户api配置
if (null != configContainer
&& configContainer.contains(configType, ConfigItem.NETTY_BUFFER_LOW_WATER_MARK)) {
return (Integer) configContainer
.get(configType, ConfigItem.NETTY_BUFFER_LOW_WATER_MARK);
} else {
// 然后在从系统变量进行获取
return ConfigManager.netty_buffer_low_watermark();
}
}
@Override
public int netty_buffer_high_watermark() {
if (null != configContainer
&& configContainer.contains(configType, ConfigItem.NETTY_BUFFER_HIGH_WATER_MARK)) {
return (Integer) configContainer.get(configType,
ConfigItem.NETTY_BUFFER_HIGH_WATER_MARK);
} else {
return ConfigManager.netty_buffer_high_watermark();
}
}
}
AbstractConfigurableInstance 有两个极重要的子类 RpcServer 和 RpcClient。
public RpcClient() {
// 创建对象的时候就指定好了 ConfigType
super(ConfigType.CLIENT_SIDE);
}
public void init() {
...
// 连接监控开关是否打开
if (switches().isOn(GlobalSwitch.CONN_MONITOR_SWITCH)) {
...
}
// 重连开关是否打开
if (switches().isOn(GlobalSwitch.CONN_RECONNECT_SWITCH)) {
...
}
}
/**
* enable connection reconnect switch on
* Notice: This api should be called before RpcClient#init()
*/
public void enableReconnectSwitch() {
this.switches().turnOn(GlobalSwitch.CONN_RECONNECT_SWITCH);
}
/**
* disable connection reconnect switch off
* Notice: This api should be called before RpcClient#init()
*/
public void disableReconnectSwith() {
this.switches().turnOff(GlobalSwitch.CONN_RECONNECT_SWITCH);
}
/**
* is reconnect switch on
* @return
*/
public boolean isReconnectSwitchOn() {
return this.switches().isOn(GlobalSwitch.CONN_RECONNECT_SWITCH);
}
最后，来看一下使用姿势：
======================= 系统变量 =======================
System.setProperty(Configs.CONN_RECONNECT_SWITCH, "true");
java -Dbolt.conn.reconnect.switch = true -jar xx.jar
======================= 用户变量 =======================
RpcClient client = new RpcClient();
// 1. 通用方式，目前 ConfigItem 只有 netty write buffer 的高低水位
client.conf().set(ConfigType.CLIENT_SIDE, ConfigItem.NETTY_BUFFER_LOW_WATER_MARK, 80 * 1024);
client.conf().set(ConfigType.CLIENT_SIDE, ConfigItem.NETTY_BUFFER_HIGH_WATER_MARK, 100 * 1024);
// 2. 设置高低水位的预留方式
client.initWriteBufferWaterMark(80 * 1024, 100 * 1024);
client.init();
======================= 开关 =======================
// 1. 通用方式
client.switches().turnOn(GlobalSwitch.CONN_RECONNECT_SWITCH);
client.switches().isOn(GlobalSwitch.CONN_RECONNECT_SWITCH);
client.switches().turnOff(GlobalSwitch.CONN_RECONNECT_SWITCH);
client.init();
// 2. 预留设置
client.enableReconnectSwitch();
client.isReconnectSwitchOn();
client.disableReconnectSwith();
