SchemaCrawler 项目中的 Lint 功能优化解析

背景介绍

SchemaCrawler 是一个强大的数据库元数据管理工具，它提供了丰富的功能来分析和处理数据库结构。其中 Lint 功能是其重要组成部分，用于检查数据库模式中的潜在问题或不符合规范的地方。

问题发现与改进过程

在 SchemaCrawler 16.22.3 版本中，Lint 功能的实现存在一个设计问题：当调用 Linters#lint 方法时，不仅会返回检查结果，还会将这些结果存储在目录对象及其包含的表对象中。这种隐式的状态改变给开发者带来了困扰，特别是当需要多次执行 Lint 检查时。

原有实现的问题

1. 副作用明显：Lint 方法不仅返回结果，还修改了传入的 Catalog 对象状态
2. 清理困难：开发者需要手动清除存储在 Catalog 和 Table 对象中的 Lint 结果
3. API 设计不直观：方法行为与开发者预期不符

优化方案

开发团队对这一问题进行了深入分析和改进：

1. 移除副作用：修改 Lint 方法使其不再修改传入的 Catalog 对象
2. 引入 LintReport：创建专门的不可变对象来承载 Lint 结果
3. 并行处理：优化 Lint 检查的执行效率，支持并行处理
4. 流式处理：新增流式 API 方便处理大量 Lint 结果

技术实现细节

LintReport 设计

新的 LintReport 类具有以下特点：

1. 不可变性：确保结果的一致性和线程安全
2. 流式处理：提供 stream() 方法支持高效处理大量结果
3. 构建器模式：通过 LintReportBuilder 灵活构建报告

使用示例

开发者现在可以这样使用 Lint 功能：

// 初始化 Linters
Linters linters = new Linters(linterConfigs, true);

// 执行 Lint 检查
LintReport report = linters.lint(catalog, connection);

// 处理结果
List<Lint> currentLints = report.getLints().stream()
    .map(Lint.class::cast)
    .toList();

自定义报告生成

对于需要筛选结果的场景，可以使用 LintReportBuilder：

// 筛选新的 Lint 结果
List<Lint> newLints = currentLints.stream()
    .filter(l -> !lastLints.contains(l))
    .toList();

// 构建自定义报告
LintReport newReport = new LintReportBuilder()
    .withLints(newLints)
    .build();

// 生成报告文本
new LintReportTextFormatter(...).generateLintReport(newReport);

其他改进

1. 恢复 CrawlInfo 访问：重新提供了获取数据库系统信息的能力，方便开发者编写特定数据库的 Lint 规则
2. 性能优化：通过并行处理提高了大规模数据库的 Lint 检查效率

总结

SchemaCrawler 16.23.2 版本对 Lint 功能进行了重要改进，解决了原有实现中的设计问题，提供了更清晰、更高效的 API。这些改进使得：

1. API 行为更加符合开发者预期
2. 消除了不必要的副作用
3. 提供了更灵活的结果处理方式
4. 提高了大规模数据库的检查效率

这些改进使得 SchemaCrawler 的 Lint 功能更加健壮和易用，为开发者提供了更好的体验。