2.0 KiB
2.0 KiB
Java后端开发规范
版本号 1.0.0
前言
本文为公司Java后端开发的代码规范，规范分如下两级：
- 【强制】：开发者必须遵循的开发规范要求
- 【推荐】：开发者选择性遵循的开发规范要求
编程约束
命名
- 【强制】杜绝完全不规范的缩写，避免望文不知义。
【反例】：AbstractClass缩写成AbsClass；condition缩写成condi；Function缩写成Fu。
- 【强制】严禁使用非全世界都知道的拼音命名。
正例：alibaba/youku/hangzhou
反例：suanFen【算分】，getGTHTypeCode【获取个体户类型编码】
类命名
- 【强制】采用大驼峰（UpperCamelCase）命名法，禁止使用数字命名。
【正例】：KeyPair，GlobalConfig
【反例】：areaSlice，AreaSlice1，AreaSlice2
- 【推荐】采用【名词】，【形容词+名词】的格式进行命名
【正例】：SMSSender，GlobalConfig
【反例】：SendSMS
-
【强制】抽象类必须以Abstract或Base开头（工具类例外：如StringUtils）；异常类名明必须以Exception结尾；测试类必须以Test结尾。
-
【强制】接口的参数类必须要以VO或Dto结尾命名；接口与接口之间的传输参数传输类必须以Dto结尾命名。
方法命名
-
【强制】采用小驼峰（LowerCamelCase）命名法，进制使用拼音命名
-
【推荐】方法参数不多于5个，多于5个后改用DTO进行传输。