Spring Boot 配置 diff 实战

做配置管理时，diff 是绕不开的功能。

比如运维要修改生产环境配置，改之前总想确认一下具体动了什么；或者比对下测试环境和生产环境的配置，看看哪里不一样。还有配置回滚前，需要看看当前版本和目标版本的差异。

这些场景都离不开差异比对。

通常我们会想到用 Unix 的 diff 命令或者 Git 的 diff 功能。但这些东西都是命令行工具，要集成到 Web 应用里还得做不少解析工作，而且输出格式也不友好，不适合直接展示给用户。

什么是 java-diff-utils

java-diff-utils 是一个强大的文本差异比对库，源自 Google 的 diff-match-patch 算法。它能够：

• 精准识别文本的增删改变化
• 生成类似 git diff 的差异报告
• 支持行级、字符级的细粒度比对
• 提供多种差异格式输出（unified、inline 等）

xml 复制代码

    
    
    
  <dependency>
    <groupId>io.github.java-diff-utils</groupId>
    <artifactId>java-diff-utils</artifactId>
    <version>4.12</version>
</dependency>

实战一：配置文件比对

先从最常见的需求入手：比对两个配置文件差异。核心代码非常简洁：

less 复制代码

    
    
    
  // 按行分割
List<String> originalLines = Arrays.asList(original.split("\n"));
List<String> revisedLines = Arrays.asList(revised.split("\n"));

// 计算差异
Patch<String> patch = DiffUtils.diff(originalLines, revisedLines);

// 遍历差异
for (AbstractDelta<String> delta : patch.getDeltas()) {
    System.out.println(delta.getType() + " at line " + delta.getSource().getPosition());
    // INSERT: 新增行
    // DELETE: 删除行
    // CHANGE: 修改行
}

DiffUtils.diff() 会返回一个 Patch 对象，其中包含了所有的差异块。每个 Delta 记录了变更类型（INSERT/DELETE/CHANGE）、位置和具体内容。

实战二：配置变更可视化

纯文本的 diff 报告不够直观？来个 HTML 可视化版本。核心思路就是遍历差异，用不同颜色标注增删改：

less 复制代码

    
    
    
  for (DiffChange change : diffResult.getChanges()) {
    // 差异头部
    html.append("<div class='diff-header'>")
        .append(String.format("@@ -%d +%d @@", srcLine, tgtLine))
        .append("</div>");

    // 删除的行（红色背景）
    for (String line : change.getOriginalLines()) {
        html.append("<div class='diff-remove'>- ").append(line).append("</div>");
    }

    // 新增的行（绿色背景）
    for (String line : change.getRevisedLines()) {
        html.append("<div class='diff-add'>+ ").append(line).append("</div>");
    }
}

配合简单的 CSS（绿色背景表示新增，红色背景表示删除），就能得到类似 Git 的 diff 展示效果。

实战三：Properties 文件智能比对

配置文件往往有顺序差异，但实际内容相同。直接按行比对会产生大量噪音。这时候应该解析为 Properties 对象，按 key 进行比对：

vbnet 复制代码

    
    
    
  // 解析为 Properties
Properties original = new Properties();
original.load(new ByteArrayInputStream(originalContent.getBytes()));
Properties revised = new Properties();
revised.load(new ByteArrayInputStream(revisedContent.getBytes()));

// 找出删除的 key
Set<String> removedKeys = new HashSet<>(original.stringPropertyNames());
removedKeys.removeAll(revised.stringPropertyNames());

// 找出新增的 key
Set<String> addedKeys = new HashSet<>(revised.stringPropertyNames());
addedKeys.removeAll(original.stringPropertyNames());

// 找出修改的 key
for (String key : original.stringPropertyNames()) {
    if (!Objects.equals(original.getProperty(key), revised.getProperty(key))) {
        modifiedKeys.add(key);
    }
}

这样比对结果只关注真正的配置变更，不会因为顺序调整而误报。

实战四：集成配置中心

把 Diff 功能集成到配置变更流程中，每次变更自动比对并记录：

scss 复制代码

    
    
    
  @Transactional
public void auditConfigChange(String configId, String newContent, String operator) {
    // 获取原配置
    ConfigEntity oldConfig = configRepository.findById(configId).orElseThrow();

    // 比对差异
    PropertiesDiffResult diff = diffService.compareProperties(
        oldConfig.getContent(), newContent);

    if (!diff.hasChanges()) {
        return; // 无变更，直接返回
    }

    // 保存变更记录
    ConfigChangeLog changeLog = new ConfigChangeLog();
    changeLog.setConfigId(configId);
    changeLog.setOperator(operator);
    changeLog.setDiffResult(JSON.toJSONString(diff));
    configChangeLogRepository.save(changeLog);

    // 发送通知
    notificationService.notifyConfigChange(diff, operator);
}

这样每次配置变更都会自动生成差异报告，方便审计和回溯。

进阶技巧

1. 忽略空白差异：比对前对文本进行归一化处理

arduino 复制代码

    
    
    
  List<String> normalizeLines(List<String> lines) {
    return lines.stream()
        .map(String::trim)
        .filter(line -> !line.isEmpty())
        .collect(Collectors.toList());
}

2. YAML 配置比对：先解析为 JSON 树，再转为规范格式比对

ini 复制代码

    
    
    
  // 解析 YAML
ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());
JsonNode originalTree = yamlMapper.readTree(originalYaml);
JsonNode revisedTree = yamlMapper.readTree(revisedYaml);

// 转为规范 JSON 字符串后比对
String originalJson = new ObjectMapper().writeValueAsString(originalTree);
String revisedJson = new ObjectMapper().writeValueAsString(revisedTree);
return compareConfigs(originalJson, revisedJson);

3. 大文件处理：配置文件过大时，建议分块比对或使用增量比对策略，避免内存溢出。

总结

java-diff-utils 虽然是个小工具，但在配置管理场景下非常实用。通过本文的实践，你可以轻松实现配置文件差异比对、可视化展示、变更审计等功能。

下面仓库提供了完整的web在线比对DEMO

ruby 复制代码

    
    
    
  https://github.com/yuboon/java-examples/tree/master/springboot-text-diff