Java - 《阿里Java开发手册》代码规范学习笔记1（编程规约）

一、 编程规约

1，包名统一使用小写

2，接口类中的方法和属性不要加任何修饰符号

3，接口和实现类的命名规则

4，枚举

// 枚举样例1
public enum ProcessStatusEnum {
    SUCCESS, PARAM_EMPTY, UNKNOWN_REASON
}

// 枚举样例2
public enum ProcessStatusEnum {
    SUCCESS("0000", "成功"),
    PARAM_EMPTY("1001", "必选参数为空"),
    UNKNOWN_REASON("9999", "未知原因成功");

    private String code;
    private String message;

    ProcessStatusEnum(String code, String message) {
        this.code = code;
        this.message = message;
    }

    public String getCode() {
        return this.code;
    }
    
    public String getMessage() {
        return this.message;
    }
}

5，各层命名规约

• 获取单个对象的方法用 get 做前缀。
• 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。获取统计值的方法用 count 做前缀。
• 插入的方法用 save/insert 做前缀。
• 删除的方法用 remove/delete 做前缀。
• 修改的方法用 update 做前缀。

• 数据对象：xxxDO，xxx 即为数据表名。
• 数据传输对：xxxDTO，xxx 为业务领域相关的名称。
• 展示对象：xxxVO，xxx 一般为网页名称。

6，变量、常量定义

public enum SeasonEnum {
    SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

    private int seq;

    SeasonEnum(int seq) {
        this.seq = seq;
    }

    public int getSeq() {
        return seq;
    }
}

7，采用 4 个空格缩进

8，所有的覆写方法，必须加 @Override 注解。

9，equals 比较

10，浮点数之间的等值判断

float a = 1.0F - 0.9F;
float b = 0.9F - 0.8F;
float diff = 1e-6F;

if (Math.abs(a - b) < diff) {
    System.out.println("true");
}

BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");

BigDecimal x = a.subtract(b);
BigDecimal y = b.subtract(c);

if (x.compareTo(y) == 0) {
    System.out.println("true");
}

11，BigDecimal 规范

BigDecimal recommend1 = new BigDecimal("0.1");
BigDecimal recommend2 = BigDecimal.valueOf(0.1);

12，基本数据类型与包装数据类型的使用标准

14，循环体内使用 append 方法进行字符串连接

// 这是一个错误示范
String str = "start";
for (int i = 0; i < 100; i++) {
    str = str + "hello"; 
}

15,使用 final 关键字的情况

• 不允许被继承的类，如：String 类。
• 不允许修改引用的域对象，如：POJO 类的域变量。
• 不允许被覆写的方法，如：POJO 类的 setter 方法。
• 不允许运行过程中重新赋值的局部变量。
• 避免上下文重复使用一个变量，使用 final 关键字可以强制重新定义一个变量，方便更好地进行重构。

16，类成员与方法访问控制从严

17，hashCode 和 equals 的处理规则

18，集合转数组规范

List<String> list = new ArrayList<>(2); 
list.add("guan");
list.add("bao");
String[] array = list.toArray(new String[0]);

String[] str = new String[] { "chen", "yang", "hao" };
List list = Arrays.asList(str); 

list.add("yangguanbao");  // 会出现运行时异常

str[0] = "change";  // list里对应的值也会随之修改，反之亦然。

20，<? extends T> 与 <? super T>

21，不要在 foreach 循环里进行元素的 remove/add 操作

//正确的做法
List <String> list = new ArrayList <>();
list.add("1");
list.add("2");
Iterator <String> iterator = list.iterator();
while (iterator.hasNext()) {
    String item = iterator.next();
    if (删除元素的条件) {
        iterator.remove();
    }
}

//错误的做法
for (String item: list) {
    if ("1".equals(item)) {
        list.remove(item);
    }
}

22，Comparator 实现类规范

• x，y 的比较结果和 y，x 的比较结果相反。
• x>y，y>z，则 x>z。
• x=y，则 x，z 比较结果和 y，z 比较结果相同。

new Comparator < Student > () {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }
};

23，集合泛型定义规范

// diamond 方式，即<>
HashMap<String, String> userCache = new HashMap<>(16); 

// 全省略方式
ArrayList<User> users = new ArrayList(10);

24，遍历 Map 类集合 KV

• keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。
• 而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。

Set<Map.Entry<String, String>> entryseSet=map.entrySet();
for (Map.Entry<String, String> entry:entryseSet) {
    System.out.println(entry.getKey()+","+entry.getValue());
}

infoMap.forEach((key, value) -> {
    System.out.println(key + "：" + value);
});

25，Map 类集合 K/V 能不能存储 null 值的情况

26，使用 Set 去重

27，创建线程或线程池时指定有意义的名称

• 比如自定义线程工厂，并且根据外部特征进行分组，比如，来自同一机房的调用，把机房编号赋值给 whatFeatureOfGroup

public class UserThreadFactory implements ThreadFactory {
	private final String namePrefix;
	private final AtomicInteger nextId = new AtomicInteger(1);

	// 定义线程组名称，在利用 jstack 来排查问题时，非常有帮助
	UserThreadFactory(String whatFeatureOfGroup) {
		namePrefix = "From UserThreadFactory's " + whatFeatureOfGroup + "-Worker-";
	}

	@Override
	public Thread newThread(Runnable task) {
		String name = namePrefix + nextId.getAndIncrement();
		Thread thread = new Thread(null, task, name, 0);
		System.out.println(thread.getName());
		return thread;
	}
}

28，线程资源必须通过线程池提供

29，线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式

30，SimpleDateFormat 使用规范

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
    @Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    }
};

objectThreadLocal.set(userInfo);
try {
    // ...
} finally {
    objectThreadLocal.remove();
}

32，锁的使用规范

33，并发修改同一记录时需要加锁

34，Timer&TimerTask 与 ScheduledExecutorService 比较

35，避免 Random 实例被多线程使用

36，多线程统计次数问题（count++）

AtomicInteger count = new AtomicInteger();
count.addAndGet(1);

LongAdder count = new LongAdder();
count.increment(); // count.add(1L);

37，ThreadLocal 对象使用 static 修饰

38，避免用 Apache Beanutils 进行属性的 copy

39，获取整数类型的随机数

Random random = new Random();
System.out.println(random.nextInt(4)); // 获取 0~3 范围内（包括 0 和 3 )的 int 类型的随机数

40，获取当前毫秒数

41，日期格式化表达式的年份统一使用小写 y

new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

42，日志输出时，字符串变量间使用占位符方式拼接

logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

43，对于 trace/debug/info 级别的日志输出，必须进行日志级别的开关判断

// 如果判断为真，那么可以输出 trace 和 debug 级别的日志
if (logger.isDebugEnabled()) {
    logger.debug("Current ID is: {} and name is: {}", id, getName());
}

44，生产环境日志、异常输出规范

附：工程结构

1，分层领域模型规约

• DO(Data Object)：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
• DTO(Data Transfer Object)：数据传输对象，Service 或 Manager 向外传输的对象。
• BO(Business Object)：业务对象，可以由 Service 层输出的封装业务逻辑的对象。
• Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。
• VO(View Object)：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

2，二方库版本号命名规范

3，禁止在子项目的 pom 依赖中出现相同的 GroupId 和 ArtifactId，但是不同的 Version

4，高并发服务器建议调小 TCP 协议的 time_wait 超时时间

5，调大服务器所支持的最大文件句柄数

6，让 JVM 碰到 OOM 场景时输出 dump 信息

//dump文件存放位置使用相对路径
nohup java -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=./ -jar test-0.0.1-SNAPSHOT.jar >/dev/null 2>&1 &

//dump文件存放位置使用绝对路径
nohup java -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/usr/local/log/ -jar test-0.0.1-SNAPSHOT.jar >/dev/null 2>&1 &

7，将 JVM 的 Xms 和 Xmx 设置成一样大小