SpringBoot 如何進行參數校驗

来源:https://www.cnblogs.com/alanlin/archive/2022/04/27/16198128.html
-Advertisement-
Play Games

為什麼需要參數校驗 在日常的介面開發中，為了防止非法參數對業務造成影響，經常需要對介面的參數進行校驗，例如登錄的時候需要校驗用戶名和密碼是否為空，添加用戶的時候校驗用戶郵箱地址、手機號碼格式是否正確。 靠代碼對介面參數一個個校驗的話就太繁瑣了，代碼可讀性極差。 Validator框架就是為瞭解決開發 ...


為什麼需要參數校驗

在日常的介面開發中，為了防止非法參數對業務造成影響，經常需要對介面的參數進行校驗，例如登錄的時候需要校驗用戶名和密碼是否為空，添加用戶的時候校驗用戶郵箱地址、手機號碼格式是否正確。 靠代碼對介面參數一個個校驗的話就太繁瑣了，代碼可讀性極差。
Validator框架就是為瞭解決開發人員在開發的時候少寫代碼，提升開發效率；Validator專門用來進行介面參數校驗，例如常見的必填校驗，email格式校驗，用戶名必須位於6到12之間等等。
接下來我們看看在SpringbBoot中如何集成參數校驗框架。

SpringBoot中集成參數校驗

引入依賴

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

定義參數實體類

package com.didiplus.modules.sys.domain;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/25
 * Desc: 字典類型領域模型
 */

@Data
@ApiModel(value = "字典類型")
public class SysDictType {

    @ApiModelProperty("ID")
    private String id;

    @NotBlank(message = "字典名稱必填項")
    @ApiModelProperty(value = "字典名稱",example = "用戶ID")
    private String typeName;

    @NotBlank(message = "字典編碼不能為空")
    @ApiModelProperty(value = "字典編碼")
    private String typeCode;

    @Email(message = "請填寫正確的郵箱地址")
    @ApiModelProperty(value = "字典編碼")
    private String email;

    @ApiModelProperty(value = "字典描述")
    private String description;

    @NotBlank(message = "字典狀態不能為空")
    @ApiModelProperty(value = "字典狀態")
    private String enable;
}

常見的約束註解如下：

註解 功能
@AssertFalse 可以為null,如果不為null的話必須為false
@AssertTrue 可以為null,如果不為null的話必須為true
@DecimalMax 設置不能超過最大值
@DecimalMin 設置不能超過最小值
@Digits 設置必須是數字且數字整數的位數和小數的位數必須在指定範圍內
@Future 日期必須在當前日期的未來
@Past 日期必須在當前日期的過去
@Max 最大不得超過此最大值
@Min 最大不得小於此最小值
@NotNull 不能為null，可以是空
@Null 必須為null
@Pattern 必須滿足指定的正則表達式
@Size 集合、數組、map等的size()值必須在指定範圍內
@Email 必須是email格式
@Length 長度必須在指定範圍內
@NotBlank 字元串不能為null,字元串trim()後也不能等於""
@NotEmpty 不能為null，集合、數組、map等size()不能為0；字元串trim()後可以等於""
@Range 值必須在指定範圍內
@URL 必須是一個URL

定義校驗類進行測試

package com.didiplus.modules.sys.controller;

import com.didiplus.modules.sys.domain.SysDictType;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/25
 * Desc: 數據字典控制器
 */
@RestController
@Api(tags = "數據字典")
@RequestMapping("/api/sys/dictType")
public class SysDictTypeController {

    @ApiOperation("字典添加")
    @PostMapping("/add")
    public SysDictType add(@Validated @RequestBody SysDictType sysDictType) {
        return  sysDictType;
    }

    @ApiOperation("字典修改")
    @PutMapping("/edit")
    public SysDictType edit(@Validated @RequestBody SysDictType sysDictType) {
        return  sysDictType;
    }


}

這裡我們先定義兩個方法add,edit，都是使用了 @RequestBody註解，用於接受前端發送的json數據。

打開介面文檔模擬提交數據


通過介面文檔看到前三個欄位都是必填項。

由於email的格式不對就被攔截了，提示是因為郵箱地址不對。

參數異常加入全局異常處理器

雖然我們之前定義了全局異常攔截器，也看到了攔截器確實生效了，但是 Validator校驗框架返回的錯誤提示太臃腫了，不便於閱讀，為了方便前端提示，我們需要將其簡化一下。
直接修改之前定義的 RestExceptionHandler，單獨攔截參數校驗的三個異常：javax.validation.ConstraintViolationException，org.springframework.validation.BindException，org.springframework.web.bind.MethodArgumentNotValidException，代碼如下：

package com.didiplus.common.web.response.Handler;

import com.didiplus.common.web.response.Result;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindException;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;

import java.util.stream.Collectors;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/24
 * Desc:  預設全局異常處理。
 */
@RestControllerAdvice
public class RestExceptionHandler {
    /**
     * 預設全局異常處理。
     * @param e the e
     * @return ResultData
     */
    @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
    public ResponseEntity<Result<String>> handleValidatedException(Exception e) {
            Result<String>  result = null;
            if (e instanceof  MethodArgumentNotValidException) {
                MethodArgumentNotValidException ex =(MethodArgumentNotValidException)  e;
                result = Result.failure(HttpStatus.BAD_REQUEST.value(),
                                ex.getBindingResult().getAllErrors().stream()
                                        .map(ObjectError::getDefaultMessage)
                                        .collect(Collectors.joining(";"))
                                );
            } else  if (e instanceof ConstraintViolationException){
                ConstraintViolationException ex = (ConstraintViolationException) e;
                result = Result.failure(HttpStatus.BAD_REQUEST.value(),
                                        ex.getConstraintViolations().stream()
                                                .map(ConstraintViolation::getMessage)
                                                .collect(Collectors.joining(";"))
                                        );
            }else  if (e instanceof BindException) {
                BindException  ex = (BindException ) e;
                result = Result.failure(HttpStatus.BAD_REQUEST.value(),
                                        ex.getAllErrors().stream()
                                                .map(ObjectError::getDefaultMessage)
                                                .collect(Collectors.joining(";"))
                                        );
            }
            return new ResponseEntity<>(result,HttpStatus.BAD_REQUEST);
    }
}

美化之後錯誤信息提示更加友好。

自定義參數校驗

雖然Spring Validation 提供的註解基本上夠用，但是面對複雜的定義，我們還是需要自己定義相關註解來實現自動校驗。
比如上面實體類中添加的sex性別屬性，只允許前端傳遞傳 M，F 這2個枚舉值，如何實現呢？

創建自定義註解

package com.didiplus.common.annotation;

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

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

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/26
 * Desc:
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(EnumString.List.class)
@Documented
@Constraint(validatedBy = EnumStringValidator.class)//標明由哪個類執行校驗邏輯
public @interface EnumString {

    String message() default "value not in enum values.";

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

    Class<? extends Payload>[] palyload() default {};
    /**
     * @return date must in this value array
     */
    String[] value();

    /**
     * Defines several {@link EnumString} annotations on the same element.
     *
     * @see EnumString
     */
    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    @Retention(RUNTIME)
    @Documented
    @interface List {

        EnumString[] value();
    }


}

自定義校驗邏輯

package com.didiplus.common.annotation;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.List;


/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/26
 * Desc:
 */
public class EnumStringValidator implements ConstraintValidator<EnumString,String> {
    private List<String> enumStringList;

    @Override
    public void initialize(EnumString constraintAnnotation) {
        enumStringList = Arrays.asList(constraintAnnotation.value());

    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        if(value == null) {
            return true;
        }
        return enumStringList.contains(value);
    }
}

在欄位上增加註解

    @ApiModelProperty(value = "性別")
    @EnumString(value = {"F","M"}, message="性別隻允許為F或M")
    private String sex;

體驗效果

分組校驗

一個對象在新增的時候某些欄位是必填，在更新是有非必填。如上面的 SysDictType中 id 屬性在新增操作時都是必填。 面對這種場景你會怎麼處理呢？
其實 Validator校驗框架已經考慮到了這種場景並且提供瞭解決方案，就是分組校驗。 要使用分組校驗，只需要三個步驟：

定義分組介面

package com.didiplus.common.base;

import javax.validation.groups.Default;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/26
 * Desc:
 */
public interface ValidGroup extends Default {

    interface Crud extends ValidGroup{
        interface Create extends Crud{

        }

        interface Update extends Crud{

        }

        interface Query extends Crud{

        }

        interface Delete extends Crud{

        }
    }
}

在模型中給參數分配分組

    @Null(groups = ValidGroup.Crud.Create.class)
    @NotNull(groups = ValidGroup.Crud.Update.class,message = "字典ID不能為空")
    @ApiModelProperty("ID")
    private String id;

體現效果


本文來自博客園，作者：北根娃，轉載請註明原文鏈接：https://www.cnblogs.com/alanlin/p/16198128.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • PHP原生圖片驗證碼轉base64格式
    前言 Python 在程式並行化方面多少有些聲名狼藉。撇開技術上的問題，例如線程的實現和 GIL，我覺得錯誤的教學指導才是主要問 題。常見的經典 Python 多線程、多進程教程多顯得偏"重"。而且往往隔靴搔癢，沒有深入探討日常工作中最有用的內容。 傳統的例子 簡單搜索下"Python 多線程教程" ...
  • Spring 源碼（7）Spring的註解是如何解析的？
    上一篇 https://www.cnblogs.com/redwinter/p/16196359.html 介紹了BeanFactoryPostProcessor的執行過程，這篇文章介紹Spring中配置的註解是如何通過ConfigurationClassPostProcessor解析的，另外分析下 ...
  • Selenium+python自動化-登錄教程
    前言 一天不寫代碼，這手就閑的發慌，好難受啊… 前面幾篇都是講一些基礎的知識，沒具體的案例，小伙伴看起來比較枯燥，有不少小伙伴給小編提建議以後多出一些具體的 案例。本篇就是拿部落論壇作為測試項目，寫一個簡單的登錄測試腳本。 在寫登錄腳本的時候呢，先要保證流程能跑起來，然後才是去想辦法優化代碼，讓自己 ...
  • 聽我說，你的函數不夠函數，你的函數需要逆變
    一個工作了7年的Java程式員，私信我關於分散式鎖的問題。 一上來就兩個靈魂拷問： Redis鎖超時怎麼辦？ Redis主從切換導致鎖失效怎麼辦？ 我說，彆著急，這些都是小問題。 那麼，關於“分散式鎖的理解和實現”這個問題，我們看看普通人高手的回答。 普通人： 嗯，分散式鎖，就是可以用來實現鎖的分佈 ...
  • springboot~自定義valid及DefaultGroupSequenceProvider的作用
    spring一切都可以基於註解來實例，像緩存，校驗，欄位映射，動態代理等等，今天主要說一下自定義的校驗及校驗的組關聯。 自定義註解，判斷name需要以"管理員"結尾 @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Con ...
  • Python學習之視頻人臉檢測識別
    今天給大家分享簡單的圖片人臉識別技術，其實在實際應用中，很多是通過視頻流的方式進行識別，比如人臉識別通道 門禁考勤系統、人臉動態跟蹤識別系統等等。 案例展示 這裡我們還是使用 opencv 中自帶了 haar人臉特征分類器，通過讀取一段視頻來識別其中的人臉。 代碼實現： Python學習交流Q群：9 ...
  • Java 18 新特性：使用Java代碼啟動jwebserver
    前幾天分享了Java 18 新特性：簡單Web伺服器的jwebserver命令行功能。 今天換一種方式，使用Java代碼來實現一個靜態資源伺服器。 詳細步驟我錄了個視頻放到B站了，感興趣的小伙伴可以點擊查看Java 18 新特性：Simple Web Server（2） 代碼比較簡單，直接貼出來了： ...
  • 如何展示實時音視頻通話時正在說話用戶的音浪
    在 K 歌場景中，經常需要拉多路流並顯示其中正在講話的用戶，我們需要甄別用戶是否說話、說話音量大小（音浪），併在 UI 上展示。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類