sbringboot常用注解和参数传递总结

普朗克.

已于 2023-09-27 09:51:20 修改

阅读量285

点赞数

文章标签： spring boot java

于 2023-09-17 17:35:37 首次发布

本文链接：https://blog.csdn.net/qq_51483032/article/details/132948077

版权

@RequestBody与@RequestParam区别

@GetMapping @PostMapping @PutMapping @DeleteMapping

@Component@Controller@Repository@Service

@Resource@AutoWired

@Data 注解

@Controller

名称	@Controller
类型	类注解
位置	SpringMVC控制器类定义上方
作用	设定SpringMVC的核心控制器bean

@RequestMapping

名称	@RequestMapping
类型	类注解或方法注解
位置	SpringMVC控制器类或方法定义上方
作用	设置当前控制器方法请求访问路径
相关属性	value(默认)，请求访问路径

 @Controller
 public class UserController {
     @RequestMapping("/save")
     @ResponseBody
     public String save(){
         System.out.println("user save ...");
         return "{'info':'springmvc'}";
     }
 }

@RequestMapping("/save")注解建立了 /save 和 save方法的对应关系

@ResponseBody

名称	@ResponseBody
类型	类注解或方法注解
位置	SpringMVC控制器类或方法定义上方
作用	设置当前控制器方法响应内容为当前返回值，无需解析

 @Controller
 public class UserController {
     @RequestMapping("/save")
     @ResponseBody
     public String save(){
         System.out.println("user save ...");
         return "{'info':'springmvc'}";
     }
 }

如果不加@ResponseBody注解，直接返回字符串，springmvc会把字符串当成页面的名称在项目中进行查找返回，因为没有对应返回值的页面，所以会报404。加上@ResponseBody注解，当前返回值不会被解析，会直接被返回进行显示。

当方法上有@ReponseBody注解后

方法的返回值为字符串，会将其作为文本内容直接响应给前端

方法的返回值为对象，会将对象转换成JSON响应给前端

响应json数据：

 @Controller
 public class UserController {   
     @RequestMapping("/toJsonPOJO")
     @ResponseBody
     public User toJsonPOJO(){
         System.out.println("返回json对象数据");
         User user = new User();
         user.setName("itcast");
         user.setAge(15);
         return user;
     }  
 }

返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖@ResponseBody注解和@EnableWebMvc注解

@RequestParam

名称	@RequestParam
类型	形参注解
位置	SpringMVC控制器方法形参定义前面
作用	绑定请求参数与处理器方法形参间的关系
相关参数	required：是否为必传参数 defaultValue：参数默认值

前端给的是name,后台接收使用的是userName,两个名称对不上，此时需要@RequestParam注解，将参数对应

 @RequestMapping("/commonParamDifferentName")
 @ResponseBody
 public String commonParamDifferentName(@RequestParam("name") String userName , int age){
     System.out.println("普通参数传递 userName ==> "+userName);
     System.out.println("普通参数传递 age ==> "+age);
     return "{'module':'common param different name'}";
 }

五种类型参数传递

普通参数：url地址传参，地址参数名与形参变量名相同，定义形参即可接收参数
POJO类型参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数
嵌套POJO类型参数：请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数
数组类型参数：请求参数名与形参对象属性名相同且请求参数为多个，定义数组类型即可接收参数
集合类型参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据

 //集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
 @RequestMapping("/listParam")
 @ResponseBody
 public String listParam(@RequestParam List<String> likes){
     System.out.println("集合参数传递 likes ==> "+ likes);
     return "{'module':'list param'}";
 }

JSON数据传输参数

常见的JSON数据类型有三种:

json普通数组（["value1","value2","value3",...]）

 //使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
 @RequestMapping("/listParamForJson")
 @ResponseBody
 public String listParamForJson(@RequestBody List<String> likes){
     System.out.println("list common(json)参数传递 list ==> "+likes);
     return "{'module':'list common for json param'}";
 }

json对象（{key1:value1,key2:value2,...}）

 @RequestMapping("/pojoParamForJson")
 @ResponseBody
 public String pojoParamForJson(@RequestBody User user){
     System.out.println("pojo(json)参数传递 user ==> "+user);
     return "{'module':'pojo for json param'}";
 }

json对象数组（[{key1:value1,...},{key2:value2,...}]）

 @RequestMapping("/listPojoParamForJson")
 @ResponseBody
 public String listPojoParamForJson(@RequestBody List<User> list){
     System.out.println("list pojo(json)参数传递 list ==> "+list);
     return "{'module':'list pojo for json param'}";
 }