Oracle中国Java软件工程师代码编写规范2022最新公开版

简介: Oracle中国Java软件工程师代码编写规范2022最新公开版

@toc

A、规则(1–2 级)

1、在switch中,每个 case 标签都应该包含 break 或者 return 。
2、不要使用空的条件分支语句。
3、在运算中不要减小数据的精度。
4、switch 语句中的 case 关键字要和后面的常量保持一个空格,switch 语句中不要定义case 之外的无用标签。
5、不要在if 语句中使用等号= 进行赋值操作。
6、静态成员或者方法使用类名访问,不使用句柄访问。
7、方法重载的时候,一定要注意方法名相同,避免类中使用两个非常相似的方法名。
8、不要在ComponentListener.componentResized() 方法中调用 serResize() 方法。
9、不要尝试覆盖父类的静态方法和私有方法。
10、不要覆盖父类的属性。
11、不要使用两级以上的内部类。
12、把内部类定义成私有类。
13、去掉接口中多余的定义(不使用 public, abstract, static, final 等,这是接口中默认的)。
14、不要定义不会被用到的局部变量、类私有属性、类私有方法和方法参数。
15、显式初始化所有的静态属性。
16、不要使用 System.getenv() 方法。
17、不要硬编码 '\n'和'\r'作为换行符号。
18、不要直接使用 java.awt.peer.*里面的接口。
19、使用 System.arraycopy() ,不使用循环来复制数组。
20、避免不必要的 instanceof 比较运算和类造型运算。
21、不要在 finalize() 方法中删除监听器(Listeners)。
22、在 finalize() 方法中一定要调用 super.finalize() 方法。
23、在 finalize() 方法中的 finally 中调用 super.finalize() 方法。
24、进行字符转换的时候应该尽可能的较少临时变量。
25、使用ObjectStream 的方法后,调用reset() ,释放对象。
26、线程同步中,在循环里面使用条件测试(使用 while(isWait) wait() 代替 if(isWait) wait())。
27、不调用过时的 Thread 类的 resume(), suspend(), stop() 方法。
28、减小单个方法的复杂度,使用的 if, while, for, switch 语句要在10个以内。
29、在Servlets中,重用JDBC连接的数据源。
30、减少在Sevlets中使用的同步方法。
31、不定义在包中没有被用到的友好属性、方法和类。
32、没有子类的友好类应该定义成 final 。
33、没有被覆盖的友好方法应该定义成 final。

B、建议(3级或以上)

34、为 switch 语句提供一个 default 选项。
35、不要在 for 循环体中对计数器的赋值。
36、不要给非公有类定义 public 构建器。
37、不要对浮点数进行比较运算,尤其是不要进行 ==, !=运算,减少 >, < 运算。
38、实现 equals() 方法时,先用 getClass() 或者 instanceof 进行类型比较,通过后才能继续比较。
39、不要重载 main() 方法用作除入口以外的其他用途。
40、方法的参数名不要和类中的方法名相同。
41、除了构建器外,不要使用和类名相同的方法名。
42、不要定义 Error 和 RuntimeException 的子类,可以定义 Exception 的子类。
43、线程中需要实现 run() 方法。
44、使用 equals() 比较两个类的值是否相同。
45、字符串和数字运算结果相连接的时候,应该把数字运算部分用小括号括起来。
46、类中不要使用非私有(公有、保护和友好)的非静态属性。
47、在类中对于没有实现的接口,应该定义成抽象方法,类应该定义成抽象类。(5级)
48、不要显式导入 java.lang.* 包;
49、初始化时不要使用类的非静态属性。
50、显式初始化所有的局部变量。
51、按照方法名把方法排序放置,同名合同类型的方法应该放在一起。
52、不要使用嵌套赋值,即在一个表达式中使用多个 = 。
53、不要在抽象类的构建器中调用抽象方法。
54、重载 equals() 方法的同时,也应该重载 hashCode() 方法。
55、工具类(Utility)不要定义构建器,包括私有构建器。
56、不要在 switch 中使用10个以上的 case 语句。
57、把 main() 方法放在类的最后。
58、声明方法违例的时候不要使用 Exception ,应该使用它的子类。
59、不要直接扔出一个Error ,应该扔出它的子类。
60、在进行比较的时候,总是把常量放在同一边(都放在左边或者都放在右边)。
61、在可能的情况下,总是为类定义一个缺省的构建器。
62、在捕获违例的时候,不使用 Exception, RuntimeException, Throwable,尽可能使用它们的子类。
63、在接口或者工具类中中定义常量。(5级)
64、使用大写'L'表示 long 常量。(5级)
65、main() 方法必须是 public static void main(String[])。(5级)
66、对返回类型为 boolean 的方法使用 is 开头,其它类型的不能使用。
67、对非boolean类型取值方法(getter)使用 get 开头,其它类型的不能使用。
68、对于设置值的方法(setter)使用 set 开头,其它类型的不能使用。
69、方法需要有同样数量参数的注释 @param。
70、不要在注释中使用不支持的标记,如:@unsupported 。
71、不要使用 Runtime.exec() 方法。
72、不要自定义本地方法(native method)。
73、使用尽量简洁的的运算符号。
74、使用集合时设置初始容量。
75、单个首字符的比较使用 charAt() 而不用 startsWith() 。
76、对于被除数或者被乘数为2的n次方的乘除运算使用移位运算符 >>, << 。77、一个字符的连接使用' '而不使用" ",如:String a = b + 'c'。
78、不要在循环体内调用同步方法和使用 try—catch 块。
79、不要使用不必要的布尔值比较,如:if (a.equals(b)), 而不是 if (a.equals(b)==true)。
80、常量字符串使用 String, 非常量字符串使用 StringBuffer 。
81、在循环条件判断的时候不要使用复杂的表达式。
82、对于“if (condition) do1; else do2;”语句使用条件操作符“if (condition)?do1:do2;”。
83、不要在循环体内定义变量。
84、使用StringBuffer的时候设置初始容量。
85、尽可能的使用局部变量进行运算。
86、尽可能少的使用 '!'操作符。(5级)
87、尽可能的对接口进行 instanceof 运算。(5级)
88、不要使用 Date[] 而要使用 long[] 替代。
89、不要显式调用 finalize() 。
90、不要使用静态集合,其内存占用增长没有边界。
91、不要重复调用一个方法获取对象,使用局部变量重用对象。
92、线程同步中,使用 notifyAll() 代替 notify()。
93、避免在同步方法中调用另一个同步方法造成的死锁。
94、非同步方法中不能调用 wait() , notify() 方法。
95、使用 wait(), notify() 代替 while(), sleep() 。
96、不要使用同步方法,使用同步块。(5级)
97、把所有的公有方法定义为同步方法。 (5级)
98、实现的 Runnable.run() 方法必须是同步方法。 (5级)
99、一个只有abstract方法、final static 属性的类应该定义成接口。
100、在 clone() 方法中应该而且必须使用 super.clone() 而不是 new 。101、常量必须定义为 final 。
102、在 for 循环中提供终止条件。
103、在 for, while 循环中使用增量计数。
104、使用 StringTokenizer 代替 indexOf() 和 substring() 。
105、不要在构建器中使用非 final 方法。
106、不要对参数进行赋值操作。(5级)
107、不要通过名字比较两个对象的类,应该使用 getClass() 。
108、安全:尽量不要使用内部类。
109、安全:尽量不要使类可以克隆。
110、安全:尽量不要使接口可以序列化。
111、安全:尽量不要使用友好方法、属性和类。
112、Servlet:不要使用 java.beans.Beans.instantiate() 方法。
113、Servlet:不再使用HttpSession时,应该尽早使用 invalidate() 方法释放 。
114、Servlet:不再使用JDBC资源时,应该尽早使用 close() 方法释放 。
115、Servlet:不要使用Servlet的 SingleThreadModel,会消耗大量资源。
116、国际化:不要使用一个字符进行逻辑操作,使用 Characater。
117、国际化:不要进行字符串连接操作,使用MessageFormat 。
118、国际化:不要使用 Date.toString() ,Time.toString() 方法。
119、国际化:字符和字符串常量应该放在资源文件中。
120、国际化:不要使用数字的 toString() 方法。
121、国际化:不要使用 StringBuffer , StringTokenizer类。
122、国际化:不要使用 String 类的 compareTo(), equals() 方法。
123、复杂度:建议的最大规模:    

  • 继承层次 5层    
  • 类的行数 1000行(包含{})    
  • 类的属性 10个    
  • 类的方法 20个    
  • 类友好方法 10个    
  • 类私有方法 15个    
  • 类保护方法 10个    
  • 类公有方法 10个    
  • 类调用方法 20个    
  • 方法参数 5个    
  • return语句 1个    
  • 方法行数 30行    
  • 方法代码 20行    
  • 注释比率 30%~50%
相关文章
|
11天前
|
Java 测试技术 应用服务中间件
常见 Java 代码缺陷及规避方式(下)
常见 Java 代码缺陷及规避方式(下)
32 0
|
13天前
|
Java
Java中ReentrantLock释放锁代码解析
Java中ReentrantLock释放锁代码解析
25 8
|
16天前
|
前端开发 小程序 Java
uniapp上传图片 前端以及java后端代码实现
uniapp上传图片 前端以及java后端代码实现
30 0
|
17天前
|
设计模式 存储 Java
23种设计模式,享元模式的概念优缺点以及JAVA代码举例
【4月更文挑战第6天】享元模式(Flyweight Pattern)是一种结构型设计模式,旨在通过共享技术有效地支持大量细粒度对象的重用。这个模式在处理大量对象时非常有用,特别是当这些对象中的许多实例实际上可以共享相同的状态时,从而可以减少内存占用,提高程序效率
31 4
|
17天前
|
设计模式 Java 中间件
23种设计模式,适配器模式的概念优缺点以及JAVA代码举例
【4月更文挑战第6天】适配器模式(Adapter Pattern)是一种结构型设计模式,它的主要目标是让原本由于接口不匹配而不能一起工作的类可以一起工作。适配器模式主要有两种形式:类适配器和对象适配器。类适配器模式通过继承来实现适配,而对象适配器模式则通过组合来实现
30 4
|
18天前
|
存储 缓存 算法
优化 Java 后台代码的关键要点
【4月更文挑战第5天】本文探讨了优化 Java 后台代码的关键点,包括选用合适的数据结构与算法、减少不必要的对象创建、利用 Java 8 新特性、并发与多线程处理、数据库和缓存优化、代码分析与性能调优、避免阻塞调用、JVM 调优以及精简第三方库。通过这些方法,开发者可以提高系统性能、降低资源消耗,提升用户体验并减少运营成本。
|
20天前
|
Java 开发工具 流计算
flink最新master代码编译出现Java Runtime Environment 问题
在尝试编译Flink源码时遇到Java运行时环境致命错误:EXCEPTION_ACCESS_VIOLATION。问题出现在JVM.dll+0x88212。使用的是Java 11.0.28和Java HotSpot(TM) 64-Bit Server VM。系统为Windows客户端,没有生成核心dump文件。错误日志保存在hs_err_pid39364.log和replay_pid39364.log。要解决这个问题,建议检查JDK版本兼容性,更新JDK或参照错误报告文件提交Bug至http://bugreport.java.com/bugreport/crash.jsp。
|
21天前
|
Java
使用Java代码打印log日志
使用Java代码打印log日志
75 1
|
21天前
|
设计模式 Java 数据库
Java设计模式精讲:让代码更优雅、更可维护
【4月更文挑战第2天】**设计模式是解决软件设计问题的成熟方案,分为创建型、结构型和行为型。Java中的单例模式确保类仅有一个实例,工厂方法模式让子类决定实例化哪个类。适配器模式则协调不兼容接口间的合作。观察者模式实现了一对多依赖,状态变化时自动通知相关对象。学习和适当应用设计模式能提升代码质量和可维护性,但需避免过度使用。设计模式的掌握源于实践与不断学习。**
Java设计模式精讲:让代码更优雅、更可维护
|
22天前
|
SQL 设计模式 安全
Java单例模式几种写法以及代码案例拿来直接使用
Java单例模式几种写法以及代码案例拿来直接使用
31 0

推荐镜像

更多