java面试宝典开发手册

Java 开发手册

目录

目录...............................................................................................................................2

1、 编程规约...............................................................................................................3

1.1、 命名风格....................................................................................................3

1.2、 常量定义....................................................................................................6

1.3、 代码格式....................................................................................................7

1.4、 OOP 规约 ................................................................................................10

1.5、 集合处理..................................................................................................14

2.2、 日志规约..................................................................................................31

3、 单元测试.............................................................................................................33

4、 安全规约.............................................................................................................35

5、 附 ：专有名词解释...........................................................................................36

1、编程规约

1.1、命名风格

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

或美元符号结束。

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

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

量 = 3

3. 【强制】 类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO /

DTO / VO / AO/ PO / UID 等。

正例：JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal /

TaPromotion

反例：javaserverlessplatform / UserDo / XMLService / TCPUDPDeal /

TAPromotion

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

风格，必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

7. 【强制】 类型与中括号紧挨相连来表示数组。

正例：定义整形数组 int[] arrayDemo;

反例：在 main 参数中，使用 String args[]来定义。

8. 【强制】 POJO 类中布尔类型变量都不要加 is 前缀，否则部分框架解析会

引起序列化错误。

说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用

is_xxx 的命名方式，所以，需要在<resultMap>设置从 is_xxx 到 xxx 的

映射关系。

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

isDeleted()，RPC 框架在反向解析的时候，“误以为” 对应的属性名称是

10. 【强制】 避免在子父类的成员变量之间、或者不同代码块的局部变量之间

采用完全相同的命名，使可读性降低。

说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通

过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要

避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相

同。

反例：

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

反例：AbstractClass“缩写” 命名成 AbsClass；condition“缩写” 命

名成 condi，此类随意缩写严重降低了代码的可阅读性。

正 例 ： 在 JDK 中 ， 表 达 原 子 更 新 的 类 名 为 ：

AtomicReferenceFieldUpdater。

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

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

具体模式。

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

正例： public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

15. 【推荐】 接口类中的方法和属性不要加任何修饰符号（public 也不要

加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口

里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应

用的基础常量。

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

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

正例：CacheServiceImpl 实现 CacheService 接口。

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

常是–able 的形容词）。

正例：AbstractTranslator 实现 Translatable 接口。

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

下划线隔开。

说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是

私有。

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