JAVA开发与命名规范V1.0
- 格式:pdf
- 大小:222.09 KB
- 文档页数:11


阿⾥JAVA开发规范,助你写出更⼲净整洁的代码⼀、命名风格1.【强制】类名使⽤UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO / DTO / VO / AO2.正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal /TaPromotion3.反例:macroPolo / UserDo / XMLService / TCPUDPDeal /TAPromotion4.【强制】⽅法名、参数名、成员变量、局部变量都统⼀使⽤lowerCamelCase 风格,必须遵从驼峰形式。
5.正例:localValue / getHttpMessage() / inputUserId6.【强制】常量命名全部⼤写,单词间⽤下划线隔开,⼒求语义表达完整清楚,不要嫌名字长。
7.正例:MAX_STOCK_COUNT 反例:MAX_COUNT8.【强制】抽象类命名使⽤Abstract 或Base 开头;异常类命名使⽤Exception 结尾;测试类命名以它要测试的类的名称开始,以Test 结尾。
9.【强制】Model 类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。
10.反例:定义为基本数据类型Boolean isDeleted;的属性,它的⽅法也是isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是deleted,导致属性获取不到,进⽽抛出异常。
11.【强制】对于Service 和DAO 类,基于SOA 的理念,暴露出来的服务⼀定是接⼝,内部的实现类⽤Impl 的后缀与接⼝区别。
正例:CacheManagerImpl 实现CacheManager 接⼝。
12.【推荐】为了达到代码⾃解释的⽬标,任何⾃定义编程元素在命名时,使⽤尽量完整的单词组合来表达其意。
正例:从远程仓库拉取代码的类命名为PullCodeFromRemoteRepository 反例:变量int a;的随意命名⽅式。
java接口命名规则
Java接口是一种抽象数据类型,它定义了类或对象应该支持的操作。
为了使Java接口易于理解和使用,应遵守以下命名规则:
1. 接口名应该以大写字母I开头,例如:IAnimal、IStudent 等。
2. 接口名应该清楚地表示它所定义的概念。
例如,接口IAnimal 应该包含与动物相关的方法,接口IStudent应该包含与学生相关的方法。
3. 接口名不应该包含任何表示实现细节的单词。
例如,不应该使用“Abstract”、“Impl”等单词。
4. 接口名应该遵循驼峰式命名规则,即第一个单词以小写字母开头,后面的单词以大写字母开头。
例如,接口名IAnimalFoodProvider应该包含三个单词,每个单词的首字母大写。
5. 接口名不应该与Java关键字重复,例如,不应该使用“int”、“float”等单词作为接口名。
遵守这些Java接口命名规则可以使代码更易于阅读、理解和维护。
- 1 -。
JAVA编程规范1.1 Java文件名与文件组织结构1.一个java源文件不应该超过2 000行。
2.在Java源文件中应该包含一个单一的公共类(class)或接口(interface),这个公共类或公共接口,应该是这个源文件的第一个类或接口。
3.一个Java源文件一般由下面的顺序构成:(1)文件注释头(2)包名(package)(3)引入(import)声明(4)类(class)或接口(interface)的声明部分1.2 Java文件注释头Java类文件注释头是用来描述该类功能及其特点,以及相关开发信息的,如该类的关联类(通常情况下不描述Java系统核心类如java.util.Vector, ng.Thread等)、开发公司或单位、版权、作者、代码审定人该类所支持的JDK版本、该类版本、开发日期、最后更改日期、修改人、复审人等信息,下面就是一个Java类文件注释头:/****************************************************************** 该类功能及其特点的描述(例如:该类是用来……)** 该类未被编译测试过。
** @see(与该类相关联的类):(AnatherClass.java)*** 开发公司或单位:××软件有限公司研发中心** 版权:本文件版权归属××公司研发中心*** @author(作者):必胜利** @since(该文件所支持的JDK版本):Jdk1.3 或JDK1.42.在重点同时难以理解的地方另加注释。
方法体内的注释应该与其所描述的代码位于同一个层次上。
在一个块注释之前一般有一空白行用于做区分代码与注释的边界。
1.7 变量的声明初始化与放置1.7.1 变量声明1.在一般情况下我们建议每一行代码,只声明一个变量;2.如果变量名称较短并且又是同一数据类型同一结构类型,并且没有给变量初始化则可以在同一行声明;1.7.2 变量初始化尽量在变量声明的地方初始化,如果变量的初始化与有待于计算或处理后的值有关,则我们可以在取得这个值后对变量做初始化。
java两个单词的包名命名规则
在Java中,包名通常遵循一种命名约定,以确保代码的可读性和可维护性。
对于包名的命名,有以下几点规则:
1. 反向域名:包名通常使用反向的域名来命名。
这有助于确保包的唯一性,并且有助于防止与外部公司的包名冲突。
2. 全部小写:包名应全部小写,这是Java的命名约定。
3. 单词分隔:包名通常由多个单词组成,这些单词之间使用下划线(`_`)分隔。
例如,`_package`。
4. 有意义:包名应具有描述性,以表明包中包含的内容或功能。
5. 不使用Java关键字:包名不应与Java的关键字(如`int`、`class`、
`void`等)冲突。
6. 不要使用空格:包名不应包含空格。
7. 尽量简短:尽管包名可以很长,但最好尽量简短,以方便记忆和维护。
对于两个单词的包名,你可以遵循上述规则,例如:
`_package`
`__app`
`__utility`
这些示例都遵循了上述规则,使用了反向域名、全部小写、下划线分隔单词,并且具有描述性。