Spring 注解大全与详解
slug
spring-annotation
date
Sep 15, 2022
tags
技术&产品
summary
type
Post
status
Published
Last edited time
Mar 19, 2024 03:35 PM
Spring 使用的注解大全和解释
注解
解释
组合注解（组合了 @Component 注解），应用在 MVC 层（控制层）,DispatcherServlet 会自动扫描注解了此注解的类，然后将 web 请求映射到注解了 @RequestMapping 的方法上。
组合注解（组合了 @Component 注解），应用在 service 层（业务逻辑层）
组合注解（组合了 @Component 注解），应用在 dao 层（数据访问层）
表示一个带注释的类是一个 “组件”，成为 Spring 管理的 Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。同时 @Component 还是一个元注解。
Spring 提供的工具（由 Spring 的依赖注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自动注入。）
JSR-250 提供的注解
JSR-330 提供的注解
声明当前类是一个配置类（相当于一个 Spring 配置的 xml 文件）
自动扫描指定包下所有使用 @Service,@Component,@Controller,@Repository 的类并注册
注解在方法上，声明当前方法的返回值为一个 Bean。返回的 Bean 对应的类中可以定义 init() 方法和 destroy() 方法，然后在 @Bean(initMethod=”init”,destroyMethod=”destroy”) 定义，在构造之后执行 init，在销毁之前执行 destroy。
声明一个切面（就是说这是一个额外功能）
后置建言（advice），在原方法前执行。
前置建言（advice），在原方法后执行。
环绕建言（advice），在原方法执行前执行，在原方法执行后再执行（@Around 可以实现其他两种 advice）
声明切点，即定义拦截规则，确定有哪些方法会被切入
声明事务（一般默认配置即可满足要求，当然也可以自定义）
声明数据缓存
开启 Spring 对 AspectJ 的支持
值得注入。经常与 Sping EL 表达式语言一起使用，注入普通字符，系统属性，表达式运算结果，其他 Bean 的属性，文件内容，网址请求内容，配置文件属性值等等
指定文件地址。提供了一种方便的、声明性的机制，用于向 Spring 的环境添加 PropertySource。与 @configuration 类一起使用。
标注在方法上，该方法在构造函数执行完成之后执行。
标注在方法上，该方法在对象销毁之前执行。
表示当一个或多个指定的文件是活动的时，一个组件是有资格注册的。使用 @Profile 注解类或者方法，达到在不同情况下选择实例化不同的 Bean。@Profile(“dev”) 表示为 dev 时实例化。
开启异步任务支持。注解在配置类上。
注解在方法上标示这是一个异步方法，在类上标示这个类所有的方法都是异步方法。
注解在配置类上，开启对计划任务的支持。
注解在方法上，声明该方法是计划任务。支持多种类型的计划任务：cron,fixDelay,fixRate
根据满足某一特定条件创建特定的 Bean
通过简单的 @Enable * 来开启一项功能的支持。所有 @Enable * 注解都有一个 @Import 注解，@Import 是用来导入配置类的，这也就意味着这些自动开启的实现其实是导入了一些自动配置的 Bean(1. 直接导入配置类 2. 依据条件选择配置类 3. 动态注册配置类)
这个是 Junit 的注解，springboot 集成了 junit。一般在测试类里使用:@RunWith(SpringJUnit4ClassRunner.class) — SpringJUnit4ClassRunner 在 JUnit 环境下提供 Sprng TestContext Framework 的功能
用来加载配置 ApplicationContext，其中 classes 属性用来加载配置类:@ContextConfiguration(classes = {TestConfig.class(自定义的一个配置类)})
用来声明活动的 profile–@ActiveProfiles(“prod”(这个 prod 定义在配置类中))
用在配置类上，开启 SpringMvc 的 Mvc 的一些默认配置：如 ViewResolver，MessageConverter 等。同时在自己定制 SpringMvc 的相关配置时需要做到两点：1. 配置类继承 WebMvcConfigurerAdapter 类 2. 就是必须使用这个 @EnableWebMvc 注解。
用来映射 web 请求（访问路径和参数），处理类和方法的。可以注解在类和方法上，注解在方法上的 @RequestMapping 路径会继承注解在类上的路径。同时支持 Serlvet 的 request 和 response 作为参数，也支持对 request 和 response 的媒体类型进行配置。其中有 value(路径)，produces(定义返回的媒体类型和字符集)，method(指定请求方式) 等属性。
将返回值放在 response 体内。返回的是数据而不是页面
允许 request 的参数在 request 体中，而不是在直接链接在地址的后面。此注解放置在参数前。
放置在参数前，用来接受路径参数。
组合注解，组合了 @Controller 和 @ResponseBody, 当我们只开发一个和页面交互数据的控制层的时候可以使用此注解。
用在类上，声明一个控制器建言，它也组合了 @Component 注解，会自动注册为 Spring 的 Bean。
用在方法上定义全局处理，通过他的 value 属性可以过滤拦截的条件：@ExceptionHandler(value=Exception.class)–表示拦截所有的 Exception。
将键值对添加到全局，所有注解了 @RequestMapping 的方法可获得次键值对（就是在请求到达之前，往 model 里 addAttribute 一对 name-value 而已）。
通过 @InitBinder 注解定制 WebDataBinder（用在方法上，方法有一个 WebDataBinder 作为参数，用 WebDataBinder 在方法内定制数据绑定，例如可以忽略 request 传过来的参数 Id 等）。
一般用在测试上，注解在类上，用来声明加载的 ApplicationContext 是一个 WebApplicationContext。他的属性指定的是 Web 资源的位置，默认为 src/main/webapp, 我们可以修改为：@WebAppConfiguration(“src/main/resources”)。
此注释自动载入应用程序所需的所有 Bean——这依赖于 Spring Boot 在类路径中的查找。该注解组合了 @Import 注解，@Import 注解导入了 EnableAutoCofigurationImportSelector 类，它使用 SpringFactoriesLoader.loaderFactoryNames 方法来扫描具有 META-INF/spring.factories 文件的 jar 包。而 spring.factories 里声明了有哪些自动配置。
SpringBoot 的核心注解，主要目的是开启自动配置。它也是一个组合注解，主要组合了 @Configurer，@EnableAutoConfiguration（核心）和 @ComponentScan。可以通过 @SpringBootApplication(exclude={想要关闭的自动配置的类名. class}) 来关闭特定的自动配置。
虽然 Spring 提倡零配置，但是还是提供了对 xml 文件的支持，这个注解就是用来加载 xml 配置的。例：@ImportResource({“classpath
将 properties 属性与一个 Bean 及其属性相关联，从而实现类型安全的配置。例：@ConfigurationProperties(prefix=”authot”，locations={“classpath
条件注解。当容器里有指定 Bean 的条件下。
条件注解。当类路径下有指定的类的条件下。
条件注解。基于 SpEL 表达式作为判断条件。
条件注解。基于 JVM 版本作为判断条件。
条件注解。在 JNDI 存在的条件下查找指定的位置。
条件注解。当容器里没有指定 Bean 的情况下。
条件注解。当类路径下没有指定的类的情况下。
条件注解。当前项目不是 web 项目的条件下。
条件注解。类路径是否有指定的值。
条件注解。当指定 Bean 在容器中只有一个，后者虽然有多个但是指定首选的 Bean。
条件注解。当前项目是 web 项目的情况下。
注解在类上，声明开启属性注入，使用 @Autowired 注入。例：@EnableConfigurationProperties(HttpEncodingProperties.class)。
在指定的自动配置类之后再配置。例：@AutoConfigureAfter(WebMvcAutoConfiguration.class)
本文由简悦 SimpRead 转码
