diff --git a/技术规范/Java后端开发规范.md b/技术规范/Java后端开发规范.md new file mode 100644 index 0000000..23649e9 --- /dev/null +++ b/技术规范/Java后端开发规范.md @@ -0,0 +1,52 @@ +# Java后端开发规范 + +> 拟稿:[黎润豪](/lirh)(个人博客) +> +>
版本号 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进行传输。 + +## 异常处理 + +## 工程结构 diff --git a/技术规范/新兵作战指南(后端篇).md b/技术规范/新兵作战指南(后端篇).md index 2a5e43c..cf57ad0 100644 --- a/技术规范/新兵作战指南(后端篇).md +++ b/技术规范/新兵作战指南(后端篇).md @@ -112,7 +112,7 @@ IDEA社区版运行tomcat必装 ### 代码规范 -推荐遵循[阿里官方Java开发手册代码规范](https://github.com/alibaba/p3c) +[Java后端开发规范](Java后端开发规范.md) ### 注释规范