SpringBoot项目中rest接口定义与参数传递和接收方式

 更新时间:2026年04月02日 09:04:44   作者:撞撞~  
本文介绍了使用RestClient测试接口的两种方式:form-data和content-type,form-data适用于所有请求方式,但URL长度有限制,content-type只适用于POST/DELETE/PUT请求,处理application/json格式参数,对于参数较多的情况,建议使用JavaBean接收

建议使用rest Client测试接口

方式一:form-data形式

参数以key-value形式传递,参数和值会直接拼接到请求url后边显示存在(POST http://localhost:8080/users/insert?id=5&userName=刘明);

适用于所有请求方式;

后台接收参数时使用注解@RequestParam

POST

提交资源时一般post请求方式,当然所有的增删改也可已使用post请求

使用@RequestParam(value = “key”) 绑定请求参数到方法入参时,参数名可以不与前台key一致

@RestController
@RequestMapping("/users")
public class UsersController {
    @PostMapping("/insert")
    public RestResult insertUserInfo(@RequestParam("userId") int id, String userName, String passWord, int age,String sex, String phone) {...}
}

请求参数可以这样显示接收,也可以从 request 中获取

insertUserInfo(HttpServletRequest request) {
        String userId = request.getParameter("userId");
        String phone = request.getParameter("phone");
		...
}

如果请求参数为定义的对象属性时,可以直接使用对象接收参数

public class User {
    private int id;
    private String userName;
    private String passWord;
    private int age;
    private String sex;
    private String phone;
}
@PostMapping("/insert")
    public RestResult insertUserInfo(User user) {...}

DELETE

删除资源

使用@PathVariable 获取url路径中的参数

@DeleteMapping("/delete/{id}")
public RestResult deleteUser(@PathVariable("id") int userId) {...}

PUT

更新资源

@PutMapping("/update/{id}")
public RestResult updateUser(@PathVariable int id, String phone) {...}

GET

获取资源

@GetMapping("/query/{id}")
    public RestResult queryUser(@PathVariable int id) {...}

方式二、content-type形式

因为GET请求头中无content-type字段,所以此种方式只适用于POST/DELETE/PUT请求,用来处理:applicatin/json格式的参数

参数以json形式传递,后台获取参数时使用注解@RequestBody

@PostMapping("/insert")
    public RestResult insertUserInfo(@RequestBody User user) {...}

我们也可以使用@JsonProperty 注解来绑定Json中的key和Bean实体的属性

这时候,前台在传递参数时,可以使用与属性名一致,也可以与注解中的value一致

但是这里得注意:这里返回给前台的json对象中的key将会是直接中的值

public class User {
    private Integer id;
    @JsonProperty("name")
    private String userName;
    @JsonProperty("pass")
    private String passWord;
    private Integer age;
    private String sex;
    private String phone;
}

总结

很明显,方式一在传递参数时,如果传入的参数太长时,或许会超过某些浏览器与服务器对URL的长度限制,会导致请求失败,因此在实际应用中,对于GET请求我们一般使用form表单形式传递参数,POST/DELETE/PUT请求我们考虑使用方式二;

对于请求参数过多的,我们可以使用Java Bean来接收参数

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

相关文章

  • Java设计模式之java命令模式详解

    Java设计模式之java命令模式详解

    这篇文章主要介绍了Java设计模式编程中命令模式的使用,在一些处理请求响应的场合经常可以用到命令模式的编程思路,需要的朋友可以参考下
    2021-09-09
  • Java中for与foreach的区别

    Java中for与foreach的区别

    本文主要介绍了Java中for与foreach的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-05-05
  • JAVA正则表达式提取key-value类型字符值代码实例

    JAVA正则表达式提取key-value类型字符值代码实例

    这篇文章主要给大家介绍了关于JAVA正则表达式提取key-value类型字符值的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-10-10
  • java判断各类型字符个数实例代码

    java判断各类型字符个数实例代码

    大家好,本篇文章主要讲的是java判断各类型字符个数实例代码,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下,方便下次浏览
    2021-12-12
  • SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验

    SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验

    我们经常需要对请求参数进行校验,本文主要介绍了SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验,具有一定的参考价值,感兴趣的可以了解一下
    2024-08-08
  • Java中的jinfo命令使用详解

    Java中的jinfo命令使用详解

    jinfo是JDK提供的一个可以实时查看Java虚拟机各种配置参数和系统属性的命令行工具,本文给大家介绍下Java中的jinfo命令使用,感兴趣的朋友一起看看吧
    2022-03-03
  • Spring自定义配置Schema可扩展(二)

    Spring自定义配置Schema可扩展(二)

    这篇文章主要介绍了Spring自定义配置Schema可扩展(二)的相关资料,需要的朋友可以参考下
    2016-01-01
  • Java Integer.valueOf()和Integer.parseInt()的区别说明

    Java Integer.valueOf()和Integer.parseInt()的区别说明

    这篇文章主要介绍了Java Integer.valueOf()和Integer.parseInt()的区别说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • spring通过导入jar包和配置xml文件启动的步骤详解

    spring通过导入jar包和配置xml文件启动的步骤详解

    这篇文章主要介绍了spring通过导入jar包和配置xml文件启动,本文分步骤通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • Java BitMap源码仿写实现

    Java BitMap源码仿写实现

    这篇文章主要介绍了Java BitMap源码仿写实现,所谓bitmap,就是用每一位来存放某种状态,适用于大规模数据,但数据状态又不是很多的情况。通常是用来判断某个数据存不存在的
    2022-12-12

最新评论