提示：
MySqlConnectorConfig类是 Debezium 中用于配置 MySQL 连接器的一个核心组件。这个类的主要职责是管理 MySQL 连接器的所有配置选项，并确保这些配置是有效的且符合预期的行为
前言
提示：MySqlConnectorConfig 类是 Debezium MySQL 连接器配置的核心，它确保了连接器能够根据提供的配置正确地初始化和运行。通过这个类，用户可以灵活地调整 MySQL 连接器的行为，以满足不同的部署环境和需求。
提示：以下是本篇文章正文内容
一、核心功能
核心功能详细说明
-
配置管理：
- 管理 MySQL 连接器的所有配置选项，包括数据库连接信息、快照模式、GTID 过滤等。
- 提供默认配置选项，并允许用户通过外部配置文件或 API 覆盖这些默认值。
-
配置验证：
- 在构造函数中进行配置验证，确保配置的正确性和一致性。
- 实现了
validateSnapshotLockingMode方法来确保snapshot.locking.mode配置项的有效性，并处理与旧配置snapshot.minimal.locking的兼容性问题。
-
配置解析：
- 解析配置中的字符串值并转换成相应的对象类型，例如将
snapshot.locking.mode字符串转换为SnapshotLockingMode枚举值。
- 解析配置中的字符串值并转换成相应的对象类型，例如将
-
服务注册：
- 注册服务提供者，例如字符集注册服务，以支持特定数据库的字符集处理。
-
配置依赖对象创建：
- 根据配置创建依赖的对象，例如
GtidSetFactory和SnapshotLockingStrategy。
- 根据配置创建依赖的对象，例如
具体作用
-
配置定义：
- 定义了配置项如
SNAPSHOT_LOCKING_MODE和SOURCE_INFO_STRUCT_MAKER。 - 使用
ConfigDefinition来组织这些配置项，并排除不需要的配置项。
- 定义了配置项如
-
配置验证：
validateSnapshotLockingMode方法确保snapshot.locking.mode的值是有效的，并且与snapshot.minimal.locking保持一致，避免同时设置这两个配置项。
-
构造函数：
- 初始化配置相关的对象，如
GtidSetFactory和SnapshotLockingStrategy。 - 设置 GTID 源过滤器 (
gtidSourceFilter) 用于过滤 GTID 集合。
- 初始化配置相关的对象，如
-
配置访问方法：
- 提供了多个方法来访问配置项的值，例如
getSnapshotLockingMode()、getSnapshotLockingStrategy()、getGtidSourceFilter()等。
- 提供了多个方法来访问配置项的值，例如
-
快照锁定策略：
- 实现了
MySqlSnapshotLockingStrategy类，它是一个SnapshotLockingStrategy的具体实现，用于控制快照过程中是否启用锁定、最小化锁定以及是否在刷新时重置隔离级别。
- 实现了
-
上下文和连接器名称：
- 提供了
getContextName()和getConnectorName()方法来返回上下文名称和连接器名称。
- 提供了
二、代码分析
// 定义了一个名为 `SOURCE_INFO_STRUCT_MAKER` 的配置项，用于指定源信息结构生成器的默认类名。
public static final Field SOURCE_INFO_STRUCT_MAKER = CommonConnectorConfig.SOURCE_INFO_STRUCT_MAKER
.withDefault(MySqlSourceInfoStructMaker.class.getName());
// 定义了一个名为 `CONFIG_DEFINITION` 的私有静态最终字段，用于存储整个配置定义。
private static final ConfigDefinition CONFIG_DEFINITION = BinlogConnectorConfig.CONFIG_DEFINITION.edit()
// 设置配置定义的名称为 "MySQL"。
.name("MySQL")
// 排除不需要的配置项，这里排除了 `GTID_SOURCE_INCLUDES` 和 `GTID_SOURCE_EXCLUDES`。
.excluding(
BinlogConnectorConfig.GTID_SOURCE_INCLUDES,
BinlogConnectorConfig.GTID_SOURCE_EXCLUDES)
// 添加需要的配置项类型，这里添加了 `JDBC_DRIVER` 和 `JDBC_PROTOCOL`。
.type(
JDBC_DRIVER,
JDBC_PROTOCOL)
// 添加连接器级别的配置项，这里是 `SNAPSHOT_LOCKING_MODE`。
.connector(SNAPSHOT_LOCKING_MODE)
// 添加事件级别的配置项，这里包括 `GTID_SOURCE_INCLUDES`、`GTID_SOURCE_EXCLUDES` 和 `SOURCE_INFO_STRUCT_MAKER`。
.events(
GTID_SOURCE_INCLUDES,
GTID_SOURCE_EXCLUDES,
SOURCE_INFO_STRUCT_MAKER)
// 创建配置定义。
.create();
// 定义了一个名为 `configDef` 的受保护静态方法，返回配置定义。
protected static ConfigDef configDef() {
return CONFIG_DEFINITION.configDef();
}
// 定义了一个名为 `ALL_FIELDS` 的公共静态字段，包含所有配置字段的集合。
public static Field.Set ALL_FIELDS = Field.setOf(CONFIG_DEFINITION.all());
// 定义了几个私有最终字段，用于存储配置项的值。
private final GtidSetFactory gtidSetFactory;
private final Predicate<String> gtidSourceFilter;
private final SnapshotLockingMode snapshotLockingMode;
private final SnapshotLockingStrategy snapshotLockingStrategy;
// 定义了一个构造函数，用于初始化配置项的值。
public MySqlConnectorConfig(Configuration config) {
// 调用父类构造函数进行初始化。
super(MySqlConnector.class, config, DEFAULT_SNAPSHOT_FETCH_SIZE);
// 创建一个 GTID 集合工厂实例。
this.gtidSetFactory = new MySqlGtidSetFactory();
// 解析快照锁定模式配置项的值，并转换为对应的枚举值。
this.snapshotLockingMode = SnapshotLockingMode.parse(config.getString(SNAPSHOT_LOCKING_MODE), SNAPSHOT_LOCKING_MODE.defaultValueAsString());
// 创建一个快照锁定策略实例。
this.snapshotLockingStrategy = new MySqlSnapshotLockingStrategy(snapshotLockingMode);
// 设置 GTID 源过滤器。
final String gtidSetIncludes = config.getString(GTID_SOURCE_INCLUDES);
final String gtidSetExcludes = config.getString(GTID_SOURCE_EXCLUDES);
this.gtidSourceFilter = gtidSetIncludes != null ? Predicates.includesUuids(gtidSetIncludes)
: (gtidSetExcludes != null ? Predicates.excludesUuids(gtidSetExcludes) : null);
// 注册字符集服务提供者。
getServiceRegistry().registerServiceProvider(new MySqlCharsetRegistryServiceProvider());
}
// 定义了一个名为 `getSnapshotLockingMode` 的公共方法，返回快照锁定模式的可选值。
public Optional<SnapshotLockingMode> getSnapshotLockingMode() {
return Optional.of(this.snapshotLockingMode);
}
// 定义了一个名为 `getSnapshotLockingStrategy` 的受保护覆盖方法，返回快照锁定策略实例。
@Override
protected SnapshotLockingStrategy getSnapshotLockingStrategy() {
return snapshotLockingStrategy;
}
// 定义了一个名为 `getSourceInfoStructMaker` 的受保护覆盖方法，返回源信息结构生成器实例。
@Override
protected SourceInfoStructMaker<? extends AbstractSourceInfo> getSourceInfoStructMaker(Version version) {
return getSourceInfoStructMaker(SOURCE_INFO_STRUCT_MAKER, Module.name(), Module.version(), this);
}
// 定义了一个名为 `getContextName` 的受保护覆盖方法，返回上下文名称。
@Override
public String getContextName() {
return Module.contextName();
}
// 定义了一个名为 `getConnectorName` 的受保护覆盖方法，返回连接器名称。
@Override
public String getConnectorName() {
return Module.name();
}
// 定义了一个名为 `getGtidSourceFilter` 的受保护覆盖方法，返回 GTID 源过滤器。
@Override
public Predicate<String> getGtidSourceFilter() {
return gtidSourceFilter;
}
// 定义了一个名为 `getGtidSetFactory` 的受保护覆盖方法，返回 GTID 集合工厂实例。
@Override
public GtidSetFactory getGtidSetFactory() {
return gtidSetFactory;
}
// 定义了一个名为 `getHistoryRecordComparator` 的受保护覆盖方法，返回历史记录比较器实例。
@Override
protected HistoryRecordComparator getHistoryRecordComparator() {
return new MySqlHistoryRecordComparator(gtidSourceFilter, getGtidSetFactory());
}
// 定义了一个名为 `MySqlSnapshotLockingStrategy` 的内部类，实现了 `SnapshotLockingStrategy` 接口。
public static class MySqlSnapshotLockingStrategy implements SnapshotLockingStrategy {
// 定义了一个私有最终字段，用于存储快照锁定模式。
private final SnapshotLockingMode snapshotLockingMode;
// 构造函数，接收快照锁定模式作为参数。
public MySqlSnapshotLockingStrategy(SnapshotLockingMode snapshotLockingMode) {
this.snapshotLockingMode = snapshotLockingMode;
}
// 实现 `isLockingEnabled` 方法，判断是否启用了锁定。
@Override
public boolean isLockingEnabled() {
return snapshotLockingMode.usesLocking();
}
// 实现 `isMinimalLockingEnabled` 方法，判断是否启用了最小化锁定。
@Override
public boolean isMinimalLockingEnabled() {
return snapshotLockingMode.usesMinimalLocking();
}
// 实现 `isIsolationLevelResetOnFlush` 方法，判断是否在刷新时重置隔离级别。
@Override
public boolean isIsolationLevelResetOnFlush() {
return snapshotLockingMode.flushResetsIsolationLevel();
}
}
// 定义了一个名为 `validateSnapshotLockingMode` 的私有静态方法，用于验证快照锁定模式配置项的有效性。
private static int validateSnapshotLockingMode(Configuration config, Field field, ValidationOutput problems) {
// 判断 `SNAPSHOT_LOCKING_MODE` 是否被明确定义。
if (config.hasKey(SNAPSHOT_LOCKING_MODE.name())) {
final SnapshotLockingMode lockingModeValue = SnapshotLockingMode.parse(
config.getString(MySqlConnectorConfig.SNAPSHOT_LOCKING_MODE));
// 如果解析失败，则添加验证问题。
if (lockingModeValue == null) {
problems.accept(SNAPSHOT_LOCKING_MODE, lockingModeValue, "Must be a valid snapshot.locking.mode value");
return 1;
}
}
// 如果所有检查都通过，则返回 0 表示没有问题。
return 0;
}MySqlConnectorConfig 类的设计目的是为了管理 Debezium MySQL 连接器的所有配置选项，并确保这些配置是有效的且符合预期的行为。它通过面向对象的方式封装了配置项的管理、验证、解析等功能，并提供了方便的方法来访问配置项的值。
面向对象特性
- 封装：
MySqlConnectorConfig封装了 MySQL 连接器的配置信息，将配置项的管理、验证和解析等操作封装在类内部，对外提供简单的接口。 - 继承：该类继承自
BinlogConnectorConfig，复用了父类的一些通用配置项和行为，同时也扩展了针对 MySQL 特定的配置项。 - 多态：通过实现接口（如
SnapshotLockingStrategy）和覆盖方法（如getSnapshotLockingStrategy），实现了不同配置项之间的多态行为。
启发
- 明确职责：
MySqlConnectorConfig类清晰地定义了其职责范围，即管理 MySQL 连接器的配置项。这启示我们在设计类时应该遵循单一职责原则，让每个类专注于完成一项任务。 - 良好的封装：通过私有字段和公开的方法，该类实现了良好的封装，隐藏了内部实现细节，只暴露必要的接口给外部调用。这有助于提高代码的可维护性和可测试性。
- 配置项的有效性验证：通过
validateSnapshotLockingMode方法对配置项进行有效性验证，确保了配置的正确性。这启示我们，在设计系统时，应考虑对输入数据进行验证，以防止因无效配置导致的问题。 - 配置项的组合：通过
ConfigDefinition类组合配置项，使得配置项的管理和维护更加方便。这启示我们，在设计复杂的配置系统时，可以通过组合的方式来简化配置项的管理。
代码优点
- 清晰的配置定义：通过
ConfigDefinition明确地定义了配置项及其关系，提高了配置的可读性和可维护性。 - 配置验证：通过
validateSnapshotLockingMode方法对配置项进行验证，确保配置的一致性和有效性。 - 模块化设计：通过将配置项的验证、解析等逻辑分离到独立的方法中，提高了代码的模块化程度，便于维护和扩展。
- 良好的命名：变量和方法的命名清晰明了，易于理解其用途，如
gtidSourceFilter、getSnapshotLockingMode等。 - 面向接口编程：通过实现接口（如
SnapshotLockingStrategy）和覆盖方法（如getSnapshotLockingStrategy），遵循了面向接口编程的原则，提高了代码的灵活性和可扩展性。
总结
提示：MySqlConnectorConfig 类是 Debezium MySQL 连接器配置的核心，它确保了连接器能够根据提供的配置正确地初始化和运行。通过这个类，用户可以灵活地调整 MySQL 连接器的行为，以满足不同的部署环境和需求。
扫一扫
1209
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
