最近发现很多初级程序员写代码时很不规范,比如方法名 类名 等,如果遇到有代码洁癖的领导肯定会被骂(什么垃圾代码),下面分享一篇不错的规范文章
在本文中,将从大到小,从外到内,总结Java编程中的命名规范。文中将会涉及到日常工作中常见的命名示例,如包命名,类命名,接口命名,方法命名,变量命名,常类命名,抽象类命名,异常类命名以及扩展类命名等。我将按照项目工程目录结构,从包,类(接口,抽象类,异常类),方法,变量和常量的顺序展开介绍。
本文是 Java 命名规范的介绍,建议收藏转发。

1. 包命名规范

包(Package)的作用是将功能相似或相关的类或者接口进行分组管理,便于类的定位和查找,同时也可以使用包来避免类名的冲突和访问控制,使代码更容易维护。通常,包命使用小写英文字母进行命名,并使用“.”进行分割,每个被分割的单元只能包含一个名词。
一般地,包命名常采用顶级域名作为前缀,例如com,net,org,edu,gov,cn,io等,随后紧跟公司/组织/个人名称以及功能模块名称。下面是一些包命名示例:
packageorg.springframework.boot.autoconfigure.cloud
packageorg.springframework.boot.util
packageorg.hibernate.action
packageorg.hibernate.cfg
packagecom.alibaba.druid
packagecom.alibaba.druid.filter
packagecom.alibaba.nacos.client.config
packagecom.ramostear.blog.web
下面是Oracle Java的一些常见包命名例子:
package
 java.beans

package
 java.io

package
 java.lang

package
 java.net

package
 java.util

package
 javax.annotation

2. 类命名规范

类(Class)通常采用名词进行命名,且首字母大写,如果一个类名包含两个以上名词,建议使用驼峰命名(Camel-Case)法书写类名,每个名词首字母也应该大写。一般地,类名的书写尽量使其保持简单和描述的完整性,因此在书写类名时不建议使用缩写(一些约定俗成的命名除外。
例如 Internationalization and Localization 缩写成i18n,Uniform Resource Identifier缩写成URI,Data Access Object缩写成DAO,JSON Web Token缩写成JWT,HyperText Markup Language缩写成HTML等等)。下列是一些常见的类命名示例:
publicclassUserDTO
{


}

classEmployeeService
{


}

classStudentDAO
{


}

classOrderItemEntity
{


}

publicclassUserServiceImpl
{


}

publicclassOrderItemController
{


}
下面是 Oracle Java 中的一些标准命名示例:
publicclassHTMLEditorKit
{


}

publicabstractclassHttpContext
{


}

publicinterfaceImageObserver
{


}

publicclassArrayIndexOutOfBoundsException
{


}

publicclassenumThread.State
{


}

2.1 接口命名规范

首先,接口(Interface)是一种表述某一类型对象动作的特殊类;简单来说,接口也是类(不太严谨),所以,接口的名称的书写也应该符合类名书写规范,首字母应该大写,与普通类名不同的是,接口命名时通常采用形容词或动词来描述接口的动作行为。下列是Oracle Java中一些标准库的接口使用形容词命名示例:关注Java项目分享
publicinterfaceCloseable
{


}

publicinterfaceCloneable
{


}

publicinterfaceRunnable
{


}

publicinterfaceComparable<T>
{


}

publicinterfaceCompletionService<V>
{


}

publicinterfaceIterable<T>
{


}

publicinterfaceEventListener
{


}
在Spring Framework标准库中,通常采用名词+动词/形容词的组合方式来命名接口,下列是Spring Framework中一些接口命名示例:
publicinterfaceAfterAdvice
{


}

publicinterfaceTargetClassAware
{


}

publicinterfaceApplicationContextAware
{


}

publicinterfaceMessageSourceResolvable
{


}
2.2 抽象类命名规范
抽象类(Abstract Class)是一种特殊的类,其命名与普通类的命名规范相当。一般地,为了将抽象类与普通类和接口做出区别,提高抽象类的可读性,在命名抽象类时,会以“Abstract”/“Base”作为类命的前缀。下面是编程中一些常规的命名示例:
publicabstractclassAbstractRepository<T>
{


}

publicabstractclassAbstractController
{


}

publicabstractclassBaseDao<T,ID>
{


}

publicabstractclassAbstractCommonService<T>
{


}
以下是Spring Framework中常见的抽象类示例:
publicabstractclassAbstractAspectJAdvice
{


}

publicabstractclassAbstractSingletonProxyFactoryBean
{


}

publicabstractclassAbstractBeanFactoryPointcutAdvisor
{


}

publicabstractclassAbstractCachingConfiguration
{


}

publicabstractclassAbstractContextLoaderInitializer
{


}
2.3 异常类命名规范
异常类(Exception Class)也是类的一种,但与普通类命名不同的是,异常类在命名时需要使用“Exception”作为其后缀。下面是常见的异常类命名示例:
publicclassFileNotFoundException
{


}

publicclassUserAlreadyExistException
{


}

publicclassTransactionException
{


}

publicclassClassNotFoundException
{


}

publicclassIllegalArgumentException
{


}

publicclassIndexOutOfBoundsException
{


}
另外,在Java中还有另外一类异常类,它们属于系统异常,这一类异常类的命名使用“Error”作为其后缀,以区分Exception(编码,环境,操作等异常)。下面是系统异常(非检查异常)的命名示例:
publicabstractclassVirtualMachineError
{


}

publicclassStackOverflowError
{


}

publicclassOutOfMemoryError
{


}

publicclassIllegalAccessError
{


}

publicclassNoClassDefFoundError
{


}

publicclassNoSuchFieldError
{


}

publicclassNoSuchMethodError
{


}
3.方法命名规范
方法(Method)命名时,其首字母应该小写,如果方法签名由多个单词组成,则从第二个单词起,使用驼峰命名法进行书写。一般地,在对方法进行命名时,通常采用动词/动词+名词的组合,下面是方法命名的一些常见示例。

3.1 表述获取

如果一个方法用于获取某个值,通常使用“get”作为其前缀,例如:
public String getUserName()
{


}

public List<Integer> getUserIds()
{


}

public User getOne()
{


}
3.2 表述查询
如果方法需要通过查询或筛选的方式获取某个数据,通常使用“find”/“query”作为其前缀,例如:
publicList
<User> findOne(Integer id){


}

publicList
<Integer> findAll(){


}

publicList
<String> queryOrders(){


}

3.3 表述条件

如果一个方法需要一些条件参数,则可以使用“by”/“with”等字符作为方法名中条件的连接符,例如:
public User findByUsername(String username)
{


}

public List<Integer> getUserIdsWithState(boolean state)
{


}

public List<User> findAllByUsernameOrderByIdDesc(String username)
{


}
3.4 表述设置
如果一个方法是要设置,插入,修改,删除等操作,应该将对应的动词(set,insert,update,delete)作为其名词的前缀,例如:
publicvoidsetName(String name)
{


}

public User insert(User user)
{


}

publicvoidupdate(User user)
{


}

publicvoidclearAll()
{


}
3.5 其他规范
如果一个方法用于获取某组数据的长度或数量,则该方法应该使用length或size命名;如果方法的返回值为布尔类型(Boolean),则该方法应该使用“is”或”has”作为前缀;
如果方法用于将一种类型的数据转换为另一种数据数类型,则可以使用“to”作为前缀。下面是综合示例:
publiclonglength()
{


}

publicintsize()
{


}

publicbooleanisOpen()
{


}

publicbooleanisNotEmpty()
{


}

publicbooleanhasLength()
{


}

public Set<Integer> mapToSet(Map map)
{


}

public UserDto convertTo(User user)
{


}

public String toString(Object obj)
{


}
4. 变量命名规范
变量(Variable)命名包括参数名称,成员变量和局部变量。变量命名通常以小写字母开头,如果变量名由多个单词构成,则从第二个单词起首字母需要大写,在变量命名过程中,不建议使用“_”作为前缀或者单词之间的分割符号。下面是一些常见的变量命名示例:关注Java项目分享
privateString
 nickName;

privateString
 mobileNumber;

private
 Long id;

privateString
 username;

private
 Long orderId;

private
 Long orderItemId;
5. 常量命名规范
一般地,常量名称采用全部大写的英文单词书写,如果常量名称由多个单词组成,则单词之间统一使用“_”进行分割,下面是常量命名示例:
publicstaticfinal
 String LOGIN_USER_SESSION_KEY =
"current_login_user"
;

publicstaticfinalint
 MAX_AGE_VALUE =
120
;

publicstaticfinalint
 DEFAULT_PAGE_NO =
1
;

publicstaticfinallong
 MAX_PAGE_SIZE =
1000
;

publicstaticfinalboolean
 HAS_LICENSE =
false
;

publicstaticfinalboolean
 IS_CHECKED =
false
;

6. 枚举命名规范

枚举(Enum)类是一种特殊的类,其命名规范遵循普通类的命名约束条件,首字母大写,采用驼峰命名法;枚举类中定义的值的名称遵循常量的命名规范,且枚举值的名称需要与类名有一定的关联性,下面是枚举的一些示例:
publicenum
 Color{

    RED,YELLOW,BLUE,GREEN,WHITE;

}

publicenum
 PhysicalSize{

    TINY,SMALL,MEDIUM,LARGE,HUGE,GIGANTIC;

}
下面是Oracle Java标准库中的一个示例:
publicenum
 ElementType{

    TYPE,

    FIELD,

    METHOD,

    PARAMETER,

    CONSTRUCTOR,

    LOCAL_VARIABLE,

    ANNOTATION_TYPE,

    PACKAGE,

    TYPE_PARAMETER,

    TYPE_USE;

}

7. 其他命名规范

7.1 数组

在定义数组时,为了便于阅读,尽量保持以下的书写规范:
int
[] array =
newint
[
10
];

int
[] idArray ={
1
,
2
,
3
,
4
,
5
};

String[] nameArray = {
"First"
,
"Yellow"
,
"Big"
}


public List<String> getNameById(Integer[] ids)
{


}


public List<String> getNameById(Integer...ids)
{


}

7.2 表述复数或者集合

如果一个变量用于描述多个数据时,尽量使用单词的复数形式进行书写,例如:
Collection<
Order
> orders;

int
[]
 values;

List<Item> items;
另外,如果表述的是一个Map数据,则应使用“map”作为其后缀,例如:
Map
<
String
,User> userMap;

Map
<
String
,List<
Object
>> listMap;

7.3 泛型类

在书写泛型类时,通常做以下的约定:
  • E表示Element,通常用在集合中;
  • ID用于表示对象的唯一标识符类型
  • T表示Type(类型),通常指代类;
  • K表示Key(键),通常用于Map中;
  • V表示Value(值),通常用于Map中,与K结对出现;
  • N表示Number,通常用于表示数值类型;
  • ?表示不确定的Java类型;
  • X用于表示异常;
  • U,S表示任意的类型。
下面时泛型类的书写示例:
publicclassHashSet<E> extendsAbstractSet<E>
{


}

publicclassHashMap<K,V> extendsAbstractMap<K,V>
{


}

publicclassThreadLocal<T>
{


}

publicinterfaceFunctor<T,XextendsThrowable>
{

T val()throws X
;

}

publicclassContainer<K,V>
{

private
 K key;

private
 V value;

    Container(K key,V value){

this
.key = key;

this
.value = value;

    }


}


publicinterfaceBaseRepository<T,ID>
{

T findById(ID id)
;


voidupdate(T t)
;


List<T> findByIds(ID...ids)
;

}


publicstatic
 <T>
List<T> methodName(Class<T> clz)
{

    List<T> dataList = getByClz(clz);

return
 dataList;

}
7.4 接口实现类
为了便于阅读,在通常情况下,建议接口实现类使用“Impl作为后缀”,不建议使用大写的“I”作为接口前缀,下面是接口和接口实现类的书写示例。
推荐写法:
publicinterfaceOrderService
{


}

publicclassOrderServiceImplimplementsOrderService
{


}
不建议的写法:
publicinterfaceIOrderService
{


}

publicclassOrderServiceimplementsIOrderService
{


}

7.5 测试类和测试方法

在项目中,测试类采用被测试业务模块名/被测试接口/被测试类+“Test”的方法进行书写,测试类中的测试函数采用“test”+用例操作_状态的组合方式进行书写,例如:
publicclassUserServiceTest{

publicvoidtestFindByUsernameAndPassword()
{


    }


publicvoidtestUsernameExist_notExist()
{


    }


publicvoidtestDeleteById_isOk()
{


    }

}
8 扩展:速记 Java 开发中的各种O
最后,通过一张表和图快速对Java中的BO,DTO,DAO,PO,POJO,VO之间的含义,区别以及联系进行梳理。
名称

使用范围

解释说明

BO
用于Service,Manager,Business等业务相关类的命名
Business Object业务处理对象,主要作用是把业务逻辑封装成一个对象。
DTO
经过加工后的PO对象,其内部属性可能增加或减少
Data Transfer Object数据传输对象,主要用于远程调用等需要大量传输数据的地方,例如,可以将一个或多个PO类的部分或全部属性封装为DTO进行传输
DAO
用于对数据库进行读写操作的类进行命名
Data Access Object数据访问对象,主要用来封装对数据库的访问,通过DAO可以将POJO持久化为PO,也可以利用PO封装出VO和DTO
PO
Bean,Entity等类的命名
Persistant Object持久化对象,数据库表中的数据在Java对象中的映射状态,可以简单的理解为一个PO对象即为数据库表中的一条记录
POJO
POJO是DO/DTO/BO/VO的统称
Plain Ordinary Java Object 简单Java对象,它是一个简单的普通Java对象,禁止将类命名为XxxxPOJO
VO
通常是视图控制层和模板引擎之间传递的数据对象
Value Object 值对象,主要用于视图层,视图控制器将视图层所需的属性封装成一个对象,然后用一个VO对象在视图控制器和视图之间进行数据传输。
AO
应用层对象
Application Object,在Web层与Service层之间抽象的复用对象模型,很少用。
下面将通过一张图来理解上述几种O之间相互转换的关系:
转链接:www.ramostear.com/blog/2020/03/20/2vxdaqjq.html
PS:如果觉得我的分享不错,欢迎大家随手点赞、在看。
(完)
加我"微信获取一份 最新Java面试题资料
请备注:666不然不通过~
最近好文
最近面试BAT,整理一份面试资料Java面试BAT通关手册,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
获取方式:关注公众号并回复 java 领取,更多内容陆续奉上。
明天见(。・ω・。)ノ♡
继续阅读
阅读原文