当前位置:   article > 正文

JavaEE 从入门到精通(二) ~SpringMVC 接收请求和设置响应

JavaEE 从入门到精通(二) ~SpringMVC 接收请求和设置响应

 晚上好,愿这深深的夜色给你带来安宁,让温馨的夜晚抚平你一天的疲惫,美好的梦想在这个寂静的夜晚悄悄成长。

目录

前言

一、获取请求数据

1. 简单参数

1.1 请求行获取参数

a. 与查询参数的名称相同,底层会自动映射到形参中。

b. 与查询参数的名称不相同,需要指定@RequestParam(value)参数映射

1.2 请求体获取参数

2. 路径参数

3. 数组参数

4. 集合参数

5. 实体参数

6. 日期参数

7. JSON参数

8. 文件参数

二、设置响应数据


前言

        数据传输在前后端分离项目中至关重要,它通过优化网络传输量和延迟、增强系统可扩展性、提高安全性、优化用户体验、支持多平台访问以及简化维护和测试,显著提升了整体系统的效率和可靠性。数据来说对于后端开发是非常重要的,后端的需求就是:根据请求数据,计算响应数据。


一、获取请求数据

在Web应用程序开发中,浏览器向服务器发送的请求可以包含多种类型的数据,这些数据对于执行业务逻辑至关重要。为了有效地处理和操作这些数据,开发人员通常需要使用各种参数来接收和映射前端的请求数据。

在Spring MVC处理请求的过程中,接收到HTTP请求后,DispatcherServlet会找到对应的处理器(HandlerMethod)。接着,系统会遍历注册的所有HandlerMethodArgumentResolver实例,寻找能够支持当前处理器方法参数的解析器。这些解析器可以基于参数类型、注解或其他条件进行匹配,实现如从请求体自动绑定JSON数据到Java对象、解析请求参数、处理请求头信息或从Session中获取数据等功能。

  1. RequestParamMethodArgumentResolver处理@RequestParam注解参数。
  2. PathVariableMethodArgumentResolver 处理路径变量,以及用于处理请求体的。
  3. RequestBodyArgumentResolver等,覆盖了大部分常见场景。
  4. MethodParameter 是 Spring Framework 提供的一个类,用于描述方法参数的元数据信息。用于获取和操作方法参数的各种信息。

注意:

如果不指定注解(来源),默认是从get请求的url参数中获取,不会获取到请求体中的内容。请求体中的数据都需要指定@RequestBody。  每个方法参数只能使用一个@RequestBody注解。

1. 简单参数

1.1 请求行获取参数

a. 与查询参数的名称相同,底层会自动映射到形参中。

请求中的 URL 参数通常会被封装成一个 Map<String, String[]> 的结构,其中键是参数名,值是参数值的数组(因为一个参数名可能对应多个值)。然后根据参数名称去查值。

Spring底层会将@RequestMapping的值,通过反射和方法名。创建一个map集合进行存储。然后根据键找到值,然后根据方法名来反射调用。

localhosthttp://localhost:8080/test?name=小红

  1. @GetMapping("/test")
  2. public String test(String name){
  3. return "获取简单类型参数";
  4. }

会将查询参数中的小红映射到name参数中。 

b. 与查询参数的名称不相同,需要指定@RequestParam(value)参数映射

@RequestParam:从请求参数中获取内容并赋值给形参,查询参数。

http://:8080/test?name=小红

  1. @GetMapping("/test")
  2. public String test(@RequestParam("name") String n){
  3. return "获取名称不一样,简单类型参数" + n;
  4. }

 会将查询参数中的小红映射到name参数中。 

1.2 请求体获取参数

如果不指定注解(来源),默认是从get请求的url参数中获取,不会获取到请求体中的内容。请求体中的数据都需要指定,@RequestBody。 

底层会请求体中自动映射到形参中。不相同名称也会自动映射、会把后面的类型当容器装到里面。

@RequestBody 注解告诉 Spring MVC 应该将请求体的内容转换为指定类型(容器)的对象(内容)

 http://:8080/test

  1. @GetMapping("/test")
  2. public String test(@RequestBody String name){
  3. return "获取名称不一样,简单类型参数" + name;
  4. }

 会从请求体中的JSON格式内容映射到String容器中。

打印name会输出  {"n":"你好"}

2. 路径参数

场景:完成删除的时候和次查询的时候。

注意: 在SpringFramework中,可以在请求的资源路径上 {路径变量} 。用于接收路径参数通过@PathVariable(路径变量的名字) 把路径参数赋值给方法声明的参数。如果方法上的参数名跟路径变量名一致,则可以不用指定路径变量名。

GET /spring-demo/hello/1,2,3 HTTP/1.1

  1. @DeleteMapping("/deleteTeacher/{abc}")
  2. public String deleteTeacher(@PathVariable("abc") Integer id){
  3. System.out.println("id: "+id);
  4. return "删除老师成功!";
  5. }
  6. @DeleteMapping("/deleteTeacherBatch/{ids}")
  7. public String deleteTeacherBatch(@PathVariable Integer[] ids){
  8. System.out.println(Arrays.toString(ids));
  9. return "批量删除老师成功!";
  10. }

会自动按照参数名称进行映射。 

3. 数组参数

浏览器提交的数据格式:

hobbies=打球&hobbies=打豆豆&hobbies=打酱油

后台代码:

数组接收:参数名字需要和前端提交的请求参数名字保持一致。

底层是Map<键,Object[]>的形式进行传递,创建完数组对象,然后根据参数查询值进行映射了。

  1. @PostMapping("/addTeacherHobbies")
  2. public String addTeacherHobbies(String[] hobbies){
  3. System.out.println(Arrays.toString(hobbies));
  4. return "添加爱好成功!";
  5. }

4. 集合参数

集合接收: 多个同名参数,默认会封装到数组当中的,list集合接受参数需要@RequestParam绑定。List不指定@RequestParam报错原因:SpringMvc会尝试帮你创建一个bean,然后将属性在进行设置属性、如果设置的话,就是告诉他,我就是简单的将请求参数解析完毕封装到里面(当个标志)。

注意:

引用参数,默认是创建对象进行通过setter方法进行添加,如果指定@RequestParam是一个标记性注解,表示不帮助我们创建对象,而是作为一个容器进行添加,数组是个特例:因为底层是Map<键,Object[]>的形式进行传递,创建完数组对象,然后根据参数查询值进行映射了。

@RequestParam:标记性形参,用来告诉Spring客户端,后面的参数是作为一个容器接受查询参数数据的。不指定value就自动会把名称相同全部内容添加到这个容器中

@RequstParam:该注解的required属性默认是true,代表请求参数必须传递。其中defaultValue = ""设置默认值 。

@RequestParam:声明后浏览器就必须传递,不传递就会报错400、400无效的参数格式、缺少必需的参数或参数值不合法。

  1. @PostMapping("/addTeacherHobbies2")
  2. public String addTeacherHobbies2(@RequestParam List<String> hobbies){
  3. System.out.println(hobbies);
  4. return "添加爱好成功!";
  5. }

@RequestParam 未指定 name,参数类型为:Map<String,String>时,用来接收 request 中所有参数的值,Map 中 key 为参数名称,value 为参数的值。

  1. @GetMapping("/params")
  2. public ResponseEntity<String> handleParams(@RequestParam Map<String, String> params) {
  3. // 处理参数的逻辑
  4. StringBuilder response = new StringBuilder();
  5. for (String key : params.keySet()) {
  6. String value = params.get(key);
  7. response.append(key).append(" = ").append(value).append("\n");
  8. }
  9. return ResponseEntity.ok(response.toString());
  10. }

对集合请求体中的数据都需要指定,@RequestBody。 

5. 实体参数

MessageConverter(消息转换器):用于处理 JSON 数据的序列化和反序列化,Spring的消息转化器是Jackson 库 。

不声明@RequestBody会将后端请求行中的数据自动通过setter方法映射到Javabean中。

会自动创建一个JavaBean的对象,它会通过反射调用对象的setter方法来设置属性。

  1. @PostMapping("/user")
  2. public ResponseEntity<String> createUser(User user) {
  3. // 假设 User 是一个简单的JavaBean,包含了字段 name 和 age
  4. // 请求的JSON体或表单数据将会自动映射到 User 对象的相应字段上
  5. // Spring 会自动创建 User 对象,并调用其 setter 方法
  6. return ResponseEntity.ok("Created user: " + user.getName());
  7. }

声明@RequestBody会将后端请求体中的数据自动映射到Javabean中。

@RequestBody用于标记一个方法参数,表示请求体的内容将会被反序列化为指定的Java对象。将请求体的JSON或XML数据解析成Java对象,并调用该对象的setter方法设置属性值。

  1. @RestController
  2. public class UserController {
  3. @PostMapping("/user")
  4. public ResponseEntity<String> createUser(@RequestBody User user) {
  5. // 请求体为 JSON 或 XML 格式
  6. // Spring 会自动将请求体的数据映射到 User 对象中
  7. // 假设 User 类有 name 和 age 属性,请求体的数据将设置到这些属性上
  8. return ResponseEntity.ok("Created user: " + user.getName());
  9. }
  10. }

测试代码:

只有id的setter方法,并没有name的setter方法

  1. public class Book {
  2. private Integer id;
  3. private String type;
  4. private String name;
  5. private String description;
  6. public void setId(Integer id) {
  7. this.id = id;
  8. }
  9. @Override
  10. public String toString() {
  11. return "Book{" +
  12. "id=" + id +
  13. ", type='" + type + '\'' +
  14. ", name='" + name + '\'' +
  15. ", description='" + description + '\'' +
  16. '}';
  17. }
  18. }
  1. @RequestMapping("/testObject")
  2. public String testObject(@RequestBody Book book){
  3. System.out.println(book);
  4. return book.toString();
  5. }

 发送数据{"id": 200,"name": "小李"}

 如果不创建对象book肯定为null,不使用setter方法赋值,肯定id和name都有值。

实际不是null,并且id有值name没有值。

6. 日期参数

注意: SpringFramework中,只能够识别的日期格式: yyyy/MM/dd  2020/01/0 

如果要修改SpringFramework认识的日期格式,需要借助于SpringFramework提供的一个注解

@DateTimeForma

浏览器提交的数据格式:

        birthday=2003-01-01

后端代码:

  1. @PostMapping("/addTeacherBirthday")
  2. public String addTeacherBirthday(@DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate birthday) {
  3. System.out.println(birthday);
  4. return "添加生日成功!";
  5. }

7. JSON参数

使用Javabean或者Map进行接收。底层会通过MessageConverter(消息转换器):用于处理 JSON 数据的序列化和反序列化,进行解析。

JavaBean

  1. @RestController
  2. public class UserController {
  3. @PostMapping("/user")
  4. public ResponseEntity<String> createUser(@RequestBody User user) {
  5. // 请求体为 JSON 或 XML 格式
  6. // Spring 会自动将请求体的数据映射到 User 对象中
  7. // 假设 User 类有 name 和 age 属性,请求体的数据将设置到这些属性上
  8. return ResponseEntity.ok("Created user: " + user.getName());
  9. }
  10. }

Map

  1. @GetMapping("/params")
  2. public ResponseEntity<String> handleParams(@RequestBody Map<String, String> params) {
  3. // 处理参数的逻辑
  4. StringBuilder response = new StringBuilder();
  5. for (String key : params.keySet()) {
  6. String value = params.get(key);
  7. response.append(key).append(" = ").append(value).append("\n");
  8. }
  9. return ResponseEntity.ok(response.toString());
  10. }

8. 文件参数

SpringMVC规定上传的文件需要是MultipartFile类型的。

响应体:包含了服务器返回给客户端的实际内容。响应体的内容类型由 Content-Type 头部字段指定。可以是HTML文档、JSON数据、图片、文件等。

如果不指定@ResponseBody: 字符串(基本数据类型)返回视图名称,对象则作为模型数据传递给视图,并将其渲染返回给客户端。

  1. @PostMapping("/upload")
  2. public ResponseEntity<String> handleFileUpload(MultipartFile file) {
  3. // 处理文件上传逻辑
  4. // 在这里可以保存文件到服务器,这里只是简单示例,不包含具体的文件处理代码
  5. return ResponseEntity.ok("File uploaded successfully: " + file.getOriginalFilename());
  6. }

二、设置响应数据

1. @ResponseBody

如果不指定@ResponseBody: 字符串(基本数据类型)返回视图名称,对象则作为模型数据传递给视图,并将其渲染返回给客户端。

指定的话:简单类型直接当成字符串响应,对象转换为json响应。

2. @RestController注解解析:

该注解是一个组合注解: 组合了两个注解: @Controller和@ResponseBody

@Controller: 标识当前类是为IOC容器的Bean对象。

@ResponseBody: 添加到类上,那么该类中所有方法的返回结果都会自动的转化成Json字符串响应给浏览器。

注意1:

如果某个方法上获取类上没有添加@ResponseBody注解,那么方法的返回结果会被当做某个静态资源的名字去使用,SpringFramework会拿着方法的返回结果取查找对应的名字的静态资源响应给浏览器。

注意2:

如果方法的返回结果就是字符串,那么SpringFramework不会做任何操作,原样返回即可!

如果方法的返回结果不是字符串,会把结果转换成json格式的字符串响应给浏览器。

3. 统一响应结果

 实际开发中,经常前后端交互时,响应结果数据的统一格式:

名称类型是否必须默认值备注其他信息
codeNumber必须响应码,1-成功,0-失败响应状态码
msgString必须提示信息正确或者错误的提示信息
dataObject必须本次操作响应的核心数据一般放前端需要的数据
  1. {
  2. "code": 1,
  3. "msg": "登录成功!",
  4. "data": {
  5. }
  6. }

提供一个类,用于封装统一格式的响应结果数据

  1. //用于封住统一的结果数据
  2. public class Result {
  3. private Integer code;//响应状态码: 1-成功,0-失败
  4. private String msg;//提示信息
  5. private Object data;//接口响应的核心数据
  6. public Result() {
  7. }
  8. public Result(Integer code, String msg, Object data) {
  9. this.code = code;
  10. this.msg = msg;
  11. this.data = data;
  12. }
  13. public Integer getCode() {
  14. return code;
  15. }
  16. public void setCode(Integer code) {
  17. this.code = code;
  18. }
  19. public String getMsg() {
  20. return msg;
  21. }
  22. public void setMsg(String msg) {
  23. this.msg = msg;
  24. }
  25. public Object getData() {
  26. return data;
  27. }
  28. public void setData(Object data) {
  29. this.data = data;
  30. }
  31. //为了外部更方便的创建Result对象,一般会在结果类中提供静态方法,用于外部调用,获取结果类的对象
  32. //给查询接口中的
  33. public static Result success(Object data){
  34. return new Result(1,"操作成功",data);
  35. }
  36. //给增删改用
  37. public static Result success(){
  38. return new Result(1,"操作成功",null);
  39. }
  40. //失败
  41. public static Result error(String msg){
  42. return new Result(0,msg,null);
  43. }
  44. }

 当提供了统一响应结果的封装类后,接口中任何方法的返回值类型都是该类

  1. //统一结果响应
  2. @GetMapping("/getAllTeacher2")
  3. public Result getAllTeacher2() {
  4. //模拟查询数据库
  5. List<Teacher> ts = new ArrayList<>();
  6. ts.add(new Teacher("张三", "123", "男"));
  7. ts.add(new Teacher("李四", "123", "男"));
  8. ts.add(new Teacher("王五", "123", "男"));
  9. //Result result = new Result(1, "操作成功", ts);
  10. Result result = Result.success(ts);
  11. return result;
  12. }
  13. @GetMapping("/findOne2")
  14. public Result findOne2() {
  15. Teacher t = new Teacher("张三", "123", "男");
  16. //Result result = new Result(1, "操作成功", t);
  17. Result result = Result.success(t);
  18. return result;
  19. }


声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小舞很执着/article/detail/933492
推荐阅读
相关标签
  

闽ICP备14008679号