Java代码编写规范

【实例简介】Java代码编写规范

关于Java代码编写规范

【实例截图】

【核心代码】

目 录 录
1 前言........................................................................................................................................... 4
2 命名规范 ................................................................................................................................... 4
2.1 P ACKAGE 的命名 .............................................................................................................. 4
2.2 C LASS 的命名 .................................................................................................................. 4
2.3 C LASS 成员的命名........................................................................................................... 4
2.4 S TATIC F INAL 变量的命名 ............................................................................................... 4
2.5 数组的命名 ....................................................................................................................... 4
2.6 方法的参数 ....................................................................................................................... 5
2.7 缩写 ................................................................................................................................... 5
2.8 标识符命名中应注意的问题 ........................................................................................... 5
2.8.1 除局部循环变量外变量名禁止取单个字符 ..................... 5
2.8.2 不用数字定义方法 ......................................... 5
2.8.3 用正确的反义词组命名 ..................................... 6
2.8.4 避免使用下划线开头 ....................................... 6
3 注释........................................................................................................................................... 6
3.1 注释 ................................................................................................................................... 6
3.2 类和接口注释说明 ........................................................................................................... 6
3.3 方法注释说明 ................................................................................................................... 7
4 书写格式规范 ........................................................................................................................... 7
4.1 代码编写规范 ................................................................................................................... 7
4.1.1 缩进 ..................................................... 7
4.1.2 空格的使用 ............................................... 7
4.1.3 {}的用法 ................................................. 8
4.1.4 if 等语句写法 ............................................. 8
4.1.5 一行只写一条语句 ......................................... 9
4.2 变量编写规范 ................................................................................................................... 9
4.2.1 公共变量 ................................................. 9
4.2.2 局部变量 ................................................ 10
4.3 程序编写规范 ................................................................................................................. 10
4.3.1 异常 .................................................... 10
4.3.2 访问类的成员变量 ........................................ 10
5 编程技巧 ................................................................................................................................. 11
5.1 一般性原则 ..................................................................................................................... 11
5.1.1 检查所有参数输入的有效性。 .............................. 11
5.1.2 减少数据类型转换 ........................................ 11
5.1.3 防止程序中的垃圾代码。 .................................. 12
5.1.4 减少递归调用。 .......................................... 13
5.1.5 少使用 BOOLEAN 参数。 .................................... 13
5.2 开发过程中的技巧 ......................................................................................................... 13
格式规范
第3页，共22页
5.2.1 不必要的对象构造 ........................................ 13
5.2.2 synchronized 关键字 ..................................... 14
5.2.3 For、foreach、stream .................................... 14
5.2.4 大量(if...else if)时尽量用 switch 语法代替 ............... 14
5.2.5 事务处理 ................................................ 14
5.2.6 boolean 型 ............................................... 15
5.2.7 equals .................................................. 15
5.2.8 BigDecimal .............................................. 15
5.2.9 静态变量的使用 .......................................... 16
5.2.10 直接返回的对象可以不用再显示声明 ........................ 16
5.2.11 不必要的引用类型 ........................................ 16
5.2.12 堆栈输出 ................................................ 16
5.2.13 redis ................................................... 16
5.2.14 Order by ................................................ 16
5.2.15 视图 .................................................... 17
5.2.16 SQL ..................................................... 17
5.3 程序效率 ......................................................................................................................... 17
5.3.1 注意代码的效率 .......................................... 17
5.3.2 提高代码效率 ............................................ 17
5.3.3 局部效率应为全局效率服务 ................................ 17
5.3.4 循环体内工作量最小化。 .................................. 18
5.3.5 仔细分析有关算法，并进行优化。 .......................... 18
5.3.6 改进输入方式 ............................................ 18
5.3.7 提高空间效率 ............................................ 18
5.3.8 循环的位置 .............................................. 18
5.3.9 尽量减少循环嵌套层次。 .................................. 19
5.3.10 尽量避免在循环中操作数据库 .............................. 19
5.3.11 避免循环体内含与循环无关的判断语句 ...................... 20
5.3.12 日志选型 ................................................ 21
5.3.13 最终 .................................................... 21
6 质量保证 ................................................................................................................................. 21
6.1 代码质量保证优先原则 ................................................................................................. 21
6.2 打开的文件要关闭 ......................................................................................................... 21
6.3 其他质量问题 ................................................................................................................. 21
7 代码分支 ................................................................................................................................. 22
8 代码审查、重构 ..................................................................................................................... 22