Springboot——@valid 做字段校验和自定义注解

news2025/8/3 19:57:14

文章目录

  • 前言
  • 注意实现
  • 测试环境
  • 验证自带的注解
  • 自定义valid注解
    • 自定义注解和处理类
    • 创建参数接收类，并增加字段注解
    • 接口中使用
  • 自测环节
    • 正常测试
    • 异常测试
  • 自定义全局异常监听
  • 扩展
    • 递归参数下valid不识别的坑

前言

再项目开发中，针对前端传递的参数信息，有些接口中需要写大量的if判断，导致代码臃肿，不够优雅。

此时，可以使用@Valid实现基本的字段校验。

注意实现

  • springboot 2.3之前 ，直接进行开发即可，无需引用额外的依赖
    集成在spring-boot-starter-web中。
  • springboot 2.3之后 需要额外引入spring-boot-starter-validation依赖信息

测试环境

springboot 2.1.4

如果你的springboot版本高于 2.3，需要额外引入下列依赖：

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

验证自带的注解

验证自带的注解，以及实现原理，可以移步到我的另一篇博客中，本篇博客不做过多的阐述。

做一个优雅的接口

自定义valid注解

官方提供的一些常用的注解，有时候并不能适合所有的开发需求。此时可以采取自定义valid的方式，实现其应有的功能。

自定义注解和处理类

创建一个自定义的注解

检查排序号是否输入，以及是否满足要求。

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

@Constraint(validatedBy = POrderParse.class) // 注解对应的处理类
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface POrder {
    // 默认提示语句
    String message() default "排序号不允许为空，且只允许是1到20的数字！";
    // 默认校验正则表达式
    String regexp() default "^([1-9])|([1]\\d)|20$";

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

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

}

定义注解后，还需要定义其指定的处理类，如下所示：

import org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorContextImpl;
import org.springframework.stereotype.Component;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

@Component
public class POrderParse implements ConstraintValidator<POrder,Object> {

    @Override
    public void initialize(POrder constraintAnnotation) {
        System.out.println("my para order validator init");
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        // 校验逻辑
        ConstraintValidatorContextImpl con = (ConstraintValidatorContextImpl) context;
        // 获取注解中的属性值
        Map<String, Object> maps = con.getConstraintDescriptor().getAttributes();
        // 获取设置的或者默认的正则表达式
        String regexp = (String) maps.get("regexp");

        // 获取数据值
        String param = String.valueOf(value);
        // 正则判断
        Pattern regexpVo = Pattern.compile(regexp);
        Matcher matcher = regexpVo.matcher(param);
        return matcher.matches();
    }
}

创建参数接收类，并增加字段注解

import cn.xj.bi.volid.MyPhone;
import cn.xj.bi.volid.POrder;
import lombok.Data;

@Data
public class User {

    @POrder
    private Integer order;
}

接口中使用

创建一个测试接口，进行应用测试。

需要使用到@Valid注解标识

@RestController
@RequestMapping("/test1")
@Api(tags = "测试")
public class TestController {

    @PostMapping("/demo4")
    @ApiOperation(value = "demo4")
    public CommonResult<String> test4(@RequestBody @Valid User user){
        return CommonResult.success("6666");
    }
)

自测环节

启动项目，进入swagger进行请求测试。

正常测试

传递满足正则要求的值，查看返回结果信息。

{
	"order": 10
}

在这里插入图片描述

异常测试

参数中传递一个不满足正则表达式的值，观察返回信息。

{
	"order": 0
}

在这里插入图片描述

自定义全局异常监听

每次返回这样的报错信息不够直观，此时可以自定义全局异常监听，如下所示：

import cn.xj.bi.vo.CommonResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.Objects;

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public CommonResult handleScopeFiledException(MethodArgumentNotValidException e) {
        log.error("字段合法性校验异常：[{}]", e.getMessage());
        // getFieldError() 和 getDefaultMessage() 的区别
        return CommonResult.error( Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage(), null);
    }
}

重启项目，再次异常测试：
在这里插入图片描述

扩展

递归参数下valid不识别的坑

递归参数的意思就是接收对象是一个类，假设是DataScope，但是在这个接收类中，还有一个List<User>这个参数变量，并且User中依旧还含有需要valid校验的字段属性。

再自定义一个valid注解，如下所示：

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

@Constraint(validatedBy = {MyPhoneValidtor.class})
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyPhone {
    String message();
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

}

valid注解具体处理类：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class MyPhoneValidtor implements ConstraintValidator<MyPhone,Object> {
    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        System.out.println("校验");
        // 故意返回false，触发异常
        return false;
    }
}

然后再请求参数接收对象中，定义如下格式：

import cn.xj.bi.volid.POrder;
import lombok.Data;

@Data
public class User {
    @POrder
    private Integer order;
    
    private Address address;
}

import cn.xj.bi.volid.MyPhone;
import lombok.Data;
import java.io.Serializable;

@Data
public class Address implements Serializable {
    @MyPhone(message = "这只是一个测试")
    private String phoneNum;
}

重启项目，传递正常的 order 值，观察Address 类中的 phoneNum 是否触发valid校验。

{
	"order": 10,
        "address":{
              "phoneNum":""
        }
}

在这里插入图片描述
发现并未触发对应的valid校验。

解决方式很简单，没有触发说明注解无效，接口中定义@Valid User 是对user对象进行valid处理，但对象类型的并不在列，只需要在对象类型的变量上增加@Valid注解即可。

import cn.xj.bi.volid.POrder;
import lombok.Data;

import javax.validation.Valid;

@Data
public class User {
    @POrder
    private Integer order;
    
    @Valid  // 迭代valid
    private Address address;
}

重启项目，继续按照上面的传参，观察响应信息。
在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/394311.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

机器学习中的数学——精确率与召回率

机器学习中的数学——精确率与召回率

在Yolov5训练完之后会有很多图片&#xff0c;它们的具体含义是什么呢&#xff1f; 通过这篇博客&#xff0c;你将清晰的明白什么是精确率、召回率。这个专栏名为白话机器学习中数学学习笔记&#xff0c;主要是用来分享一下我在 机器学习中的学习笔记及一些感悟&#xff0c;也希…
阅读更多...
Java开发 - Redis初体验

Java开发 - Redis初体验

前言 es我们已经在前文中有所了解&#xff0c;和es有相似功能的是Redis&#xff0c;他们都不是纯粹的数据库。两者使用场景也是存在一定的差异的&#xff0c;本文目的并不重点说明他们之间的差异&#xff0c;但会简要说明&#xff0c;重点还是在对Redis的了解和学习上。学完本…
阅读更多...
Lab2_Simple Shell_2020

Lab2_Simple Shell_2020

Lab2: 实验目的&#xff1a;给xv6添加新的系统调用 并理解系统调用是如何工作的&#xff0c;并理解xv6内核的一些内部特征 实验准备&#xff1a; 阅读xv6的第2章以及第4章的4.3,4.3小节熟悉下面的源码 用户态相关的代码&#xff1a;user/user.h和user/usys.pl内核态相关的代…
阅读更多...
第八章：枚举类与注解

第八章：枚举类与注解

第八章&#xff1a;枚举类与注解 8.1&#xff1a;枚举类的使用 ​ 类的对象只有有限个&#xff0c;确定的。我们称此类为枚举类。当需要定义一组常量是&#xff0c;强烈建议使用枚举类。如果枚举类中只有一个对象&#xff0c;则可以作为单例模式的实现方式。 如何定义枚举类 …
阅读更多...
一图来看你需要拥有那些知识储备

一图来看你需要拥有那些知识储备

技术实践 数据 关系型数据 MySQLSQLServerOraclePostgrSQLDB2 大数据存储 RedisMemcacheMongoDBHBaseHive 大数据处理 Hadoop 数据报表看板 DataGearGrafanaKibanaMetaBase 消息对列 Rabbit MQRock MQActive MQKafka 大数据搜索 SolrElasticSearchLucenHive 服务提…
阅读更多...
HBase负载均衡的实现机制

HBase负载均衡的实现机制

数据库集群负载均衡的实现依赖于数据库的数据分片设计&#xff0c;可以在一定程度上认为数据分片就是数据读写负载&#xff0c;那么负载均衡功能就是数据分片在集群中均衡的实现。 一、Region迁移 作为一个分布式系统&#xff0c;分片迁移是最基础的核心功能。集群负载均衡、…
阅读更多...
【实现“下一题”按钮的功能 Objective-C语言】

【实现“下一题”按钮的功能 Objective-C语言】

一、刚才我们把上半部分这个界面，给大家搭好了，懒加载也加载好了，接下来，我们要实现的就是点击“下一题”，是不是实现这个效果， 1.类似于图片浏览器这个效果呀， 来看一下，我们这里的这个数据懒加载已经加载起来了， 那么同时，我们界面上这些控件也都摆好了， 并且，…
阅读更多...
商务会议租车价格受哪些因素影响!

商务会议租车价格受哪些因素影响!

有重要客户来访&#xff1f;要主办一次重要的会议&#xff1f;或者只是一次普通的机场接送。会议商务租车将能够根据您的需求为您提供全方位服务。 会议商务租车的概念 是指为满足企业商务活动的需要而提供的一种汽车服务。它主要包括&#xff1a;根据客户要求提供各种车型&…
阅读更多...
黑马程序员提高变成

黑马程序员提高变成

这里写目录标题函数模板1.2.2 函数模板注意事项1.2.3 函数模板案例调用规则类模板与函数模板区别类模板与继承类模板成员函数类外实现#pragma once类模板与友元案例重新定义【】stl2.2 STL基本概念STL六大组件容器算法迭代器初识vectorvector容器嵌套容器string容器string赋值操…
阅读更多...
作为 React 开发者你应该知道的 7 个库

作为 React 开发者你应该知道的 7 个库

在成为一名全面的React开发人员的过程中&#xff0c;您会遇到无数的库&#xff0c;让您感到茫然和困惑。因此&#xff0c;这里列出了作为React开发人员学习不会出错的 7 个库。1.反应兜风React Joyride是一个库&#xff0c;可帮助您为React应用程序创建演练和导览。它是向现有用…
阅读更多...
C++从头再来：知识点速通

C++从头再来：知识点速通

1. 关于scanf 1.1 读入数字 scanf 的返回值表示成功输入的变量个数&#xff0c;当输入结束时&#xff0c;scanf将无法再次读取数据&#xff0c;返回0 # include <stdio.h> # include <math.h> # include <time.h># define M 1000000; // compute the max,…
阅读更多...
99.【Git】

99.【Git】

Git(一)、什么是版本控制1.什么是版本控制2、常见的版本控制工具(二)、版本控制分类1、本地版本控制2、集中版本控制 SVN3、分布式版本控制 Git(三)、Git与SVN的主要区别1、Git历史(四)、Git下载与环境配置1.git下载2、启动Git(五)、常用的Linux命令1.Linux常用命令(六)、Git必…
阅读更多...
hadoop兼容性验证

hadoop兼容性验证

前言 Hadoop是一个由Apache基金会所开发的分布式系统基础架构&#xff0c;主要解决海量数据的存储和海量数据的分析计算问题&#xff0c;广义上来说&#xff0c;Hadoop通常是指一个更广泛的概念–hadoop生态圈 Hadoop优缺点&#xff1a; 优点&#xff1a; 1、高可靠性&#x…
阅读更多...
使用WebSocket、SockJS、STOMP实现消息实时通讯功能

使用WebSocket、SockJS、STOMP实现消息实时通讯功能

客户端 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head><title>websocket client</title><script src"http://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.min.js"></script>…
阅读更多...
Softing smartLink网关——推进过程工业数字化转型

Softing smartLink网关——推进过程工业数字化转型

虽然在过程工业中各工厂所投入的运营时间千差万别&#xff0c;但仍需按照新标准来进行有效控制和管理&#xff0c;而这就需要使用一种能够聚合其异构数据的数字通信架构。对此&#xff0c;Softing提供了两种网关解决方案&#xff0c;可用于将过程工业通信架构集成到现有以太网系…
阅读更多...
初次使用ESP32-CAM记录

初次使用ESP32-CAM记录

模块的配置和图片 摄像头&#xff1a;8225N V2.0 171026 模块esp-32s 参考资料&#xff1a;https://docs.ai-thinker.com/esp32 配置环境 参考&#xff1a;https://blog.csdn.net/weixin_43794311/article/details/128622558 简单使用需要注意的地方 基本的环境配置和串口…
阅读更多...
学习笔记：Java并发编程（补）ThreadLocal

学习笔记：Java并发编程（补）ThreadLocal

【尚硅谷】学习视频&#xff1a;https://www.bilibili.com/video/BV1ar4y1x727【黑马程序员】学习视频&#xff1a;https://www.bilibili.com/video/BV15b4y117RJ 参考书籍 《实战 JAVA 高并发程序设计》 葛一鸣 著《深入理解 JAVA 虚拟机 | JVM 高级特性与最佳实践》 周志明 著…
阅读更多...
大数据项目实战之数据仓库：用户行为采集平台——第3章 用户行为日志

大数据项目实战之数据仓库：用户行为采集平台——第3章 用户行为日志

第3章 用户行为日志 3.1 用户行为日志概述 用户行为日志的内容&#xff0c;主要包括用户的各项行为信息以及行为所处的环境信息。收集这些信息的主要目的是优化产品和为各项分析统计指标提供数据支撑。收集这些信息的手段通常为埋点。 目前主流的埋点方式&#xff0c;有代码…
阅读更多...
流量与日志分析

流量与日志分析

文章目录1.流量与日志分析1.1系统日志分析1.1.1window系统日志与分析方法1.1.2linux 系统日志与分析方法1.2 web日志分析iis 日志分析方法apache日志分析**access_log****error_log**nginx日志分析tomcat 日志分析主流日志分析工具使用1.流量与日志分析 日志&#xff0c;是作为…
阅读更多...
Dns域名解析服务器

Dns域名解析服务器

前言 域名解析服务器的介绍 域名服务器的类型划分 DNS域名解析的过程 为什么需要DNS解析域名为IP地址&#xff1f; 通俗理解Dns DNS劫持 DNS污染 Dns面试经验 前言 DNS是一个应用层协议&#xff0c;用来获取域名对应的IP地址 域名解析服务器的介绍 DNS&#xff08;Dom…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023