SpringBoot Web注解

前言：本篇文章主要记录SpringBoot Web开发中常用的一些注解。

一、 注解列表

(一)、控制器注解

1.@Controller
2.@RestController
3.@ResponseBody
4.@RequestBody
5.@RequestMapping
6.@GetMapping
7.@PostMapping
8.@PutMapping

（二）、数据绑定注解

1.@ModelAttribute
2.@PathVariable
3.@RequestParam
4.@RequestHeader

（三）、视图

常用视图模板引擎如下：
1.ThymLeaf（官方推荐）
2.JSP
3.FreeMarker
4.Velocity
5.Groovy
6.Mustache

注解解析

（一）控制类注解

1.@Controller
类型：类注解
作用：标识一个类为控制器，DispatcherServlet会扫描所有的控制器类，便检测该类中@RequestMapping注解标记的方法。

2.@RestController
类型：类注解
作用：由@ResponseBody和@Controller组成，这样使得不需要控制类中每个响应方法都加上@ResponseBody注解。

3.@ResponseBody
类型：方法注解
作用：将方法的返回值直接写入HTTP响应体中，一般在异步获取数据时使用【也就是AJAX】。
在使用@RequestMapping后，返回值通常被解析为调整路径，但是加上@ResponseBody返回结果就不会被解析为跳转路径，而是直接写入HTTP响应体中。

4.@RequestBody
类型：参数注解
作用：将前台发送过来固定格式的数据【XML/JSON】等封装为对应的JavaBean对象，封装时使用到的一个对象是系统默认配置的HttpMessageConverter进行解析，然后封装到形参上。

区分RequestBody和ResponseBody

   @RequestMapping("/login")
   @ResponseBody
   public Obejct login(@RequestBody User loginUser, HttpSession session) {
        user = userService.checkLogin(loginUser);
        session.setAttribute("user",user);
        return new JsonResult(user); 
   }

5.@RequestMapping
类型：类注解/方法注解
作用：用来处理请求地址映射，用于方法表示直接访问地址，用于类上表示所有响应请求的方法都是以该地址作为父路径。

@RequestMapping注解六个参数

• value：指定请求的实际地址，指定的地址可以是URI Template模式
• method：指定请求的method类型，GET、POST、PUT、DELETE等；

• consumes：指定处理请求的提交内容类型（Content-Type），例如application/json，text/html
• produces：指定返回的内容类型，仅当request请求头中的（Accept）类型中包含该指定类型才返回；

• params：指定request中必须包含某些参数值，才让该方法处理;
• headers：指定request中必须包含某些指定的header值，才让该方法处理;

//地址映射例子
@RestController  
@RequestMapping("/home")  
public class IndexController {  
    @RequestMapping("/")  
    String get() {  
        //mapped to hostname:port/home/  
        return "Hello from get";  
    }  
    @RequestMapping("/index")  
    String index() {  
        //mapped to hostname:port/home/index/  
        return "Hello from index";  
    }  
}  

6.@GetMapping
类型：方法注解
作用：组合注解，是@RequestMapping（method = RequestMethod.GET）的缩写。

//只接受get方式的请求
@GetMapping("/testGetMapping")  
    public String testGetMapping(Model model) {
        model.addAttribute("msg","测试@GetMapping注解");
        return "success";
    }

7.@PostMapping
类型：方法注解
作用：组合注解，是@RequestMapping（method = RequestMethod. POST)的缩写。

//只接受post方式的请求
@PostMapping("/testPostMapping")
    public String testPostMapping(Model model) {
      model.addAttribute("msg","测试@PostMapping注解");
      return "success";
}

8.@PutMapping
类型：方法注解
作用：组合注解，是@RequestMapping（method = RequestMethod.PUT）的缩写。

（二）数据类注解

1.@ModelAttribute
类型：方法注解
作用：最主要的作用是将数据添加到模型对象中，用于视图页面展示时使用。@ModelAttribute等价于 model.addAttribute("attributeName", object); 但是根据@ModelAttribute注释的位置不同，和其他注解组合使用，致使含义有所不同。

    @ModelAttribute   
    public void populateModel(@RequestParam String abc, Model model) {    
       model.addAttribute("attributeName", abc);    
    }    

2.@PathVariable
类型：方法注解
作用：获取url中的数据（即/请求地址/{参数1}/{参数2}），注意不同于请求参数，即不是?后面的参数。

//这里id即为获取的url中的参数
//请求地址localhost:8080/hello/id
  @RestController
public class HelloController {
 
  @RequestMapping(value="/hello/{id}",method= RequestMethod.GET)
  public String sayHello(@PathVariable("id") Integer id){
    return "id:"+id;
  }
}

3.@RequestParam
类型：方法注解
作用：获取请求参数的值

//请求地址localhost:8080/hello?id=1000
//id为1000
@RestController
public class HelloController {
 
  @RequestMapping(value="/hello",method= RequestMethod.GET)
  public String sayHello(@RequestParam("id") Integer id){
    return "id:"+id;
  }
}

4.@RequestHeader
类型：参数注解
作用：从HTTP请求头中提取指定的某个请求头，等价于HttpServletRequest.getHeader(String).

参数名	是否必须	作用
value	默认为空	请求头参数名
required	默认为true	表示请求头中是否必须包含对应参数，否则抛出异常
defaultValue	默认为空或不存在	当请求头参数缺少或者有请求参数但值为空时，值采用该设置值

//参数必须包含，无参数默认值例子
@RequestMapping("/testRequestHeader")
    public String testRequestHeader( @RequestHeader(value = "key", required = true)  String key) {
        System.out.println("testRequestHeader, key:" + key);
        return SUCCESS;
    }