Java的命名规则

长_卿

已于 2022-05-11 17:22:43 修改

阅读量564

点赞数

分类专栏： java 文章标签： java

于 2022-05-11 17:10:14 首次发布

原文链接：https://www.jb51.net/article/224291.htm#_lab2_1_2

版权

java 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

为什么要规范化命名

在我们学习Java时候，项目、包、类、方法、变量、常量等都是有严格要求的，不然会给别人别人阅读使用以及自己带来大量的烦恼。

项目命名规则

全部小写，例如testjavaproject、studentmanagement等

包命名规范

包命名统一使用小写，点分隔符。
JAVA包里面不能嵌套包。
为了表达嵌套关系有了表分隔符，使用"."进行分隔。
4.每个被分个的单元只包含一个单词
一般采用顶级域名作为前缀，例如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

类命名规范

类通常采用名词进行命名，而且首字母大写，如果一个类名包含两个以上名词，建议使用驼峰命名法，每个单词首字母大写，一般的，类名的书写尽量使其保持简单和描述的完整性，因此在书写类时不建议缩写。(一些约定俗成的命名除外。例如 Internationalization and Localization 缩写成 i8n , Uniform Resource Identifer缩写成 URI ， Data Access Object 缩写成DAO ， JSON Web Token 缩写成JWT 等等) . 下列是一些常见的类命名提示:
例如:
public class UserDTO{
}
class EmployeeService{
}
class StudentDAO{
}
class OrderItemEntity{
}
class UserServiceImpl{
}

接口命名规范

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

}
public interface Cloneable{

}
public interface Runnable{

}
public interface Comparable{

}
public interface CompletionService{

}
public interface Iterable{

}
public interface EventListener{

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

public interface AfterAdvice{

}
public interface TargetClassAware{

}
public interface ApplicationContextAware{

}
public interface MessageSourceResolvable{

}

异常类命名规范

异常类(Expression class) 也是类的一种，但是与普通类命名不同的是，异常类在命名时需要使用“Expression" 作为其后缀。下面是常见的异常类命名示例：
public class FileNotFoundExpression{
}
public class UserAlreadyExistException{}
public class TransactionException{}
public class ClassNotFoundException{}

另外，在Java中还有另外一类异常，他们属于系统异常，这一类异常类的命名使用"Error"作为后缀，以区分Exception ,下面是系统异常的命名示例：
public abstract class VirtualMathineError{}
public class OutOfMemoryError{}

抽象类命名规范

抽象类是一种特殊的类，其命名与普通类的命名规范相当。一般的，为了将抽象类与普通类作区别，提高抽象类的可读性，在命名抽象类的时候，会以"Abstrract"/"Base“ 作为类名的前缀。一些常规的命名示例：
public abstract class AbstractRepository{

}
public abstract class AbstractController{

}
public abstract class BaseDao<T,ID>{

}
public abstract class AbstractCommonService{

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

public abstract class AbstractAspectJAdvice{

}
public abstract class AbstractSingletonProxyFactoryBean{

}
public abstract class AbstractBeanFactoryPointcutAdvisor{

}
public abstract class AbstractCachingConfiguration{

}
public abstract class AbstractContextLoaderInitializer{

}

变量命名规范

变量命名包括参数名称，成员变量和局部变量。成员变量名由多个单词构成，则从第二个单词起首字母需要大写。
下面是一些常见的变量名示例;
private String nickName ;
private String mobileNumber ;
private Long id;
private String username ;
private Long orderId ;

常量命名规范

一般的，常量名称采用全部大写英文单词书写，如果常量名称由多个单词构成，则单词之间统一使用"_"进行分割，下面是常量命名示例：
public static final String LOGIN_USER_SESSION_KEY = “current_login_user”;
public static final int MAX_AGE_VALUE = 120 ;
public static final int DEFALUT_PAGE_NO = 1;

枚举变量规范

public enum Color{
RED,YELLOW , BLUE , GREEN , WHITE ;
}
public enum PhysicalSIze
{TINY , SMALL , MEDIUM , LARGE , HUGE , GIGANTIC ;
}

方法命名规范

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

表述获取

如果一个方法用于获取某个值，通常使用”get“作为前缀，例如：
public String getUserName()
{
}
public List getUserIds(){
}
public User getOne(){
}

表述查询

如果某个方法需要通过查询或筛选的方式获取某个数据，通常使用”find"/"query"作为其前缀，例如：
public List findOne(Integer id)
{
}
public List findAll()
{
}
public List queryOrders()
{
}

表述条件

如果一个方法需要一些条件参数，则可以使用“by” / “with” 等字符作为方法中条件的连接符，例如：
public User findByUsername(String usertname)
{
}
public List getUserIdWithState(boolean state)
{
}

表述设置

如果一个方法是要设置，插入，删除，修改等操作，应该将对应的动词（set ,insert , update , delete) 作为其名词的前缀，例如：
public void setName(String name)
{
}

public User insert(User user)
{
}
public update(User user)
{
}
public void clearAll()
{
}

其他规范

如果一个方法用于获取某个某组数据的长度或者数量，则该该方法应该使用length或者size命名; 如果方法的返回值为布尔l类型(Boolean ) , 则该方法应该使用is 或者has 作为前缀；
如果方法用于将某一种类型的数据转换为另一种类型的数据，则可以使用”to" 作为前缀。下面是综合实例：
public long length(){}
public int size(){}
public boolean isOpen(){}
public boolean isNotEmpty(){}
public boolean hasLength(){}
public Set mapToSet(Map map){}
public UserDto convertTo(User user)
{
}

其数组，集合，泛型类，接口实现类，测试类以及测试方法

数组

在定义数组的时候，为了方便阅读，尽量保持以下的书写规范 :
int [] array = new int[10] ;
int [] idArray = {1,2,3,4,5} ;
String [] nameArray = {"First” ， “Yellow” ， “Big”} ；
public List getNameById(Integer [] ids)
{
}
public List getNameById()Integer…ids){}

表述复数或者集合

如果一个变量用于描述多个数据时，尽量使用单词的复数形式进行书写，例如:
Collection orders ;
int [] values;
List items ;
另外，如果表述的是一个Map数据，则应使用"map“ 作为其后缀，例如：
Map<String , User> userMap ;
Map <String , List> , listMap ;

泛型类

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

public class HashSet extends AbstractSet{

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

}
public class ThreadLocal{

}
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;
}

}

public interface BaseRepository<T,ID>{
T findById(ID id);

void update(T t);

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

}

public static List methodName(Class clz){
List dataList = getByClz(clz);
return dataList;
}

接口实现类

接口实现类使用"Impl”作为后缀，下面是接口和接口实现类的书写示例:
推荐写法:
public interface OrderService
{
}
public class OrderServiceImpl implements OrderService
{
}

测试类与测试方法

在项目中，测试类采用被测试业务模块名/被测试接口/被测试类+“Test”的方法进行书写，测试类中的测试函数采用“test”+用例操作_状态的组合方式进行书写，例如：
public class UserServiceTest{
public void testFindByUsernameAndPassword(){
}
public void testUsernameExist_notExist(){
}
public void testDeleteById_isOk(){
}
}

长_卿

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Java的命名规则

为什么要规范化命名项目命名规则包命名规范类命名规范接口命名规范异常类命名规范抽象类命名规范变量命名规范常量命名规范枚举变量规范方法命名规范表述获取表述查询表述条件表述设置其他规范其数组，集合，泛型类，接口实现类，测试类以及测试方法数组表述复数或者集合泛型类接口实现类测试类与测试方法为什么要规范化命名在我们学习Java时候，项目、包、类、方法、变量、常量等都是有严格要求的，不然会给别人别人阅读使用以及自己带来大量的烦恼。这里写目录标题为什么要规范化命名项目命名规则包命名规范类命名规范接口命名规.
复制链接

扫一扫