全面的JAVA开发规范（pdf）_java规范下载

JAVA

开发规范

3星 · 超过75%的资源需积分: 9 107 浏览量更新于2023-05-27 评论收藏 1.21MB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源评论

资源推荐

Java 开发规范 
1 
 ............................................................................................................................................................  
目录 
第一章  编程规约 ............................................................................................................................. 2 
一、  命名风格 ......................................................................................................................... 2 
二、  常量定义 ......................................................................................................................... 4 
三、  代码格式 ......................................................................................................................... 5 
四、  OOP  规约 ....................................................................................................................... 7 
五、  集合处理 ......................................................................................................................... 9 
六、  并发处理 ....................................................................................................................... 12 
七、  控制语句 ....................................................................................................................... 14 
八、  注释规约 ....................................................................................................................... 15 
九、  其它约定 ....................................................................................................................... 17 
第二章  异常日志 ........................................................................................................................... 18 
一、  异常处理 ....................................................................................................................... 18 
二、  日志规约 ....................................................................................................................... 19 
第三章  数据库 ............................................................................................................................... 20 
一、  建表规约 ....................................................................................................................... 20 
二、  索引规约 ....................................................................................................................... 21 
三、  SQL  语句 ...................................................................................................................... 22 
四、  ORM 映射 ..................................................................................................................... 23 
第四章  分层 ................................................................................................................................... 24 
一、  应用分层 ....................................................................................................................... 24 
第五章  开发工具规约 ................................................................................................................... 25 
一、  MAVEN .......................................................................................................................... 25 
二、  SVN ................................................................................................................................ 26 
第六章  服务器与中间件 ............................................................................................................... 26 
一、  linux ............................................................................................................................... 26 
二、  F5 ................................................................................................................................... 27 
第七章  NOSQL ............................................................................................................................... 27 
一、  redis ............................................................................................................................... 27 
二、  mongodb ....................................................................................................................... 27 
三、  elasticsearch .................................................................................................................. 27 
 
 
 
 
 
 
 
 
 
 
 

Java 开发规范

第一章编程规约

一、命名风格

1．【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符

号结束。

反例：_name / __name / $Object / name_ / name$ / Object$

2．【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的

方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命

名方式也要避免采用。

正例：facebook / taobao / youku / cpic 等国际通用的名称，可视同英文。

反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3. 【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：

DO / BO / DTO / VO / AO

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，

必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚。

正例：MAX_STOCK_COUNT

反例：MAX_COUNT

6. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；

测试类命名以它要测试的类的名称开始，以 Test 结尾；业务逻辑类命名使用 Service 结尾；

数据持久类使用 DAO 结尾; Controller 类：业务名+Controller 以业务名开以 Controller 结尾；

Feign 接口申明以 Feign 结尾。

正例：AbstractAction /

7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args;

反例：使用 String args[]的方式来定义。

8. 【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化

错误。

反例：定义为基本数据类型 Boolean isDeleted；的属性，它的方法也是 isDeleted()，RPC

框架在反向解析的时候，“以为”对应的属性名称是 deleted，导致属性获取不到，进而抛

出异常。

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包

名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

正例：应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考

spring 的框架结构）

Java 开发规范

10. 【强制】杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随

意缩写严重降低了代码的可阅读性。

11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完

整的单词组合来表达其意。

正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。

反例：变量 int a; 的随意命名方式。

12. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例： public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

13. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代

码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义

变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名：void f();

接口基础常量表示：String COMPANY = "alibaba";

反例：接口方法定义：public abstract void f();

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价

值的默认实现。

14. 接口和实现类的命名有两套规则：

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是

接口，内部的实现类用 Impl 的后缀与接口区别。

正例：CacheServiceImpl 实现 CacheService 接口。

2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able

的形式）。

正例：AbstractTranslator 实现 Translatable。

15. 【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下

划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKOWN_REASON。

16. 【参考】各层命名规约：

A) Service/DAO 层方法命名规约

1）获取单个对象的方法用 get 做前缀。

2）获取多个对象的方法用 list 做前缀。

3）获取统计值的方法用 count 做前缀。

4）插入的方法用 save/insert 做前缀。

5）删除的方法用 remove/delete 做前缀。

6）修改的方法用 update 做前缀。

B) Controller 层命名规约

1) 在 CLASS 类名前申明 Controller 路径。

正例：

@Controller

Java 开发规范

了表示“是”的变量：

类 A 中：public static final String YES = "yes";

类 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

3）子工程内部共享常量：即在当前子工程的 constant 目录下。

4）包内共享常量：即在当前包下单独的 constant 目录下。

5）类内共享常量：直接在类内部 private static final 定义。

5. 【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚

举类。下面正例中的数字就是延伸信息，表示星期几。

正例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5),

SATURDAY(6), SUNDAY(7);}

三、代码格式

1. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换

行；如果是非空代码块则：

1）左大括号前不换行。

2）左大括号后换行。

3）右大括号前换行。

4）右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

2. 【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空

格。详见第 5 条下方正例提示。

反例：if (空格 a == b 空格)

3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格

时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

正例：（涉及 1-5 点）

public static void main(String[] args) {

// 缩进 4 个空格

String say = "hello";

// 运算符的左右必须有一个空格

int flag = 0;

// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不

需要空格

if (flag == 0) {

System.out.println(say);

}

// 左大括号前加空格且不换行；左大括号后换行

if (flag == 1) {

System.out.println("world");

剩余27页未读，继续阅读

Hi,好先生

2018-12-04

好,可以使用

y543188451

粉丝: 1
资源: 1

会员权益专享

全面的JAVA开发规范（pdf）

评论1

会员权益专享

最新资源

全面的JAVA开发规范（pdf）

评论1

阿里巴巴Java开发规范手册.pdf

java范例开发大全pdf版

java PDF 转 PDF

2023高级java面试题pdf

刘中兵 java真经高手 pdf

java 使用 itextpdf 打印PDF文件

java openoffice转换pdf文件

java原生打印PDF文件

java高级面试题pdf

java html转pdf

java 图片转pdf

java pdf工具类

java生成pdf工具类

华为JAVA编码规范.pdf

echarts导出java到pdf

java WORD 转pdf

java ofd转pdf

京瓷复合机扫描设置软件

BSP89 INFINEON 英飞凌芯片 中文版规格书手册.pdf

会员权益专享

最新资源

BSP89 INFINEON 英飞凌芯片中文版规格书手册.pdf