Spring注解总结
目录
Spring注解大全
<!-- 注解扫描 -->
<context:component-scan base-package="com.zwk.annotation"/>
<!--使用mvc注解声明 -->
<mvc:annotation-driven/>
1.声明bean的注解
| Spring注解 | 描述 |
|---|---|
| @Component | 组件，声明一个bean放入IOC容器, 没有明确的角色, 有以下三个衍生层 |
| @Repository | 持久层声明的注解 (dao层) |
| @Service | 在业务逻辑层使用 (service层) |
| @Controlle | 声明Http处理对象 (web层) |
这些注解都可以添加参数, 例如@Component("user") , 即参数就相当于bean标签中的id属性, 如果不写参数, 默认id为类名首字母小写
2.注入bean的注解(依赖注入)
| Spring注解 | 描述 |
|---|---|
| @Autowired | Spring提供的工具（由Spring的依赖注入工具, 根据类型自动装配(byType （BeanPostProcessor、BeanFactoryPostProcessor）自动注入。） |
| @Qualifier | 根据名字的方式进行装配,不能单独使用 ,需要结合@Autowired来使用 参数就是要注入的bean的id |
| @Inject | 由JSR-330提供 |
| @Resource | 由JSR-250提供, 先根据类型匹配, 没有再根据名字匹配, 都没有则抛出异常 |
3.@Bean的属性支持
| Spring注解 | 描述 |
|---|---|
| @Scope | 设置Spring容器如何新建Bean实例（方法上，得有@Bean） 其设置类型包括： Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）, Protetype （每次调用新建一个bean）, Request （web项目中，给每个http request新建一个bean）, Session （web项目中，给每个http session新建一个bean） |
| @StepScope | 在Spring Batch中还有涉及 |
| @PostConstruct | 由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod |
| @PreDestory | 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod |
| @Lazy | 延迟加载, 当第一次调用对象的时候创建, 参数有true和false, 默认为true |
4.切面（AOP）相关注解
| Spring注解 | 描述 |
|---|---|
| @Aspect | 声明一个切面（类上）,使用@After、@Before、@Around定义建言（advice）， 可直接将拦截规则（切点）作为参数。 |
| @After | 在方法执行之后执行（方法上） |
| @Before | 在方法执行之前执行（方法上） |
| @Around | 在方法执行之前与之后执行（方法上） |
| @PointCut | 声明切点, 在java配置类中使用@EnableAspectJAutoProxy 注解开启Spring对AspectJ代理的支持（类上） |
5.java配置类相关注解
| Spring注解 | 描述 |
|---|---|
| @Configuration | 声明当前类为配置类，相当于xml形式的Spring配置（类上） |
| @Bean | 注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上） |
| @Configuration | 声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上） |
| @ComponentScan | 用于对Component进行扫描，相当于xml中的context:component-scan（类上） |
| @WishlyConfiguration | 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解 |
6.@Value注解
@Value() 为属性注入值（属性上）
例如:
@Value("张三")
String name;
// 上面写法等效于, 只不过上面的写法是让spring给赋值
String name = "张三";
7.环境切换
| Spring注解 | 描述 |
|---|---|
| @Profile | 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上） |
| @Conditional | Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上） |
8.异步相关
| Spring注解 | 描述 |
|---|---|
| @EnableAsync | 配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上） |
| @Async | 在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务） |
9.定时任务相关
| Spring注解 | 描述 |
|---|---|
| @EnableScheduling | 在配置类上使用，开启计划任务的支持（类上） |
| @Scheduled | 来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持） |
10.@Enable*注解说明
这些注解主要用来开启对xxx的支持。
| Spring注解 | 描述 |
|---|---|
| @EnableAspectJAutoProxy | 开启对AspectJ自动代理的支持 |
| @EnableAsync | 开启异步方法的支持 |
| @EnableScheduling | 开启计划任务的支持 |
| @EnableWebMvc | 开启Web MVC的配置支持 |
| @EnableConfigurationProperties | 开启对@ConfigurationProperties注解配置Bean的支持 |
| @EnableJpaRepositories | 开启对SpringData JPA Repository的支持 |
| @EnableTransactionManagement | 开启注解式事务的支持 |
| @EnableCaching | 开启注解式的缓存支持 |
11.测试相关注解
| Spring注解 | 描述 |
|---|---|
| @RunWith | 运行器，Spring中通常用于对JUnit的支持 |
| @ContextConfiguration | 用来加载配置ApplicationContext，其中classes属性用来加载配置类 |
12.SpringMVC部分
上一部分的注解是Spring的注解，这一部分的注解是SpringMVC的注解
| 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的控制器内 的方法有效。 |
| @ExceptionHandler | 用于全局处理控制器里的异常 |
| @InitBinder | 用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。 |
| @ModelAttribute | 本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的 @RequestMapping都能获得在此处设置的键值对。 |
