使用javax.validation.constraints对请求体进行统一校验

 更新时间:2024年07月04日 08:54:05   作者:半山惊竹  
这篇文章主要介绍了使用javax.validation.constraints对请求体进行统一校验方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

一、序言

在处理请求的时候,通常需要对参数进行校验是否为空,参数的长度等进行校验,

如果在controller层一个一个的写校验就很麻烦,于是就有了javax.validation.constraints包。

二、注解类型

不同的注解用于不同的数据类型,小伙伴们可以下载源码看一些常用的比如非空限制的注解的区别,

我这里截几个图:

所以我一般的处理是,如果是字符串类型就用@NotBlank,

如果是集合数组之类就用@NotEmpty,如果是对象就用@NotNull

当然还有别的包的校验类型,比如限制请求参数的长度就可以用到另外一个包里的注解了,在pom中增加依赖:

<dependency>
	<groupId>org.hibernate.validator</groupId>
	<artifactId>hibernate-validator</artifactId>
	<version>6.0.17.Final</version>
	<scope>compile</scope>
</dependency>

三、使用注解

3.1 请求实体类增加注解

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;


/**
 * @author FanHuiFang
 * @version 1.0
 * @date 2024年04月27日 19:58
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserSaveReq {
    @NotBlank(message = "name不能为空")
    private String name;

    @NotNull(message = "年龄不能为空")
    private Long age;

    @NotEmpty(message = "朋友列表不能为空")
    private List<String> friends;

    @NotNull(message = "客户手机号不能为空")
    @Length(min = 8, max = 16, message = "客户手机号不合法")
    private String userPhone;
}

3.2 控制层

import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;
import org.springframework.validation.Errors;

@PostMapping(value = "/saveUser")
public ResultBean<String> saveUser(@Valid @RequestBody UserSaveReq req, Errors errors) {
    if (Objects.isNull(req)) return ResultBean.fail("缺少必要的请求参数");
    if (errors.hasErrors() && Objects.nonNull(errors.getFieldError())) {
        String errorMessage = errors.getFieldError().getDefaultMessage();
        log.error("保存用户信息时请求参数错误:{}", errorMessage);
        return ResultBean.fail(errorMessage);
    }
    //保存处理......
    
}

当进行请求的时候,如果缺少某个参数,或者比如长度不对,就会返回异常信息,这样就不用一个个的进行校验了。

注意:这里请求参数中需要加上@Valid注解,如果不加,应该是校验没有生效的

比如手机号号长度不对,就会返回

{
    "code": 0,
    "message": "客户手机号不合法",
    "data": null
}

这里也附带一下我用的ResultBean,以免看的云里雾里的:

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.ToString;

import java.io.Serializable;

/**
 * @author FanHuiFang
 * @version 1.0
 * @date 2024年04月27日 21:50
 */

@Builder
@Data
@AllArgsConstructor
@ToString
public class ResultBean<T> implements Serializable {
    private Integer code;
    private String message;
    private T data;


    public ResultBean(int code, String message, T data) {
        this.code = code;
        this.data = data;
        this.message = message;
    }

    public ResultBean(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public static <T> ResultBean<T> data(T data) {
        return data("操作成功", data);
    }

    public static <T> ResultBean<T> data(String message, T data) {
        return data(1, message, data);
    }

    public static <T> ResultBean<T> data(int code, String message, T data) {
        return new ResultBean<>(code, message, data);
    }


    public static <T> ResultBean<T> fail(String message, T data) {
        return new ResultBean<>(0, message, data);
    }

    public static <T> ResultBean<T> fail(Integer code, String message) {
        return new ResultBean<>(code, message);
    }

    public static <T> ResultBean<T> fail(String message) {
        return new ResultBean<>(0, message, null);
    }
}

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • java编程创建型设计模式工厂方法模式示例详解

    java编程创建型设计模式工厂方法模式示例详解

    这篇文章主要为大家介绍了java编程创建型设计模式之工厂方法模式的创建及案例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2022-02-02
  • Java中的vector类使用方法示例详解

    Java中的vector类使用方法示例详解

    这篇文章主要介绍了Java vector类的使用详解及实例的相关资料,需要的朋友可以参考下
    2017-04-04
  • java利用phantomjs进行截图实例教程

    java利用phantomjs进行截图实例教程

    PlantomJs是一个基于javascript的webkit内核无头浏览器 也就是没有显示界面的浏览器,你可以在基于 webkit 浏览器做的事情,它都能做到。下面这篇文章主要给大家介绍了关于java利用phantomjs进行截图的相关资料,需要的朋友可以参考下
    2018-10-10
  • JavaWeb使用Session和Cookie实现登录认证

    JavaWeb使用Session和Cookie实现登录认证

    本篇文章主要介绍了JavaWeb使用Session和Cookie实现登录认证,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-03-03
  • MapTask阶段shuffle源码分析

    MapTask阶段shuffle源码分析

    今天小编就为大家分享一篇关于MapTask阶段shuffle源码分析,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • 使用jps命令查看Java进程的详细指南

    使用jps命令查看Java进程的详细指南

    jps是Java开发者和系统管理员的得力助手,它简化了Java进程监控的过程,使得快速检查应用运行状态变得轻而易举,在Java开发和运维场景中,jps是一个非常实用的命令行工具,本文介绍了如何有效地使用 jps命令来查看Java进程的详细指南,需要的朋友可以参考下
    2024-10-10
  • java显示声音波形图示例

    java显示声音波形图示例

    这篇文章主要介绍了java显示声音波形图示例,需要的朋友可以参考下
    2014-05-05
  • SpringBoot自定义Starter及使用

    SpringBoot自定义Starter及使用

    这篇文章主要介绍了SpringBoot自定义Starter及使用,Starter是Spring Boot中的一个非常重要的概念,Starter相当于模块,它能将模块所需的依赖整合起来并对模块内的Bean根据环境进行自动配置,需要的朋友可以参考下
    2023-07-07
  • springboot的controller层的常用注解说明

    springboot的controller层的常用注解说明

    这篇文章主要介绍了springboot的controller层的常用注解说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-10-10
  • java图片缩放实现图片填充整个屏幕

    java图片缩放实现图片填充整个屏幕

    这篇文章主要介绍了java图片缩放实现图片填充整个屏幕,本文提供了两种解决方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-05-05

最新评论