如何才能写出高质量java代码,这篇文章让你轻松搞定

一,命名风格

1,代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

2,代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

3,类名、方法名、参数名、成员变量、局部变量都统一使UpperCamelCase 风格,必须遵从驼峰形式。

4,常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

5,抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾 。

6,接口的请求参数的bean,以Req结尾,接口的响应的bean,以Resp结尾.

7,包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式。

8,杜绝完全不规范的缩写,避免望文不知义。

9,为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。

10,如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。

11,接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁 性,并加上有效的 Javadoc 注释。

二,常量定义

1,不允许任何魔法值(即未经定义的常量)直接出现在代码中 。

2,long 或者 Long 初始赋值时,使用大写的 L,不能是小写的 l,小写容易跟数字 1 混 淆,造成误解。

3,不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护(看bean的使用范围,不要全部都写在CoreData里面)。

三,OOP规约

1,避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。

2,所有的覆写方法,必须加@Override 注解 。

3,相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。

4,外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。

5,不能使用过时的类或方法。

6,Object 的 equals 方法容易抛空指针异常,统一使用StringUtils.equals()方法。

7,所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。

8,构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。

9,当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起, 便于阅读。

10,类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。

11,循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展 。

12,类成员与方法访问控制从严。

四,集合处理

1.不要在 foreach 循环里进行元素的 remove/add 操作 。

2.在 JDK7 版本及以上,Comparator 要满足如下三个条件:

2.1 x,y的比较结果和y,x的比较结果相反

2.2 x=y,则x,z比较结果和y,z比较结果相同。

2.3 x>y,y>z,则x>z。

3.使用 entrySet 遍历 Map 类集合 KV,而不是 keySet 方式进行遍历。

五,并发处理

1,获取单例对象需要保证线程安全,其中的方法也要保证线程安全。

2,线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。

3,SimpleDateFormat 是线程不安全的类,一般不要定义为static变量,如果定义为 static,必须加锁,或者使用 DateUtils 工具类。

4,避免 Random 实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一 seed 导致的性能下降。

5,在并发场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优化问题隐患。

六,控制语句

1,在一个 switch 块内,每个 case 要么通过 break/return 等来终止,要么注释说明程 序将继续执行到哪一个 case 为止;在一个 switch 块内,都必须包含一个 default 语句并且 放在最后,即使它什么代码也没有。

2,在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码。

3,表达异常的分支时,少用 if-else 方式 ,可使用卫语句。

4,循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、 获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。

七,注释规约

1,类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用 // xxx方式。

2,所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、 异常说明外,还必须指出该方法做什么事情,实现什么功能。

3,方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释 ,使用/* */注释,注意与代码对齐。

4,代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑 等的修改。

5,对于注释的要求:第一、能够准确反应设计思想和代码逻辑;第二、能够描述业务含 义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同 天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看 的,使其能够快速接替自己的工作。

————————————————

编程是一个神秘而又美丽的领域,这个领域的大门像着所有拥有理想的人们敞开。编程也是一个残酷而又充满竞争的领域,随时会淘汰掉不够努力的人。

对于刚学习Java的初学者,很多适合会感觉学的没有方向,越学越迷茫,这样的情况一般都是学习方法开始就是错误的。没有把Java技术进行专业系统化的学习。从就业和节约时间的角度考虑,如果有谁遇到这方面的问题,可以加入我的学习裙686.827.638里面有相应的学习资料,可以自行来下载获取(适合初学者)多跟大家一起交流,不要一个人盲目的学,少走弯路才是学习Java最大的捷径。

你可能感兴趣的:(如何才能写出高质量java代码,这篇文章让你轻松搞定)