java中常见的命名规范

1、包命名规范
            使用小写英文字母进行命名，并使用“.”进行分割，每个被分割的单元只能包含一个名词。
            一般地，包命名常采用顶级域名作为前缀，例如com，net，org，edu，gov，cn，io等，随后紧跟公司/组织/个人名称以及功能模块名称。
          

                 package com.alibaba.druid
                package com.alibaba.druid.filter
                package com.alibaba.nacos.client.config
                package java.beans
                package java.io
                package java.lang
                package java.net
                package java.util

        2、类命名规范
            通常采用名词进行命名，且首字母大写，如果一个类名包含两个以上名词，建议使用驼峰命名(Camel-Case)法书写类名,每个名词首字母也应该大写
        
        3、接口命名规范
            首先，接口(Interface)是一种表述某一类型对象动作的特殊类；简单来说，接口也是类(不太严谨)，所以，接口的名称的书写也应该符合类名书写规范，首字母应该大写，与普通类名不同的是，接口命名时通常采用形容词或动词来描述接口的动作行为。
            在Spring Framework标准库中，通常采用名词+动词/形容词的组合方式来命名接口
          

  eg：
            public interface AfterAdvice{
    
            }
            public interface TargetClassAware{
                
            }
            public interface ApplicationContextAware{
                
            }
            public interface MessageSourceResolvable{
                
            }

        4、抽象类命名规范：
        抽象类(AbstractClass)是一种特殊的类，其命名与普通类的命名规范相当。一般地，为了将抽象类与普通类和接口做出区别，
        提高抽象类的可读性，在命名抽象类时，会以“Abstract”/“Base”作为类名的前缀。
      

 public abstract class AbstractRepository<T>{
    
        }
        public abstract class AbstractController{
            
        }
        public abstract class BaseDao<T,ID>{
            
        }
        public abstract class AbstractCommonService<T>{
            
        }

        5、异常类命名规范：
        异常类(Exception Class)也是类的一种，但与普通类命名不同的是，异常类在命名时需要使用“Exception”作为其后缀。
        另外，在Java中还有另外一类异常类，它们属于系统异常，这一类异常类的命名使用“Error”作为其后缀，以区分Exception(编码，环境，操作等异常)。
        
        6、方法命名规范
            方法(Method)命名时,其首字母应该小写，如果方法签名由多个单词组成，则从第二个单词起，使用驼峰命名法进行书写。一般地，在对方法进行命名时，通常采用动词/动词+名词的组合，
            6.1、获取某个值
                通常使用“get”作为其前缀，
              

                  public String getUserName(){
                    
                }
                public List<Integer> getUserIds(){
                    
                }
                public User getOne(){
                    
                }

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

               public List<User> findOne(Integer id){
                    
                }
                public List<Integer> findAll(){
                    
                }
                public List<String> queryOrders(){
                    
                }

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

                public User findByUsername(String username){
    
                }
                public List<Integer> getUserIdsWithState(boolean state){
                    
                }
                public List<User> findAllByUsernameOrderByIdDesc(String username){
                    
                }

            6.4、如果一个方法是要设置，插入，修改，删除等操作，应该将对应的动词(set,insert,update,delete)作为其名词的前缀
            
            6.5、如果一个方法用于获取某组数据的长度或数量，则该方法应该使用length或size命名；如果方法的返回值为布尔类型(Boolean)，
                则该方法应该使用“is”或”has”作为前缀
                如果方法用于将一种类型的数据转换为另一种数据数类型，则可以使用“to”作为前缀
        
        7、变量命名规范：
            变量(Variable)命名包括参数名称，成员变量和局部变量。变量命名通常以小写字母开头，如果变量名由多个单词构成，则从第二个单词起首字母需要大写，在变量命名过程中，不建议使用“_”作为前缀或者单词之间的分割符号
            private String nickName;
            private String mobileNumber;
            private Long id;
            
        8、常量命名规范：
            一般地，常量名称采用全部大写的英文单词书写，如果常量名称由多个单词组成，则单词之间统一使用“_”进行分割
         

            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;

            
        9、枚举命名规范：
            枚举(Enum)类是一种特殊的类，其命名规范遵循普通类的命名约束条件，首字母大写，采用驼峰命名法；枚举类中定义的值的名称遵循常量的命名规范，且枚举值的名称需要与类名有一定的关联性，
          

  public enum ElementType{
                TYPE,
                FIELD,
                METHOD,
                PARAMETER,
                CONSTRUCTOR,
                LOCAL_VARIABLE,
                ANNOTATION_TYPE,
                PACKAGE,
                TYPE_PARAMETER,
                TYPE_USE;
            }

        
        10、数组命名规范：
            int[] array = new int[10];
            int[] idArray ={1,2,3,4,5};
            
        11、如果一个变量用于描述多个数据时，尽量使用单词的复数形式进行书写，另外，如果表述的是一个Map数据，则应使用“map”作为其后缀
        
        12、泛型类命名规范：
            在书写泛型类时，通常做以下的约定：

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

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

        13、接口实现类命名规范：
            为了便于阅读，在通常情况下，建议接口实现类使用“Impl作为后缀”
            
        14、测试类及测试方法命名规范：
            在项目中，测试类采用被测试业务模块名/被测试接口/被测试类+“Test”的方法进行书写，测试类中的测试函数采用“test”+用例操作_状态的组合方式进行书写
          

  public class UserServiceTest{

            public void testFindByUsernameAndPassword(){
                
            }

            public void testUsernameExist_notExist(){
                
            }

            public void testDeleteById_isOk(){
                
            }
        }

        
        15、java开发中的几种O
        
            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层之间抽象的复用对象模型，很少用。