SpringBoot常见get/post请求参数处理、参数注解校验及参数自定义注解校验详解

更新时间：2022年03月14日 11:58:39 作者：BraveSoul360

这篇文章主要给大家介绍了关于SpringBoot常见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 中有该报错。

总结

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

您可能感兴趣的文章:

关于Spring事务隔离、传播属性与@Transactional注解
这篇文章主要介绍了关于事务隔离、Spring传播属性与@Transactional注解,如果一组处理步骤或者全部发生或者一步也不执行，我们称该组处理步骤为一个事务,需要的朋友可以参考下
2023-05-05
Spring MVC-@RequestMapping注解详解
@RequestMapping注解的作用，就是将请求和处理请求的控制器方法关联起来，建立映射关系。这篇文章主要给大家介绍了关于SpringMVC中@RequestMapping注解用法,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-04-04
java对数组进行排序的方法
这篇文章主要介绍了java对数组进行排序的方法,涉及java数组排序的技巧,需要的朋友可以参考下
2015-03-03
Spring Boot + Canal 实现数据库实时监控
这篇文章主要介绍了Spring Boot + Canal实现数据库实时监控，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下
2022-08-08
MyBatis-Plus更新对象时将字段值更新为null的四种常见方法
MyBatis-Plus 是一个 MyBatis 的增强工具,在简化开发、提高效率方面表现非常出色,而,在使用 MyBatis-Plus 更新对象时,默认情况下是不会将字段值更新为 null 的,如果你需要将某些字段的值更新为 null,有几种方法可以实现,本文将介绍几种常见的方法
2024-11-11
java实现翻转单词顺序列
这篇文章主要为大家详细介绍了java实现翻转单词顺序列，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-03-03
浅谈SpringSecurity重写默认配置
这篇文章主要介绍了SpringSecurity重写默认配置,包括注入Bean、扩展WebSecurityConfigurerAdapter、重写端点授权配置及实现AuthenticationProvider,感兴趣的可以了解一下
2025-01-01
如何在java 8 stream表达式实现if/else逻辑
这篇文章主要介绍了如何在java 8 stream表达式实现if/else逻辑,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-04-04
Java中Console对象实例代码
这篇文章主要介绍了Java中Console对象实例代码，分享了相关代码示例，小编觉得还是挺不错的，具有一定借鉴价值，需要的朋友可以参考下
2018-02-02
java实现自动回复聊天机器人
这篇文章主要为大家详细介绍了java实现自动回复聊天机器人，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-08-08