JAVA后端|JAVA开发手册笔记 java|开发手册

项目组上周发了一个JAVA开发手册文档，阅读了以下并搜集了一些资料，做了一些笔记分享给大家
一、编程规约（一）命名风格
前期基础知识

POJO：Plain Ordinary Java Object，简单普通java对象， POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。
PO：Persistant Object，持久化对象
DTO：Data Transfer Object，数据传输对象，xxxDTO，xxx 为业务领域相关的名称。
DAO：Data Access Object，数据访问对象
BO：Business Object，业务对象
VO：Value Object/View Object，值对象，xxxVO，xxx 一般为网页名称。
AO：Application Object，应用对象

文章图片

（二）常量定义

（三）代码格式

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"); // 右大括号前换行，右大括号后有 else，不用换行 } else { System.out.println("ok"); // 在右大括号后直接结束，则必须换行 } }
注释的双斜线与注释内容之间有且仅有一个空格
在进行强制类型转换时，右括号与强制转换值之间不需要空格隔开例int a = 1; char b = (int)a;
StringBuilder sb = new StringBuilder(); // 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行 sb.append("yang").append("hao")... .append("chen")... .append("chen")... .append("chen");
参数逗号后应该加空格
IDE的中文件的换行符使用Unix格式

（四）OOP规约

静态变量或方法直接调用类名访问
所有重写的方法添加@Override注解
接口过时需要加@Deprecated注解
Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。
整型包装类的对象值之间的比较用equals方法
浮点数不能做==判断，要用误差函数，误差在某一个范围内贼认定两浮点数相等
包装型数据用compareTo方法判断，equals方法会比较精度
将Double转换为BigDecisimal例子：BigDecimal recommend1 = new BigDecimal("0.1"); BigDecimal recommend2 = BigDecimal.valueOf(0.1);，使用valueOf
类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter方法。
字符串的连接使用StringBuffer的append方法
POJO类属性必须使用包装数据类型，必须重现toString方法，不要设定任何属性的默认值，不能同时存在对应属性的isXxx()和getXxx()方法
setter方法中参数名称与类成员变量名称一致，getter、setter不要增加业务逻辑
类的访问控制（private、public、protected）

（五）日期时间

（六）集合处理

高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格

集合类	Key	Value	Super	说明
Hashtable	不允许为null	不允许为null	Dictionary	线程安全
ConcurrentHashMap	不允许为null	不允许为null	AbstractMap	锁分段技术
TreeMap	不允许为null	允许为null	AbstractMap	线程不安全
HashMap	允许为null	允许为null	AbstractMap	线程不安全

（七）并发处理

获取单例对象保证线程安全
注意加锁顺序以免出现死锁
高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
上锁在try之前，解锁在finally中
并发修改数据时，要加锁，要么在应用层加锁，要么在缓存加锁，要么在数据库曾使用乐观锁，使用version作为更新依据
- 乐观锁：在数据进行提交更新的时候，才会正式对数据的冲突与否进行检测，如果发现冲突了，则返回给用户错误的信息，让用户决定如何去做。
- 悲观锁：在修改数据之前先锁定，再修改的方式被称之为悲观并发控制，分为共享锁和拍他锁。
资金相关的金融敏感信息使用悲观锁策略：一锁、二判、三更新、四释放
Random线程安全，但是会导致性能下降

（八）控制语句

（九）注释规约

（十）前后端规约

减少null的返回
服务端发生错误需要给前端的响应信息包括：HTTP状态码、errorCode、errorMessage、用户信息提示四个部分，JSON数据格式为lowerCamelCase风格
超大整数返回使用String字符串，浮点数会存在精度损失
服务端返回数据使用JSON，前后端时间格式同意使用“yyyy-MM-dd HH:mm:ss”，统一为GMT

（十一）其他