SpringBoot接口接收json参数解析

目录
  • SpringBoot接口接收json参数
    • 前言
    • 前提
    • 一、GET
    • 二、DELETE
    • 三、POST/PUT/PATCH
  • Springboot restFul 参数检验
    • 概述
    • 常用注解
    • 简单应用举例
    • 自定义校验
    • 抛出BindException而非MethodArgumentNotValidException

SpringBoot接口接收json参数

前言

通常来讲,HTTP 方法会映射为 CRUD 动作,但这并不是严格的限制,有时候 PUT 也可以用来创建新的资源,POST 也可以用来更新资源。所以在平时的 Web 开发中,你可能常看到method 的值是 GET 和 POST,但是我们需要养成一个好的编码习惯。

CRUD 动作 HTTP 方法
Create POST
Read GET
Update PUT(全部资源) 或 PATCH(部分资源)
Delete DELETE

前提

首先在controller上加上注解:@RestController

@RestController
@RequestMapping("/user")
@Api(tags = "user", description = "用户控制器")
public class UserController {
    // ...
}

详细介绍

一、GET

1)@PathVariable 获取路径参数。即 url/{id} 这种形式。

    @GetMapping("/getDetail/{id}")
    @ApiOperation(value = "根据id获取用户")
    public RbacUser getDetail(@PathVariable Long id) {
        return userService.getById(id);
    }

2)@RequestParam 获取查询参数。即 url?name=xx 这种形式

主要有参数:

  • value:参数名字,即入参的请求参数名字,如username表示请求的参数区中的名字为username的参数的值将传入;
  • required:是否必须,默认是true,表示请求中一定要有相应的参数,否则会报错;
    @GetMapping("/getByAccount")
    @ApiOperation(value = "根据账号获取用户")
    public RbacUser getByAccount(@RequestParam(required = false) String account) {
        return userService.getByAccount(account);
    }

3) 直接封装DTO参数形式

    @GetMapping("/find")
    @ApiOperation(value = "根据条件获取用户")
    public List<RbacUser> find(RbacUserDTO rbacUserDTO) {
        return userService.find(rbacUserDTO);
    }

二、DELETE

@PathVariable 获取路径参数。即 url/{id} 这种形式。

    @DeleteMapping("/delete/{id}")
    @ApiOperation(value = "删除用户")
    public void delete(@PathVariable Long id) {
        userService.delete(id);
    }

三、POST/PUT/PATCH

@RequestBody 将HTTP请求正文插入方法中,使用适合的 HttpMessageConverter 将请求体写入某个对象。

    @PostMapping("/create")
    @ApiOperation(value = "创建用户")
    public RbacUser getByAccount(@RequestBody @Validated RbacUserDTO rbacUserDTO) {
        return userService.save(rbacUserDTO);
    }
  • @Validated:对数据进行校验,以下注解报错会直接返回,如果校验类中包含一个对象引用属性,需要在属性上加上@Valid注解

具体参数检验请参看下面

Springboot restFul 参数检验

概述

对请求参数进行检验,这在web中开始经常能碰到,如果用一个个if/else去做判断,相信这样的代码可读性会比较差

JSR-303 是java为bean数据合法性校验提供的标准框架,是Java EE6中的一项子规范,叫做BeanValidation。JSR303通过在Bean属性上标注@NotNull、@Max等标准的注解指定校验规则,并通过这些标准的验证接口对Bean进行验证。

规定一些检验规范即校验注解,如@Null, @NotNull, @Pattern,位于javax.validation.constraints包下,只提供规范 不提供实现。

在Spring中,有两种方式可以验证输入,一是利用Spring自带的验证框架,二是利用JSR-303的实现,一般建议使用JSR-303的实现,比如Hibernate-Validator。

Hibernate-Validator 是JSR-303的实现。Hibernate Validator提供了JSR-303规范中所有内置constraint的实现,除此之外还有一些附加的constraint,如@Email, @Length, @Range等,位于org.hibernate,validator.constraints包下。

spring-boot-starter-web包里面已经有了hibernate-vlidator包,不需要额外引用hibernate validator依赖。

同时Spring为了给开发者提供便捷,对Hibernate-Validator进行了二次封装,封装了LocalValidatorFactorBean作为validator的实现,这个类兼容了Spring的Validation体系和Hibernate的Validation体系,LocalValidatorFactorBean已经成为了Validator的默认实现。

说明:JSR-349是JSR-303的升级版,添加了一些新特性

如下图,是spring boot 2.1.1中hibernate依赖情况:

常用注解

属性 描述 举例
@AssertTrue 应用于boolean属性,该属性值必须为true
@AssertTrue

boolean isOkay;

@AssertFalse 应用于boolean属性,该属性值必须为false
@AssertFalse

boolean isOkay;

@DecimalMax 只能小于或等于指定值
@DecimalMax("1.1")

BigDecimal price;

@DecimalMin 只能大于或等于指定值
@DecimalMin("1.1")

BigDecimal price;

@Digits 该属性值必须在指定范围内,interger属性定义该数值的最大整数部分,fraction属性定义该数值的最大 小数部分
@Digits(integer=5, fraction=2)

BigDecimal price;

@Future 检查该字段是否是属于未来的日期
@Future

Date shippingDate;

@Max 该字段的值只能小于或等于该值
@Max(20)

int age;

@Min 该字段的值只能大于或等于该值
@Min(20)

int age;

@NotNull 该字段不能为Null
@NotNull

String name;

@Null 该字段必须是Null
@Null

String dest;

@Past 该字段必须是过去的一个日期
@Past

Date birthDate;

@Size 检查该字段的size是否在min和max之间,可以是字符串、数组、集合、Map等
@Size(min=2, max=10)

String description;

@Pattern 该属性值必须与指定的常规表达式相匹配
@Pattern(regexp="\\d{3}")

String areaCode;

@NotBlank 只用于String, 不能为Null且trim()之后size>0
@NotBlank

String src;

@NotEmpty 不能为Null,且size>0
@NotEmpty

String src;

@Email 被注释的元素必须是电子邮箱地址
@Length 被注释的字符串String 大小必须在指定范围内
@Length(min=6, max=12, message="密码长度必须在6~12")

String src;

@Range BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型,验证注解的元素值在最小值和最大值之间
@Valid
指定递归验证(下篇讲)关联的对象;

如用户对象中有个地址对象属性,如果想在验证用户对象时一起验证地址对象的话,在地址对象上加@Valid注解即可级联验证

简单应用举例

需要检验的Bean定义:

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁")
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getPhoneNum() {
        return phoneNum;
    }

    public void setPhoneNum(String phoneNum) {
        this.phoneNum = phoneNum;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

返回错误字段定义:

public class ArgumentsInvalidResponseBean {
    private String argumentName;
    private String exceptionMsg;

    public ArgumentsInvalidResponseBean() {
    }

    public ArgumentsInvalidResponseBean(String argumentName, String exceptionMsg) {
        this.argumentName = argumentName;
        this.exceptionMsg = exceptionMsg;
    }

    public String getArgumentName() {
        return argumentName;
    }
    public void setArgumentName(String argumentName) {
        this.argumentName = argumentName;
    }

    public String getExceptionMsg() {
        return exceptionMsg;
    }
    public void setExceptionMsg(String exceptionMsg) {
        this.exceptionMsg = exceptionMsg;
    }
}

全局异常处理:

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public List<ArgumentsInvalidResponseBean> methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException ex){
        System.out.println("===================methodArgumentNotValidExceptionHandler Occur============");

        List<ArgumentsInvalidResponseBean> argumentsInvalidResponseBeanList = new ArrayList<>();
        for (FieldError error : ex.getBindingResult().getFieldErrors()){
            ArgumentsInvalidResponseBean bean = new ArgumentsInvalidResponseBean();
            bean.setArgumentName(error.getField());
            bean.setExceptionMsg(error.getDefaultMessage());

            argumentsInvalidResponseBeanList.add(bean);
        }
        return argumentsInvalidResponseBeanList;
    }

测试代码:

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Valid @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

在PostMan中测试:

注意这里,年龄和邮箱是有错误的,运行后查看返回值,具体如下:

自定义校验

新建注解类 MyConstraint:

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyConstraintValidator.class)
public @interface MyConstraint {
    String message() default "这是一个自定义注解,检测输入是否大写";
    Class<?>[] groups() default {};

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

实现MyConstraintValidator:

public class MyConstraintValidator implements ConstraintValidator<MyConstraint, String> {
    @Override
    public void initialize(MyConstraint constraintAnnotation) {
        System.out.println("+++++++++++++myConstraint init");
    }

    @Override
    public boolean isValid(String o, ConstraintValidatorContext constraintValidatorContext) {
        if (!o.equals(o.toUpperCase())){
            System.out.println("输入信息必须是大写");
            return false;
        }
        return true;
    }
}

当输入信息不是全大写字符时,则检验不通过

使用:

在上面StudentBean中加入检验

  @MyConstraint
  private String className;

测试:

结果如下:

这时说明自定义检验可以工作了

抛出BindException而非MethodArgumentNotValidException

当请求中 Content-Type为“application/x-www-form-urlencoded”时,Spring会把数据解析成 web form data而非json,会使用 FormHttpMessageConverter来转换post的body 并且异常转为BindException。

如果我们想要Spring把POST数据认为是json并且使用MappingJackson2HttpMessageConverter来解析数据,可以把Content-Type设置成 application/json

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

(0)

相关推荐

  • SpringBoot过滤器如何获取POST请求的JSON参数

    目录 SpringBoot过滤器获取POST请求的JSON参数 想到了使用过滤器来实现这个功能 所以我们可以通过获取到输入流来获取body 从源码我们可以看到 我们创建一个类并继承这个包装类 有一点需要注意的 SpringBoot过滤器获取POST请求的JSON参数 项目中需要将每个请求的路径和请求参数以及响应结果,都记录在日志中,这样在出现问题时可以快速定位是哪里出现了问题. 想到了使用过滤器来实现这个功能 当请求来到过滤器时,会有一个Request参数,通过该参数就能获取到请求路径和请求参数

  • SpringBoot学习之Json数据交互的方法

    JSON知识讲解 JSON的定义 JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式.它基于 ECMAScript (欧洲计算机协会制定的js规范)的一个子集,采用完全独立于编程语言的文本格式来存储和表示数据.简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言. 易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率. 解释来自于百度百科,说简单点.JSON就是一串字符串 只不过元素会使用特定的符号标注. JSON

  • 详解Springboot之接收json字符串的两种方式

    第一种方式.通过关键字段@RequestBody,标明这个对象接收json字符串.还有第二种方式,直接通过request来获取流.在spring中,推荐使用. 代码地址 https://gitee.com/yellowcong/springboot-demo/tree/master/springboot-json 项目结构 其实项目里面没啥类容,就是一个控制器和pom.xml配置 配置fastjson 添加fastjson的依赖到pom.xml中 <dependency> <groupI

  • SpringBoot接口接收json参数解析

    目录 SpringBoot接口接收json参数 前言 前提 一.GET 二.DELETE 三.POST/PUT/PATCH Springboot restFul 参数检验 概述 常用注解 简单应用举例 自定义校验 抛出BindException而非MethodArgumentNotValidException SpringBoot接口接收json参数 前言 通常来讲,HTTP 方法会映射为 CRUD 动作,但这并不是严格的限制,有时候 PUT 也可以用来创建新的资源,POST 也可以用来更新资源

  • springboot接口接收数组及多个参数的问题及解决

    目录 springboot接口接收数组及多个参数问题 springboot接收复杂集合参数,集合对象 springboot接口接收数组及多个参数问题 本例为个人经历,必然存在认知局限与不足,欢迎指正以及提供更好方法. 若接口中需要接受数组,那么接口应该如何写呢? 一般而言我们会想到 @PostMapping("/xxxx") public String test(List list){ do sth; } 假设我们写的接口正确,写完接口我希望使用postman来测试一下 params中

  • springboot中PostMapping正常接收json参数后返回404问题

    目录 PostMapping接收json参数后返回404 问题描述 解决 @PostMapping注解解析 PostMapping接收json参数后返回404 问题描述 js中传递json数据给后端,后端可以正常接收参数,但返回404. js                 function rootConfirm(ids, types) {                     $.tool.confirm("确定结束" + options.modalName + "?&

  • SpringBoot如何接收数组参数的方法

    1.创建一个表单实体类,将数组封装到实体类中(Post提交) 表单类代码: @Data public class MyForm { private int[] ids; } 控制器代码: @Slf4j @RestController @RequestMapping("/info") public class InfoController { @PostMapping("/test") public String test(@RequestBody MyForm fo

  • SpringBoot接口如何对参数进行校验

    目录 前言 什么是不优雅的参数校验 实现案例 POM 请求参数封装 Controller中获取参数绑定结果 校验结果 进一步理解 Validation分组校验? @Validate和@Valid什么区别? 有哪些常用的校验? 自定义validation? 前言 在以SpringBoot开发Restful接口时, 对于接口的查询参数后台也是要进行校验的,同时还需要给出校验的返回信息放到上文我们统一封装的结构中.那么如何优雅的进行参数的统一校验呢? 什么是不优雅的参数校验 后端对前端传过来的参数也是

  • Spring boot中自定义Json参数解析器的方法

    一.介绍 用过springMVC/spring boot的都清楚,在controller层接受参数,常用的都是两种接受方式,如下 /** * 请求路径 http://127.0.0.1:8080/test 提交类型为application/json * 测试参数{"sid":1,"stuName":"里斯"} * @param str */ @RequestMapping(value = "/test",method = Re

  • Springboot 接口需要接收参数类型是数组问题

    目录 接口需要接收参数类型是数组 多个参以“,”拼接传递即可 那么除了这样,我们还能怎么协调呢? springboot接口接收数组及多个参数问题 若接口中需要接受数组,那接口应该如何写呢? 在body中用json格式传参数不就好了吗! 问题解决- 接口需要接收参数类型是数组 如题,一般我们普遍采用的协调方式: 多个参以“,”拼接传递即可 如: 那么除了这样,我们还能怎么协调呢? 其实对应get请求,springmvc内部是已经支持了这种以“,”逗号拼接的方式,也就是说,传参方式不变,但是我们后台

  • SpringBoot之使用枚举参数案例详解

    接口开发过程中不免有表示类型的参数,比如 0 表示未知,1 表示男,2 表示女.通常有两种做法,一种是用数字表示,另一种是使用枚举实现. 使用数字表示就是通过契约形式,约定每个数字表示的含义,接口接收到参数,就按照约定对类型进行判断,接口维护成本比较大. 在 Spring 体系中,使用枚举表示,是借助 Spring 的 Converter 机制,可以将数字或字符串对应到枚举的序号或者 name,然后将前端的输入转换为枚举类型. 在场景不复杂的场景中,枚举可以轻松胜任. 于是,迅速实现逻辑,准备提

  • SpringBoot实现接口的各种参数校验的示例

    目录 1.添加依赖 2.接口参数校验 2.1 requestBody参数校验 2.2 requestParam/PathVariable参数校验 3.统一异常处理 4.进阶使用 4.1 分组校验 4.2 嵌套校验 4.3 集合校验 4.4 自定义校验 5.快速失败 (Fail Fast) 6.@Valid和@Validated区别 7.实现原理 7.1 requestBody参数校验实现原理 7.2 方法级别的参数校验实现原理 在我们进行接口开发时,在对参数的接收时,我们需要冗余复杂的校验规则

随机推荐