Spring 常用注解

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

本文主要罗列Spring及SpringMVC相关注解：

一、Spring部分

1、声明Bean的注解

@Component注解：组件，没有明确的角色；
@Service注解：在业务Service层使用；
@Repository注解：在数据访问层使用；
@Controller注解：在表现层申明控制器；

2、注入bean的注解

@Autowired注解：注入bean，由Spring提供，可用于属性上，set方法上；
@inject注解：由JSR-330提供；
@Resource注解：由JSR-250提供

为了简洁好看，可以写在属性上，但是为了逻辑的严密性，比如判断是否为空，为空怎么办？或者是一些需要特殊处理的逻辑性问题，写在set方法上可以加一些逻辑处理；

2.1、@Bean

@Scope设置Spring容器如何创建Bean，可选值有：

1. Singleton：单例，一个Spring容器中只有一个bean的实例，默认；
2. Protetype：多例，每次调用都会创建一个Bean的实例；
3. Request：（Web）request表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP request内有效；
4. Session：（Web）session作用域表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP session内有效;
5. Global session：（Web） global session作用域类似于标准的HTTP Session作用域，不过它仅仅在基于portlet的web应用中才有意义；

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

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

3、配置类相关

@Configuration注解：声明当前类为配置类，相当于XML形式的配置，其内部有@Component注解，表示是一个该类也是一个bean；
@Bean注解：使用位置在方法上，表示当前方法的返回值为一个bean，相当于XML形式的Bean标签；
@ComponentScan注解：用于对Component进行扫描装配，相当于XML中的autoScan标签；

4、切面相关

@Aspect注解：在类上使用，声明一个切面；
@After注解：在方法执行之后执行（方法上）；
@Before注解： 在方法执行之前执行（方法上）；
@Around注解：在方法执行之前与之后执行（方法上）；
@PointCut注解：声明切点；

在配置类中需要使用@EnableAspectJAutoProxy开启Spring对AspectJ代理的支持；

5、值注入@Value

@Value 为属性注入值（属性上）

注入普通字符串

    @Value("normal")
    private String normal; // 注入普通字符串

注入操作系统属性

    @Value("#{systemProperties['os.name']}")
    private String systemPropertiesName; // 注入操作系统属性

注入表达式结果

    @Value("#{ T(java.lang.Math).random() * 100.0 }")
    private double randomNumber; //注入表达式结果

注入其他Bean属性：注入beanInject对象的属性another

    @Value("#{beanInject.another}")
    private String fromAnotherBean;

注入文件资源

    @Value("classpath:com/hry/spring/configinject/config.txt")
    private Resource resourceFile; // 注入文件资源

注入URL资源

    @Value("http://www.baidu.com")
    private Resource testUrl; // 注入URL资源

6、异步相关

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

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

注意：异步调用比如由外部函数调用，不能由本类函数调用，否则会绕过代理，变成同步操作；

7、定时任务相关

@EnableScheduling注解：在配置类上使用，开启计划任务的支持（类上）
@Scheduled注解：
来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）

8、Enable*相关

用于开启对XXX的支持；

@EnableAspectJAutoProxy注解：开启对AspectJ自动代理的支持

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

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

@EnableWebMvc注解：开启Web MVC的配置支持

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

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

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

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

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

二、SpringMVC部分

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

@Controller注解：声明该类为SpringMVC中的Controller

@RequestMapping注解：用于映射Web请求，包括访问路径和参数（类或方法上）

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

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

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

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

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

@ExceptionHandle注解：用于全局处理控制器里的异常

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

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

软件编程