spring boot常见get 、post请求参数处理、参数注解校验、参数自定义注解校验问题解析

更新时间：2023年09月11日 14:55:43 作者：BraveSoul360

这篇文章主要介绍了spring boot常见get 、post请求参数处理、参数注解校验、参数自定义注解校验,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

spring boot 常见http get ,post请求参数处理

在定义一个Rest接口时通常会利用GET、POST、PUT、DELETE来实现数据的增删改查；这几种方式有的需要传递参数，后台开发人员必须对接收到的参数进行参数验证来确保程序的健壮性
GET
一般用于查询数据，采用明文进行传输，一般用来获取一些无关用户信息的数据
POST
一般用于插入数据
PUT
一般用于数据更新
DELETE
一般用于数据删除
一般都是进行逻辑删除（即：仅仅改变记录的状态，而并非真正的删除数据）

@PathVaribale 获取url中的数据
@RequestParam 获取请求参数的值
@GetMapping 组合注解，是 @RequestMapping(method = RequestMethod.GET) 的缩写
@RequestBody 利用一个对象去获取前端传过来的数据

PathVaribale 获取url路径的数据

请求URL：localhost:8080/hello/id 获取id值

实现代码如下：

@RestController
public class HelloController {
    @RequestMapping(value="/hello/{id}/{name}",method= RequestMethod.GET)
    public String sayHello(@PathVariable("id") Integer id,@PathVariable("name") String name){
        return "id:"+id+" name:"+name;
    }
}

在浏览器中

输入地址：localhost：8080/hello/100/hello

输出：id:81name:hello

RequestParam 获取请求参数的值

获取url参数值，默认方式，需要方法参数名称和url参数保持一致localhost:8080/hello?id=1000

@RestController
public class HelloController {
    @RequestMapping(value="/hello",method= RequestMethod.GET)
    public String sayHello(@RequestParam Integer id){
        return "id:"+id;
    }
}

输出：

id：100

url中有多个参数时，如：localhost:8080/hello?id=98&&name=helloworld具体代码如下：

@RestController
public class HelloController {
    @RequestMapping(value="/hello",method= RequestMethod.GET)
    public String sayHello(@RequestParam Integer id,@RequestParam String name){
        return "id:"+id+ " name:"+name;
    }
}

获取url参数值，执行参数名称方式localhost:8080/hello?userId=1000

@RestController
public class HelloController {
    @RequestMapping(value="/hello",method= RequestMethod.GET)
    public String sayHello(@RequestParam("userId") Integer id){
        return "id:"+id;
    }
}

输出：

id：100

注意

不输入id的具体值，此时返回的结果为null。具体测试结果如下：id：null不输入id参数，则会报如下错误：whitelable Error Page错误

GET参数校验

用法：不输入id时，使用默认值具体代码如下：localhost：8080/hello

@RestController
public class HelloController {
    @RequestMapping(value="/hello",method= RequestMethod.GET)
    //required=false 表示url中可以无id参数，此时就使用默认参数
    public String sayHello(@RequestParam(value="id",required = false,defaultValue = "1") Integer id){
        return "id:"+id;
    }
}

输出

id:1

POST JSON参数校验

常用校验注解

这里写图片描述

注意：

接收到的参数默认都是字符串类型的

有的注解只能用在String类型的属性上

@JsonProperty可以实现前端的属性名和后台实体类的属性名不一致问题

校验方式：
使用@RequestBody @Valid 对JSON参数进行获取和校验。
通过BindingResult bindingResult 去获取校验结果。

BindingResult 源码：

这里写图片描述

技巧01：利用BindingResult对象的hasErrors方法判断是否有参数错误

技巧02：利用BindingResult对象的getFieldErrors方法获取所有有参数错误的属性

技巧03：利用错误属性对象的getDefaultMessage去获取错误提示信息

@RequestMapping(value = "/demo5",produces = MediaType.TEXT_PLAIN_VALUE)
    @ResponseBody
    public String test5(@RequestBody @Valid  User user , BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> objectErrors = bindingResult.getAllErrors();
            System.out.println(objectErrors.toString());
            for(ObjectError objectError: objectErrors){
                System.out.println("objectError = " + objectError.getObjectName());
                System.out.println("objectError = " + objectError.getDefaultMessage());
                System.out.println("objectError = " + objectError.getCode());
                System.out.println("objectError = " + objectError.getArguments());
            }
        }
        String str =  user.toString();
        return str;
    }

对应User实体类代码：

public class User {
    @NotEmpty(message = "ID不能为空")
    @NotBlank(message = "ID不能为空哟")
    private String id;
    @Min(value = 18)
    @Max(value = 30)
    private Integer age;
    @NotEmpty(message = "昵称不能为空")
    @NotBlank(message = "昵称不能为空哟")
    @JsonProperty("nickname") //  当前端属性为nick后台接收对象的属性为nickName时可以用@JsonProperty来保持一致
    private String name;
    ....省略get set方法

自定义注解校验

1、定义一个校验注解

代码如下：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Constraint(validatedBy = MyFormValidatorClass.class)
public @interface MyFormValidator {
    String value();
    String message() default "name can be test";
    Class<?>[] groups() default {};
    Class<? extends Payload>[]  payload() default {};
}

2、定义一个约束校验

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.lang.annotation.Annotation;
public class MyFormValidatorClass implements ConstraintValidator<MyFormValidator, Object>, Annotation {
    private String values;
    @Override
    public void initialize(MyFormValidator myFormValidator) {
        this.values = myFormValidator.value();
    }
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if("test".equals((String)value)){
            return true;
        }
        return false;
    }
    @Override
    public Class<? extends Annotation> annotationType() {
        return null;
    }
}

3、实体类中使用

public class User2 {
    @NotEmpty(message = "ID不能为空")
    @NotBlank(message = "ID不能为空哟")
    //自定义校验注解-校验id是否为test
    @MyFormValidator(value = "abc",message = "dd")
    private String id;
    @Min(value = 18)
    @Max(value = 30)
    private Integer age;
    @NotEmpty(message = "昵称不能为空")
    @NotBlank(message = "昵称不能为空哟")
    @JsonProperty("nickname") //  当前端属性为nick后台接收对象的属性为nickName时可以用@JsonProperty来保持一致

4、测试代码：

@RequestMapping(value = "/demo6",produces = MediaType.TEXT_PLAIN_VALUE)
    @ResponseBody
    public String test6(@RequestBody @Valid User2 user , BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> objectErrors = bindingResult.getAllErrors();
            System.out.println(objectErrors.toString());
            for(ObjectError objectError: objectErrors){
                System.out.println("objectError = " + objectError.getObjectName());
                System.out.println("objectError = " + objectError.getDefaultMessage());
                System.out.println("objectError = " + objectError.getCode());
                System.out.println("objectError = " + objectError.getArguments());
            }
        }
        String str =  user.toString();
        return str;
    }

当请求参数ID不为test，objectErrors 中有该报错。

到此这篇关于spring boot常见get 、post请求参数处理、参数注解校验、参数自定义注解校验的文章就介绍到这了,更多相关spring boot参数注解校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Spring中@Scope的几种取值方式
这篇文章主要介绍了Spring中@Scope的几种取值方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
java自定义线程池的原理简介
这篇文章主要介绍了java自定义线程池的原理详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
当Mybatis遇上目录树超全完美解决方案
这篇文章主要介绍了当Mybatis遇上目录树有哪些解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-04-04
springboot在服务器上的几种启动方式(小结)
这篇文章主要介绍了springboot在服务器上的几种启动方式(小结)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-09-09
通过简易例子讲解Java回调机制
这篇文章主要介绍了通过简易例子讲解Java回调机制,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-11-11
JAVA JNI原理详细介绍及简单实例代码
这篇文章主要介绍了JAVA JNI原理的相关资料,这里提供简单实例代码，需要的朋友可以参考下
2016-12-12
深入理解Java8新特性之Lambda表达式的基本语法和自定义函数式接口
Lambda 表达式，也可称为闭包，它是推动 Java 8 发布的最重要新特性。Lambda 允许把函数作为一个方法的参数（函数作为参数传递进方法中）。使用 Lambda 表达式可以使代码变的更加简洁紧凑
2021-11-11
SpringBoot 整合 JMSTemplate的示例代码
这篇文章主要介绍了SpringBoot 整合 JMSTemplate的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
SpringBoot获取配置文件内容的几种方式总结
大家都知道SpringBoot获取配置文件的方法有很多,下面这篇文章主要给大家介绍了关于SpringBoot获取配置文件内容的几种方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-02-02
带你了解Java常用类小结
今天带大家学习Java常用工具类,文中有非常详细的图文解说及代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下，希望能给你带来帮助
2021-07-07