Java编程规范
java 开发规范
java开发规范
(一)java命名规范
1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义
例子:变量——用户数据(userList)、方法——getUserData(int type)等。
说明:正常变量定义使用驼峰命名,特殊的如DTO\VO\DO等除外。
2、类名的定义
(1)普通类名采用大写字母开始;
(2)抽象类采用Abstract或Base开头。例子:普通类——class UserModel,抽象类——abstract class AbstractUserDefinition等。
3、常量、类型、接口、子类的定义
(1)常量使用全大写且单词之间用"_“隔开; (2)boolean变量不能使用is开头;
(3)接口尽量不要修饰符、子类紧跟接口追加Impl。
例子:常量——SORT_TYPE,布尔类型——flag,接口——UserService,实现类——UserServiceImpl等。
说明:常量不可组装,需要原子性定义,不能出现"KEY”+SORT_TYPE 这种内部出现。
4、包名、异常、枚举、方法名称的定义
(1)包名一律采用小写; (2)异常都采用_Exception结尾; (3)枚举都是以Enum结尾;
(4)方法名称——根据方法内容采用如插入insert-*。
例子:异常——UserException,包名——com.test,枚举——UserEnum,方法名称——insertUser等。
5、领域模型定义规范:主要是以VO\DTO\DO等结尾
例子:用户数据——UserDTO等(1)数据对象:xxxDO,xxx 即为数据表名。
java 编程规范
java 编程规范
Java编程规范是为了促进Java代码的可读性、可维护性和可
扩展性而制定的标准。以下是一些常见的Java编程规范:
一、命名规范
1. 类名、接口名、枚举名首字母大写,采用驼峰命名法。
2. 变量名、方法名首字母小写,采用驼峰命名法。
3. 常量名全部大写,使用下划线分割单词。
4. 包名全部小写,使用点号分割单词。
二、代码格式
1. 使用4个空格缩进。
2. 每行代码长度不超过80个字符。
3. 在二元运算符(如赋值、算术运算、逻辑运算)两侧添加空格。
4. 在逗号、冒号、分号之后添加空格。
5. 在左花括号之后和右花括号之前添加空格。
6. 在注释之前添加空格。
三、代码结构
1. 类的成员按照作用域排列,先是静态成员,然后是实例成员。
2. 类的方法按照功能排列,先是构造方法,然后是其他方法。
3. 每个类只负责一个功能,遵循单一职责原则。
4. 使用适当的访问修饰符控制成员变量和方法的访问级别。
四、异常处理
1. 不要捕获异常而不做任何处理,应该记录日志或者抛出更高
级别的异常。
2. 不要将整个方法体放在try-catch块中,应该只捕获需要处理的异常。
3. 不要使用异常控制程序的流程,应该使用条件语句或者循环结构。
五、注释规范
1. 使用Javadoc注释对类、方法、参数、返回值进行说明。
2. 在每个类的头部使用Javadoc注释描述该类的功能。
3. 使用内联注释对代码进行解释、补充和说明。
4. 注释应该清楚、简明、不冗余,遵循自然语言的习惯。
六、其他规范
1. 避免使用魔法数值,应该使用常量或者枚举来表示。
java开发规范
java开发规范
Java 开发规范
1.命名规范:
(1)包名要求全部小写;
(2)类名使用驼峰表示法,首字母大写;
(3)方法名驼峰表示法,首字母小写;
(4)常量字段名较长的是全部大写,单词之间用下划线分隔;
(5)变量命名使用驼峰表示法,文件名也采用驼峰表示法;
2. 代码组织规范:
(1)类前必须有注释,包含类名,作者,日期,简要说明;
(2)public 的内部类或内部接口类前也需要有注释;
(3)新增方法或变量必须添加注释,说明方法或变量的作用;
(4)不使用编译器警告选项,必须对所有的编译器的警告进行处理;
3. 代码规约:
(1)一行只放一条语句,行长不能超过80个字符;
(2)在表达式中间,每个运算符两侧必须有一个空格;
(3)每个代码块左括号前加一个空格,右括号后加一个空格;
(4)if,while 等关键字后面都加一个空格;
(5)使用Javadoc标准,保证各类、方法和字段都有完整的注释;
4. 代码质量控制:
(1)按照具体的代码质量控制规则,进行代码质量检查;
(2)特定的文件以特定的编码格式编辑,不得混用;
(3)代码不得包含未使用的变量,常量,导入和类;
(4)保证可ログ出力:必要的情况下,可以进行日志记录,定位代码运行情况;
(5)保证可测试:针对每个实现模块,提供单元测试,检查代码可靠性;
Java编程规范
Java编程规范
Java编程规范是一种约定俗称的规范,旨在使Java代码易于
理解、维护和调试。它使得多人合作开发更加容易,可以避免一些常见的错误和问题。
以下是一些常见的Java编程规范:
1.类命名和包命名:类名使用驼峰式命名,包名使用小写字母。类名和包名应该是有意义的,具有描述性。
2.变量命名:变量名使用驼峰式命名,尽量使用有意义的名字,避免使用单个字符作为变量名。
3.常量命名:常量名使用大写字母和下划线命名,使用final
修饰。
4.缩进:使用4个空格进行缩进,不要使用制表符。
5.行长度:每行代码应该尽量控制在80个字符以内,可以在
需要的地方使用换行符(\)。
6.注释:代码应该有足够的注释,包括类、方法和变量的注释。注释应该清晰、简洁,并且易于理解。
7.引入包:只引入需要使用的包,避免通配符导入。
8.类成员的声明顺序:类成员的声明顺序应该按照以下顺序:
公有静态常量、私有静态常量、私有静态变量、私有常量、私有变量、构造函数、公有方法、私有方法。
9.异常处理:避免使用异常捕获的通配符,应该只捕获需要处理的异常。
10.不要使用魔法数字:避免在代码中使用未经解释的魔法数字,应该使用常量或者枚举类型来代替。
11.使用自定义异常:当需要抛出异常时,应该使用自定义的异常类型,而不是Java提供的通用异常类型。
12.避免使用过时的API:使用最新的API,避免使用已经过时的API。
13.使用适当的命名规范:方法名应该以动词开头,变量名应该以名词或者名词短语开头。
14.避免使用嵌套过深的代码:控制代码的嵌套层次,避免代码过于复杂。
Java语言编程规范参考
JAVA编程规范
业务与软件产品线编辑
V1.0
前言
Java语言编程规范是新员工进公司后必须掌握的技术基本知识,共分五部分:1、排版规范,2、注释规范,3、命名规范,4、编码规范,5、JTEST规范。
目录
JAVA编程规范 (1)
前言 (2)
第一章JAVA语言编程规范总则 (4)
第二章排版规范 (4)
2.1规则 (4)
2.2建议 (8)
第三章注释规范 (8)
3.1规则 (9)
3.2 建议 (16)
第四章命名规范 (18)
4.1 规则 (18)
4.2 建议 (20)
第五章编码规范 (21)
1.1 规则 (21)
5.2建议 (26)
第六章JTEST规范 (28)
6.1 规则(1-2 级) (28)
6.2 建议(3级或以上) (29)
第一章 JAVA语言编程规范总则
为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。
本规范总则是基于Java语言的编程规则的总的原则,针对不同应用环境的编程规范在遵守本规范总则的基础上,还必须遵守相应开发环境的编程规范。本规范适用于使用Java语言编程的部门和产品。
本规范总则的内容包括:排版规范,注释规范,命名规范,编码规范,JTEST规范等。
本规范总则的示例采用以下的术语描述:
★规则:编程时强制必须遵守的原则。
★建议:编程时必须加以考虑的原则.
★格式:对此规范格式的说明。
★说明:对此规则或建议进行必要的解释。
★示例:对此规则或建议从正、反两个方面给出例子。
第二章排版规范
2.1规则
1. *程序块要采用缩进风格编写,缩进的空格数为4个。
java 代码规范
java 代码规范
Java代码规范是指在Java程序设计中遵循的一些规则和约定,旨在提高代码的可读性、可维护性和可移植性。遵守代码规范可以帮助团队成员更好地理解和协作开发,提高代码的质量和可靠性。本文将围绕Java代码规范展开讨论,包括命名规范、代码风格、注释规范、异常处理等方面的内容。
一、命名规范
1.包名规范
包名应该全小写,连接符可以使用小写字母和下划线,不推荐使用数字。包名应该能够清晰地表达包所包含的内容,不要使用太长或者太短的包名。
2.类名规范
类名应该采用驼峰命名法,首字母大写,类名应该能够清晰地表达类的用途,不要使用太长或者太短的类名。如果类名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
3.接口名规范
接口名应该采用驼峰命名法,首字母大写,接口名应该能够清晰地表达接口的用途,不要使用太长或者太短的接口名。如果接口名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
4.变量名规范
变量名应该采用驼峰命名法,首字母小写,变量名应该能够清晰地表达变量的用途,不要使用太长或者太短的变量名。如果变量名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
5.常量名规范
常量名应该全大写,单词之间使用下划线分隔,常量名应该能够清晰地表达常量的用途,不要使用太长或者太短的常量名。
6.方法名规范
方法名应该采用驼峰命名法,首字母小写,方法名应该能够清晰地表达方法的用途,不要使用太长或者太短的方法名。如果方法名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
二、代码风格
1.缩进和空格
java 编码规范
java 编码规范
《Java编码规范》
1. 代码风格
- 代码缩进:使用4个空格进行缩进,不使用制表符。
- 行长限制:每行代码不超过80个字符,超出则进行换行。
- 行尾空格:行尾不留空格。
- 行尾注释:行尾注释与代码之间至少保留2个空格的距离。
- 命名规范:使用驼峰命名法,类名首字母大写,变量和方法
名首字母小写。
- 常量命名:常量使用全大写字母,并用下划线分隔单词。
- 空行:类与方法之间保留一个空行,方法内逻辑块之间保留
一个空行。
2. 注释规范
- 文件注释:每个源文件的头部必须包含文件注释,说明该文
件的作者、日期等信息。
- 类注释:每个类的头部必须包含类注释,描述该类的作用、
用法等。
- 方法注释:每个方法必须包含方法注释,描述该方法的功能、参数、返回值等。
- 代码注释:在代码中需要加入注释说明的地方,添加合理的
注释来增加代码可读性。
3. 包和导入规范
- 包名规范:包名全部小写,多个包名之间用英文句点"."分隔,采用反域名形式命名。
- 导入规范:不要使用通配符"*"导入整个包,应明确导入所需的类。
4. 类和接口规范
- 类结构顺序:依次按照成员变量、构造方法、普通方法的顺
序来编写类的结构。
- 成员变量声明:先声明公有的静态常量,再声明私有的静态
变量,接着声明私有的实例变量。
- 构造方法:在类的开头部分声明构造方法,按照方法名和参
数顺序进行编写。
- 方法和变量:局部变量应放在使用的最近位置上,避免声明
太早或太迟,增加代码的可读性。
5. 异常处理规范
- 异常的捕获和处理:在可能发生异常的地方进行捕获和处理,而不是简单地将异常抛出给上层调用者。
JAVA编程规范
JAVA编程规范
Java编程规范
1为什么需要编程规范
1、在软件的⽣命周期中,80%的⼯作是在产品的维护上。
2、在软件产品的整个⽣命周期中,它的维护不可能都由产品的开发⼈员来完成。
3、良好的编程规范,可以增加程序的可读性,让⼯程师更好更彻底的理解程序。
4、当原代码作为产品提交时,需要象其它产品⼀样,有着良好的包装。
因此,要求开发⼈员遵守编程规范。
2⽂件的命名
2.1 ⽂件后缀
1)JA V A 源⽂件后缀为.java;
2)JA V A类⽂件后缀为.class
2.2 公有⽂件名
1)编译⽂件(GNUmakefile)命名为gunmakefile
2)注释⽂件名readme
3⽂件的组织
当⼀个⽂件有多个部分组成时,应⽤空⾏来分隔,并尽可能给出注释。
应尽量避免超过2000⾏的⽂件。
3.1 Java源代码⽂件
每个Java原代码⽂件由⼀个单独的公共类或接⼝(interface)组成。当有私有的类或接⼝与公有的类或接⼝相关时,可以将它们放在⼀个⽂件中。其中的公共类或接⼝应该是第⼀个成员。
⼀个JA V A源⽂件的组织顺序如下:
◆起始注释
◆包声明及导⼊包声明
类或接⼝声明
3.1.1起始注释声明
所有的Java源代码⽂件均应该包含象C语⾔那样的起始注释,列出类名,版本信息,⽇期及版权声明。
如下:
/*
* 类名称
*
* 版本信息
*
* ⽇期
*
* 版权声明
*/
3.1.2包及导⼊包声明
第⼀个⾮注释⾏应该是包声明,紧接着的是导⼊包的声明。
如:
package java.awt;
import java.awt.peer.CanvasPeer;
Java编程规范(10页)免费下载.pdf
简单语句
每行最多包含一个语句。
例如:
argv++;
// Байду номын сангаас确
argc++;
// 正确
argv++; argc--; // 错误,应该避免这样写
组合语句
组合语句使用大括号括起来的一串语句。
1. 大括号中的语句比组合语句多一级缩进。
}
¾ 行尾注释 注释标记“//”能够注释一行或者该行由“//”开始直到行尾的部分。行尾注释不
能用在多行文本注释中。但它可以将多行代码注释掉。这三种注释方法举例如下。
if (foo > 1) {
// Do a double-flip.
...
}
else{
return false;
// Explain why here.
例: public static final int NOT_FOUND = 100; //正确的顺序 final static private String policyNo; //不正确的顺序。
1.1.6 声明规范
变量声明
¾ 每行定义变量数目 每行定义的变量数目必须有且只有一个。 例如: int level; // indentation level int size; // size of table
java代码开发规范
java代码开发规范
Java代码开发规范(Java Coding Convention)是一组编写Java 代码的规范和约定,以提高代码的可读性、可维护性和可重用性。下面是一个包含大约1000字的Java代码开发规范概述:
1. 命名规范:
- 类名使用大写开头的驼峰式命名法,如MyClass。
- 方法名和变量名使用小写开头的驼峰式命名法,如myMethod。
- 常量名使用全大写字母和下划线的命名法,如
MY_CONSTANT。
- 包名使用全小写字母,可以使用多级包名,如
com.example.myproject。
2. 缩进和空格:
- 使用4个空格进行代码块缩进。
- 除了特殊情况,每行代码最多120个字符。
- 操作符前后加上空格,如a + b。
3. 注释:
- 使用Javadoc风格的类、方法和变量注释。
- 注释应该简洁明了,不要使用废话或无关信息。
- 注释应该更新以反映代码的变化。
4. 源文件:
- 每个源文件只包含一个公有类。
- 源文件应该以UTF-8编码保存。
- 导入语句应该按照字母顺序排序。
5. 类的结构:
- 每个类应该包含类的成员变量、构造方法、公有方法和私有方法,按照这个顺序。
- 成员变量应该使用private修饰,并提供相应的getter和setter方法。
- 公有方法应该提供必要的参数检查和异常处理。
6. 代码块:
- 使用大括号包围代码块,即使代码块只有一行。
- 尽量减少嵌套层次,避免深层次的if-else或循环嵌套。
- switch语句应该包含default情况,并在每个case结束后加上break。
java语言规范
java语言规范
Java是一种广泛应用在软件开发领域的高级编程语言。它具有简单、面向对象、跨平台和安全的特性,使得它成为许多开发者首选的语言之一。为了保证Java代码的一致性和可维护性,Java语言规范定义了一些准则和规则。以下是Java语言规范
的一些重要内容:
1. 标识符:Java语言中的标识符包括类、方法、变量、常量等的命名。标识符必须以字母、下划线或美元符号开头,后面可以是字母、数字、下划线或美元符号。标识符是区分大小写的。
2. 数据类型:Java提供了基本数据类型和引用数据类型。基本数据类型包括整型、浮点型、字符型和布尔型。引用数据类型包括类、接口和数组。
3. 变量和常量:在Java中,变量用于存储数据,常量用于表
示不可变的值。变量必须先声明后使用,声明变量时必须指定其数据类型。常量一旦被赋值后就不能再改变。
4. 控制流程:Java支持条件语句、循环语句和跳转语句。条件语句根据条件的真假来执行不同的代码块。循环语句可以重复执行一段代码块。跳转语句用于改变代码的执行顺序。
5. 方法和类:Java中的方法用于封装一段功能代码,可以被重复使用。方法可以有参数和返回值。类是Java中面向对象的
基本组织单位,它包含属性和方法。
6. 继承和接口:Java支持类之间的继承关系。一个类可以继承另一个类的属性和方法,并可以在此基础上扩展自己的功能。Java还支持接口的定义,接口用于定义一组方法,在类中实现接口可以达到多继承的效果。
7. 异常处理:在Java中,异常是一种程序运行过程中出现的
错误情况。Java提供了异常处理机制,可以捕获和处理异常,保证程序在出现异常时能够正常运行。
JAVA开发规范文档
JAVA开发规范文档
引言:
为了提高JAVA开发效率和可维护性,降低开发过程中的错误率,特制定此开发规范文档。本规范适用于所有JAVA开发项目,包括前端、后端和移动端开发。
1.命名规范
1.2 类名:采用驼峰命名法,首字母大写,如UserService。
1.3 方法名:采用驼峰命名法,首字母小写,如getUserList。
1.4 变量名:采用驼峰命名法,首字母小写,如userName。
1.5常量名:全部大写,使用下划线分隔,如MAX_COUNT。
1.6 接口名:采用驼峰命名法,首字母大写,如UserService。
1.7 枚举名:采用驼峰命名法,首字母大写,如ColorType。
2.注释规范
2.2方法或代码块内应有必要的注释,解释方法的功能和输入输出参数的含义。
2.3注释要简洁明了,不得使用拗口难懂的词汇。
2.4注释要与代码保持同步更新。
3.代码风格规范
3.1缩进:使用4个空格进行缩进,不得使用制表符。
3.2行宽:每行代码不得超过120个字符。
3.3空行:合理使用空行,以提高代码的可读性。
3.4操作符前后空格:操作符前后必须有一个空格,如a=b+c。
3.5大括号位置:大括号应该独占一行,且与前面的语句间有一个空格。
3.6代码块注释:使用//或/*...*/对代码块进行注释,描述代码块的功能和作用。
3.7异常处理:所有异常都需要捕获处理,不允许直接忽略异常。
3.8类内方法的顺序:构造方法、公有方法、私有方法,按照方法访问权限从公有到私有的顺序排列。
4.代码规范
4.1不允许出现未使用的变量和方法。
开发规范_JAVA程序编写规范
Java程序开发书写规范
【注意】
每一个在公司使用Java语言从事系统开发工作的新员工必须首先阅读本文件,并在工作中严格按照本文件的说明进行源程序书写。
目录
程序开发书写规范 (1)
1. 文件头部注释 (2)
2. 类头部注释 (3)
3. 方法头部注释 (4)
4. 命名规范 (5)
5. 示例程序........................................................................ 错误!未定义书签。
6. 注意事项 (5)
1.文件头部注释
说明:在所有程序文件的头部,都应有此注释。
格式:
2.类头部注释
说明:
在类的源程序文件中,都应有此注释。该注释必须位于类定义的上方,导入说明(import语句)的下方
格式:
3.方法头部注释
说明:在程序文件中所有public方法的头部,都应有此注释。
格式:
注:
文中带<>的部分必须填写。
“[]”为可选项,只在必要时填写
其中“/**”“@param”和“@return”等蓝色字体必须按照标准书写
4.命名规范
在java程序中:
●日期格式为“yyyy-mm-dd”
●时间格式为:“yyyy-mm-dd hh:mm:ss”
5.注意事项
在实际工作中,必须严格按照本标准说明中的规范进行书写,尤其注意以下注释的格式:
●注释开始符号必须为“/**”,
●对于参数的说明必须使用“*@param”开始,并另起一行书写具体参数
列表
●每一参数说明使用独立的“*@param”标志
●返回值说明必须使用“*@return”开始,并另起一行书写返回值说明
Java代码规范详细版
Java代码规范
1。标识符命名规范
1.1 概述
标识符的命名力求做到统一、达意和简洁。尽量做到每个人按照规范来,多人开发如一人开发一样。
1.1.1 统一
统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用supplier,也可以用provider,但是我们只能选定一个使用,至少在一个Java项目中保持统一.统一是作为重要的,如果对同一概念有不同的表示方法,会使代码混乱难以理解。即使不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一次。
1。1.2 达意
达意是指,标识符能准确的表达出它所代表的意义,比如:newSupplier,OrderPaymentGatewayService等;而supplier1, service2,idtts等则不是好的命名方式。准确有两成含义,一是正确,而是丰富。如果给一个代表供应商的变量起名是order,显然没有正确表达。同样的,supplier1, 远没有targetSupplier意义丰富。
1。1。3 简洁
简洁是指,在统一和达意的前提下,用尽量少的标识符.如果不能达意,宁愿不要简洁。比如:theOrderNameOfTheTargetSupplierWhichIsTransfered 太长,transferedTargetSupplierOrderName则较好,但是transTgtSplOrdNm就不好了.省略元音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写.
1。1.4 骆驼法则
Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之间不使用特殊符号分割,而是通过首字母大写来分割。比如: supplierName,addNewContract,而不是supplier_name, add_new_contract.
java代码编写规范
java代码编写规范
Java代码编写规范是为了保持代码的一致性、可读性、可维护性和可扩展性而制定的一套规则。以下是一些常见的Java代码编写规范:
1. 命名规范:
- 类名使用大写字母开头的驼峰命名法,如MyClass。
- 方法名使用小写字母开头的驼峰命名法,如myMethod。 - 变量名使用小写字母开头的驼峰命名法,并能直观地描述变量的含义,如myVariable。
- 常量名使用全大写的下划线命名法,如MAX_SIZE。
2. 缩进和空格:
- 使用4个空格进行缩进,不要使用Tab键。
- 运算符之间加空格,如 a + b。
- 逗号之后加空格,如int a, int b。
- 括号之间加空格,如if (condition)。
- 方法和类的左括号不另起一行。
3. 注释规范:
- 使用Javadoc格式进行注释,包括类、方法和成员变量的说明。
- 每个方法需说明参数、返回值和可能抛出的异常。
- 不要保留没有用的注释。
- 注释应该与代码保持一致,不要误导阅读者。
4. 类和方法的设计:
- 类应该具有单一的职责,不要包含无关的功能。
- 方法应该具有清晰的目的和语义,不要过长或过于复杂。 - 类和方法应该尽量避免过多的参数,如果参数过多,可以考虑使用封装对象。
5. 异常处理:
- 对于可能抛出的异常,应该根据情况进行合理的处理,而不是简单地忽略或抛出异常。
- 使用try-catch语句来捕获并处理异常,避免在代码中出现不受控制的异常。
6. 代码重构:
- 定期进行代码重构,提高代码的可读性和可维护性。
- 删除无用的代码和注释。
Java语言编程规范
DKBA
华为技术有限公司企业技术规范
DKBA1040-2001.12
代替(DKBA200106-003)Java语言编程规范
2001-12-XX发布2001-12-XX实施
华为技术有限公司发布
目次
前
言 (3)
1 范围11
2 规范性引用文件11
3 术语和定义11
4 排版规范12
4.1 规则12
1.*程序块要采用缩进风格编写,缩进的空格数为4个。12
12
2.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与
引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、
for、do、while、switch、case语句中的程序都要采用如上的缩进
方式。
13
3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长
表达式要在低优先级操作符处划分新行,操作符放在新行之
首,划分出的新行要进行适当的缩进,使排版整齐,语句可
读。
4.*不允许把多个短语句写在一行中,即一行只写一条语句13
13
5.*if, for, do, while, case, switch, default 等语句自占一
行,且if, for, do, while等语句的执行语句无论多少都要加括
号{}。
6.*相对独立的程序块之间、变量说明之后必须加空行。13
7.*对齐只使用空格键,不使用TAB键。14
14
8.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操
作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密
切的立即操作符(如.),后不应加空格。
4.2 建议15
15
1.类属性和类方法不要交叉放置,不同存取范围的属性或者方
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
Java编程规范本文引用阿里Java开发手册。GitHub阅读地址:
目录
编程规约
- 命名规约
- 常量定义
- 格式规范
- OOP规约
- 集合处理
- 并发处理
- 控制语句
- 注释规约
- 其他
- 异常处理
- 建表规约
- 索引规约
- SQL规约
- ORM规约
编程规约
命名规约
1、【强制】所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束
反例: _name / __name / $Object / name_ / name$ / Object$1
2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式,更不允许直接使用中的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即纯拼音的命名方式也要避免采用。
反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;
正例: ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称,可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名) DO / DTO / VO / DAO 等。
正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例: macroPolo / UserDo / XMLService / TCPUDPDeal
/ TAPromotion123
4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage() / inputUserId1
5、【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT123
6、【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
7、【强制】中括号是数组类型的一部分,数组定义如下:String[] args ;
反例:请勿使用 String args[] 的方式来定义1
8、【强制】 POJO 类中的任何布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 boolean isSuccess;的属性,它的方法也是 isSuccess(), RPC框架在反向解析的时候,“以为”对应的属性名称是 success,导致属性获取不到,进而抛出异常。1
9、【强制】包名统一使用小写,点分隔符之间有且仅有一
个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为、类名为 MessageUtils (此规则参考 spring的框架结构)1
10、【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:某业务代码>AbstractClass“缩写”命名成AbsClass; condition“缩写”命名成condi,此类随意缩写严重降低了代码的可阅读性。1
11、【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。
正例: public class OrderFactory; public class LoginProxy; public class ResourceObserver;123
12、【推荐】接口类中的方法和属性不要加任何修饰符号( public 也不要加),保持代码的简洁性,并加上有效的javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名: void f(); 接口基础常量表示:String COMPANY = 'alibaba';
反例:接口方法定义: public abstract void f();
说明: JDK8 中接口允许有默认实现,那么这个default 方法,是对所有实现类都有价值的默认实现。12345 13、接口和实现类的命名有两套规则:
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。正例: CacheServiceImpl 实现CacheService 接口。
2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。正例:AbstractTranslator 实现 Translatable。123
14、【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字: DealStatusEnum;成员名称:SUCCESS / UNKOWN_REASON。123
15、【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1)获取单个对象的方法用 get 做前缀。
2)获取多个对象的方法用 list 做前缀。
3)获取统计值的方法用 count 做前缀。
4)插入的方法用 save(推荐)或 insert 做前