Java使用validation拦截非法提交的数据的方法实现

 更新时间:2025年07月28日 09:38:34   作者:moxiaoran5753  
这篇文章主要介绍了Java使用validation拦截非法提交的数据,包含依赖引入、实体类注解配置、控制器@Valid/@Validated使用规范,具有一定的参考价值,感兴趣的可以了解一下

注意:本文使用的是Springboot 2.x版本,如果使用其他版本会略有差异,本文仅作抛转引义,开发时需结合自己项目的实际情况来定。

一.引入依赖

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

二.提交数据的实体类添加验证规则的注解

  需根据属性的类型和业务规则添加相应的注解

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

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

/**
 * @author: 
 * @Desc:
 * @create: 2025-04-14 10:32
 **/
@Data
public class StoreDeviceDTO {

    @NotNull(message = "storeId不能为空")
    private Long storeId;

    @NotBlank(message = "设备名称不能为空")
    private String deviceName;

    @NotBlank(message = "设备图片不能为空")
    @URL(message = "设备图片必须是一个合法的URL地址")
    private String deviceImage;
}

三.在控制器方法上添加@Valid注解

@PostMapping("/addApply")
public AjaxResult add(@Valid @RequestBody StoreApplyDTO storeApplyDTO)
{
	storeApplyService.saveStoreApply(storeApplyDTO);
	return AjaxResult.success();
}

如果传的集合类型的数据,则比较特殊,需要在控制器类名上加上@Validated注解,同时方法中也要加上上@Validated注解,正确的使用方式如下:

@RestController
@Validated
public class StoreDeviceController {
    @Autowired
    private IStoreDeviceService storeDevicesService;

   
    @PostMapping("/saveDevices")
    public AjaxResult saveDevices(@RequestBody @Validated List<@Valid StoreDeviceDTO> deviceDTOList) {
        storeDevicesService.saveDevices(deviceDTOList);
        return AjaxResult.success();
    }

}

其中@Valid和@Validated引用的包为:

import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;

为了给前端返回时是可读性强的文字说明,而不是一堆英文说明,需要在全局异常处理类中添加如下代码:

@RestControllerAdvice
public class GlobalExceptionHandler
{
   /**
     * 自定义验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
    {
        //log.error(e.getMessage(), e);
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        return AjaxResult.error(message);
    }
}

第一个返回示例:

{
    "msg": "门店id不能为空",
    "code": 500
}

第二个返回示例(可进一步优化):

{
    "msg": "saveDevices.deviceDTOList[0].deviceName: 设备名称不能为空, saveDevices.deviceDTOList[0].deviceImage: 设备图片必须是一个合法的URL地址",
    "code": 500
}

拓展:分组校验

很多时候,有新增和修改操作,需进行不同的验证,比如新增时无需带id,而修改时必须带id,此时可通过分组检验,以实现区别对接。下面是实现的过程:

1.创建新建和修改的分组interface

//新增
public interface AddGroup {
}
//修改
public interface UpdateGroup {
}

2.请求体添加分组注解

import com.bbc.validate.group.AddGroup;
import com.bbc.validate.group.UpdateGroup;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.*;
import java.util.List;

/**
 * @author: 
 * @Desc:
 * @create: 2025-03-22 14:34
 **/
@Data
@ApiModel(description = "认证项目请求体")
public class CertificateDTO {

    @ApiModelProperty("申请认证ID")
    @NotNull(message = "申请认证ID不能为空",groups ={UpdateGroup.class})
    private Long id;

    @NotNull(message = "storeId不能为空",groups ={AddGroup.class,UpdateGroup.class})
    private Long storeId;

    @NotBlank(message = "认证项目不能为空",groups ={AddGroup.class,UpdateGroup.class})
    @ApiModelProperty("认证项目")
    private String project;

    @NotNull(message = "请上传证书材料", groups = {AddGroup.class})
    @Size(min = 1, max = 9, message = "请上传1-9张证书材料图片", groups = {AddGroup.class, UpdateGroup.class})
    @ApiModelProperty("认证项目材料图片(1-9张)")
    private List<String> certificateMaterials;

    @Size(max = 200, message = "认证说明最多200个字符")
    @ApiModelProperty("认证说明/备注(最多200字)")
    private String instructions;
}

3.controller中的方法添加了分组

@ApiOperation("新增认证管理")
@Log(title = "认证管理", businessType = BusinessType.INSERT)
@PostMapping("/saveProject")
@RepeatSubmit(interval = 5000, message = "不允许重复提交,请稍候再试")
public AjaxResult add(@Validated(AddGroup.class) @RequestBody CertificateDTO certificateDTO)
{
	certificateService.saveCertificateProject(certificateDTO);
	return AjaxResult.success();
}

/**
 * 修改认证管理
 */
@ApiOperation("修改认证管理")
@Log(title = "认证管理", businessType = BusinessType.UPDATE)
@PutMapping("/editProject")
public AjaxResult edit(@Validated(UpdateGroup.class) @RequestBody CertificateDTO certicateDTO)
{
	certificateService.updateCertificateProject(certicateDTO);
	return AjaxResult.success();
}

避坑指南:

如果DTO类某个属性添加了分组校验,但Controller方法未指定校验分组,会导致分组校验失效,没有添加分组注解的基础校验仍然有效

情况说明:

1. 默认行为

  • 未指定分组:当Controller方法没有使用@Validated指定分组时,只会校验没有分组的约束注解
  • 有分组注解:带有groups属性的校验注解将被跳过(因为没有添加@Validated注解)

2. 示例分析

public class CertificateDTO {
    @NotEmpty(message = "证书材料不能为空", groups = {AddGroup.class})  // 有分组
    private List<String> certificateMaterials;
    
    @Size(max = 200)  // 无分组
    private String instructions;
}

在Controller中:

@PostMapping
public void save(@RequestBody @Valid StoreCertificateDTO dto) {
    // 只会校验instructions字段
    // certificateMaterials不会被校验,因为未指定AddGroup分组
}

3. 解决方案

方案1:在Controller类上添加@Validated注解

@RestController
@Validated(AddGroup.class)  // 指定默认分组
public class CertificateController {
    @PostMapping
    public void save(@RequestBody @Valid CertificateDTO dto) {
        // 现在会校验AddGroup分组和没有分组的约束
    }
}

方案2:在方法参数上指定分组

@PostMapping
public void save(@RequestBody @Validated(AddGroup.class) StoreCertificateDTO dto) {
    // 明确指定校验分组
}

方案3:混合使用(推荐)

@RestController
@Validated  // 类级别启用校验
public class CertificateController {
    @PostMapping("/add")
    public void add(@RequestBody @Validated(AddGroup.class) StoreCertificateDTO dto) {
        // 添加操作使用AddGroup分组
    }
    
    @PostMapping("/update")
    public void update(@RequestBody @Validated(UpdateGroup.class) StoreCertificateDTO dto) {
        // 更新操作使用UpdateGroup分组
    }
}

4. 重要注意事项

@Valid vs @Validated

  • @Valid(JSR-303)不支持分组
  • @Validated(Spring扩展)支持分组

默认校验

  • 没有分组的约束注解总是会被校验
  • 有分组的约束只在指定对应分组时才会校验

继承关系

  • 分组可以继承,父接口的分组会被子接口继承

分组虽好,使用不当可能会得不到预期的结果,那么什么情况下要分组,什么情况下不分组呢:

5. 使用建议

  • 明确指定分组:重要的业务校验都应该明确指定分组
  • 分层设计
    • 基础校验(非空、格式等)可以不分组
    • 业务规则校验使用分组
  • 文档注释:在代码中注明各分组的用途
  • 测试覆盖:编写测试验证分组校验是否按预期工作

到此这篇关于Java使用validation拦截非法提交的数据的文章就介绍到这了,更多相关Java使用validation拦截非法提交内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • java finally块执行时机全面分析

    java finally块执行时机全面分析

    下面小编就为大家带来一篇java finally块执行时机全面分析。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-08-08
  • java 获取路径的各种方法(总结)

    java 获取路径的各种方法(总结)

    下面小编就为大家带来一篇java 获取路径的各种方法(总结)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-08-08
  • Java+EasyExcel实现文件的导入导出

    Java+EasyExcel实现文件的导入导出

    在项目中我们常常需要Excel文件的导入与导出,手动输入相对有些繁琐,所以本文教大家如何在Java中轻松导入与导出Excel文件,感兴趣的可以学习一下
    2021-12-12
  • Java利用ip2region实现获取IP地址详情

    Java利用ip2region实现获取IP地址详情

    ip2region是一个离线IP地址定位库和IP定位数据管理框架,10微秒级别的查询效率,提供了众多主流编程语言的 xdb 数据生成和查询客户端实现。本文将利用ip2region实现获取IP地址详情,感兴趣的可以了解一下
    2022-07-07
  • 使用VisualVM分析日志

    使用VisualVM分析日志

    文章强调程序员需掌握多种工具(如JMeter、ELK、Prometheus等)应对工作挑战,避免线上事故,重点介绍VisualVM作为Java故障排查工具,通过分析大对象和GC监控,提升代码质量与问题定位效率
    2025-07-07
  • SpringBoot设置HTTP响应状态码过程(HTTP Status Code)

    SpringBoot设置HTTP响应状态码过程(HTTP Status Code)

    本文介绍了HTTP响应状态码的分类及其在SpringBoot中的使用示例,状态码包括信息、成功、重定向、客户端错误和服务器错误,常用的几种状态码有200(请求成功)、400(客户端错误)、404(资源未找到)和500(服务器内部错误)
    2026-01-01
  • RabbitMQ交换机使用场景和消息可靠性总结分析

    RabbitMQ交换机使用场景和消息可靠性总结分析

    这篇文章主要为大家介绍了RabbitMQ交换机使用场景和消息可靠性总结分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • java实现扫雷游戏控制台版

    java实现扫雷游戏控制台版

    这篇文章主要为大家详细介绍了java实现扫雷游戏控制台版,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-04-04
  • Springboot整合hibernate validator 全局异常处理步骤详解

    Springboot整合hibernate validator 全局异常处理步骤详解

    本文分步骤给大家介绍Springboot整合hibernate validator 全局异常处理,补呢文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2024-01-01
  • Java Predicate接口定义详解

    Java Predicate接口定义详解

    Predicate是Java中的一个函数式接口,它代表一个判断逻辑,接收一个输入参数,返回一个布尔值,这篇文章主要介绍了Java Predicate接口的定义及示例代码,需要的朋友可以参考下
    2025-04-04

最新评论