Skip to the content.

Home / cs-notes / Books / Java / 阿里Java开发手册 / v2022.02.03 / Note / 存疑

编程规约

命名风格

  1. 要求, 避免拼音
    • 问题: 业务中的专属名词不易翻译, 或者不容易准确又简短地翻译
      • 而且很多业务功能相似度较高, 用有限的词汇不易保证英文命名用词的唯一性
  2. [强制] 服务接口名称为 SomeService, 服务实现类命名为 SomeServiceImpl
    • 项目中命名规则是 接口为 ISomeService, 实现类为 SomeService, 是否需要调整
  3. 对于当前项目类型中, 对 DO/DTO/BO/VO 的分层理解 是否有必要统一

异常日志

日志规约

  1. 用户的异常输入, 输出 warn 日志, 留作回应用户投诉的依据

  2. 日志尽量用英文

  3. 用户敏感信息需要脱敏处理