Files

2.1 KiB
Raw Permalink Blame History

数据访问层编码规范

  • 功能:规定数据访问层的实现方式,避免手写 SQL 与字符串 key 取值带来的跨库隐患。
  • 何时用:编写 Mapper 或查询逻辑、需要聚合或联表、评审数据访问代码时。

编码规范

数据访问层

  • 优先使用纯 MyBatis-Plus Java API(Wrappers.<T>lambdaQuery()、selectList、selectById 等),避免手写 XML SQL
  • 复杂查询通过 Wrappers 链式构建条件,必要时使用 .apply() 拼接原生 SQL 片段
  • 查询结果一律用类承载,禁止 selectMaps + 字符串 key 取值
    • MyBatis 对 Map 结果直接用 JDBC 列名作 key,不做属性映射:map-underscore-to-camel-case 与「属性名大小写不敏感」只对类结果生效。而数据库的标识符大小写规则各不相同(MySQL 保留别名、H2/PostgreSQL 转小写、Oracle 转大写),row.get("taskNum") 会在部分库上静默取到 null,表现为「数据莫名变 0」而不是报错
    • 单列聚合用 selectObjs,多列聚合用下面的自定义 Mapper 方法
  • Wrapper 表达不了的查询(SUM/GROUP BY/多表 JOIN)收敛到 Mapper 层,用自定义方法 + 显式结果类(dto/ 下的类或实体),参考 ReviewRecallRecordMapper.sumReviewDurationByTask → dto/TaskReviewDuration + resources/mapper/ReviewRecallRecordMapper.xml
    • 结果映射:列名与属性能对应时可用自动映射,但 map-underscore-to-camel-case 必须在 application.yml 里显式声明(已配置),不要依赖框架默认值;出现别名、计算列或列名与属性不一致时必须写显式 <resultMap>
    • 自定义 SQL 不会被 @TableLogic 自动追加逻辑删除条件,必须显式写 deleted = 0;租户条件 created_by = ? 仍由 TenantLineInnerInterceptor 自动追加
    • 上述两条不能只靠 mock 单测,需落库集成测试守住(参考 ReviewDurationIntegrationTest)
    • 反向约束:Wrapper 能表达的查询不要为「类型安全」提前下沉为自定义 SQL;确实要下沉时,SQL 只留在 Mapper 层,不要在 service 里拼字符串