Java最新Java 命名规范（非常全面，可以收藏），java常见事务面试题

写在最后

还有一份JAVA核心知识点整理（PDF）：JVM，JAVA集合，JAVA多线程并发，JAVA基础，Spring原理，微服务，Netty与RPC，网络，日志，Zookeeper，Kafka，RabbitMQ，Hbase，MongoDB，Cassandra，设计模式，负载均衡，数据库，一致性哈希，JAVA算法，数据结构，加密算法，分布式缓存，Hadoop，Spark，Storm，YARN，机器学习，云计算…

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取

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

3.1 表述获取

如果一个方法用于获取某个值，通常使用“get”作为其前缀，例如：

public String getUserName(){

}

public List getUserIds(){

}

public User getOne(){

}

3.2 表述查询

如果方法需要通过查询或筛选的方式获取某个数据，通常使用“find”/“query”作为其前缀，例如：

public List findOne(Integer id){

}

public List findAll(){

}

public List queryOrders(){

}

3.3 表述条件

如果一个方法需要一些条件参数，则可以使用“by”/“with”等字符作为方法名中条件的连接符，例如：

public User findByUsername(String username){

}

public List getUserIdsWithState(boolean state){

}

public List 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 mapToSet(Map map){

}

public UserDto convertTo(User user){

}

public String toString(Object obj){

}

4. 变量命名规范

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

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,WHITE;

}

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 getNameById(Integer[] ids){

}

public List getNameById(Integer…ids){

}

7.2 表述复数或者集合

如果一个变量用于描述多个数据时，尽量使用单词的复数形式进行书写，例如：

Collection orders;

int[] values;

List items;

另外，如果表述的是一个Map数据，则应使用“map”作为其后缀，例如：

Map<String,User> userMap;

Map<String,List> listMap;

7.3 泛型类

在书写泛型类时，通常做以下的约定：

• 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 findByIds(ID…ids);

}

public static List methodName(Class clz){

List dataList = getByClz(clz);

return dataList;

}

7.4 接口实现类

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

推荐写法：

public interface OrderService{

}

public class OrderServiceImpl implements OrderService{

}

不建议的写法：

public interface IOrderService{

}

最后

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取

议使用大写的“I”作为接口前缀，下面是接口和接口实现类的书写示例。

推荐写法：

public interface OrderService{

}

public class OrderServiceImpl implements OrderService{

}

不建议的写法：

public interface IOrderService{

}

最后

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

[外链图片转存中…(img-KGNirPcU-1715371583877)]

[外链图片转存中…(img-3XWKi0cH-1715371583877)]

[外链图片转存中…(img-oRtIMuHQ-1715371583877)]

[外链图片转存中…(img-8mxdgmwe-1715371583878)]

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取