Spring注解大全

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

本文主要罗列spring|springmvc相关注解的简介。

spring部分
1.声明bean的注解

　　@component 组件，没有明确的角色

　　@service 在业务逻辑层使用（service层）

　　@repository 在数据访问层使用（dao层）

　　@controller 在展现层使用，控制器的声明（c）

2.注入bean的注解

　　@autowired：由spring提供

　　@inject：由jsr-330提供

　　@resource：由jsr-250提供

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

3.java配置类相关注解

　　@configuration 声明当前类为配置类，相当于xml形式的spring配置（类上）

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

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

　　@componentscan 用于对component进行扫描，相当于xml中的（类上）

　　@wishlyconfiguration 为@configuration与@componentscan的组合注解，可以替代这两个注解

4.切面（aop）相关注解

　　spring支持aspectj的注解式切面编程。

　　@aspect 声明一个切面（类上） 

　　使用@after、@before、@around定义建言（advice），可直接将拦截规则（切点）作为参数。

　　@after 在方法执行之后执行（方法上）
　　@before 在方法执行之前执行（方法上）
　　@around 在方法执行之前与之后执行（方法上）

　　@pointcut 声明切点
　　在java配置类中使用@enableaspectjautoproxy注解开启spring对aspectj代理的支持（类上）

5.@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

6.@value注解

　　@value 为属性注入值（属性上）
　　支持如下方式的注入：
　　》注入普通字符

@value("michael jackson")
string name;

　　》注入操作系统属性

@value("#{systemproperties['os.name']}")
string osname;

　　》注入表达式结果

@value("#{ t(java.lang.math).random() * 100 }")
string randomnumber;

　　》注入其它bean属性

@value("#{domeclass.name}")
string name;

　　》注入文件资源

@value("classpath:com/hgs/hello/test.txt")
string resource file;

　　》注入网站资源

@value("http://www.cznovel.com")
resource url;

　　》注入配置文件

@value("${book.name}")
string bookname;

　　注入配置使用方法：
　　① 编写配置文件（test.properties）

book.name=《三体》

　　② @propertysource 加载配置文件(类上)

@propertysource("classpath:com/hgs/hello/test/test.propertie")

　　③ 还需配置一个propertysourcesplaceholderconfigurer的bean。

7.环境切换

　　@profile 通过设定environment的activeprofiles来设定当前context需要使用的配置环境。（类或方法上）

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

8.异步相关

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

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

9.定时任务相关

　　@enablescheduling 在配置类上使用，开启计划任务的支持（类上）

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

10.@enable*注解说明

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

　　@enableaspectjautoproxy 开启对aspectj自动代理的支持

　　@enableasync 开启异步方法的支持

　　@enablescheduling 开启计划任务的支持

　　@enablewebmvc 开启web mvc的配置支持

　　@enableconfigurationproperties 开启对@configurationproperties注解配置bean的支持

　　@enablejparepositories 开启对springdata jpa repository的支持

　　@enabletransactionmanagement 开启注解式事务的支持

　　@enabletransactionmanagement 开启注解式事务的支持

　　@enablecaching 开启注解式的缓存支持

11.测试相关注解

　　@runwith 运行器，spring中通常用于对junit的支持

@runwith(springjunit4classrunner.class)

　　@contextconfiguration 用来加载配置applicationcontext，其中classes属性用来加载配置类

@contextconfiguration(classes={testconfig.class})

　　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都能获得在此处设置的键值对。

　　如有遗漏或有误的地方，希望帮忙指出。
---------------------
作者：it_faquir
来源：csdn
原文：https://blog.csdn.net/it_faquir/article/details/78025203
版权声明：本文为博主原创文章，转载请附上博文链接！