SpringBoot请求与响应实例全解析

更新时间：2026年04月29日 09:44:06 作者：PowerCodejt

文章主要介绍了SpringBoot中请求与响应的处理方式,包括简单参数、实体参数、数组集合参数、日期参数、JSON参数和路径参数的处理,同时,还介绍了响应的处理,包括@ResponseBody注解和统一响应结果类的设计

Spring Boot请求与响应

一、请求

1.简单参数

1.1请求参数名称与方法形参名称一致

@RestController
public class RequestController {
     @RequestMapping("/easyParam")
    public String simpleParam(String name ,Integer age){
        //获取请求参数
        return name+":::"+age;
    }
}

postman测试( GET 请求)

postman测试( POST请求 )

结论：不论是GET请求还是POST请求，对于简单参数来讲，只要保证请求参数名和Controller方法中的形参名保持一致，就可以获取到请求参数中的数据值。

1.2请求参数名称与方法形参名称一致

@RequestMapping("/simpleParam")
public String simpleParam(String username , Integer age ){//请求参数名和形参名不相同
    return username+"  :  "+age;
}

结论：对于简单参数来讲，请求参数名和controller方法中的形参名不一致时，无法接收到请求数据。

解决方案：可以使用Spring提供的@RequestParam注解完成映射

    public String simpleParam(@RequestParam("name") String username , Integer age ){//请求参数名和形参名不相同
    return username+"  :  "+age;
}

如果该参数是可选的，可以将required属性设置为false

@RequestMapping("/easyParam")
    public String simpleParam(@RequestParam(value = "name",required = false) String username , Integer age ){//请求参数名和形参名不相同
        return username+"  :  "+age;
    }

2.实体参数

请求参数封装到一个实体类对象中。请求参数名与实体类的属性名相同

2.1 简单实体对象

定义POJO实体类：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    private String name;
    private Integer age;      
}

Controller方法：

@RequestMapping("/easyPojo")
    public String simplePojo(Student student){
        return "name = "+student.getName()+", age = "+student.getAge()+";
    }

[说明]参数名和实体类属性名一致时,参数值才会传递，参数名和实体类属性名不一致时,不传递值2.2 复杂实体对象

复杂实体对象指的是，在实体类中有一个或多个属性，也是实体对象类型的。如下：

Student类中有一个Address类型的属性（Address是一个实体类）

复杂实体对象的封装，需要遵守如下规则：

请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套实体类属性参数。

定义POJO实体类：

Address实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Address {
    private String province;
    private String city;
}

Student实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
private String name;
private Integer age;
private Address address;
}

Controller方法：

@RestController
public class RequestController {
    //实体参数：复杂实体对象
    @RequestMapping("/complexPojo")
    public String complexPojo(Student student){
        return "name = "+student.getName()+
                ", age = "+student.getAge()+
                ", job = "+student.getJob()+
        ", address.city = "+student.getAddress().getCity()+
        ", address.province = "+student.getAddress().getProvince();
    }
}

Postman测试：

3.数组集合参数

数组集合参数的使用场景：在HTML的表单中，有一个表单项是支持多选的(复选框)，可以提交选择的多个值。

后端程序接收上述多个值的方式有两种：数组、集合 3.1 数组

数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数

Controller方法：

    //数组集合参数
    @RequestMapping("/arrayParam")
    public String arrayParam(String[] course){
        System.out.println(Arrays.toString(course));
        return "课程: "+Arrays.toString(course);
    }

Postman测试：

3.2 集合

默认情况下，请求中参数名相同的多个值，是封装到数组。如果要封装到集合，要使用@RequestParam绑定参数关系

Controller方法：

 //数组集合参数
    @RequestMapping("/listParam")
    public String listParam(@RequestParam List<String> course){
        return "课程: "+course;
    }

Postman测试：

3日期参数

日期类型的参数在进行封装的时候，需要通过@DateTimeFormat注解，以及其pattern属性来设置日期的格式。

使用@DateTimeFormat注解设置日期类型数据格式，默认格式yyyy/MM/dd。

@DateTimeFormat注解的pattern属性中指定了哪种日期格式，前端的日期参数就必须按照指定的格式传递。后端controller方法中，需要使用Date类型或LocalDateTime类型，来封装传递的参数。

Controller方法：

//日期时间参数
    @RequestMapping("/dataParam")
    public String dataParam(Date date,
                            @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                            @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
        System.out.println("参数传递 date ==> "+date);
        System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
        System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
        return "{'module':'data param'}";
    }

Postman测试：

3.4 JSON参数前后端分离后，前端向后台会传递JSON格式数据,进行交互。 Postman发送JSON格式数据：

服务端Controller方法接收JSON格式数据：

传递json格式的参数，在Controller中会使用实体类进行封装。封装规则：JSON数据键名与形参对象属性名相同，定义POJO类型形参即可接收参数。需要使用 @RequestBody标识。 @RequestBody注解：将JSON数据映射到形参的实体类对象中（JSON中的key和实体类中的属性名保持一致） Controller方法：

//5. json参数
    @RequestMapping("/jsonParam")
    public String jsonParam(@RequestBody Student student){
        return "name = "+student.getName()+
                ", age = "+student.getAge()+               
                ", address.city = "+student.getAddress().getCity()+
                ", address.province = "+student.getAddress().getProvince();
    }

Postman测试：

3.5路径参数传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递(GET请求)。

在现在的开发中，经常还会直接在请求的URL中传递参数。例如：

http://localhost:8080/path/1  
http://localhost:880/path/1/0

路径参数：

前端：通过请求URL直接传递参数后端：使用{…}来标识该路径参数，需要使用@PathVariable获取路径参数

Controller方法：

//路径参数
    @RequestMapping("/path/{id}")
    public String pathParam(@PathVariable Integer id){
        return "id = "+id;
    }

Postman测试：

传递多个路径参数：

Controller方法：

二、响应

2.1 @ResponseBody 前面所编写的controller方法中，都已经设置了响应数据。

思考：controller方法中的return的结果，怎么就可以响应给浏览器呢？

答案：使用@ResponseBody注解

@ResponseBody注解：

类型：方法注解、类注解位置：书写在Controller方法上或类上作用：将方法返回值直接响应给浏览器如果返回值类型是实体对象/集合，将会转换为JSON格式后在响应给浏览器但是在Controller中，只在类上添加了@RestController注解、方法添加了@RequestMapping注解，并没有使用@ResponseBody注解，怎么给浏览器响应呢？

原因是在类上添加的@RestController注解，是一个组合注解。

@RestController = @Controller + @ResponseBody 在类上添加@RestController就相当于添加了@ResponseBody注解。

类上有@RestController注解或@ResponseBody注解时：表示当前类下所有的方法返回值做为响应数据方法的返回值，如果是一个POJO对象或集合时，会先转换为JSON格式，在响应给浏览器。下面测试响应数据：

@RestController
public class ResponseController {
@RequestMapping("/study")
public String study(){
    return "根据SpringBoot开发实战学习SpringBoot";
}
//响应实体对象
@RequestMapping("/getAddr")
public Address getAddr(){
    Address addr = new Address();//创建实体类对象
    addr.setProvince("湖南");
    addr.setCity("衡阳");
    return addr;
}
//响应集合数据
@RequestMapping("/listAddr")
public List<Address> listAddr(){
    List<Address> list = new ArrayList<>();//集合对象
    Address addr = new Address();
    addr.setProvince("湖南");
    addr.setCity("衡阳");
    Address addr2 = new Address();
    addr2.setProvince("湖南");
    addr2.setCity("长沙");
    list.add(addr);
    list.add(addr2);
    return list;
}
}

postman测试：

2.2 统一响应结果开发项目中，controller方法会定义一个统一的返回结果。方案如下：

统一的返回结果使用类来描述，包含：

响应状态码：当前请求是成功，还是失败状态码信息：给页面的提示信息返回的数据：给前端响应的数据（字符串、对象、集合）定义在一个实体类Result来统一响应结果，代码如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
    private Integer code;
    private String message;
    private Object data;
    public static Result success(Object data) {
        return new Result(200, "success", data);
    }
    public static Result success() {
        return new Result(200, "success", null);
    }
    public static Result error(String message) {
        return new Result(500, message, null);
    }
    public static Result error(Integer code, String message) {
        return new Result(code, message, null);
    }
}

改造Controller：

@RestController
public class StudentController {
    @RequestMapping("/stu_study")
    public Result study(){
        return Result.success( "根据SpringBoot开发实战学习SpringBoot");
    }
    //响应实体对象
    @RequestMapping("/stu_getAddr")
    public Result getAddr(){
        Address addr = new Address();//创建实体类对象
        addr.setProvince("湖南");
        addr.setCity("衡阳");
        return Result.success(addr);
    }
    //响应集合数据
    @RequestMapping("/stu_listAddr")
    public Result listAddr(){
        List<Address> list = new ArrayList<>();//集合对象
        Address addr = new Address();
        addr.setProvince("湖南");
        addr.setCity("衡阳");
        Address addr2 = new Address();
        addr2.setProvince("湖南");
        addr2.setCity("长沙");
        list.add(addr);
        list.add(addr2);
        return  Result.success(list);
    }
}

使用Postman测试：

前端只需要按照统一格式的返回结果进行解析。

到此这篇关于SpringBoot请求与响应实例全解析的文章就介绍到这了,更多相关springboot请求与响应内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java判断上传图片格式的实例代码
这篇文章主要介绍了Java判断上传图片格式的实例代码,在文中给大家提到了Java使用文件头的类型判断上传的文件是否为图片类型，需要的朋友可以参考下
2019-06-06
Java技术汇总
本篇文章主要对Java基本知识点和技术点的一些看法和介绍，具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
使用Jackson实现Map与Bean互转方式
这篇文章主要介绍了使用Jackson实现Map与Bean互转方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
解决Spring Security 用户帐号已被锁定问题
这篇文章主要介绍了解决Spring Security 用户帐号已被锁定问题,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
springboot3环境隔离的实现
在开发中,环境很多,本文主要介绍了springboot3环境隔离的实现，能够快速切换开发、测试、生产环境，具有一定的参考价值，感兴趣的可以了解一下
2024-03-03
JAVA实现SOCKET多客户端通信的案例
这篇文章主要介绍了JAVA实现SOCKET多客户端通信的案例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
Spring Boot 直接用jar运行项目的方法
这篇文章主要介绍了Spring Boot 直接用jar运行项目的方法，非常不错，具有参考借鉴价值，需要的朋友参考下
2018-02-02
Spring Boot 钩子全集实战EnvironmentPostProcessor全解
文章详细介绍了SpringBoot中的EnvironmentPostProcessor扩展点,该点在配置加载阶段提供强大的定制化能力,适用于配置中心化、加密解密、动态覆盖和校验等场景,感兴趣的朋友跟随小编一起看看吧
2026-01-01
Java中LinkedHashSet的实现原理详解
这篇文章主要介绍了Java中LinkedHasSet的实现原理详解,LinkedHashSet 是具有可预知迭代顺序的 Set 接口的哈希表和链接列表实现,此实现与HashSet 的不同之处在于,后者维护着一个运行于所有条目的双重链接列表,需要的朋友可以参考下
2023-09-09
一文带你初识java中的String类
String代表字符串,Java 程序中的所有字符串字面值(如 "abc" )都作为此类的实例实现,这篇文章主要给大家介绍了关于java中String类的相关资料,需要的朋友可以参考下
2021-10-10

SpringBoot请求与响应实例全解析

目录

Spring Boot请求与响应

一、请求

二、响应

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具