最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

SpringBoot實現(xiàn)接口的各種參數(shù)校驗的示例

 更新時間：2022年01月26日 15:08:12   作者：ZNineSun  
本文主要介紹了SpringBoot實現(xiàn)接口的各種參數(shù)校驗的示例，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

在我們進行接口開發(fā)時，在對參數(shù)的接收時，我們需要冗余復(fù)雜的校驗規(guī)則 來進行接口參數(shù)的校驗，接下來推薦一個好用的校驗工具Spring Validation。

Java API規(guī)范 (JSR303) 定義了Bean校驗的標(biāo)準(zhǔn)validation-api，但沒有提供實現(xiàn)。hibernate validation是對這個規(guī)范的實現(xiàn)，并增加了校驗注解如@Email、@Length等。

Spring Validation是對hibernate validation的二次封裝，用于支持spring mvc參數(shù)自動校驗。接下來，我們以spring-boot項目為例，介紹Spring Validation的使用。

1.添加依賴

<!--新增validator-->
        <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
     <!--添加lombok-->
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.接口參數(shù)校驗

對于web服務(wù)來說，為防止非法參數(shù)對業(yè)務(wù)造成影響，在Controller層一定要做參數(shù)校驗的！大部分情況下，請求參數(shù)分為如下兩種形式：

  • POST、PUT請求，使用requestBody傳遞參數(shù)；
  • GET請求，使用requestParam/PathVariable傳遞參數(shù)。

下面我們簡單介紹下requestBody和requestParam/PathVariable的參數(shù)校驗實戰(zhàn)！

2.1 requestBody參數(shù)校驗

POST、PUT請求一般會使用requestBody傳遞參數(shù)，這種情況下，后端使用DTO對象進行接收。只要給 DTO 對象加上@Validated注解就能實現(xiàn)自動參數(shù)校驗。

比如，有一個保存User的接口，要求userName長度是2-10，account和password字段長度是6-20。如果校驗失敗，會拋出MethodArgumentNotValidException異常，Spring默認(rèn)會將其轉(zhuǎn)為400（Bad Request）請求。

DTO 表示數(shù)據(jù)傳輸對象（Data Transfer Object），用于服務(wù)器和客戶端之間交互傳輸使用的。在 spring-web 項目中可以表示用于接收請求參數(shù)的Bean對象。

我們只需要兩步就可以實現(xiàn)剛剛對user對象參數(shù)的需求

1.在實體類上聲明約束注解

import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotNull;

@Data
public class UserDTO {

    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @NotNull
    @Length(min = 6, max = 20)
    private String account;

    @NotNull
    @Length(min = 6, max = 20)
    private String password;
}

2.在接口方法參數(shù)上聲明校驗注解

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {

    @PostMapping("/save")
    public Map<String, Object> saveUser(@RequestBody @Validated UserDTO userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        return result;
    }
}

接下來我們進行一下測試

在這里插入圖片描述

我們可以看到密碼位數(shù)不對時會轉(zhuǎn)為400請求參數(shù)不對的錯誤

2.2 requestParam/PathVariable參數(shù)校驗

GET請求一般會使用requestParam/PathVariable傳參。
如果參數(shù)比較多 (比如超過 6 個)，還是推薦使用DTO對象接收。否則，推薦將一個個參數(shù)平鋪到方法入?yún)⒅?。在這種情況下，必須在Controller類上標(biāo)注@Validated注解，并在入?yún)⑸下暶骷s束注解 (如@Min等)。
如果校驗失敗，會拋出ConstraintViolationException異常。代碼示例如下：

package com.example.code.controller;

import com.example.code.po.UserDTO;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @GetMapping("{userId}")
    public Map<String, Object> detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
        Map<String, Object> result = new HashMap<>();
        UserDTO userDTO = new UserDTO();
        userDTO.setUserId(userId);
        userDTO.setAccount("11111111111111111");
        userDTO.setUserName("xixi");
        userDTO.setAccount("11111111111111111");
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }

    @GetMapping("getByAccount")
    public Map<String, Object> getByAccount(@Length(min = 6, max = 20) @NotNull String account) {
        Map<String, Object> result = new HashMap<>();
        UserDTO userDTO = new UserDTO();
        userDTO.setUserId(10000000000000003L);
        userDTO.setAccount(account);
        userDTO.setUserName("xixi");
        userDTO.setAccount(account);
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

在這里插入圖片描述

3.統(tǒng)一異常處理

在我們剛剛的測試中會發(fā)現(xiàn)如果校驗失敗，會拋出MethodArgumentNotValidException或者ConstraintViolationException異常。
但是在實際項目開發(fā)中，通常會用統(tǒng)一異常處理來返回一個更友好的提示。比如我們系統(tǒng)要求無論發(fā)送什么異常，http的狀態(tài)碼必須返回200，由業(yè)務(wù)碼去區(qū)分系統(tǒng)的異常情況。

import org.springframework.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolationException;
import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class CommonExceptionHandler {

    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Map<String, Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        Map<String, Object> result = new HashMap<>();
        BindingResult bindingResult = ex.getBindingResult();
        StringBuilder sb = new StringBuilder("校驗失敗:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        result.put("code", 500);
        result.put("msg", msg);
        return result;
    }

    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public Map<String, Object> handleConstraintViolationException(ConstraintViolationException ex) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 500);
        result.put("msg", ex.getMessage());
        return result;
    }
}

在這里插入圖片描述

4.進階使用

4.1 分組校驗

在實際項目中，可能多個方法需要使用同一個DTO類來接收參數(shù)，而不同方法的校驗規(guī)則很可能是不一樣的。
這個時候，簡單地在DTO類的字段上加約束注解無法解決這個問題。因此，spring-validation支持了分組校驗的功能，專門用來解決這類問題。
還是繼續(xù)使用上面的例子，比如保存User的時候，UserId是可空的，但是更新User的時候，UserId的值必須>=10000000000000000L；其它字段的校驗規(guī)則在兩種情況下一樣。這個時候使用分組校驗的代碼示例如下：

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@Data
public class UserDTO_Groups {
    @Min(value = 10000000000000000L, groups = Update.class)
    private Long userId;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 2, max = 10, groups = {Save.class, Update.class})
    private String userName;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String account;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String password;


    public interface Save {
    }

    public interface Update {
    }
}

在@Validated注解上指定校驗分組

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/save_group")
    public Map<String, Object> saveUser_Group(@RequestBody @Validated(UserDTO_Groups.Save.class) UserDTO_Groups userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }

    @PostMapping("/update_group")
    public Map<String, Object> updateUser(@RequestBody @Validated(UserDTO_Groups.Update.class) UserDTO_Groups userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

4.2 嵌套校驗

在實際開發(fā)中，我們保存User信息的時候同時還帶有Job信息。需要注意的是，此時DTO類的對應(yīng)字段必須標(biāo)記@Valid注解。

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.Valid;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

/**
 * 嵌套校驗
 */
@Data
public class UserDTO_Nest {
    @Min(value = 10000000000000000L, groups = Update.class)
    private Long userId;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 2, max = 10, groups = {Save.class, Update.class})
    private String userName;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String account;

    @NotNull(groups = {Save.class, Update.class})
    @Length(min = 6, max = 20, groups = {Save.class, Update.class})
    private String password;

    @NotNull(groups = {Save.class, Update.class})
    @Valid
    private Job job;

    public interface Save {
    }

    public interface Update {
    }
}

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@Data
public class Job {

    @Min(value = 1, groups = UserDTO_Nest.Update.class)
    private Long jobId;

    @NotNull(groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    @Length(min = 2, max = 10, groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    private String jobName;

    @NotNull(groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    @Length(min = 2, max = 10, groups = {UserDTO_Nest.Save.class, UserDTO_Nest.Update.class})
    private String position;

}


package com.example.code.controller;

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import com.example.code.po.UserDTO_Nest;
import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {

    @PostMapping("/save1")
    public Map<String, Object> save1(@RequestBody @Validated(UserDTO_Nest.Save.class) UserDTO_Nest userList) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userList);
        return result;
    }
}

因為我們在代碼中設(shè)置了嵌套校驗要求job不能為空，所以:

在這里插入圖片描述

我們在job類匯總設(shè)置了position最小長度為2，所以：

在這里插入圖片描述

嵌套校驗可以結(jié)合分組校驗一起使用。
嵌套集合校驗會對集合里面的每一項都進行校驗，例如List< Job>字段會對這個list里面的每一個Job對象都進行校驗。

4.3 集合校驗

如果請求體直接傳遞了json數(shù)組給后臺，并希望對數(shù)組中的每一項都進行參數(shù)校驗。
此時，如果我們直接使用java.util.Collection下的list或者set來接收數(shù)據(jù)，參數(shù)校驗并不會生效！我們可以使用自定義list集合來接收參數(shù)：

1.包裝List類型，并聲明@Valid注解

package com.example.code.validate;

import lombok.experimental.Delegate;

import javax.validation.Valid;
import java.util.ArrayList;
import java.util.List;

public class ValidationList<E> implements List<E> {

    @Delegate
    @Valid
    public List<E> list = new ArrayList<>();

    @Override
    public String toString() {
        return list.toString();
    }
}

注意：@Delegate注解受lombok版本限制，1.18.6以上版本可支持。如果校驗不通過，會拋出NotReadablePropertyException，同樣可以使用統(tǒng)一異常進行處理。
接下來我們開發(fā)接口，使其可以批量保存

import com.example.code.po.UserDTO;
import com.example.code.po.UserDTO_Groups;
import com.example.code.po.UserDTO_Nest;
import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/saveList")
    public Map<String, Object> saveList(@RequestBody @Validated(UserDTO_Nest.Save.class) ValidationList<UserDTO_Nest> userList) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userList);
        return result;
    }
}

4.4 自定義校驗

在我們實際的業(yè)務(wù)開發(fā)中，我們的需求總是比框架提供的這些簡單校驗要復(fù)雜的多，我們可以通過自定義校驗來滿足我們的需求。

假設(shè)我們自定義加密id（由數(shù)字或者a-f的字母組成，32-256長度）校驗，主要分為兩步：

1.自定義約束注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EncryptIdValidator.class})
public @interface EncryptId {

    String message() default "加密id格式錯誤";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

2.實現(xiàn)ConstraintValidator接口編寫約束校驗器

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> {

    private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$");

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {

        if (value != null) {
            Matcher matcher = PATTERN.matcher(value);
            return matcher.find();
        }
        return true;
    }
}

3.在實體類上的字段中進行使用

import com.example.code.validate.EncryptId;
import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.NotNull;

@Data
public class UserDTO {

    private Long userId;

    @NotNull
    @Length(min = 2, max = 10)
    private String userName;

    @NotNull
    @Length(min = 6, max = 20)
    private String account;

    @NotNull
    @EncryptId
    private String password;
}

4.測試

import com.example.code.validate.ValidationList;
import org.hibernate.validator.constraints.Length;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.HashMap;
import java.util.Map;

@RestController
public class UserController {
    @PostMapping("/save2")
    public Map<String, Object> save2(@RequestBody @Validated UserDTO userDTO) {
        Map<String, Object> result = new HashMap<>();
        result.put("code", 20000);
        result.put("data", userDTO);
        return result;
    }
}

結(jié)果如下：

在這里插入圖片描述

我們可以看到自定義的校驗已經(jīng)應(yīng)用成功了

5.快速失敗 (Fail Fast)

Spring Validation默認(rèn)會校驗完所有字段，然后才拋出異常。此時如果需要校驗字段過多則會影響前后端交互的速度，我們可以通過一些簡單的配置，開啟Fali Fast模式，一旦校驗失敗就立即返回。

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

@Component
public class ValidatorConfig {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()

                .failFast(true)
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }
}

6.@Valid和@Validated區(qū)別

區(qū)別@Valid@Validated
提供者JSR-303 規(guī)范Spring
是否支持分組不支持支持
標(biāo)注位置METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USETYPE, METHOD, PARAMETER
嵌套校驗支持不支持

7.實現(xiàn)原理

7.1 requestBody參數(shù)校驗實現(xiàn)原理

在spring-mvc中，RequestResponseBodyMethodProcessor是用于解析@RequestBody標(biāo)注的參數(shù)以及處理@ResponseBody標(biāo)注方法的返回值的。顯然，執(zhí)行參數(shù)校驗的邏輯肯定就在解析參數(shù)的方法resolveArgument()中：

于是我們看一下RequestResponseBodyMethodProcessor的resolveArgument()方法

在這里插入圖片描述

可以看到調(diào)用了validateIfApplicable()進行參數(shù)校驗，我們在看看validateIfApplicable()具體是如何校驗的

在這里插入圖片描述

我們可以看到真正的校驗，無論是@Validated、@Valid都是通過binder.validate(validationHints);實現(xiàn)，所以我們在接著往下看看WebDataBinder.validate()實現(xiàn)

在這里插入圖片描述

最終發(fā)現(xiàn)底層最終還是調(diào)用了Hibernate Validator進行真正的校驗處理

7.2 方法級別的參數(shù)校驗實現(xiàn)原理

上面提到的將參數(shù)一個個平鋪到方法參數(shù)中，然后在每個參數(shù)前面聲明約束注解的校驗方式，就是方法級別的參數(shù)校驗,如下圖所示：

在這里插入圖片描述

實際上，這種方式可用于任何Spring Bean的方法上，比如Controller/Service等。其底層實現(xiàn)原理就是AOP，具體來說是通過MethodValidationPostProcessor動態(tài)注冊AOP切面，然后使用MethodValidationInterceptor對切點方法織入增強。

我們看一下MethodValidationPostProcessor中源碼的實現(xiàn)

在這里插入圖片描述

最終調(diào)用的是MethodValidationInterceptor()，那么我們進入到該類看一下

在這里插入圖片描述

實際上，不管是requestBody參數(shù)校驗還是方法級別的校驗，最終都是調(diào)用Hibernate Validator執(zhí)行校驗，Spring Validation只是做了一層封裝。
至此對于接口參數(shù)的校驗就到此結(jié)束了，有問題歡迎大家來下方討論，謝謝。

到此這篇關(guān)于SpringBoot實現(xiàn)接口的各種參數(shù)校驗的示例的文章就介紹到這了,更多相關(guān)SpringBoot 接口參數(shù)校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

相關(guān)文章

最新評論

星座| 刚察县| 鹰潭市| 永宁县| 通榆县| 西吉县| 姚安县| 肥乡县| 五常市| 和硕县| 南和县| 贡山| 兴安盟| 土默特左旗| 理塘县| 贵州省| 阿坝县| 闽清县| 昔阳县| 双牌县| 崇左市| 泌阳县| 郎溪县| 正镶白旗| 临夏县| 特克斯县| 肇庆市| 鹤山市| 高清| 安多县| 余江县| 香格里拉县| 长宁县| 翼城县| 田东县| 义乌市| 泰安市| 贵南县| 扎兰屯市| 英德市| 曲靖市|