Java實現優雅的參數校驗方法詳解

Posted on by

一、引子

要對方法的參數進行校驗，最簡單暴力的寫法是這個樣子：

    public static void utilA(String a,BigDecimal b){
        if (StringUtils.isEmpty(a)){
            System.out.println("a不可為空");
            return;
        }
        if (b == null){
            System.out.println("b不可為空");
            return;
        }
        if (b.compareTo(BigDecimal.ZERO) != 1){
            System.out.println("b的取值范圍不正確");
            return;
        }
        System.out.println("do something");
    }

這樣做從功能角度來說一點問題也沒有。

但是從代碼的長期維護性上來說，代碼復用率低，校驗規則一旦多起來很難維護，而且怎麼看怎麼顯得笨拙，對於有一點追求的工程師來說，這麼一大坨還是挺難接受的。

雖然有一些諸如 Preconditions(com.google) 的解決方案，但很難適應所有的場景，用起來也沒到非常得心應有的地步。

二、如何優雅地校驗參數

Spring官方推薦的，語義清晰的優雅的方法級別校驗（入參校驗、返回值校驗）

2.1 官方指導意見

Spring官方在SpringBoot文檔中，關於參數校驗（Validation）給出的解決方案是這樣的：

@Service
@Validated
public class MyBean {
 
    public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code,
            Author author) {
        ...
    }
 
}

Spring Boot 官網文檔 《37. Validation》

也就是說，使用 JSR-303 規范，直接利用註解進行參數校驗。

（JSR-303 是 JAVA EE 6 中的一項子規范，叫做 Bean Validation，官方參考實現是 Hibernate Validator）

2.2 註解用法說明

2.2.1.註解簡介

對於簡單類型參數（非Bean），直接在參數前，使用註解添加約束規則。註解如下所示：

@AssertTrue / @AssertFalse 

驗證適用字段：boolean

註解說明：驗證值是否為true / false

@DecimalMax / @DecimalMin

驗證適用字段：BigDecimal,BigInteger,String,byte,short,int,long

註解說明：驗證值是否小於或者等於指定的小數值，要註意小數存在精度問題

@Digits

驗證適用字段：BigDecimal,BigInteger,String,byte,short,int,long

註解說明：驗證值的數字構成是否合法

屬性說明：integer:指定整數部分的數字的位數。fraction: 指定小數部分的數字的位數。

@Future / @Past

驗證適用字段：Date,Calendar

註解說明：驗證值是否在當前時間之後 / 之前

屬性說明：公共

@Max / @Min

驗證適用字段：BigDecimal,BigInteger,String,byte,short,int,long

註解說明：驗證值是否小於或者等於指定的整數值

屬性說明：公共

註意事項：建議使用在Stirng,Integer類型，不建議使用在int類型上，因為表單提交的值為“”時無法轉換為int

@NotNull / @Null

驗證適用字段：引用數據類型

註解說明：驗證值是否為非空 / 空

屬性說明：公共

@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大於0,隻對字符串,且會去掉前後空格. 

@NotEmpty 檢查約束元素是否為Null或者是EMPTY.

@NotBlank 與 @NotEmpty 的區別：空格（" "）對於 NotEmpty 是合法的，而 NotBlank 會拋出校驗異常

@Pattern

驗證適用字段：String

註解說明：驗證值是否配備正則表達式

屬性說明：regexp:正則表達式flags: 指定Pattern.Flag 的數組，表示正則表達式的相關選項。

@Size

驗證適用字段：String,Collection,Map,數組

註解說明：驗證值是否滿足長度要求

屬性說明：max:指定最大長度，min:指定最小長度。

@Length(min=, max=)：專門應用於String類型

@Valid

驗證適用字段：遞歸的對關聯對象進行校驗

註解說明：如果關聯對象是個集合或者數組,那麼對其中的元素進行遞歸校驗,如果是一個map,則對其中的值部分進行校驗(是否進行遞歸驗證)

屬性說明：無

@Range(min=, max=) 被指定的元素必須在合適的范圍內 

@CreditCardNumber信用卡驗證 

@Email 驗證是否是郵件地址，如果為null,不進行驗證，算通過驗證。 

@URL(protocol=,host=, port=,regexp=, flags=)

2.2.2使用

1.引入依賴

 <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.1.5.Final</version>
        </dependency>

2.在對應字段上添加註解,方法被調用時，如果傳入的實際參數與約束規則不符，會直接拋出 ConstraintViolationException ，表明參數校驗失敗。

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
 
/**
 * @Author: wangxia
 * @Date: 2021/10/20 16:30
 */
public class TestPerson {
 
    @NotEmpty(message = "用戶名不能為空")
    private String username;
 
    @Min(value = 0,message = "年齡不能小於0歲")
    @Max(value =150,message = "年齡不能大於150歲")
    private int age;
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public int getAge() {
        return age;
    }
 
    public void setAge(int age) {
        this.age = age;
    }
}

3..對於Bean類型的參數，在Bean內部的各個字段上面追加約束註解，然後在方法的參數前面添加 @Validated或@Valid註解即可。示例：

@RequestMapping("/")
@RestController
public class TestValidatController {
 
    @PostMapping("/testValid")
    public String testValid(@Validated @RequestBody TestPerson testPerson){
        return "測試成功";
    }
 
}

4.優雅捕獲異常，這一步可以省略，但是請求時會直接返回,400的異常提示，不太優雅。

@ControllerAdvice
@ResponseBody 
public class MethodArgumentNotValidHandel {
 
 
    @ExceptionHandler(value=MethodArgumentNotValidException.class)
    public JSONObject MethodArgumentNotValidHandler(HttpServletRequest request,
                                                    MethodArgumentNotValidException exception) throws Exception
    {
        JSONObject result=new JSONObject();
        result.put("code","fail");
        JSONObject errorMsg=new JSONObject();
        for (FieldError error : exception.getBindingResult().getFieldErrors()) {
            errorMsg.put(error.getField(),error.getDefaultMessage());
        }
        result.put("msg",errorMsg);
        return result;
    }
 
}

添加優雅捕獲的異常提示:

未添加優雅捕獲的異常提示:

到此這篇關於Java實現優雅的參數校驗方法詳解的文章就介紹到這瞭,更多相關Java參數校驗內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：