Spring 注解大全与详解

1.声明bean的注解

@Controller

组合注解（组合了@Component注解），应用在MVC层（控制层）,DispatcherServlet会自动扫描注解了此注解的类，然后将web请求映射到注解了@RequestMapping的方法上。

@Service

组合注解（组合了@Component注解），应用在service层（业务逻辑层）

@Reponsitory

组合注解（组合了@Component注解），应用在dao层（数据访问层）

@Component

表示一个带注释的类是一个“组件”，成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。

同时@Component还是一个元注解。

 

2.注入bean的注解

@Autowired

Spring提供的工具（由Spring的依赖注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自动注入。）

@Resource

JSR-250提供的注解

@Inject

JSR-330提供的注解

 

3.java配置类相关注解

@Configuration

声明当前类是一个配置类（相当于一个Spring配置的xml文件）

@ComponentScan

自动扫描指定包下所有使用@Service,@Component,@Controller,@Repository的类并注册

@Bean

 注解在方法上，声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destroy()方法，然后在@Bean(initMethod=”init”,destroyMethod=”destroy”)定义，在构造之后执行init，在销毁之前执行destroy。

@Configuration

声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）

@WishlyConfiguration

 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

 

4.切面（AOP）相关注解

@Aspect

声明一个切面（就是说这是一个额外功能）

@After

后置建言（advice），在原方法前执行。

@Before

前置建言（advice），在原方法后执行。

@Around

环绕建言（advice），在原方法执行前执行，在原方法执行后再执行（@Around可以实现其他两种advice）

@PointCut

声明切点, 在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）

@Transactional

声明事务（一般默认配置即可满足要求，当然也可以自定义）

@Cacheable

声明数据缓存

@EnableAspectJAutoProxy

开启Spring对AspectJ的支持

 

5. @Bean的属性支持

@Scope

设置Spring容器如何新建Bean实例（方法上，得有@Bean）

其设置类型包括：Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）,

Protetype （每次调用新建一个bean）,

Protetype （每次调用新建一个bean）,

Request （web项目中，给每个http request新建一个bean）,

Session （web项目中，给每个http session新建一个bean）,

GlobalSession（给每一个 global http session新建一个Bean实例）

@StepScope

在Spring Batch中还有涉及

@PostConstruct

由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod

@PreDestory

由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

 

6. @Value注解

@Value

值得注入。经常与Sping EL表达式语言一起使用，注入普通字符，系统属性，表达式运算结果，其他Bean的属性，文件内容，网址请求内容，配置文件属性值等等

 

7.环境切换

@Profile

表示当一个或多个指定的文件是活动的时，一个组件是有资格注册的。使用@Profile注解类或者方法，达到在不同情况下选择实例化不同的Bean。@Profile(“dev”)表示为dev时实例化。

@PropertySource

指定文件地址。提供了一种方便的、声明性的机制，用于向Spring的环境添加PropertySource。与@configuration类一起使用。

@PostConstruct

标注在方法上，该方法在构造函数执行完成之后执行。

@PreDestroy

标注在方法上，该方法在对象销毁之前执行。

@Conditional

Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

 

8.异步相关

@EnableAsync

配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）

@Async

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

 

9.定时任务相关

@EnableScheduling

注解在配置类上，开启对计划任务的支持。

@Scheduled

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

@Conditional

根据满足某一特定条件创建特定的Bean

 

10. @Enable*注解说明

@Enable*

通过简单的@Enable*来开启一项功能的支持。所有@Enable*注解都有一个@Import注解，@Import是用来导入配置类的，这也就意味着这些自动开启的实现其实是导入了一些自动配置的Bean(1.直接导入配置类2.依据条件选择配置类3.动态注册配置类)

@EnableAspectJAutoProxy

开启对AspectJ自动代理的支持

@EnableAsync

 开启异步方法的支持

@EnableScheduling

 开启计划任务的支持

@EnableWebMvc

 开启Web MVC的配置支持

@EnableConfigurationProperties

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

@EnableJpaRepositories

开启对SpringData JPA Repository的支持

@EnableTransactionManagement

 开启注解式事务的支持

@EnableCaching

开启注解式的缓存支持

 

11.测试相关注解

@RunWith

这个是Junit的注解，springboot集成了junit。一般在测试类里使用:@RunWith(SpringJUnit4ClassRunner.class) — SpringJUnit4ClassRunner在JUnit环境下提供Sprng TestContext Framework的功能

@ContextConfiguration

用来加载配置ApplicationContext，其中classes属性用来加载配置类:@ContextConfiguration(classes = {TestConfig.class(自定义的一个配置类)})

@ActiveProfiles

用来声明活动的profile–@ActiveProfiles(“prod”(这个prod定义在配置类中))

 

12.SpringMVC部分

@EnableWebMvc

用在配置类上，开启SpringMvc的Mvc的一些默认配置：如ViewResolver，MessageConverter等。同时在自己定制SpringMvc的相关配置时需要做到两点：1.配置类继承WebMvcConfigurerAdapter类2.就是必须使用这个@EnableWebMvc注解。

@RequestMapping

用来映射web请求（访问路径和参数），处理类和方法的。可以注解在类和方法上，注解在方法上的@RequestMapping路径会继承注解在类上的路径。同时支持Serlvet的request和response作为参数，也支持对request和response的媒体类型进行配置。其中有value(路径)，produces(定义返回的媒体类型和字符集)，method(指定请求方式)等属性。

@Controller

声明该类为SpringMVC中的Controller

@ResponseBody

支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）

@RequestBody

允许request的参数在request体中，而不是在直接链接在地址的后面。此注解放置在参数前。

@PathVariable

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

@RestController

组合注解，组合了@Controller和@ResponseBody,当我们只开发一个和页面交互数据的控制层的时候可以使用此注解。

@ControllerAdvice

用在类上，声明一个控制器建言，它也组合了@Component注解，会自动注册为Spring的Bean。

通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上， 这对所有注解了 @RequestMapping的控制器内的方法有效。

@ExceptionHandler

用在方法上定义全局处理，通过他的value属性可以过滤拦截的条件：@ExceptionHandler(value=Exception.class)–表示拦截所有的Exception。

@ModelAttribute

将键值对添加到全局，所有注解了@RequestMapping的方法可获得次键值对（就是在请求到达之前，往model里addAttribute一对name-value而已）。

@InitBinder

通过@InitBinder注解定制WebDataBinder（用在方法上，方法有一个WebDataBinder作为参数，用WebDataBinder在方法内定制数据绑定，例如可以忽略request传过来的参数Id等）。

@WebAppConfiguration

一般用在测试上，注解在类上，用来声明加载的ApplicationContext是一个WebApplicationContext。他的属性指定的是Web资源的位置，默认为src/main/webapp,我们可以修改为：@WebAppConfiguration(“src/main/resources”)。

@EnableAutoConfiguration

此注释自动载入应用程序所需的所有Bean——这依赖于Spring Boot在类路径中的查找。该注解组合了@Import注解，@Import注解导入了EnableAutoCofigurationImportSelector类，它使用SpringFactoriesLoader.loaderFactoryNames方法来扫描具有META-INF/spring.factories文件的jar包。而spring.factories里声明了有哪些自动配置。

@SpingBootApplication

SpringBoot的核心注解，主要目的是开启自动配置。它也是一个组合注解，主要组合了@Configurer，@EnableAutoConfiguration（核心）和@ComponentScan。可以通过@SpringBootApplication(exclude={想要关闭的自动配置的类名.class})来关闭特定的自动配置。

@ImportResource

虽然Spring提倡零配置，但是还是提供了对xml文件的支持，这个注解就是用来加载xml配置的。例：@ImportResource({“classpath

@ConfigurationProperties

将properties属性与一个Bean及其属性相关联，从而实现类型安全的配置。例：@ConfigurationProperties(prefix=”authot”，locations={“classpath

@ConditionalOnBean

条件注解。当容器里有指定Bean的条件下。

@ConditionalOnClass

条件注解。当类路径下有指定的类的条件下。

@ConditionalOnExpression

条件注解。基于SpEL表达式作为判断条件。

@ConditionalOnJava

条件注解。基于JVM版本作为判断条件。

@ConditionalOnJndi

条件注解。在JNDI存在的条件下查找指定的位置。

@ConditionalOnMissingBean

条件注解。当容器里没有指定Bean的情况下。

@ConditionalOnMissingClass

条件注解。当类路径下没有指定的类的情况下。

@ConditionalOnNotWebApplication

条件注解。当前项目不是web项目的条件下。

@ConditionalOnResource

条件注解。类路径是否有指定的值。

@ConditionalOnSingleCandidate

条件注解。当指定Bean在容器中只有一个，后者虽然有多个但是指定首选的Bean。

@ConditionalOnWebApplication

条件注解。当前项目是web项目的情况下。

@EnableConfigurationProperties

注解在类上，声明开启属性注入，使用@Autowired注入。例：@EnableConfigurationProperties(HttpEncodingProperties.class)。

@AutoConfigureAfter

在指定的自动配置类之后再配置。例：@AutoConfigureAfter(WebMvcAutoConfiguration.class)