Java1 -java代码规范

技术尖刀

已于 2022-01-18 22:37:45 修改

阅读量247

点赞数

分类专栏： Java 文章标签： java 开发语言后端

于 2022-01-18 22:28:42 首次发布

本文链接：https://blog.csdn.net/weixin_41714868/article/details/122569375

版权

Java 专栏收录该内容

25 篇文章 0 订阅

订阅专栏

一、Java日常命名规范<基础>

1.project（项目名）
　说法不一，暂定小写，eg：arraytest

2.包名
　　小写，eg：package arrayapp;
　　还可以分部分起名，域名起头，eg:com.frontfree.javagroup;

3.类名/接口名
　　首字母大写，

public class ArrayApp{}

4.方法名
　　首字母小写，其他单词首字母大写，eg：

public void getName(){}

一般情况下，获取方法用get做前缀，eg：getName();

boolean类型，用is做前缀，eg : isEmpty();

类的设置方法，用set做前缀，eg：setName();

5.变量名
　　首字母小写，eg：

int nElems=0；

为区分数据类型，建议设置成　strClassName 这种类型，表示该变量是str类型

6.常量名/静态变量

	static int THREAD_FLAG;
	public static final String GAME_COLOR="RED";

二、编码规范<严格>

1、命名风格

【强制】 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美
元符号结束。
反例：_name / __name / $name / name_ / name$ / name__
解释：有很多开源代码是下划线开头，比如我们要讲的 eureka 源码中，我们可以不吸收这种风格。因为 python 下划线开头是内部变量，此规定是让其他语言转过来的开发者更容易理解。
【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。
正例：renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量= 3
解释：中国在世界上影响力增大了，但还是不建议用拼音或中文，中文有同音字，汉字会有编码问题，Pingfen：评分，平分。
【强制】 类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO /DTO / VO / AO / PO / UID 等。
正例：JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal /TaPromotion
反例：javaserverlessplatform / UserDo / XMLService / TCPUDPDeal /TAPromotion
Ta：谢谢。
解释:
DO（ Data Object）：与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
DTO（ Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
BO（ Business Object）：业务对象。由 Service 层输出的封装业务逻辑的对象。
VO（ View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
AO (Application Object) :应用对象,在 Web 层与 Service 层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
POJO 是 DO / DTO / BO / VO 的统称.
【强制】 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase
风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
【强制】 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，
不要嫌名字长。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例：MAX_COUNT / EXPIRED_TIME
【强制】 抽象类命名使用 Abstract 或 Base 开头；
异常类命名使用Exception 结尾；
测试类命名以它要测试的类的名称开始，以 Test 结尾。
【强制】 类型与中括号紧挨相连来表示数组。
正例：定义整形数组 int[] arrayDemo;
反例：在 main 参数中，使用 String args[]来定义。
解释：便于阅读，一下就知道是数组。国产化标准。像高铁。
【强制】 POJO 类中布尔类型变量都不要加 is 前缀，否则部分框架解析会引起序列化错误。
说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is_xxx的命名方式，所以，需要在设置从 is_xxx 到 xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。
解释：这是开发中的一个坑，如果不知道，这个点，很难发现问题。
debug，com.p3c.controller.ApiTestController，在 postman 中传入
{
“num”:1,
“isSuccess”:true
}
但是 controller 收到的却是 false;
【强制】 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
【强制】 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。
说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。
反例：

public class ConfusingName {
public int age;
// 非 setter/getter 的参数名称，不允许与本类成员变量同名
	public void getData(String alibaba) {
		if(condition) {
		final int money = 531;
		// ...
		}
		for (int i = 0; i < 10; i++) {
		// 在同一方法体中，不允许与其它代码块中的 money 命名相同
		final int money = 615;
		// ...
		}
	}
}
class Son extends ConfusingName {
//允许与父类的成员变量名称相同
	public int age;
}

解释：便于阅读。

【强制】 杜绝完全不规范的缩写，避免望文不知义。
反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成condi，此类随意缩写严重降低了代码的可阅读性。
解释：你懂但是别人不懂。
【推荐】 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。
反例：int a 的随意命名方式。
【推荐】 在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName /COUNT_TERMINATED_THREAD
解释：没有原因，正常些思考。
【推荐】 如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模
式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例：

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名 void commit();
接口基础常量 String COMPANY = “alibaba”;
反例：接口方法定义 public abstract void f();
说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
解释：接口变量：public static final，接口方法：public abstract，大家都知道的，就没必要累赘。
接口和实现类的命名有两套规则：
1）【强制】 对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。
例：CacheServiceImpl 实现 CacheService 接口。
2） 【推荐】 如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。
正例：AbstractTranslator 实现 Translatable 接口。
解释：SOA：Service-Oriented Architecture，面向服务架构。服务间只通过接口进行沟通。
【参考】 枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS /UNKNOWN_REASON。
【参考】 各层命名规约：
A) Service/DAO 层方法命名规约
1）获取单个对象的方法用 get 做前缀。
2）获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。
3）获取统计值的方法用 count 做前缀。
4）插入的方法用 save/insert 做前缀。
5）删除的方法用 remove/delete 做前缀。
6）修改的方法用 update 做前缀。
B) 领域模型命名规约
1）数据对象：xxxDO，xxx 即为数据表名。
2）数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3）展示对象：xxxVO，xxx 一般为网页名称。
4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。
解释：领域模型是一个分析模型，帮助系统分析人员、用户认识现实业务的工具，描述的是业务中涉及到的实体及其相互之间的关系，它是需求分析的产物，与问题域相关。
DO（ Data Object）：与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
DTO（ Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
BO（ Business Object）：业务对象。由 Service 层输出的封装业务逻辑的对象。
VO（ View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。