Spring常用注解整理

按注解的位置分

1.类注解

@Component：泛指各种组件；@Controller、@Service、@Repository都可以称为@Component。

@Controller：控制层

@Service：业务层

@Repository：数据访问层

@Mapper：mybatis

@RequestMapping：用于映射web请求，包括访问路径和参数。

@RestController：该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。

@Import(要导入到容器中的组件)；

@Configuration：声明当前类为配置类；

@ComponentScan：用于对Component进行扫描；

@EnableWebMvc：在配置类中开启Web MVC的配置支持。

@ExceptionHandler：用于全局处理控制器里的异常。

@ControllerAdvice：全局异常处理，全局数据绑定，全局数据预处理

@Transactional ：事务；@Transactional 注解放在类级别时，表示所有该类的公共方法都配置相同的事务属性信息。EmployeeService 的所有方法都支持事务并且是只读。当类级别配置了@Transactional，方法级别也配置了@Transactional，应用程序会以方法级别的事务属性信息来管理事务，换言之，方法级别的事务属性信息会覆盖类级别的相关配置信息。

@FunctionalInterface：lambda表达式的接口注解

@Aspect ：声明一个切面

@PointCut ：声明切点

@Profile：指定组件在哪个环境的情况下才能被注册到容器中，不指定，任何环境下都能注册这个组件。

@Conditional：通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。

@EnableAsync：配置类中通过此注解开启对异步任务的支持

@Async：在实际执行的bean方法使用该注解来声明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

@EnableScheduling：在配置类上使用，开启计划任务的支持

@JsonIgnoreProperties：此注解是类注解，作用是json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响。写法将此标签加在user类的类名上 ，可以多个属性也可以单个属性。

@RunWith：运行器，Spring中通常用于对JUnit的支持

@ContextConfiguration(locations = {“classpath*😕.xml"})：用来加载配置文件，其中classes属性用来加载配置类。@ContextConfiguration：这个注解通常与@RunWith(SpringJUnit4ClassRunner.class)联合使用用来测试。括号里的locations = {"classpath😕*.xml”}就表示将classpath路径里所有的xml文件都包括进来，自动扫描的bean就可以拿到，此时就可以在测试类中使用@Autowired注解来获取之前自动扫描包下的所有bean。

@EqualsAndHashCode：让lombok帮你生成equals(Object other)和hashCode()方法的实现

@Schema：@schema注解标注在class上，表示此类对应的数据库表对应的schema。可以用如下语句判断某个实体类上是否带有@schema注解，从而得到schema。

@InitBinder：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。

@XmlAccessType.FIELD：映射这个类中的所有字段到XML

@XmlAccessType.PROPERTY：映射这个类中的属性（get/set方法）到XML

@XmlAccessType.PUBLIC_MEMBER：将这个类中的所有public的field或property同时映射到XML（默认）

@XmlAccessType.NONE：不映射

2.方法注解

@Bean：注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式；

@Scope：设置类型包括

@JsonIgnore：在json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响。如果注解失效，可能是因为你使用的是fastJson，尝试使用对应的注解来忽略字段，注解为：@JSONField(serialize = false)，使用方法一样。

@Transactional ：事务；@Transactional 注解放在类级别时，表示所有该类的公共方法都配置相同的事务属性信息。EmployeeService 的所有方法都支持事务并且是只读。当类级别配置了@Transactional，方法级别也配置了@Transactional，应用程序会以方法级别的事务属性信息来管理事务，换言之，方法级别的事务属性信息会覆盖类级别的相关配置信息。

@After： 在方法执行之后执行

@Before： 在方法执行之前执行

@Around ：在方法执行之前与之后执行

@Scheduled：来申明这是一个任务，包括cron,fixDelay,fixRate等类型（需先开启计划任务的支持）

@EnableAspectAutoProxy：开启对AspectJ自动代理的支持；

@EnableAsync：开启异步方法的支持；

@EnableScheduling：开启计划任务的支持；

@EnableWebMvc：开启web MVC的配置支持；

@EnableConfigurationProperties：开启对@ConfigurationProperties注解配置Bean的支持；

@EnableJpaRepositories：开启对SpringData JPA Repository的支持；

@EnableTransactionManagement：开启注解式事务的支持；

@EnableCaching：开启注解式的缓存支持；

3.属性、变量注解

@Autowired：由bean提供；@Autowired可以作用在变量、setter方法、构造函数上；有个属性为required，可以配置为false；

@Inject：由JSR-330提供；@Inject用法和@Autowired一样。

@Resource：由JSR-250提供；@Autowired、@Inject是默认按照类型匹配的，@Resource是按照名称匹配的，@Autowired如果需要按照名称匹配需要和@Qualifier一起使用，@Inject和@Name一起使用。

@Primary：让spring进行自动装配的时候，默认使用首选的bean，和@Qualifier一个效果。

@JsonIgnore：在json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响。如果注解失效，可能是因为你使用的是fastJson，尝试使用对应的注解来忽略字段，注解为：@JSONField(serialize = false)，使用方法一样。（最好是注解在属性上）

@JsonFormat：此注解用于属性或者方法上（最好是属性上），可以方便的把Date类型直接转化为我们想要的模式

@JsonSerialize：此注解用于属性或者getter方法上，用于在序列化时嵌入我们自定义的代码，比如序列化一个double时在其后面限制两位小数点。

@JsonDeserialize：此注解用于属性或者setter方法上，用于在反序列化时可以嵌入我们自定义的代码，类似于上面的@JsonSerialize

@Transient：如果一个属性并非数据库表的字段映射，就务必将其标示为@Transient，否则ORM框架默认其注解为@Basic；

@JsonIgnoreType：标注在类上，当其他类有该类作为属性时，该属性将被忽略。

@JsonProperty： 可以指定某个属性和json映射的名称。例如我们有个json字符串为{“user_name”:”aaa”}，
而java中命名要遵循驼峰规则，则为userName，这时通过@JsonProperty 注解来指定两者的映射规则即可。这个注解也比较常用。

@JsonPropertyOrder：在将 java pojo 对象序列化成为 json 字符串时，使用 @JsonPropertyOrder 可以指定属性在 json 字符串中的顺序。

@JsonInclude：在将 java pojo 对象序列化成为 json 字符串时，使用 @JsonInclude 注解可以控制在哪些情况下才将被注解的属性转换成 json，例如只有属性不为 null 时。

@JsonInclude(JsonInclude.Include.NON_NULL)：这个注解放在类头上，返给前端的json里就没有null类型的字段，即实体类与json互转的时候 属性值为null的不参与序列化。另外还有很多其它的范围，例如 NON_EMPTY、NON_DEFAULT等

@JsonSetter：标注于 setter 方法上，类似 @JsonProperty ，也可以解决 json 键名称和 java pojo 字段名称不匹配的问题。

4.参数注解

@ResponseBody：支持将返回值放到response内，而不是一个页面，通常用户返回json数据。

@RequestBody：允许request的参数在request体中，而不是在直接连接的地址后面。（放在参数前）

@PathVariable：用于接收路径参数，比如@RequestMapping(“/hello/{name}”)声明的路径，将注解放在参数前，即可获取该值，通常作为Restful的接口实现方法。

5.其他

@Value注解
（1）支持如下方式的注入：
注入普通字符
注入操作系统属性
注入表达式结果
注入其它bean属性
注入文件资源
注入网站资源
注入配置文件
（2）@Value三种情况的用法。
${}是去找外部配置的参数，将值赋过来
#{}是SpEL表达式，去寻找对应变量的内容
#{}直接写字符串就是将字符串的值注入进去

.
.
.
.
.
.
.
语雀文档：
SpringBoot注解
.
.
.
.
.
.
.
.
.
.
.
（感谢指正、补充）