Java?命名規(guī)范（非常全面）
時(shí)間：2021-10-29 16:42:00
手機(jī)看文章
掃描二維碼
隨時(shí)隨地手機(jī)看文章
[導(dǎo)讀]來(lái)源：https://www.ramostear.com/blog/2020/03/20/2vxdaqjq.html最近發(fā)現(xiàn)很多初級(jí)程序員寫代碼時(shí)很不規(guī)范，比如方法名類名等，如果遇到有代碼潔癖的領(lǐng)導(dǎo)肯定會(huì)被罵（什么垃圾代碼），下面分享一篇不錯(cuò)的規(guī)范文章在本文中，將從大到小，從外到...
1. 包命名規(guī)范
包(Package)的作用是將功能相似或相關(guān)的類或者接口進(jìn)行分組管理，便于類的定位和查找，同時(shí)也可以使用包來(lái)避免類名的沖突和訪問(wèn)控制，使代碼更容易維護(hù)。通常，包名使用小寫英文字母進(jìn)行命名，并使用“.”進(jìn)行分割，每個(gè)被分割的單元只能包含一個(gè)名詞。
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.io
package java.lang
package java.net
package java.util
package javax.annotation
2. 類命名規(guī)范
類(Class)通常采用名詞進(jìn)行命名，且首字母大寫，如果一個(gè)類名包含兩個(gè)以上名詞，建議使用駝峰命名(Camel-Case)法書寫類名,每個(gè)名詞首字母也應(yīng)該大寫。一般地，類名的書寫盡量使其保持簡(jiǎn)單和描述的完整性，因此在書寫類名時(shí)不建議使用縮寫(一些約定俗成的命名除外。
}
class EmployeeService{
}
class StudentDAO{
}
class OrderItemEntity{
}
public class UserServiceImpl{
}
public class OrderItemController{
}
下面是 Oracle Java 中的一些標(biāo)準(zhǔn)命名示例：
}
public abstract class HttpContext{
}
public interface ImageObserver{
}
public class ArrayIndexOutOfBoundsException{
}
public class enum Thread.State{
}
2.1 接口命名規(guī)范
首先，接口(Interface)是一種表述某一類型對(duì)象動(dòng)作的特殊類；簡(jiǎn)單來(lái)說(shuō)，接口也是類(不太嚴(yán)謹(jǐn))，所以，接口的名稱的書寫也應(yīng)該符合類名書寫規(guī)范，首字母應(yīng)該大寫，與普通類名不同的是，接口命名時(shí)通常采用形容詞或動(dòng)詞來(lái)描述接口的動(dòng)作行為。下列是Oracle Java中一些標(biāo)準(zhǔn)庫(kù)的接口使用形容詞命名示例：
}
public interface Cloneable{
}
public interface Runnable{
}
public interface Comparable{
}
public interface CompletionService{
}
public interface Iterable{
}
public interface EventListener{
}
在Spring Framework標(biāo)準(zhǔn)庫(kù)中，通常采用名詞 動(dòng)詞/形容詞的組合方式來(lái)命名接口，下列是Spring Framework中一些接口命名示例：
}
public interface TargetClassAware{
}
public interface ApplicationContextAware{
}
public interface MessageSourceResolvable{
}
2.2 抽象類命名規(guī)范
}
public abstract class AbstractController{
}
public abstract class BaseDao
}
public abstract class AbstractCommonService{
}
以下是Spring Framework中常見的抽象類示例：
}
public abstract class AbstractSingletonProxyFactoryBean{
}
public abstract class AbstractBeanFactoryPointcutAdvisor{
}
public abstract class AbstractCachingConfiguration{
}
public abstract class AbstractContextLoaderInitializer{
}
2.3 異常類命名規(guī)范
}
public class UserAlreadyExistException{
}
public class TransactionException{
}
public class ClassNotFoundException{
}
public class IllegalArgumentException{
}
public class IndexOutOfBoundsException{
}
另外，在Java中還有另外一類異常類，它們屬于系統(tǒng)異常，這一類異常類的命名使用“Error”作為其后綴，以區(qū)分Exception(編碼，環(huán)境，操作等異常)。下面是系統(tǒng)異常(非檢查異常)的命名示例：
}
public class StackOverflowError{
}
public class OutOfMemoryError{
}
public class IllegalAccessError{
}
public class NoClassDefFoundError{
}
public class NoSuchFieldError{
}
public class NoSuchMethodError{
}
3.方法命名規(guī)范
3.1 表述獲取
如果一個(gè)方法用于獲取某個(gè)值，通常使用“get”作為其前綴，例如：
}
public ListgetUserIds(){
}
public User getOne(){
}
3.2 表述查詢
}
public ListfindAll(){
}
public ListqueryOrders(){
}
3.3 表述條件
如果一個(gè)方法需要一些條件參數(shù)，則可以使用“by”/“with”等字符作為方法名中條件的連接符，例如：
}
public ListgetUserIdsWithState(boolean state){
}
public ListfindAllByUsernameOrderByIdDesc(String username){
}
3.4 表述設(shè)置
}
public User insert(User user){
}
public void update(User user){
}
public void clearAll(){
} 3.5 其他規(guī)范
}
public int size(){
}
public boolean isOpen(){
}
public boolean isNotEmpty(){
}
public boolean hasLength(){
}
public SetmapToSet(Map map){
}
public UserDto convertTo(User user){
}
public String toString(Object obj){
}
4. 變量命名規(guī)范
private String mobileNumber;
private Long id;
private String username;
private Long orderId;
private Long orderItemId;
5. 常量命名規(guī)范
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. 枚舉命名規(guī)范
枚舉(Enum)類是一種特殊的類，其命名規(guī)范遵循普通類的命名約束條件，首字母大寫，采用駝峰命名法；枚舉類中定義的值的名稱遵循常量的命名規(guī)范，且枚舉值的名稱需要與類名有一定的關(guān)聯(lián)性，下面是枚舉的一些示例：
RED,YELLOW,BLUE,GREEN,WHITE;
}
public enum PhysicalSize{
TINY,SMALL,MEDIUM,LARGE,HUGE,GIGANTIC;
}
下面是Oracle Java標(biāo)準(zhǔn)庫(kù)中的一個(gè)示例：
TYPE,
FIELD,
METHOD,
PARAMETER,
CONSTRUCTOR,
LOCAL_VARIABLE,
ANNOTATION_TYPE,
PACKAGE,
TYPE_PARAMETER,
TYPE_USE;
}
7. 其他命名規(guī)范
7.1 數(shù)組
在定義數(shù)組時(shí)，為了便于閱讀，盡量保持以下的書寫規(guī)范：
int[] idArray ={1,2,3,4,5};
String[] nameArray = {"First","Yellow","Big"}
public ListgetNameById(Integer[] ids){
}
public ListgetNameById(Integer...ids){
}
7.2 表述復(fù)數(shù)或者集合
如果一個(gè)變量用于描述多個(gè)數(shù)據(jù)時(shí)，盡量使用單詞的復(fù)數(shù)形式進(jìn)行書寫，例如：
int[] values;
Listitems;
另外，如果表述的是一個(gè)Map數(shù)據(jù)，則應(yīng)使用“map”作為其后綴，例如：
Map
7.3 泛型類
在書寫泛型類時(shí)，通常做以下的約定：
- E表示Element，通常用在集合中；
- ID用于表示對(duì)象的唯一標(biāo)識(shí)符類型
- T表示Type(類型)，通常指代類；
- K表示Key(鍵),通常用于Map中；
- V表示Value(值),通常用于Map中，與K結(jié)對(duì)出現(xiàn)；
- N表示Number,通常用于表示數(shù)值類型；
- ？表示不確定的Java類型；
- X用于表示異常；
- U,S表示任意的類型。
}
public class HashMap
}
public class ThreadLocal{
}
public interface Functor
T val() throws X;
}
public class Container
private K key;
private V value;
Container(K key,V value){
this.key = key;
this.value = value;
}
}
public interface BaseRepository
T findById(ID id);
void update(T t);
ListfindByIds(ID...ids);
}
public staticListmethodName(Classclz){
ListdataList = getByClz(clz);
return dataList;
}
7.4 接口實(shí)現(xiàn)類
}
public class OrderServiceImpl implements OrderService{
}
不建議的寫法：
}
public class OrderService implements IOrderService{
}
7.5 測(cè)試類和測(cè)試方法
在項(xiàng)目中，測(cè)試類采用被測(cè)試業(yè)務(wù)模塊名/被測(cè)試接口/被測(cè)試類 “Test”的方法進(jìn)行書寫，測(cè)試類中的測(cè)試函數(shù)采用“test” 用例操作_狀態(tài)的組合方式進(jìn)行書寫，例如：
public void testFindByUsernameAndPassword(){
}
public void testUsernameExist_notExist(){
}
public void testDeleteById_isOk(){
}
}
8 擴(kuò)展：速記 Java 開發(fā)中的各種O
| 名稱 | 使用范圍 | 解釋說(shuō)明 |
|---|---|---|
| BO | 用于Service,Manager,Business等業(yè)務(wù)相關(guān)類的命名 | Business Object業(yè)務(wù)處理對(duì)象，主要作用是把業(yè)務(wù)邏輯封裝成一個(gè)對(duì)象。 |
| DTO | 經(jīng)過(guò)加工后的PO對(duì)象，其內(nèi)部屬性可能增加或減少 | Data Transfer Object數(shù)據(jù)傳輸對(duì)象，主要用于遠(yuǎn)程調(diào)用等需要大量傳輸數(shù)據(jù)的地方，例如，可以將一個(gè)或多個(gè)PO類的部分或全部屬性封裝為DTO進(jìn)行傳輸 |
| DAO | 用于對(duì)數(shù)據(jù)庫(kù)進(jìn)行讀寫操作的類進(jìn)行命名 | Data Access Object數(shù)據(jù)訪問(wèn)對(duì)象，主要用來(lái)封裝對(duì)數(shù)據(jù)庫(kù)的訪問(wèn)，通過(guò)DAO可以將POJO持久化為PO，也可以利用PO封裝出VO和DTO |
| PO | Bean,Entity等類的命名 | Persistant Object持久化對(duì)象，數(shù)據(jù)庫(kù)表中的數(shù)據(jù)在Java對(duì)象中的映射狀態(tài)，可以簡(jiǎn)單的理解為一個(gè)PO對(duì)象即為數(shù)據(jù)庫(kù)表中的一條記錄 |
| POJO | POJO是DO/DTO/BO/VO的統(tǒng)稱 | Plain Ordinary Java Object 簡(jiǎn)單Java對(duì)象，它是一個(gè)簡(jiǎn)單的普通Java對(duì)象，禁止將類命名為XxxxPOJO |
| VO | 通常是視圖控制層和模板引擎之間傳遞的數(shù)據(jù)對(duì)象 | Value Object 值對(duì)象，主要用于視圖層，視圖控制器將視圖層所需的屬性封裝成一個(gè)對(duì)象，然后用一個(gè)VO對(duì)象在視圖控制器和視圖之間進(jìn)行數(shù)據(jù)傳輸。 |
| AO | 應(yīng)用層對(duì)象 | Application Object，在Web層與Service層之間抽象的復(fù)用對(duì)象模型，很少用。 |
下載文檔
