Java常用的注解

注解本身没有功能的，就和 xml 一样。注解和 xml 都是一种元数据，元数据即解释数据的数据，这就是所谓配置。

Spring 部分

声明 bean 的注解

• @Component 组件，没有明确的角色，在类上使用注解

• @Component，该注解的 value 属性用于指定该 bean 的 id 值

• @Repository 用于对 DAO 实现类进行注解

• @Service 用于对 Service 实现类进行注解

• @Controller 用于对 Controller 实现类进行注解

注入 bean 的注解

• @Autowired：由 Spring 提供

• @Inject：由 JSR-330 提供

• @Resource：由 JSR-250 提供

都可以注解在 set 方法和属性上，推荐注解在属性上(一目了然，少写代码)。

Java 配置类相关注解

• @Configuration 表示当前类充当 Spring 容器，即所有的 Bean 将由这个类来创建(类上)

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

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

• @ComponentScan 用于对 Component 进行扫描，相当于 xml 中的（类上）

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

切面（AOP）相关注解

Spring 支持 AspectJ 的注解式切面编程。

• @Aspect 指定当前 POJO 类将作为切面(类上)

使用 @After 、 @Before 、 @Around 定义建言 (advice) ，可直接将拦截规则（切点）作为参数。

• @After 在方法执行之后执行（方法上）

• @Before 在方法执行之前执行（方法上）

• @Around 在方法执行之前与之后执行（方法上）

• @Pointcut 定义切入点

在 Java 配置类中使用 @EnableAspectJAutoProxy 注解开启 Spring 对 AspectJ 代理的支持（类上）

@Bean 的属性支持

• @Scope 设置 Spring 容器如何新建 Bean 实例(方法上，得有 @Bean )

其设置类型包括：

• Singleton (单例,一个 Spring 容器中只有一个 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

@Value注解

@Value 为属性注入值(属性上)支持如下方式的注入：

1. 注入普通字符串

@Value("normal")

private String normal

2. 注入文件资源

@Value("classpath:com/huang/spring/configinject/config.txt")

private Resource resourceFile;

3. 注入 URL 资源

@Value("https://www.huangyuanzhi.top")

private Resource testUrl;

4. 注入表达式结果

@Value("#{ T(java.lang.Math).random() * 100.0 }")

private double randomNumber;

5. 注入其它 bean 属性

@Value("{domeClass.name}")
String name;

6. 注入配置文件

@Value("${book.name}")

private String bookName;

注入配置使用方法：

(1) 编写配置文件（test.properties）

book.name=《三体》

(2) @PropertySource 加载配置文件(类上)

@PropertySource("classpath:com/huang/spring/configinject/config.properties")

(3) 还需配置一个 PropertySourcesPlaceholderConfigurer 的 bean 。

环境切换

• @Profile 通过设定 Environment 的 ActiveProfiles 来设定当前 context 需要使用的配置环境。(类或方法上)

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

异步相关

• @EnableAsync 配置类中，通过此注解开启对异步任务的支持，叙事性 AsyncConfigurer 接口(类上)

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

定时任务相关

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

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

@Enable* 注解说明

这些注解主要用来开启对xxx的支持。

• @EnableAspectJAutoProxy 开启对 AspectJ 自动代理的支持

• @EnableAsync 开启异步方法的支持

• @EnableScheduling 开启计划任务的支持

• @EnableWebMvc 开启 Web MVC 的配置支持

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

• @EnableJpaRepositories 开启对 SpringData JPA Repository 的支持

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

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

测试相关注解

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

• @ContextConfiguration 用来加载配置 ApplicationContext ，其中 classes 属性用来加载配置类

Spring MVC 部分

• @EnableWebMvc 在配置类中开启 Web MVC 的配置支持，如一些 ViewResolver 或者 MessageConverter 等，若无此句，重写 WebMvcConfigurerAdapter 方法(用于对 SpringMVC 的配置)。

• @Controller 表示当前类为处理器

• @RequestMapping 表示当前方法为处理器方法；该方法要对 value 属性所指定的 URL 进行处理与响应； 被注解的方法的方法名可以随意。

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

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

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

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

• @ControllerAdvice 通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了 @Controller 的类的方法可使用

• @ExceptionHandler 、 @InitBinder 、 @ModelAttribute 注解到方法上，这对所有注解了 @RequestMapping 的控制器内的方法有效。

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

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

• @ModelAttribute 本来的作用是绑定键值对到 Model 里，在 @ControllerAdvice 中是让全局的 @RequestMapping 都能获得在此处设置的键值对。