Spring 最常用的 7 大类注解,史上最强整理!
上一篇:一个90后员工猝死的全过程
随着技术的更新迭代,Java5.0开始支持注解。而作为java中的领军框架spring,自从更新了2.5版本之后也开始慢慢舍弃xml配置,更多使用注解来控制spring框架。
而spring的的注解那么多,可能做java很多年,都用不上。这里按照类型总结了这7种最常用的注解。
一. 核心注解
@Required
此注解用于bean的setter方法上。表示此属性是必须的,必须在配置阶段注入,否则会抛出BeanInitializationExcepion。
@Autowired
此注解用于bean的field、setter方法以及构造方法上,显式地声明依赖。根据type来autowiring。
当在field上使用此注解,并且使用属性来传递值时,Spring会自动把值赋给此field。也可以将此注解用于私有属性(不推荐),如下。
@Component
public class User {@Autowired private Address address;
}
最经常的用法是将此注解用于settter上,这样可以在setter方法中添加自定义代码。如下:
@Component
public class User {private Address address;@AutoWiredpublic setAddress(Address address) {// custom codethis.address=address;}
}
当在构造方法上使用此注解的时候,需要注意的一点就是一个类中只允许有一个构造方法使用此注解。此外,在Spring4.3后,如果一个类仅仅只有一个构造方法,那么即使不使用此注解,那么Spring也会自动注入相关的bean。如下:
@Component
public 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来指定名称。
@Component
public class User {@Autowired@Qualifier("address1")private Address address;...
}
@Configuration
此注解用在class上来定义bean。其作用和xml配置文件相同,表示此bean是一个Spring配置。此外,此类可以使用@Bean注解来初始化定义bean。
@Configuartion
public class SpringCoreConfig {@Beanpublic 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的属性中。此注解值的注入发生在AutowiredAnnotationBeanPostProcessor类中。
二. 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";}
}
此外,Spring4.3之后引入了一系列@RequestMapping的变种。如下:
@GetMapping
@PostMapping
@PutMapping
@PatchMapping
@DeleteMapping
分别对应了相应method的RequestMapping配置。
@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" />
注解配置则需要如下开启:
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {@Overridepublic 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){
}
@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 {}
三. Spring Boot注解
@EnableAutoConfiguration
此注解通常被用在主应用class上,告诉Spring Boot自动基于当前包添加Bean、对bean的属性进行设置等。
@SpringBootApplication
此注解用在Spring Boot项目的应用主类上(此类需要在base package中)。使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan。
此注解同时添加了以下几个注解:
@Configuration
@EnableAutoConfiguration
@ComponentScan
四. Stereotype注解
@Component
此注解使用在class上来声明一个Spring组件(Bean), 将其加入到应用上下文中。
@Controller
前文已经提到过
@Service
此注解使用在class上,声明此类是一个服务类,执行业务逻辑、计算、调用内部api等。是@Component注解的一种具体形式。
@Repository
此类使用在class上声明此类用于访问数据库,一般作为DAO的角色。
此注解有自动翻译的特性,例如:当此种component抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch块。
五. 数据访问注解
@Transactional
此注解使用在接口定义、接口中的方法、类定义或者类中的public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,会被一些运行时基础设施来消费。
六. 任务执行、调度注解
@Scheduled
此注解使用在方法上,声明此方法被定时调度。使用了此注解的方法返回类型需要是Void,并且不能接受任何参数。
@Scheduled(fixedDelay=1000)
public void schedule() {}@Scheduled(fixedRate=1000)
public void schedulg() { }
第二个与第一个不同之处在于其不会等待上一次的任务执行结束。
@Async
此注解使用在方法上,声明此方法会在一个单独的线程中执行。不同于Scheduled注解,此注解可以接受参数。
使用此注解的方法的返回类型可以是Void也可是返回值。但是返回值的类型必须是一个Future。
七. 测试注解
@ContextConfiguration
此注解使用在Class上,声明测试使用的配置文件,此外,也可以指定加载上下文的类。
此注解一般需要搭配SpringJUnit4ClassRunner使用。
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringCoreConfig.class)
public class UserServiceTest {}
最后,关注公众号互联网架构师,在后台回复:2T,可以获取我整理和创作的 Java 系列教程非常齐全。
推荐阅读
1、2019 年 9 月全国程序员工资统计,你是什么水平?
2、如何才能成为优秀的架构师?
3、从零开始搭建创业公司后台技术栈
4、程序员一般可以从什么平台接私活?
5、37岁程序员被裁,120天没找到工作,无奈去小公司,结果懵了...
6、滴滴业务中台构建实践,首次曝光
7、不认命,从10年流水线工人,到谷歌上班的程序媛,一位湖南妹子的励志故事
8、15张图看懂瞎忙和高效的区别!
Spring 最常用的 7 大类注解,史上最强整理!相关推荐
- 苹果电脑常用的计算机英语怎么说,史上最强苹果电脑Mac Pro发布 有啥亮点(中英文)...
新东方留学生资料下载 姓名 手机号 短信验证码 图片验证码 年级 请选择 5年级 6年级 7年级 8年级 9年级 高一 高二 高三 高三复习 大一 大二 大三 大四 大五 研一 研二 研三 博一 博二 ...
- 刚刚,史上最强Apollo3.5在CES发布!暗藏百度无人驾驶7大黑科技武器
雷刚 发自 凹非寺 量子位 报道 | 公众号 QbitAI Wow,wow,wow~ 2019CES大展已开幕,1月8日的Westgate酒店宴会厅现场,感叹声此起彼伏. 这是在百度Apollo C ...
- 人工智能、大数据、和数据科学领域,常用的十大类算法
AI正在改变我们的职业.我们的工作方式和我们的企业文化.AI让我们得以专注于那些真正关键的技术,让人力资源得以充分发挥他们的长处.但在工作场景中应用AI确实会让事情变得复杂,因为有各种不同层级的算法可 ...
- Spring基础专题——第九章(基础注解编程——上)
目标,去年一年比较懒吧,所以今年我希望我的知识可以分享给正在奋斗中的互联网开发人员,以及未来想往架构师上走的道友们我们一起进步,从一个互联网职场小白到一个沪漂湿人,一路让我知道分享是一件多么重要的事情 ...
- 史上最强Java架构师的13大技术能力讲解! | 附架构师能力图谱
从程序员进阶成为架构师,并非一蹴而就,需要系统化.阶段性地学习,在实战项目中融会贯通,这如同打怪通关,我们得一关一关突破,每攻破一个关口,就能得到更精良的装备,技能值也随之不断增长,直至大获全胜. 凡 ...
- Android项目中常用的工具类集(史上最全整理)
如果你是一名有经验的Android开发者,那么你一定积累了不少的工具类,这些工具类是帮助我们快速开发的基础.如果你是新手,那么有了这些辅助类,可以让你的项目做起来更加的简单. 下面介绍一个在GitHu ...
- Java常用工具类整合(史上最全)
JSON转换工具 package com.taotao.utils;import java.util.List;import com.fasterxml.jackson.core.JsonProces ...
- 大满足!史上最全|托盘类自动化立体库视频合集
大家好,我是智能仓储物流技术研习社,社长老K.上篇介绍了自动化立体库的起源.发展过程和各种应用,具体见文章: 自动化立体库的前世今生 文章中附有各种种类的立体库的视频,由于微信文章的最多出现3个 ...
- C#200个基础工具类,史上最全快收藏下载
场景 包含工具类部分如下: CSV文件转换;DataTable转实体;Excel操作类;FTP操作类;Html操作类;IP辅助类;JSON操作;JS操作;URL的操作类;XML操作类;处理多媒体的公共 ...
- 史上最全整理:大投机家 杰西·利弗莫尔 投资原则及启示(期货股票交易者必收藏)
导读: 尽管杰西·利弗莫尔先生没有做到善始善终,身后落得个极其悲惨的下场,但作为华尔街20世纪最大的神话,无论是他的追随者还是劲敌都承认--杰西·利弗莫尔是最杰出的股市操盘手之一. 壹 杰西·利弗莫尔 ...
最新文章
- python图像验证码识别_python 简单图像识别--验证码
- linux中文系统装offci,Ubuntu 14.04 LTS中安装fcitx中文输入法的教程
- POJ 2778 DNA Sequence (自动机DP+矩阵快速幂)
- 严重性代码说明项目文件行 禁止显示状态错误 C4996 fopen('fscanf'、strcmp):This function or variable may be unsafe. 最全解决办法
- 采购订单单位与基本计量单位不一致问题案例
- 一个即将步入运维的菜虫内心
- python 逗号作用 语句间_Python 逗号的几种作用
- java转换为字符串_java – 如何从int转换为字符串?
- 排序算法理解总结篇——冒泡排序、选择排序、插入排序、希尔排序、归并排序、堆排序、计数排序、基数排序、桶排序
- 动手制作Dos、WinPE、Slax Linux|winpe+dos+Mini Linux U盘启动盘
- C语言算法碎碎记录之“一圈人,数到几的人就出去,最后一个是几号”
- Java通过 JDBC 连接数据库操作
- vmware您无权输入许可证秘钥
- java编程选游戏本还是轻薄本,编程用什么笔记本,超薄本还是游戏本
- remote debugger java,VS2015 远程调试:Remote Debugger
- 纯小白如何拥有一个自己的服务器,并建立网站?
- 机器学习系列4 使用Python创建Scikit-Learn回归模型
- SQLServer LDF日志文件过大解决方案 2021-09-26
- SDS(Spoken Dialogue System) 对话系统
- 【Android】HAL层浅析