JSON 排序集成指南与工作流自动化#

介绍#

JSON 排序是一个看起来很”小”的功能，但将其集成到自动化工作流中后，能够产生意想不到的效果。本文将介绍 4 个集成方案，让你的代码管道自动处理 JSON 排序。

集成场景#

场景一：Git Pre-commit 自动排序#

在 Git 提交前自动对项目中的 JSON 文件排序：

1
- repo: local
2
  hooks:
3
    - id: sort-json-files
4
      name: Sort JSON config files
5
      entry: powershell -Command "Get-ChildItem -Filter *.json -Recurse | ForEach-Object { json-sort-cli $_.FullName }"
6
      language: system
7
      files: \.json$

场景二：API 响应自动排序脚本#

在后端服务中增加中间件，对响应 JSON 自动排序：

1
// Express 中间件 - 自动排序响应体
2
function sortResponse(req, res, next) {
3
  const originalJson = res.json.bind(res);
4
  res.json = function(body) {
5
    if (body && typeof body === 'object') {
6
      body = sortKeysRecursive(body);
7
    }
8
    return originalJson(body);
9
  };
10
  next();
11
}
12

13
function sortKeysRecursive(obj) {
14
  if (Array.isArray(obj)) return obj.map(sortKeysRecursive);
15
  if (obj !== null && typeof obj === 'object') {
16
    return Object.keys(obj).sort().reduce((acc, key) => {
17
      acc[key] = sortKeysRecursive(obj[key]);
18
      return acc;
19
    }, {});
20
  }
21
  return obj;
22
}

场景三：数据 ETL 管道中的排序环节#

在 ETL（提取 - 转换 - 加载）流程中，在数据转换阶段加入排序步骤：

1
# ETL pipeline step
2
import json
3

4
def transform_step(raw_data):
5
    data = json.loads(raw_data)
6
    sorted_data = json.dumps(data, indent=2, sort_keys=True, ensure_ascii=False)
7
    return sorted_data

场景四：CI 构建产物排序#

在 CI 中构建完成后，对所有生成的 JSON 文件执行统一排序：

1
- name: Normalize JSON output
2
  run: |
3
    # 对所有构建产物中的 JSON 文件排序
4
    for file in dist/**/*.json; do
5
      node -e "
6
        const fs = require('fs');
7
        const data = JSON.parse(fs.readFileSync('$file', 'utf8'));
8
        fs.writeFileSync('$file', JSON.stringify(data, null, 2) + '\n');
9
      "
10
    done

总结#

JSON 排序虽然简单，但通过工作流自动化可以在整个团队层面统一标准。使用星点网 JSON 排序工具进行日常开发和调试，结合 Git Hooks 和 CI 流程实现自动化，让 JSON 数据始终保持一致的顺序规范。

更多在线工具，请访问星点网 xingdian.net 免费使用。