Home Spring 请求响应
Post
Cancel

Spring 请求响应

Posted Jan 14, 2024 Updated Jan 16, 2024
By yexca
10 min read

浏览器发送请求会先经过 DispatcherServlet 转给各 *Controller 程序进行处理，处理完成后返回给 DispatcherServlet 处理结果，然后再返回浏览器

DispatcherServlet 被称为核心控制器或前端控制器

对于浏览器请求数据，会被封装到 HttpServletRequest 对象，响应数据被封装到 HttpServletResponse

*Controller 接收请求，设置响应

请求

简单参数

首先为原始方式，获取请求参数通过 HttpServletRequest 对象手动获取

1
2
3
4
5
6
7
8
9

@RequestMapping("/simpleParam")
public String simpleParam(HttpServletRequest request){
    String name = request.getParameter("name");
    String ageStr = request.getParameter("age");

    int age = Integer.parseInt(ageStr);
    System.out.println(name + ";" + age);
    return "OK";
}

当浏览器访问 http://localhost:8080/simpleParam?name=tom&age=18 网页返回字符串 “OK”，程序返回 “Tom;18”

显然这种方式过于麻烦，在 SpringBoot 中可以通过参数名与形参名相同，定义形参即可接收参数

1
2
3
4
5

@RequestMapping("/simpleParam")
public String simpleParam(String name, Integer age){
    System.out.println(name + ";" + age);
    return "OK";
}

效果同上

不过上述方法就是是请求的参数名不同也会继续运行，没有的参数为 null

可以使用 @RequestParam 完成映射实现请求名与形参名不同

1
2
3
4
5
6
7

@RequestMapping("/simpleParam")
public  String simpleParam(@RequestParam(name = "name") String username, Integer age){
    // 当声明@RequestParam后代表该参数必须被传递，不然报错
    // 若更改为@RequestParam(name = "name", required = false)代表该参数不是必须的
    System.out.println(username + ";" + age);
    return "OK";
}

实体参数

如果只是少量的参数用上述可以，但若是较多的数据可以通过简单实体对象，请求参数名与形参对象属性名相同，定义 POJO 接收即可

1
2
3
4
5
6
7
8
9
10
11
12

@RequestMapping("/simplePojo")
public String simplePojo(User user){
    System.out.println(user);
    return "OK";
}

// User类
public class User{
    private String name;
    private Integer age;
    // set get toString 方法
}

访问 http://localhost:8080/simplePojo?name=tom&age=18 网页返回字符串 “OK”，程序返回 “User{name=’tom’, age=18}”

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

@RequestMapping("/complexPojo")
public String complexPojo(UserComplex user){
    System.out.println(user);
    return "OK";
}

// User类
public class UserComplex{
    private String name;
    private Integer age;
    private Address address;
    // set get toString
}

// Address类
public class Address{
    private String province;
    private String city;
    // set get toString
}

访问 http://localhost:8080/complexPojo?name=tom&age=18&address.province=beijing&address.city=beijing 网页返回字符串 “OK”，程序返回 “UserComplex{name=’tom’, age=1000, address=Address{province=’ads,beijing’, city=’asda,beijing’}}”

数组参数

请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接受参数。例如复选框

1
2
3
4
5

@RequestMapping("/arrayParam")
public String arrayParam(String[] hobby){
    System.out.println(Arrays.toString(hobby));
    return "OK";
}

访问 http://localhost:8080/arrayParam?hobby=ads&hobby=58s 网页返回字符串 “OK”，程序返回 “[ads, 58s]”

集合参数

请求参数名与形参数组名称相同且请求参数为多个，@RequestParam 绑定参数关系

1
2
3
4
5

@RequestMapping("/listParam")
public String listParam(@RequestParam List<String> hobby){
    System.out.println(hobby);
    return "OK";
}

访问 http://localhost:8080/listParam?hobby=ads&hobby=58s 网页返回字符串 “OK”，程序返回 “[ads, 58s]”

日期参数

使用 @DateTimeFormat 注解完成日期参数格式转换

需要注意的是传参有三种形式

  • yyyy-MM-dd HH:mm:ss
  • yyyy/MM/dd HH:mm:ss
  • yyyy年MM月dd日 HH时mm分ss秒

需要前后端统一才可

1
2
3
4
5

@RequestMapping("/dateParam")
public String dateParam(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime localDateTime){
    System.out.println(localDateTime);
    return "OK";
}

访问 http://localhost:8080/dateParam?localDateTime=2024-01-01%2001:01:01 网页返回字符串 “OK”，程序返回 “2024-01-01T01:01:01”

JSON 参数

JSON 数据键名与形参对象属性名相同，定义 POJO 类型形参即可接收参数，需要使用 @RequestBody 标识

若要传输 JSON 数据，必须使用 POST 请求

1
2
3
4
5

@RequestMapping("/jsonParam")
public String jsonParam(@RequestBody UserComplex userComplex){
    System.out.println(userComplex);
    return "OK";
}

请求数据

1
2
3
4
5
6
7
8

{
    "name": "jane",
    "age": "18",
    "address": {
        "province": "上海",
        "city": "上海"
    }
}

使用 POST 方法请求 http://localhost:8080/jsonParam 数据如上，网页返回字符串 “OK”，程序返回 “UserComplex{name=’jane’, age=18, address=Address{province=’上海’, city=’上海’}}”

路径参数

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

1
2
3
4
5

@RequestMapping("/path/{id}")
public String pathParam(@PathVariable Integer id){
    System.out.println(id);
    return "OK";
}

访问 http://localhost:8080/path/52 网页返回字符串 “OK”，程序返回 “52”

访问 http://localhost:8080/path/255 网页返回字符串 “OK”，程序返回 “255”

对于多个路径参数

1
2
3
4
5

@RequestMapping("/path/{id}/{name}")
public String pathParam(@PathVariable Integer id, @PathVariable String name){
    System.out.println(id + ";" + name);
    return "OK";
}

访问 http://localhost:8080/path/255/Tom 网页返回字符串 “OK”，程序返回 “255;Tom”

总结

  1. 简单参数
    • 定义方法形参，请求参数名与形参变量名一致
    • 如果不一致，通过 @RequestParam 手动映射
  2. 实体参数
    • 请求参数名，与实体对象的属性名一致，会自动接收封装
  3. 数组集合参数
    • 数组：请求参数名与数组名一致，直接封装
    • 集合：请求参数名与数组名一致，@RequestParam 绑定关系
  4. 日期参数
    • @DateTimeFormat
  5. JSON 参数
    • @RequestBody
  6. 路径参数
    • @PathVariable

响应

使用 @RequestBody 处理响应

上面请求里之所以可以响应是因为注解 @RestController 包含 @Controller 和 @ResponseBody

@RequestBody

类型：方法注解、类注解

位置：Controller方法上或类上

作用：将方法返回值直接响应，若返回值类型为 实体对象或集合 将会转换为 JSON 格式响应

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

@RestController
public class ResponseController {
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello SpringBoot");
        return "Hello SpringBoot";
    }

    @RequestMapping("/getAddr")
    public Address getAddr(){
        Address address = new Address();
        address.setProvince("上海");
        address.setCity("上海");
        return address;
    }

    @RequestMapping("/listAddr")
    public List<Address> listAddr(){
        List<Address> list = new ArrayList<>();
        Address address1 = new Address();
        address1.setProvince("北京");
        address1.setCity("北京");
        Address address2 = new Address();
        address2.setProvince("上海");
        address2.setCity("上海");

        list.add(address1);
        list.add(address2);
        return list;
    }
}

访问相应网址测试

统一响应结果

以上三个方法返回类型都不一样，使得前端开发较为困难，为此可以统一响应结果为一个类

1
2
3
4
5
6
7
8
9

public class Result{
    // 响应码，1代表成功，0代表失败
    private Integer code;
    // 提示信息
    private String msg;
    // 返回的数据
    private Object data;
    // ...
}

使得所有的响应方法返回一个 Result 对象，使得项目管理与维护更容易

例如如下类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

public class Result {
    private Integer code ;//1 成功 , 0 失败
    private String msg; //提示信息
    private Object data; //数据 data

    public Result() {
    }
    public Result(Integer code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public Object getData() {
        return data;
    }
    public void setData(Object data) {
        this.data = data;
    }

    public static Result success(Object data){
        return new Result(1, "success", data);
    }
    public static Result success(){
        return new Result(1, "success", null);
    }
    public static Result error(String msg){
        return new Result(0, msg, null);
    }

    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", msg='" + msg + '\'' +
                ", data=" + data +
                '}';
    }
}

那么上面代码可以改为

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

@RequestMapping("/hello")
public Result hello(){
    System.out.println("Hello SpringBoot");
    return Result.success("Hello SpringBoot");
}

@RequestMapping("/getAddr")
public Result getAddr(){
    Address address = new Address();
    address.setProvince("上海");
    address.setCity("上海");
    return Result.success(address);
}

@RequestMapping("/listAddr")
public Result listAddr(){
    List<Address> list = new ArrayList<>();
    Address address1 = new Address();
    address1.setProvince("北京");
    address1.setCity("北京");
    Address address2 = new Address();
    address2.setProvince("上海");
    address2.setCity("上海");

    list.add(address1);
    list.add(address2);
    return Result.success(list);
}

访问相应网址测试

后端, Spring
SpringBoot JavaWeb
This post is licensed under CC BY 4.0 by the author.
Recently Updated
Contents

maven 学习

结构化开发