接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

这篇具有很好参考价值的文章主要介绍了接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

目录

1:JSR303校验

1.1:统一校验的需求

1.2:统一校验实现

1.3:分组校验

1.4:校验规则不满足?


1:JSR303校验

1.1:统一校验的需求

前端请求后端接口传输参数,是在controller中校验还是在Service中校验?

答案是都需要校验,只是分工不同。

Contoller中校验请求参数的合法性,包括:必填项校验,数据格式校验,比如:是否是符合一定的日期格式,等。

Service中要校验的是业务规则相关的内容,比如:课程已经审核通过所以提交失败。

Service中根据业务规则去校验不方便写成通用代码,Controller中则可以将校验的代码写成通用代码。

早在JavaEE6规范中就定义了参数校验的规范,它就是JSR-303,它定义了Bean Validation,即对bean属性进行校验。

SpringBoot提供了JSR-303的支持,它就是spring-boot-starter-validation,它的底层使用Hibernate Validator,Hibernate Validator是Bean Validation 的参考实现。

所以,我们准备在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。

1.2:统一校验实现

首先添加依赖

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

在javax.validation.constraints包下有很多这样的校验注解,直接使用注解定义校验规则即可。

接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

规则如下:接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

示例:一个接口的参数校验

接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

@Data
@ApiModel(value="AddCourseDto", description="新增课程基本信息")
public class AddCourseDto {

 @NotEmpty(message = "课程名称不能为空")
 @ApiModelProperty(value = "课程名称", required = true)
 private String name;

 @NotEmpty(message = "适用人群不能为空")
 @Size(message = "适用人群内容过少",min = 10)
 @ApiModelProperty(value = "适用人群", required = true)
 private String users;

 @ApiModelProperty(value = "课程标签")
 private String tags;

 @NotEmpty(message = "课程分类不能为空")
 @ApiModelProperty(value = "大分类", required = true)
 private String mt;

 @NotEmpty(message = "课程分类不能为空")
 @ApiModelProperty(value = "小分类", required = true)
 private String st;

 @NotEmpty(message = "课程等级不能为空")
 @ApiModelProperty(value = "课程等级", required = true)
 private String grade;

 @ApiModelProperty(value = "教学模式(普通,录播,直播等)", required = true)
 private String teachmode;

 @ApiModelProperty(value = "课程介绍")
 private String description;

 @ApiModelProperty(value = "课程图片", required = true)
 private String pic;

 @NotEmpty(message = "收费规则不能为空")
 @ApiModelProperty(value = "收费规则,对应数据字典", required = true)
 private String charge;

 @ApiModelProperty(value = "价格")
 private Float price;
 @ApiModelProperty(value = "原价")
 private Float originalPrice;


 @ApiModelProperty(value = "qq")
 private String qq;

 @ApiModelProperty(value = "微信")
 private String wechat;
 @ApiModelProperty(value = "电话")
 private String phone;

 @ApiModelProperty(value = "有效期")
 private Integer validDays;
}

 上边用到了@NotEmpty和@Size两个注解,@NotEmpty表示属性不能为空,@Size表示限制属性内容的长短。

 定义好校验规则还需要开启校验,在controller方法中添加@Validated注解,如下

接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

如果校验出错Spring会抛出MethodArgumentNotValidException异常,我们需要在统一异常处理器中捕获异常,解析出异常信息。

    @ResponseBody
    //处理器捕获入口参数报的错误进入该方法内进行处理
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e){
       //创建一个集合进行接收不合法信息
        List<String> msgList = new ArrayList<>();
        BindingResult bindingResult = e.getBindingResult();
        //入口参数校验,可能有多个参数信息都不合法,存放
        bindingResult.getFieldErrors().stream().forEach(fieldError -> msgList.add(fieldError.getDefaultMessage()));
      
        //处理集合内的不合法提示,为字符串
        String msg = StringUtils.join(msgList, ",");
        //记录异常
        log.error("系统异常{}",msg);
        //解析出异常信息
        RestErrorResponse restErrorResponse = new RestErrorResponse(msg);

        return restErrorResponse;
    }

使用httpclient进行测试一下

 接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

可以看到校验器生效。 

1.3:分组校验

有时候在同一个属性上设置一个校验规则不能满足要求,比如:订单编号由系统生成,在添加订单时要求订单编号为空,在更新 订单时要求订单编写不能为空。此时就用到了分组校验,同一个属性定义多个校验规则属于不同的分组,比如:添加订单定义@NULL规则属于insert分组,更新订单定义@NotEmpty规则属于update分组,insert和update是分组的名称,是可以修改的。

下边举例说明

我们用class类型来表示不同的分组,所以我们定义不同的接口类型(空接口)表示不同的分组,由于校验分组是公用的,所以定义在 公共调用的工程中。如下:

/**
 * 定义一个校验分组
 */
public class ValidationGroups {

 public interface Inster{};
 public interface Update{};
 public interface Delete{};

}

在接收参数的模型类中进行填写分组

接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法 在Controller方法中启动校验规则指定要使用的分组名:

接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

 再次测试,由于这里指定了update分组,所以抛出 异常信息:添加课程名称不能为空。

如果修改分组为ValidationGroups.Inster.class,异常信息为:修改课程名称不能为空。

 接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

1.4:校验规则不满足?

如果javax.validation.constraints包下的校验规则满足不了需求怎么办?

1、手写校验代码 。

2、自定义校验规则注解。

如何自定义校验规则注解,请自行查阅资料实现。文章来源地址https://www.toymoban.com/news/detail-426786.html

到了这里,关于接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【SpringMVC】JSR 303与拦截器注解使用

       JSR 303,它是Java EE(现在称为Jakarta EE)规范中的一部分。JSR 303定义了一种用于验证Java对象的标准规范,也称为Bean验证。         Bean验证是一种用于验证对象属性的框架,它可以确保对象符合特定的规则和约束。这些规则可以包括字段的非空性、长度限制、格式验证等。

    2024年02月07日
    浏览(54)
  • 【SpringMVC】JSR 303与拦截器注释使用

    目录 一、JSR 303 1.1 JSR 303介绍 1.2 为什么要使用JSR-303 1.3 常用注解 1.4 使用示例 1.4.1 导入JSR303依赖 1.4.2 配置校验规则 1.4.3 编写方法校验  1.4.4 编写前端 1.4.5 测试 ​编辑  1.5 @Validated与@Valid区别   二、拦截器(interceptor)  2.1 什么是拦截器 ? 2.2 拦截器与过滤器的区别  

    2024年02月07日
    浏览(46)
  • SpringMVC中的JSR303与拦截器的使用

         JSR303是Java中的一个标准,用于 验证和校验JavaBean对象的属性的合法性 。它提供了一组用于定义验证规则的注解,如@NotNull、@Min、@Max等。在Spring MVC中,可以使用JSR303注解对请求参数进行校验。 前端不是已经校验过数据了吗?为什么我们还要做校验呢,直接用不就好了?

    2024年02月07日
    浏览(43)
  • Spring-MVC使用JSR303及拦截器,增强网络隐私安全

    目录 一、JSR303 ( 1 )  是什么 ( 2 )  作用 ( 3 )  常用注解 ( 4 )  入门使用 二、拦截器 2.1  是什么 2.2  拦截器与过滤器的区别 2.3  应用场景 2.4 基础使用 2.5 用户登录权限控制 给我们带来的收获 JSR 303是Java规范请求(Java Specification Request)的一部分, 它定义了一套标准的Jav

    2024年02月09日
    浏览(43)
  • 学习 [Spring MVC] 的JSR 303和拦截器,提高开发效率

                                                   🎬 艳艳耶✌️ :个人主页                                                  🔥 个人专栏 : 《推荐】Spring与Mybatis集成整合》                                                  ⛺️    生活的理想,不断更

    2024年02月09日
    浏览(46)
  • “JSR303和拦截器在Java Web开发中的应用与实践“

    在Java Web开发过程中,我们经常会遇到需要对输入数据进行验证和处理,同时需要对请求进行拦截与控制的需求。为了方便实现这些功能,我们可以使用JSR303验证框架和拦截器技术。本篇博客将介绍JSR303和拦截器的基本概念,并探讨它们在Java Web开发中的应用与实践。 什么是

    2024年02月09日
    浏览(43)
  • Python-Python高阶技巧:HTTP协议、静态Web服务器程序开发、循环接收客户端的连接请求

    当前版本号[20231114]。 版本 修改说明 20231114 初版 1.1 网址的概念 网址又称为URL,URL的英文全拼是(Uniform Resoure Locator),表达的意思是 统一资源定位符 ,通俗理解就是网络资源地址。 URL地址:https://www.itcast.com/18/1122/10/E178J2O4000189FH.html 1.2 URL的组成 域名 : IP地址的别名 ,它是用

    2024年02月04日
    浏览(65)
  • FRP内网穿透参数配置+服务器与客户端的简易配置+完整配置详解(Windows)

    有设备A,想访问处于局域网的设备C时,可以通过处在公网的设备B进行转发 前提条件:一个有公网IP的电脑,云服务器、有公网IPV4/6的设备均可,如果使用ipv6模式,那么设备BC都必须支持ipv6才行,ipv6地址除了bind_addr和server_addr,都要用[]括起来 本文基于:v0.48.0版本 官网: 官

    2024年02月05日
    浏览(52)
  • samba客户端的使用与服务端的搭建

    samba是SMB文件共享协议的应用软件,可以让Linux系统和Windows系统之间相互共享资源。 在Linux系统中使用smbd服务器提供提供共享资源;使用smbclient去访问其他smbd服务器所提供的共享资源。 在Windows中有SMB/CIFS服务器和客户端。 SMB(Server Message Block)协议是一种在局域网上共享资

    2024年02月02日
    浏览(35)
  • git客户端的使用

    分布式版本控制工具。 具有中央服务器仓库和本地仓库。 客户端下载:GitHub Desktop | Simple collaboration from your desktop 左上角: File - New repository 本地的两个仓库: 查看当前仓库的路径并打开: 注意: 路径①是用户可以手动操作文件的工作目录;路径②存放该仓库所有的操作、

    2024年02月06日
    浏览(44)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包