Merge branch 'master' of 47.107.61.133:chinaweal/public
This commit is contained in:
commit
82c526ce0b
|
|
@ -0,0 +1,52 @@
|
|||
# Java后端开发规范
|
||||
|
||||
> 拟稿：[黎润豪](/lirh)<a href="https://blog.lroyia.top" target="_blank">（个人博客）</a>
|
||||
>
|
||||
> <div><font>版本号 1.0.0 </font></div>
|
||||
>
|
||||
|
||||
## 前言
|
||||
|
||||
本文为公司Java后端开发的代码规范，规范分如下两级：
|
||||
|
||||
- <font color="red">【强制】</font>：开发者必须遵循的开发规范要求
|
||||
- <font color="green">【推荐】</font>：开发者选择性遵循的开发规范要求
|
||||
|
||||
## 编程约束
|
||||
|
||||
### 命名
|
||||
|
||||
- <font color="red">【强制】</font>杜绝完全不规范的缩写，避免望文不知义。
|
||||
|
||||
> <font color="red">【反例】</font>：AbstractClass缩写成AbsClass；condition缩写成condi；Function缩写成Fu。
|
||||
|
||||
- <font color="red">【强制】</font>严禁使用非全世界都知道的拼音命名。
|
||||
|
||||
> <font color="green">正例</font>：alibaba/youku/hangzhou
|
||||
> <font color="red">反例</font>：suanFen【算分】，getGTHTypeCode【获取个体户类型编码】
|
||||
|
||||
#### 类命名
|
||||
|
||||
- <font color="red">【强制】</font>采用大驼峰（UpperCamelCase）命名法，禁止使用数字命名。
|
||||
|
||||
> <font color="green">【正例】</font>：KeyPair，GlobalConfig
|
||||
> <font color="red">【反例】</font>：areaSlice，AreaSlice1，AreaSlice2
|
||||
|
||||
- <font color="green">【推荐】</font>采用【名词】，【形容词+名词】的格式进行命名
|
||||
|
||||
> <font color="green">【正例】</font>：SMSSender，GlobalConfig
|
||||
> <font color="red">【反例】</font>：SendSMS
|
||||
|
||||
- <font color="red">【强制】</font>抽象类必须以Abstract或Base开头（工具类例外：如StringUtils）；异常类名明必须以Exception结尾；测试类必须以Test结尾。
|
||||
|
||||
- <font color="red">【强制】</font>接口的参数类必须要以VO或Dto结尾命名；接口与接口之间的传输参数传输类必须以Dto结尾命名。
|
||||
|
||||
#### 方法命名
|
||||
|
||||
- <font color="red">【强制】</font>采用小驼峰（LowerCamelCase）命名法，进制使用拼音命名
|
||||
|
||||
- <font color="green">【推荐】</font>方法参数不多于5个，多于5个后改用DTO进行传输。
|
||||
|
||||
## 异常处理
|
||||
|
||||
## 工程结构
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# 技术规范
|
||||
|
||||
入职请先看：
|
||||
|
||||
- [新兵作战指南（前端篇）](新兵作战指南（前端篇）.md)
|
||||
- [新兵作战指南（后端篇）](新兵作战指南（后端篇）.md)
|
||||
|
|
@ -112,7 +112,7 @@ IDEA社区版运行tomcat必装
|
|||
|
||||
### 代码规范
|
||||
|
||||
推荐遵循[阿里官方Java开发手册代码规范](https://github.com/alibaba/p3c)
|
||||
[Java后端开发规范](Java后端开发规范.md)
|
||||
|
||||
### 注释规范
|
||||
|
||||
|
|
@ -179,12 +179,12 @@ IDEA社区版运行tomcat必装
|
|||
|
||||
Q1：如何快速地去熟悉自己所要负责的项目。
|
||||
|
||||
A2：在接到项目后，我们应首先去了解项目背景和项目的主干业务流程。根据自己的社会阅历去对整体项目进行一个初步的完整业务推测模型。推测完后，再去阅读其他相关的项目文档和源码去印证修改自己的业务模型。
|
||||
> A1：在接到项目后，我们应首先去了解项目背景和项目的主干业务流程。根据自己的社会阅历去对整体项目进行一个初步的完整业务推测模型。推测完后，再去阅读其他相关的项目文档和源码去印证修改自己的业务模型。
|
||||
|
||||
Q2：阅读源码过程中，遇到自己未曾涉足过的技术点怎么办？
|
||||
|
||||
A2：首先，我们要确定这个技术点是否会对我们的业务开发和修改有所关联，从而确定我们是否真的需要关注这个技术点相关的接口或代码段。如果不需要，我们就只需记下这段的位置，将需求完成后再反过来去学习提升自己。如果需要去关注这个技术点，首先到企业微信上找对应的人问，同时提取技术点的关键词，到百度中找该技术点的资料。如果在该问题在2小时内未能解决，应及时在项目组群内问，请求协助，切勿藏着问题。
|
||||
> A2：首先，我们要确定这个技术点是否会对我们的业务开发和修改有所关联，从而确定我们是否真的需要关注这个技术点相关的接口或代码段。如果不需要，我们就只需记下这段的位置，将需求完成后再反过来去学习提升自己。如果需要去关注这个技术点，首先到企业微信上找对应的人问，同时提取技术点的关键词，到百度中找该技术点的资料。如果在该问题在2小时内未能解决，应及时在项目组群内问，请求协助，切勿藏着问题。
|
||||
|
||||
Q3：如何快速找到我要修改的别人已经开发的功能点的代码位置。
|
||||
|
||||
A3：运行项目，在浏览器中的network找到对应业务的相关接口。通过[RestfulTool](#restfultool)插件（快捷键`ctrl`+`alt`+`/`）搜索该接口，接口找到对应的diamante位置。
|
||||
> A3：运行项目，在浏览器中的network找到对应业务的相关接口。通过[RestfulTool](#restfultool)插件（快捷键`ctrl`+`alt`+`/`）搜索该接口，接口找到对应的diamante位置。
|
||||
|
|
|
|||
Loading…
Reference in New Issue