測試開發專題:如何在spring-boot中進行參數校驗

  • 2020 年 5 月 14 日
  • 筆記

上文我們討論了spring-boot如何去獲取前端傳遞過來的參數，那傳遞過來總不能直接使用，需要對這些參數進行校驗，符合程序的要求才會進行下一步的處理，所以本篇文章我們主要討論spring-boot中如何進行參數校驗。

lombok使用介紹

在介紹參數校驗之前，先來了解一下lombok的使用，因為在接下來的實例中或有不少的對象創建，但是又不想寫那麼多的getter和setter，所以先介紹一下這個很強大的工具的使用。

Lombok 是一個可以通過簡單的註解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java代碼的工具，通過使用對應的註解，可以在編譯源碼的時候生成對應的方法。

添加maven依賴

在pom文件中添加如下內容：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>

基礎註解

@Getter給類增加get方法

@Setter給類增加set方法

@Builder給類增加構建者模式

@AllArgsConstructor給類增加全參構造方法

@NoArgsConstructor給類增加無參數構造方法

@RequiredArgsConstructor按照必填屬性增加構造方法

@NonNull變量值不能為空

這裡只簡單列一下常用註解的含義，具體的使用方式在參數校驗的實例中體現。

實戰

上篇文章中我們用BannerCreateDto這個對象了來接收前端傳遞的參數，那時是手動添加的get和set方法，這裡我們用lombok註解來簡化掉之前的樣板代碼：

@Setter
@Getter
public class BannerCreateDto {
    private String name;
    private Integer pos;
}

接口的定義還是和之前一樣。不同做任何修改：

@PostMapping(value = "/create")
public Map<String, Object> createBanner(@RequestBody BannerCreateDto dto){
    Map<String, Object> res = new HashMap<>();
    res.put("id", 10000);
    res.put("name", dto.getName());
    res.put("pos", dto.getPos());
    return res;
}

重新運行程序，訪問接口

image-20200513215504732還是和之前一樣，能夠請求成功並正常的返回數據。

一般情況下，我們會針對返回的數據，來單獨定義對象來進行描述，這裡我們也定義一個

@Builder
@Getter
public class BannerResponseDto {
    private int id;
    private String name;
    private Integer pos;
}

這裡用到了@Builder、@Getter，在接口中構造對象並返回：

@PostMapping(value = "/create")
public BannerResponseDto createBanner(@RequestBody BannerCreateDto dto){

    return BannerResponseDto.builder()
            .id(500)
            .name(dto.getName())
            .pos(dto.getPos())
            .build();
}

可以看到lombok的@Builder註解，能夠讓類通過構建者模式去創建對象，省去了大量的set代碼，而且可讀性也很好。

訪問接口，看看數據返回的時候正常：

image-20200513220111657

與之前是一樣的，能夠正常返回數據，那接下來我們就正式看一下，spring-boot如何進行參數校驗了。

參數校驗

參數校驗就是說對前端傳過來的數據進行合理性校驗，看他能否滿足我們的業務規則，那這些對參數進行校驗的代碼是該放在那裡呢，是在Controller里還是說單獨存放，又獲取採用其他什麼方式呢？

參數校驗該怎麼做

首先要明確的一點，在Controller，不應該有大量邏輯判斷的代碼，為什麼呢，我們可想想當參數較多的時候，對每個參數進行合理性校驗的話，那代碼量該有多少，那就會嚴重污染Controller，導致維護起來是很艱難的，所以應該要有一個合理的機制能把校驗的代碼抽離出來，從而保證Controller的簡潔性。

在java的世界裏有這麼個概念叫做 JSR，是Java Specification Requests的首字母縮寫，是編程語言Java規範請求或者說是Java語言的說明書，既然是說明書那就一定有各個版本，在JSR-303版本中，提出了Bean Validation的驗證規範，目前主要有兩個兩個框架實現了Bean Validation規範，一個事自帶的javax.validation.api和hibernate-validator框架，而hibernate-validator框架應用的更加廣泛一點。

那我們就用這種Bean Validation這種驗證框架進行參數的驗證

實戰

@RestController
@Validated
public class BannerController {


    @GetMapping("/v3/banner")
    public Map<String, Object> getBannerDetailV2(@RequestParam Integer id, @RequestParam @Max(10) Integer pos){
        Map<String, Object> body = new HashMap<>();
        body.put("id", id);
        body.put("pos", pos);
        return body;
    }
}

上面代碼中，@Max(10)註解來驗證輸入參數的pos，限制其輸入參數最大值為10，運行程序我們來測試一下：

image-20200513230808654

訪問接口//localhost:8081/v3/banner?id=12&pos=33後，看到我們控制台的輸出提示輸入不能超過10，這裡的這個message不是我寫的哈，這是java國際化後的效果能夠根據你所在地區決定顯示什麼語言。

當然這裡我們也可以自定義錯誤的message：

@GetMapping("/v3/banner")
public Map<String, Object> getBannerDetailV2(@RequestParam Integer id,
                                             @RequestParam @Max(value = 10, message = "超過10了，趕緊看看哇") Integer pos){
    Map<String, Object> body = new HashMap<>();
    body.put("id", id);
    body.put("pos", pos);
    return body;
}

還是上面的請求路徑，看看控制台輸出：

image-20200513231126756

可以看到控制台輸出了我們自定義的內容。這裡有一點要注意，要想使得校驗生效，比如在Controller上方打上@Validated註解，至於為什麼我們後面分解。

上面的驗證都是比較基礎的數據類型，但是如果現在要有驗證更加複雜一點的java對象呢，又該如何操作，那接下來我們再看看這部分的內容。

java對象進行驗證

單個對象

還是用上面的BannerResponseDto來進行演示

import org.hibernate.validator.constraints.Length;
@Setter
@Getter
public class BannerCreateDto {
    @Length(min = 2, max = 4, message = "banner名稱必須是2-10個字符")
    private String name;
    private Integer pos;
}

對於這些基礎類型的成員變量仍然使用這些基礎註解進行校驗定義，上面我們使用了 @Length註解來定義banner名稱的字符長度範圍，並定義發生錯誤時提示的message,這裡還需要在Controller里額外的處理一下：

@PostMapping("/v3/banner/create")
public BannerResponseDto createBanner(@RequestBody @Validated BannerCreateDto dto){

    return BannerResponseDto.builder()
            .id(500)
            .name(dto.getName())
            .pos(dto.getPos())
            .build();
}

@Validated BannerCreateDto這裡必須要加@Validated註解，否則無法觸發校驗機制。

嵌套

如果某個類的成員變量也是一個自定義對象，那校驗該是什麼樣的呢,下面我們來看一下。

先定義一個新的對象，用來接收banner到的素材信息

@Getter
@Setter
public class MaterialDto {
    @Length(min = 2, max = 5, message = "素材的名稱長度範圍必須在2-5之內")
    private String name;
}

然後banner對象增加一個成員變量

@Setter
@Getter
public class BannerCreateDto {
    @Length(min = 2, max = 4, message = "banner名稱必須是2-10個字符")
    private String name;
    private Integer pos;

    @Valid
    private MaterialDto materialDto;
}

這裡有一點，要想使得這種級聯的關係能夠觸發校驗機制，必須 @Valid註解進行標記，我們來請求一下url看看效果

image-20200513234439584

可以看到校驗沒通過，再看看控制台輸出內容：

image-20200513234506001

輸出了我們定義的錯誤信息。

總結

本篇文章主要介紹了裏面lombok的使用，以及校驗規範介紹和校驗框架基本註解的使用，還有自定義對象校驗，下篇文章我們將通過自定義註解來實現更加個性化的校驗規則，敬請期待。

歡迎大家去 我的博客 瞅瞅，裏面有更多關於測試實戰的內容哦！！

VirMach 便宜 VPS

QNews

QNews