agilelabs-fx-docs main checks/naming-and-data-conversion.md

命名与数据转换检查

本页用于检查 C#、数据库和前端三层之间的命名风格、转换机制和语义一致性。

检查目标

  • 判断项目是否明确区分 PascalCasesnake_casecamelCase 三层规则。
  • 判断命名转换是否由统一配置承担,而不是靠人工散落处理。
  • 判断同一概念是否在不同层保持同一根词。

必查项

  • C# 代码对象是否统一使用 PascalCase
  • 数据库表名、列名和审计字段是否统一使用 snake_case
  • 前端 JSON 字段是否统一使用 camelCase
  • ORM、Json 序列化和映射层是否提供统一转换机制。
  • 同一概念是否在数据库、实体、DTO、接口字段中保持同一根词。

判定标准

  • 格式差异由统一配置转换,语义命名保持一致,判定为合规。
  • 若控制器、SQL 或前端页面里手工维护多套字段名,判定为不合规。
  • 若数据库命名、代码命名和前端命名都没有清晰边界,判定为高风险。
  • 若旧系统存在偏差但有适配层隔离,判定为受控偏差。

常见不合规信号

  • 数据库表名使用 PascalCase 或混用多种风格。
  • 前端直接消费 PascalCase 字段。
  • 代码里同时出现 user_idUserIduserId,但没有统一转换入口。
  • 同一概念在不同层分别叫 userIdaccountIdmemberId,语义不一致。

规则依据

示例项目对照