驼峰命名规范(Java命名规范整理笔记)

驼峰命名规范(Java命名规范整理笔记)

2020年新年伊始,花点時间总结一下Java编程中的命名规范。做为新年首先篇总结性的文章,承上启下,总结以往七年的学习历程,展望新的将来。

介绍

在本文中,将从大到小,从外到内,总结Java编程中的命名规范。文中将会涉及到平日工作中常见的命名示例,如包命名,类命名,接口命名,办法命名,变量命名,常类命名,抽象类命名,出现异常类命名以及扩展类命名等。我将依照项目工程目录构造,从包,类(接口,抽象类,出现异常类),办法,变量和常量的顺序展开介绍。

1. 包命名规范

包(Package)的作用是将作用接近或有关的类或是接口进行分组管理,便于类的定位和查找,与此同时还可以使用包来制止类名的冲突和访问控制,使代码更非常容易维护。一般,包命使用小写英文字母进行命名,并使用“.”进行分割,每个被分割的单元只有包含一个名词。通常地,包命名常选用顶级域名做为前缀,例如com,net,org,edu,gov,cn,io等,随后紧跟公司/组织/个人名称以及作用模块名称。接下来是某些包命名示例:

package org.springframework.boot.autoconfigure.cloud

package org.springframework.boot.util

package org.hibernate.action

package org.hibernate.cfg

package com.alibaba.druid

package com.alibaba.druid.filter

package com.alibaba.nacos.client.config

package com.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等等这些)。下列是某些常见的类命名示例:

public class UserDTO{

//TODO…

}

class EmployeeService{

//TODO…

}

class StudentDAO{

//TODO…

}

class OrderItemEntity{

//TODO…

}

public class UserServiceImpl{

//TODO…

}

public class OrderItemController{

//TODO…

}

接下来是Oracle Java中的某些标准命名示例:

public class HTMLEditorKit{

//…

}

public abstract class HttpContext{

//…

}

public interface ImageObserver{

//…

}

public class ArrayIndexOutOfBoundsException{

//…

}

public class enum Thread.State{

//…

}

2.1 接口命名规范

首先,接口(Interface)是一种表述某一种类的对象动作的特殊类;简单而言,接口也是类(不太严谨),因此,接口的名称的书写也应当符合类名书写规范,首字母应当大写,与普通类名不一样的是,接口命名时一般选用形容词或动词来形容接口的动作个人行为。下列是Oracle Java中某些标准库的接口使用形容词命名示例:

public interface Closeable{

//…

}

public interface Cloneable{

//…

}

public interface RunnableP{

//…

}

public interface Comparable<T>{

//…

}

public interface CompletionService<V>{

//…

}

public interface Iterable<T>{

//…

}

public interface EventListener{

//…

}

在Spring Framework标准库中,一般选用名词+动词/形容词的组合方式来命名接口,下列是Spring Framework中某些接口命名示例:

public interface AfterAdvice{

//…

}

public interface TargetClassAware{

//…

}

public interface ApplicationContextAware{

//…

}

public interface MessageSourceResolvable{

//…

}

2.2 抽象类命名规范

抽象类(Abstract Class)是一种特殊的类,其命名与普通类的命名规范相当。通常地,为了更好地将抽象类与普通类和接口做出差别,提升抽象类的可读性,在命名抽象类时,会以“Abstract”/“Base”做为类命的前缀。接下来是编程中某些常规的命名示例:

public abstract class AbstractRepository<T>{

//…

}

public abstract class AbstractController{

//…

}

public abstract class BaseDao<T,ID>{

//…

}

public abstract class AbstractCommonService<T>{

//…

}

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

public abstract class AbstractAspectJAdvice{

//…

}

public abstract class AbstractSingletonProxyFactoryBean{

//…

}

public abstract class AbstractBeanFactoryPointcutAdvisor{

//…

}

public abstract class AbstractCachingConfiguration{

//…

}

public abstract class AbstractContextLoaderInitializer{

//…

}

2.3 出现异常类命名规范

出现异常类(Exception Class)也是类的一种,但与普通类命名不一样的是,出现异常类在命名时有必要使用“Exception”做为其后缀。接下来是常见的出现异常类命名示例:

public class FileNotFoundException{

//…

}

public class UserAlreadyExistException{

//…

}

public class TransactionException{

//…

}

public class ClassNotFoundException{

//…

}

public class IllegalArgumentException{

//…

}

public class IndexOutOfBoundsException{

//…

}

此外,在Java中还有此外一类出现异常类,它们属于系统出现异常,这种类出现异常类的命名使用“Error”做为其后缀,以区分Exception(编码,自然环境,实际操作等出现异常)。接下来是系统出现异常(非检查出现异常)的命名示例:

public abstract class VirtualMachineError{

//…

}

public class StackOverflowError{

//…

}

public class OutOfMemoryError{

//…

}

public class IllegalAccessError{

//…

}

public class NoClassDefFoundError{

//…

}

public class NoSuchFieldError{

//…

}

public class NoSuchMethodError{

//…

}

3.办法命名规范

办法(Method)命名时,其首字母应当小写,要是办法签名由多个单词组成,则从第2个单词起,使用驼峰命名法进行书写。通常地,在对办法进行命名时,一般选用动词/动词+名词的组合,接下来是办法命名的某些常见示例。

3.1 表述获得

要是一个办法用于获得某个值,一般使用“get”做为其前缀,例如:

public String getUserName(){

//…

}

public List<Integer> getUserIds(){

//…

}

public User getOne(){

//…

}

3.2 表述查询

要是办法有必要通过查询或筛选的方式获得某个数据,一般使用“find”/“query”做为其前缀,例如:

public List<User> findOne(Integer id){

//…

}

public List<Integer> findAll(){

//…

}

public List<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)做为其名词的前缀,例如:

public void setName(String name){

//…

}

public User insert(User user){

//…

}

public void update(User user){

//…

}

public void clearAll(){

//…

}

3.5 其他规范

要是一个办法用于获得某组数据的长度或数量,则该办法应当使用length或size命名;要是办法的返回值为布尔种类(Boolean),则该办法应当使用“is”或”has”做为前缀;要是办法用于将一种种类的数据转换为另一种数据数种类,则可以使用“to”做为前缀。接下来是整体示例:

public long length(){

//…

}

public int size(){

//…

}

public boolean isOpen(){

//…

}

public boolean isNotEmpty(){

//…

}

public boolean hasLength(){

//…

}

public Set<Integer> mapToSet(Map map){

//…

}

public UserDto convertTo(User user){

//…

}

public String toString(Object obj){

//…

}

4. 变量命名规范

变量(Variable)命名包含参数名称,成员变量和局部变量。变量命名一般以小写字母开头,要是变量名由多个单词组成,则从第2个单词起首字母有必要大写,在变量命名环节中,不提议使用“_”做为前缀或是单词之间的分割符号。接下来是某些常见的变量命名示例:

private String nickName;

private String mobileNumber;

private Long id;

private String username;

private Long orderId;

private Long orderItemId;

5. 常量命名规范

通常地,常量名称选用全部大写的英文单词书写,要是常量名称由多个单词组成,则单词之间统一使用“_”进行分割,接下来是常量命名示例:

public static final String LOGIN_USER_SESSION_KEY = “current_login_user”;

public static final int MAX_AGE_VALUE = 120;

public static final int DEFAULT_PAGE_NO = 1;

public static final long MAX_PAGE_SIZE = 1000;

public static final boolean HAS_LICENSE = false;

public static final boolean IS_CHECKED = false;

6. 枚举命名规范

枚举(Enum)类是一种特殊的类,其命名规范遵循普通类的命名约束条件,首字母大写,选用驼峰命名法;枚举类中概念的值的名称遵循常量的命名规范,且枚举值的名称有必要与类名有必须的关联性,接下来是枚举的某些示例:

public enum Color{

RED,YELLOW,BLUE,GREEN,WHIT互联网E;

}

public enum PhysicalSize{

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

}

接下来是Oracle Java标准库中的一个示例:

public enum ElementType{

TYPE,

FIELD,

METHOD,

PARAMETER,

CONSTRUCTOR,

LOCAL_VARIABLE,

ANNOTATION_TYPE,

PACKAGE,

TYPE_PARAMETER,

TYPE_USE;

}

7. 其他命名规范

7.1 数组

在概念数组时,为了更好地便于阅读,尽量维持以下的书写规范:

int[] array = new int[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表示任意的种类。

接下来时泛型类的书写示例:

public class HashSet<E> extends AbstractSet<E>{

//…

}

public class HashMap<K,V> extends AbstractMap<K,V>{

//…

}

public class ThreadLocal<T>{

//…

}

public interface Functor<T,X extends Throwable>{

T val() throws X;

}

public class Container<K,V>{

private K key;

private V value;

Container(K key,V value){

this.key = key;

this.value = value;

}

//getter and setter …

}

public interface BaseRepository<T,ID>{

T findById(ID id);

void update(T t);

List<T> findByIds(ID…ids);

}

public static <T> List<T> methodName(Class<T> clz){

List<T> dataList = getByClz(clz);

return dataList;

}

7.4 接口实现类

为了更好地便于阅读,在一般状况下,提议接口实现类使用“Impl做为后缀”,不提议使用大写的“I”做为接口前缀,接下来是接口和接口实现类的书写示例。

推举写法:

public interface OrderService{

//…

}

public class OrderServiceImpl implements OrderService{

//…

}

不提议的写法:

public interface IOrderService{

//…

}

public class OrderService implements IOrderService{

//…

}

7.5 测试类和测试办法

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

public class UserServiceTest{

public void testFindByUsernameAndPassword(){

//…

}

public void testUsernameExist_notExist(){

//…

}

public void testDeleteById_isOk(){

//…

}

}

8 扩展:速记Java开发中的各种各样O

最后,通过一张表和图快速对Java中的BO,DTO,DAO,PO,POJO,VO之间的含义,差别以及联系进行梳理。

接下来将通过一张图来理解上述几种O之间一起转换的关系: