随着技术的更新迭代,java5.0开始支持注解。而作为java中的领军框架spring,自从更新了2.5版本之后也开始慢慢舍弃xml配置,更多使用注解来控制spring框架。而spring的的注解那么多,可能做java很多年,都用不上。这里按照类型总结了这7种最常用的注解。1
核心注解
@required此注解用于bean的setter方法上。表示此属性是必须的,必须在配置阶段注入,否则会抛出beaninitializationexcepion。@autowired此注解用于bean的field、setter方法以及构造方法上,显式地声明依赖。根据type来autowiring。当在field上使用此注解,并且使用属性来传递值时,spring会自动把值赋给此field。也可以将此注解用于私有属性(不推荐),如下。@componentpublic class user { @autowired private address address;}
最经常的用法是将此注解用于settter上,这样可以在setter方法中添加自定义代码。如下:
@componentpublic class user { private address address; @autowired public setaddress(address address) { // custom code this.address=address; }}
当在构造方法上使用此注解的时候,需要注意的一点就是一个类中只允许有一个构造方法使用此注解。
此外,在spring4.3后,如果一个类仅仅只有一个构造方法,那么即使不使用此注解,那么spring也会自动注入相关的bean。如下:
@componentpublic class user { private address address; public user(address address) { this.address=address; }}<bean id="user" class="xx.user"/>
@qualifier
此注解是和@autowired一起使用的。使用此注解可以让你对注入的过程有更多的控制。@qualifier可以被用在单个构造器或者方法的参数上。当上下文有几个相同类型的bean, 使用@autowired则无法区分要绑定的bean,此时可以使用@qualifier来指定名称。@componentpublic class user { @autowired @qualifier("address1") private address address; ...}
@configuration
此注解用在class上来定义bean。其作用和xml配置文件相同,表示此bean是一个spring配置。此外,此类可以使用@bean注解来初始化定义bean。@configuartionpublic class springcoreconfig { @bean public adminuser adminuser() { adminuser adminuser = new adminuser(); return adminuser; }}
@componentscan此注解一般和@configuration注解一起使用,指定spring扫描注解的package。如果没有指定包,那么默认会扫描此配置类所在的package。@lazy此注解使用在spring的组件类上。默认的,spring中bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean,那么可以在此类上使用lazy注解,表示此bean只有在第一次被使用的时候才会被创建和初始化。此注解也可以使用在被@configuration注解的类上,表示其中所有被@bean注解的方法都会延迟初始化。@value此注解使用在字段、构造器参数和方法参数上。@value可以指定属性取值的表达式,支持通过#{}使用springel来取值,也支持使用${}来将属性来源中(properties文件、本地环境变量、系统属性等)的值注入到bean的属性中。推荐大家看下:java 必须掌握的 12 种 spring 常用注解,这篇也是必看了。
此注解值的注入发生在autowiredannotationbeanpostprocessor类中。2
spring mvc和rest注解
@controller此注解使用在class上声明此类是一个spring controller,是@component注解的一种具体形式。
@requestmapping此注解可以用在class和method上,用来映射web请求到某一个handler类或者handler方法上。当此注解用在class上时,就创造了一个基础url,其所有的方法上的@requestmapping都是在此url之上的。可以使用其method属性来限制请求匹配的http method。@controller@requestmapping("/users")public class usercontroller { @requestmapping(method = requestmethod.get) public string getuserlist() { return "users"; }}
这篇也推荐大家看下:spring mvc常用注解。此外,spring4.3之后引入了一系列@requestmapping的变种。如下:
@getmapping@postmapping@putmapping@patchmapping@deletemapping分别对应了相应method的requestmapping配置。
关注微信公众号:java技术栈,在后台回复:spring,可以获取我整理的 n 篇最新 spring 教程,都是干货。@cookievalue此注解用在@requestmapping声明的方法的参数上,可以把http cookie中相应名称的cookie绑定上去。@reuestmapping("/cookievalue") public void getcookievalue(@cookievalue("jsessionid") string cookie){}
cookie即http请求中name为jsessionid的cookie值。@crossorigin此注解用在class和method上用来支持跨域请求,是spring 4.2后引入的。@crossorigin(maxage = 3600)@restcontroller@requestmapping("/users")public class accountcontroller { @crossorigin(origins = "http://xx.com") @requestmapping("/login") public result userlogin() { // ... }}
@exceptionhandler
此注解使用在方法级别,声明对exception的处理逻辑。可以指定目标exception。@initbinder此注解使用在方法上,声明对webdatabinder的初始化(绑定请求参数到javabean上的databinder)。在controller上使用此注解可以自定义请求参数的绑定。@matrixvariable此注解使用在请求handler方法的参数上,spring可以注入matrix url中相关的值。这里的矩阵变量可以出现在url中的任何地方,变量之间用;分隔。如下:// get /pets/42;q=11;r=22@requestmapping(value = "/pets/{petid}")public void findpet(@pathvariable string petid, @matrixvariable int q) { // petid == 42 // q == 11}
需要注意的是默认spring mvc是不支持矩阵变量的,需要开启。<mvc:annotation-driven enable-matrix-variables="true" />
注解配置则需要如下开启:
@configurationpublic class webconfig extends webmvcconfigureradapter { @override public void configurepathmatch(pathmatchconfigurer configurer) { urlpathhelper urlpathhelper = new urlpathhelper(); urlpathhelper.setremovesemicoloncontent(false); configurer.seturlpathhelper(urlpathhelper); }}
@pathvariable
此注解使用在请求handler方法的参数上。@requestmapping可以定义动态路径,如:@requestmapping("/users/{uid}")
可以使用@pathvariable将路径中的参数绑定到请求方法参数上。
@requestmapping("/users/{uid}")public string execute(@pathvariable("uid") string uid){}
关注微信公众号:java技术栈,在后台回复:spring,可以获取我整理的 n 篇最新 spring 系列程,都是干货。
@requestattribute
此注解用在请求handler方法的参数上,用于将web请求中的属性(request attributes,是服务器放入的属性值)绑定到方法参数上。@requestbody此注解用在请求handler方法的参数上,用于将http请求的body映射绑定到此参数上。httpmessageconverter负责将对象转换为http请求。@requestheader此注解用在请求handler方法的参数上,用于将http请求头部的值绑定到参数上。@requestparam此注解用在请求handler方法的参数上,用于将http请求参数的值绑定到参数上。@requestpart此注解用在请求handler方法的参数上,用于将文件之类的multipart绑定到参数上。@responsebody此注解用在请求handler方法上。和@requestbody作用类似,用于将方法的返回对象直接输出到http响应中。@responsestatus此注解用于方法和exception类上,声明此方法或者异常类返回的http状态码。可以在controller上使用此注解,这样所有的@requestmapping都会继承。@controlleradvice此注解用于class上。前面说过可以对每一个controller声明一个exceptionmethod。这里可以使用@controlleradvice来声明一个类来统一对所有@requestmapping方法来做@exceptionhandler、@initbinder以及@modelattribute处理。@restcontroller此注解用于class上,声明此controller返回的不是一个视图而是一个领域对象。其同时引入了@controller和@responsebody两个注解。@restcontrolleradvice此注解用于class上,同时引入了@controlleradvice和@responsebody两个注解。@sessionattribute此注解用于方法的参数上,用于将session中的属性绑定到参数。@sessionattributes此注解用于type级别,用于将javabean对象存储到session中。一般和@modelattribute注解一起使用。如下:@modelattribute("user")public puser getuser() {}// controller和上面的代码在同一controller中@controller@seesionattributes(value = "user", types = { user.class})public class usercontroller {}
3
spring boot注解
@enableautoconfiguration此注解通常被用在主应用class上,告诉spring boot自动基于当前包添加bean、对bean的属性进行设置等。@springbootapplication此注解用在spring boot项目的应用主类上(此类需要在base package中)。使用了此注解的类首先会让spring boot启动对base package以及其sub-pacakage下的类进行component scan。这篇整理的也非常全:spring boot 最核心的 25 个注解,建议大家看下。此注解同时添加了以下几个注解:@configuration@enableautoconfiguration@componentscan4
stereotype注解
@component此注解使用在class上来声明一个spring组件(bean), 将其加入到应用上下文中。@controller前文已经提到过@service此注解使用在class上,声明此类是一个服务类,执行业务逻辑、计算、调用内部api等。是@component注解的一种具体形式。@repository此类使用在class上声明此类用于访问数据库,一般作为dao的角色。此注解有自动翻译的特性,例如:当此种component抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch块。
5
数据访问注解
@transactional此注解使用在接口定义、接口中的方法、类定义或者类中的public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,会被一些运行时基础设施来消费。6
任务执行、调度注解
@scheduled此注解使用在方法上,声明此方法被定时调度。使用了此注解的方法返回类型需要是void,并且不能接受任何参数。@scheduled(fixeddelay=1000)public void schedule() {}@scheduled(fixedrate=1000)public void schedulg() {}
第二个与第一个不同之处在于其不会等待上一次的任务执行结束。@async此注解使用在方法上,声明此方法会在一个单独的线程中执行。不同于scheduled注解,此注解可以接受参数。使用此注解的方法的返回类型可以是void也可是返回值。但是返回值的类型必须是一个future。7
测试注解
@contextconfiguration此注解使用在class上,声明测试使用的配置文件,此外,也可以指定加载上下文的类。此注解一般需要搭配springjunit4classrunner使用。@runwith(springjunit4classrunner.class)@contextconfiguration(classes = springcoreconfig.class)public class userservicetest {}
以上就是spring 最常用的 7 大类注解,史上最强整理!的详细内容。