Java 最佳命名规则记录

时间:2023-03-09 15:49:48
Java 最佳命名规则记录
  1. 类名:使用双驼峰规则。如 TestService
  2. 包名:命名全小写,且使用小写 如使用 web.csvdata.util 而不是 web.csvData.util 或 web.csvdata.utils
  3. 数据库和表名:用下划线分割命名
  4. 变量命名:使用单驼峰,且变量名需要自解释。如使用 id2ValueMap 而不是 idMap
  5. 变量长度:保证自解释,再长也不用缩写
  6. 布尔值: 使用boolean started 而不是 boolean start、 boolean isUser 而不是 boolean user
  7. 保存资源方法名:幂等用save,不幂等用add
  8. 方法命名:{ACTION}{TARGET_DESC}(by|to){PARAM_DESC}{BEHAVIOR_DESC}

    其中 ACTION: save/add/update/get/query/remove/。

    TARGET_DESC:操作对象的描述。比如getUserDataById里的UserData

    PARAM_DESC:使用的参数的说明。比如 byId、byIds里的Id和Ids

    BEHAVIOR_DESC: 行为的描述: 如同步syn,异步Async

    比如需要写一个通过id获取活动信息的异步方法。可以命名为getActivityByIdAsync()