Springboot注解总结

SpringBootApplication

包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主类上；

Repository、Service、Controller、RestController、Component

分别用于标注数据访问组件，业务层组件、控制层组件，RestController包含@Controller和@ResponseBody；Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注；

ResponseBody

表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，

加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中；比如异步获取json数据，加上@responsebody后，会直接返回json数据；

RequestBody

参数前加上这个注解之后，认为该参数必填。表示接受json字符串转为对象 List等；

ComponentScan

组件扫描。个人理解相当于，如果扫描到有@Component @Controller @Service等这些注解的类，则把这些类注册为bean*；

Configuration

指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上；

Bean

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理；

EnableAutoConfiguration

让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上；

AutoWired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作；

当加上（required=false）时，就算找不到bean也不报错；

Qualifier

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用；

Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。与@Autowired干类似的事；

RequestMapping

 RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径；

该注解有六个属性: 

params:指定request中必须包含某些参数值是，才让该方法处理。

headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。  

value:指定请求的实际地址，指定的地址可以是URI Template 模式  

method:指定请求的method类型， GET、POST、PUT、DELETE等  

consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;  

produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回。

GetMapping、@PostMapping等:

相当于@RequestMapping（value=”/”，method=RequestMethod.Get\Post\Put\Delete等） 。是个组合注解；

RequestParam

用在方法的参数前面。相当于 request.getParameter()；

PathVariable

路径变量。如 RequestMapping(“user/get/mac/{macAddress}”) ；

public String getByMacAddress(
@PathVariable(“macAddress”) String macAddress){
//do something;
}

参数与大括号里的名字相同的话，注解后括号里的内容可以不填。

ControllerAdvice

包含@Component。可以被扫描到。统一处理异常；

ExceptionHandler(Exception.class)

用在方法上面表示遇到这个异常就执行以下方法。

ModelAttribute

使用地方有三种：

1、标记在方法上。

标记在方法上，会在每一个@RequestMapping标注的方法前执行，如果有返回值，则自动将该返回值加入到ModelMap中。

(1) 在有返回的方法上:

当ModelAttribute设置了value，方法返回的值会以这个value为key，以参数接受到的值作为value，存入到Model中，如下面的方法执行之后，最终相当于 model.addAttribute("user_name", name);假如 @ModelAttribute没有自定义value，则相当于

model.addAttribute("name", name);

(2) 在没返回的方法上：

需要手动model.add方法

我们在当前类下建一个请求方法：

2、标记在方法的参数上。

标记在方法的参数上，会将客户端传递过来的参数按名称注入到指定对象中，并且会将这个对象自动加入ModelMap中，便于View层使用.我们在上面的类中加入一个方法如下

PostConstruct

用来标记是在项目启动的时候执行这个方法。用来修饰一个非静态的void()方法

也就是spring容器启动时就执行，多用于一些全局配置、数据字典之类的加载

被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次。PostConstruct在构造函数之后执行,init()方法之前执行。PreDestroy（）方法在destroy()方法执行执行之后执

PreDestroy

被@PreDestroy修饰的方法会在服务器卸载Servlet的时候运行，并且只会被服务器调用一次，类似于Servlet的destroy()方法。被@PreDestroy修饰的方法会在destroy()方法之后运行，在Servlet被彻底卸载之前

Scope

用来配置 spring bean 的作用域，它标识 bean 的作用域。

默认值是单例

1、singleton:单例模式,全局有且仅有一个实例

2、prototype:原型模式,每次获取Bean的时候会有一个新的实例

3、request:request表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP request内有效

4、session:session作用域表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP session内有效

5、global session:只在portal应用中有用，给每一个 global http session 新建一个Bean实例。

SessionAttributes

默认情况下Spring MVC将模型中的数据存储到request域中。当一个请求结束后，数据就失效了。如果要跨页面使用。那么需要使用到session。而@SessionAttributes注解就可以使得模型中的数据存储一份到session域中

参数：

1、names：这是一个字符串数组。里面应写需要存储到session中数据的名称。

2、types：根据指定参数的类型，将模型中对应类型的参数存储到session中

3、value：和names是一样的。

参考

40 个 SpringBoot 常用注解