spring boot中進行參數(shù)校驗的方法

這篇文章主要講解了spring boot中進行參數(shù)校驗的方法，內(nèi)容清晰明了，對此有興趣的小伙伴可以學習一下，相信大家閱讀完之后會有幫助。

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

lombok使用介紹

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

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

添加maven依賴

在pom文件中添加如下內(nèi)容：

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

基礎(chǔ)注解

@Getter給類增加get方法

@Setter給類增加set方法

@Builder給類增加構(gòu)建者模式

@AllArgsConstructor給類增加全參構(gòu)造方法

@NoArgsConstructor給類增加無參數(shù)構(gòu)造方法

@RequiredArgsConstructor按照必填屬性增加構(gòu)造方法

@NonNull變量值不能為空

這里只簡單列一下常用注解的含義，具體的使用方式在參數(shù)校驗的實例中體現(xiàn)。

實戰(zhàn)

上篇文章中我們用BannerCreateDto這個對象了來接收前端傳遞的參數(shù)，那時是手動添加的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;
}

重新運行程序，訪問接口

還是和之前一樣，能夠請求成功并正常的返回數(shù)據(jù)。

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

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

這里用到了@Builder、@Getter，在接口中構(gòu)造對象并返回：

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

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

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

訪問接口，看看數(shù)據(jù)返回的時候正常：

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

參數(shù)校驗

參數(shù)校驗就是說對前端傳過來的數(shù)據(jù)進行合理性校驗，看他能否滿足我們的業(yè)務(wù)規(guī)則，那這些對參數(shù)進行校驗的代碼是該放在那里呢，是在Controller里還是說單獨存放，又獲取采用其他什么方式呢？

參數(shù)校驗該怎么做

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

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

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

實戰(zhàn)

@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)注解來驗證輸入?yún)?shù)的pos，限制其輸入?yún)?shù)最大值為10，運行程序我們來測試一下：

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

當然這里我們也可以自定義錯誤的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;
}

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

可以看到控制臺輸出了我們自定義的內(nèi)容。這里有一點要注意，要想使得校驗生效，比如在Controller上方打上@Validated注解，至于為什么我們后面分解。

上面的驗證都是比較基礎(chǔ)的數(shù)據(jù)類型，但是如果現(xiàn)在要有驗證更加復(fù)雜一點的java對象呢，又該如何操作，那接下來我們再看看這部分的內(nèi)容。

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;
}

對于這些基礎(chǔ)類型的成員變量仍然使用這些基礎(chǔ)注解進行校驗定義，上面我們使用了 @Length注解來定義banner名稱的字符長度范圍，并定義發(fā)生錯誤時提示的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注解，否則無法觸發(fā)校驗機制。

嵌套

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

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

@Getter
@Setter
public class MaterialDto {
 @Length(min = 2, max = 5, message = "素材的名稱長度范圍必須在2-5之內(nèi)")
 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;
}

這里有一點，要想使得這種級聯(lián)的關(guān)系能夠觸發(fā)校驗機制，必須 @Valid注解進行標記，我們來請求一下url看看效果

可以看到校驗沒通過，再看看控制臺輸出內(nèi)容：

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

看完上述內(nèi)容，是不是對spring boot中進行參數(shù)校驗的方法有進一步的了解，如果還想學習更多內(nèi)容，歡迎關(guān)注億速云行業(yè)資訊頻道。