JAVA环境搭建后的必备良器,阿里代码规范检查工具

作者: admin 分类: Tools 发布时间: 2018-10-11 01:00  阅读: 243 views
  • 看到项目代码一团乱麻你是否很头疼?
  • 仔细揣摩同一项目下迥异的写作风格是否很奔溃?
  • 很后怕没有规范的约束项目后期是否越来越臃肿,难以扩展?
  • 开发环境好不容易搭建好难道就是为了一堆垃圾代码服务么?

经历过的人肯定知道规范统一的项目后期非常容易调整、升级等。见识过的人肯定也想遵循一套固定的规则去完成项目并约束自己的习惯。团队内部的协作人员更加肯定知道这意味着效率的提升、解疑的方便性。

良心的阿里开发团队做了一个良心的插件产品。很贴合的解决了这个问题。如下图

 

操作简单、提示明确,并且带有正确的范例说明,更能够快速的定位问题代码。

果然是一个精心制作、用心良苦的好物。

有代码洁癖的赶紧拿来试试了。

代码已经开源,

GitHub:https://github.com/alibaba/p3c

eclipse规范检查工具的安装使用请看

https://github.com/alibaba/p3c/tree/master/eclipse-plugin

Idea规范检查工具的安装使用请看

https://github.com/alibaba/p3c/tree/master/idea-plugin

 

 

试用之后感觉很好,个人可以潜移默化的改变自己的编码风格,团队可以快速统一格式,好用且得益颇多。

以下是摘出的部分编码规范:

数据库部分


 

  1. 【强制】不要使用count(列名)或count(常量)来替代count(),count()是SQL92定义的标准统计行数的语法,跟数据库无关,跟NULL和非NULL无关。
  2. 说明:count(*)会统计值为NULL的行,而count(列名)不会统计此列为NULL值的行。
  3. 【强制】count(distinct col) 计算该列除NULL之外的不重复行数,注意 count(distinct col1, col2) 如果其中一列全为NULL,那么即使另一列有不同的值,也返回为0。
  4. 【强制】当某一列的值全是NULL时,count(col)的返回结果为0,但sum(col)的返回结果为NULL,因此使用sum()时需注意NPE问题。
  5. 正例:可以使用如下方式来避免sum的NPE问题: SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;
  6. 【强制】使用ISNULL()来判断是否为NULL值。 说明:NULL与任何值的直接比较都为NULL。
  7. 1) NULL<>NULL的返回结果是NULL,而不是false。
  8. 2) NULL=NULL的返回结果是NULL,而不是true。
  9. 3) NULL<>1的返回结果是NULL,而不是true。
  10. 【强制】 在代码中写分页查询逻辑时,若count为0应直接返回,避免执行后面的分页语句。
  11. 【强制】不得使用外键与级联,一切外键概念必须在应用层解决。
  12. 说明:以学生和成绩的关系为例,学生表中的student_id是主键,那么成绩表中的student_id则为外键。如果更新学生表中的student_id,同时触发成绩表中的student_id更新,即为级联更新。外键与级联更新适用于单机低并发,不适合分布式、高并发集群;级联更新是强阻塞,存在数据库更新风暴的风险;外键影响数据库的插入速度。
  13. 【强制】禁止使用存储过程,存储过程难以调试和扩展,更没有移植性。
  14. 【强制】数据订正(特别是删除、修改记录操作)时,要先select,避免出现误删除,确认无误才能执行更新语句。
  15. 【推荐】in操作能避免则避免,若实在避免不了,需要仔细评估in后边的集合元素数量,控制在1000个之内。
  16. 【参考】如果有全球化需要,所有的字符存储与表示,均以utf-8编码,注意字符统计函数的区别。
  17. 说明:

SELECT LENGTH(“轻松工作”); 返回为12

SELECT CHARACTER_LENGTH(“轻松工作”); 返回为4

如果需要存储表情,那么选择utf8mb4来进行存储,注意它与utf-8编码的区别。

18. 【参考】 TRUNCATE TABLE 比 DELETE 速度快,且使用的系统和事务日志资源少,但TRUNCATE无事务且不触发trigger,有可能造成事故,故不建议在开发代码中使用此语句。

说明:TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。


编码部分

  1. 【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全。
  2. 说明:资源驱动类、工具类、单例工厂类都需要注意。
  3. 【强制】创建线程或线程池时请指定有意义的线程名称,方便出错时回溯。
  4. 正例:

public class TimerTaskThread extends Thread {

public TimerTaskThread() {

super.setName(“TimerTaskThread”);

}

}

  1. 【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。
  2. 说明:使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销,解决资源不足的问题。如果不使用线程池,有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
  3. 【强制】线程池不允许使用Executors去创建,而是通过ThreadPoolExecutor的方式,这样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。
  4. 说明:Executors返回的线程池对象的弊端如下: 1)FixedThreadPool和SingleThreadPool: 允许的请求队列长度为Integer.MAX_VALUE,可能会堆积大量的请求,从而导致OOM。 2)CachedThreadPool和ScheduledThreadPool: 允许的创建线程数量为Integer.MAX_VALUE,可能会创建大量的线程,从而导致OOM。
  5. 【强制】SimpleDateFormat 是线程不安全的类,一般不要定义为static变量,如果定义为static,必须加锁,或者使用DateUtils工具类。
  6. 正例:注意线程安全,使用DateUtils。亦推荐如下处理:

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {

Override

protected DateFormat initialValue() {

return new SimpleDateFormat(“yyyy-MM-dd”);

}

};

说明:如果是JDK8的应用,可以使用Instant代替Date,LocalDateTime代替Calendar,DateTimeFormatter代替SimpleDateFormat,官方给出的解释:

simple beautiful strong immutable thread-safe。

  1. 【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁;能锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。
  2. 说明:尽可能使加锁的代码块工作量尽可能的小,避免在锁代码块中调用RPC方法。
  3. 【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造成死锁。
  4. 说明:线程一需要对表A、B、C依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序也必须是A、B、C,否则可能出现死锁。
  5. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加锁,要么在数据库层使用乐观锁,使用version作为更新依据。
  6. 说明:如果每次访问冲突概率小于20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次数不得小于3次。
  7. 【强制】多线程并行处理定时任务时,Timer运行多个TimeTask时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用ScheduledExecutorService则没有这个问题。
  8. 【推荐】使用CountDownLatch进行异步转同步操作,每个线程退出前必须调用countDown方法,线程执行代码注意catch异常,确保countDown方法被执行到,避免主线程无法执行至await方法,直到超时才返回结果。
  9. 说明:注意,子线程抛出异常堆栈,不能在主线程try-catch到。
  10. 【推荐】避免Random实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一seed 导致的性能下降。
  11. 说明:Random实例包括java.util.Random 的实例或者 Math.random()的方式。
  12. 正例:在JDK7之后,可以直接使用API ThreadLocalRandom,而在 JDK7之前,需要编码保证每个线程持有一个实例。
  13. 【推荐】在并发场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优化问题隐患(可参考 The “Double-Checked Locking is Broken” Declaration),推荐解决方案中较为简单一种(适用于JDK5及以上版本),将目标属性声明为 volatile型。
  14. 反例:

class Singleton {

private Helper helper = null;

public Helper getHelper() {

if (helper == null)

synchronized(this) {

if (helper == null)

helper = new Helper();

}

return helper;

}

// other methods and fields…

}

  1. 【参考】volatile解决多线程内存不可见问题。对于一写多读,是可以解决变量同步问题,但是如果多写,同样无法解决线程安全问题。如果是count++操作,使用如下类实现:

AtomicInteger count = new AtomicInteger();

count.addAndGet(1);

如果是JDK8,推荐使用LongAdder对象,比AtomicLong性能更好(减少乐观锁的重试次数)。

14. 【参考】 HashMap在容量不够进行resize时由于高并发可能出现死链,导致CPU飙升,在开发过程中可以使用其它数据结构或加锁来规避此风险。

15. 【参考】ThreadLocal无法解决共享对象的更新问题,ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共享的,所以设置为静态变量,所有此类实例共享此静态变量 ,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

 

当然还有很多合理的规则规范等,自己去摸索学习吧


   原创文章,转载请标明本文链接: JAVA环境搭建后的必备良器,阿里代码规范检查工具

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!

发表评论

电子邮件地址不会被公开。 必填项已用*标注