【整理】Spring 常用注解!千万不要错过!
来自:徐宝 | 责编:乐乐
链接:my.oschina.net/lixingsikao/blog/3218281
干货前奏
随着技术的更新迭代Java5.0开始支持注解。作为Java中的头号领军 spring 也开始在改变 从XML配置转为注解配置 接口编程也更加广泛使用
而spring的注解很多 可能有的不接触,用不上。
这里总结7种最常用的注解。
核心注解
@Required
此注解用于bean的setter方法上。表示此属性是必须的,必须在配置阶段注入,否则会抛出BeanInitializationExcepion。
@Autowired
此注解用于bean的field、setter方法以及构造方法上,显式地声明依赖。根据type来autowiring。
当在field上使用此注解,并且使用属性来传递值时,Spring会自动把值赋给此field。也可以将此注解用于私有属性(不推荐),如下。
最经常的用法是将此注解用于settter上,这样可以在setter方法中添加自定义代码。如下:
当在构造方法上使用此注解的时候,需要注意的一点就是一个类中只允许有一个构造方法使用此注解。
此外,在Spring4.3后,如果一个类仅仅只有一个构造方法,那么即使不使用此注解,那么Spring也会自动注入相关的bean。如下:
@Qualifier
此注解是和@Autowired一起使用的。使用此注解可以让你对注入的过程有更多的控制。@Qualifier可以被用在单个构造器或者方法的参数上。当上下文有几个相同类型的bean, 使用@Autowired则无法区分要绑定的bean,此时可以使用@Qualifier来指定名称。
@Configuration
此注解用在class上来定义bean。其作用和xml配置文件相同,表示此bean是一个Spring配置。此外,此类可以使用@Bean注解来初始化定义bean。
@ComponentScan
此注解一般和@Configuration注解一起使用,指定Spring扫描注解的package。如果没有指定包,那么默认会扫描此配置类所在的package及其子包(本人常用)
@Lazy
此注解使用在Spring的组件类上。默认的,Spring中Bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean,那么可以在此类上使用Lazy注解,表示此bean只有在第一次被使用的时候才会被创建和初始化。此注解也可以使用在被@Configuration注解的类上,表示其中所有被@Bean注解的方法都会延迟初始化。
@Value
此注解使用在字段、构造器参数和方法参数上。@Value可以指定属性取值的表达式,支持通过#{}使用SpringEL来取值,也支持使用${}来将属性来源中(Properties文件、本地环境变量、系统属性等)的值注入到bean的属性中。(本人常用)
pring MVC和REST注解
@Controller
(这就不用多说了吧 天天用)
此注解使用在class上声明此类是一个Spring controller,是
@Component注解的一种具体形式。
@RequestMapping
此注解可以用在class和method上,用来映射web请求到某一个handler类或者handler方法上。当此注解用在Class上时,就创造了一个基础url,其所有的方法上的@RequestMapping都是在此url之上的。可以使用其method属性来限制请求匹配的http method。(使用频率贼高)
@RequestMapping的变种@GetMapping
@PostMapping
@PutMapping
@PatchMapping
@DeleteMapping
@CookieValue
此注解用在@RequestMapping声明的方法的参数上,可以把HTTP cookie中相应名称的cookie绑定上去。
cookie即http请求中name为JSESSIONID的cookie值。
@CrossOrigin
此注解用在class和method上用来支持跨域请求,是Spring 4.2后引入的。(现在多用CORS工具类解决)
@ExceptionHandler
此注解使用在方法级别,声明对Exception的处理逻辑。可以指定目标Exception。
@InitBinder
此注解使用在方法上,声明对WebDataBinder的初始化(绑定请求参数到JavaBean上的DataBinder)。在controller上使用此注解可以自定义请求参数的绑定。
@MatrixVariable
此注解使用在请求handler方法的参数上,Spring可以注入matrix url中相关的值。这里的矩阵变量可以出现在url中的任何地方,变量之间用;分隔。如下:
需要注意的是默认Spring mvc是不支持矩阵变量的,需要开启。
注解配置则需要如下开启:
@PathVariable
此注解使用在请求handler方法的参数上。@RequestMapping可以定义动态路径,如:
可以使用@PathVariable将路径中的参数绑定到请求方法参数上。
@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两个注解。
(说白了就是基于REST风格的控制器)
@RestControllerAdvice
此注解用于class上,同时引入了@ControllerAdvice和@ResponseBody两个注解。
@SessionAttribute
此注解用于方法的参数上,用于将session中的属性绑定到参数。
@SessionAttributes
此注解用于type级别,用于将JavaBean对象存储到session中。一般和@ModelAttribute注解一起使用。如下:
Spring Boot注解
@EnableAutoConfiguration
此注解通常被用在主应用class上,告诉Spring Boot自动基于当前包添加Bean、对bean的属性进行设置等。
@SpringBootApplication
此注解用在Spring Boot项目的应用主类上(此类需要在base package中)。使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan。
Stereotype注解
@Component
此注解使用在class上来声明一个Spring组件(Bean), 将其加入到应用上下文中。
@Controller
前文已经提到过
@Service
此注解使用在class上,声明此类是一个服务类,执行业务逻辑、计算、调用内部api等。是@Component注解的一种具体形式。
@Repository
此类使用在class上声明此类用于访问数据库,一般作为DAO的角色。此注解有自动翻译的特性,例如:当此种component抛出了一个异常,那么会有一个handler来处理此异常,无需使用try-catch块。
数据访问注解
@Transactional
此注解使用在接口定义、接口中的方法、类定义或者类中的public方法上。需要注意的是此注解并不激活事务行为,它仅仅是一个元数据,会被一些运行时基础设施来消费。
任务执行、调度注解
@Scheduled
此注解使用在方法上,声明此方法被定时调度。使用了此注解的方法返回类型需要是Void,并且不能接受任何参数。
第二个与第一个不同之处在于其不会等待上一次的任务执行结束。
@Async
此注解使用在方法上,声明此方法会在一个单独的线程中执行。不同于Scheduled注解,此注解可以接受参数。使用此注解的方法的返回类型可以是Void也可是返回值。但是返回值的类型必须是一个Future。
测试注解
@ContextConfiguration
此注解使用在Class上,声明测试使用的配置文件,此外,也可以指定加载上下文的类。此注解一般需要搭配SpringJUnit4ClassRunner使用。
以上一共是⑦大类
感觉不错的点个赞吧~~
文章推荐程序员效率:画流程图常用的工具程序员效率:整理常用的在线笔记软件远程办公:常用的远程协助软件,你都知道吗?51单片机程序下载、ISP及串口基础知识硬件:断路器、接触器、继电器基础知识
【整理】Spring 常用注解!千万不要错过!相关推荐
- Spring 常用注解 脑图版
Spring 常用注解 脑图版 学习Spring Boot过程的笔记,通过思维导图整理自己的思路,更符合大脑记忆;在线版可以看到注释及代码实现; 在线脑图地址: http://naotu.baidu. ...
- Spring系列之Spring常用注解总结
参看博客:https://www.cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺 ...
- Spring常用注解总结
传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 1.如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml文 ...
- spring autowired idea都匹配上了_你清楚这几个Spring常用注解吗?
作者:平凡希http://cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 如 ...
- Java 必须掌握的 12 种 Spring 常用注解
转载自 Java 必须掌握的 12 种 Spring 常用注解 1.声明bean的注解 @Component 组件,没有明确的角色 @Service 在业务逻辑层使用(service层) @Repo ...
- Spring常用注解 - 使用注解来构造IoC容器
Spring常用注解 使用注解来构造IoC容器 用注解来向Spring容器注册Bean.需要在applicationContext.xml中注册<context:component-scan b ...
- autowired注解_Spring系列之Spring常用注解总结
作者:平凡希来源:https://www.cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做 ...
- sessionattribute 被spring 扫描不到_Spring 系列之 Spring 常用注解总结(肝硬化的干货)...
传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 1. 如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml ...
- java 知识积累_java学习知识积累-spring常用注解
java学习知识积累-spring常用注解 类的分层注解,由于我们后台开发都是分为三层进行开发的,所以Spring框架提供了三种对于不同层的注解方式: 控制层:@Controller 服务层:@Ser ...
- Spring常用注解你知道有哪些吗?
Spring 常用注解 今天给大家介绍一下 Spring 中的常用注解,同时这些注解也是 Spring 中经常用到的注解,下面我们就一起来看看都有哪些注解吧. 1.@Controller 在控制层使用 ...
最新文章
- Matlab姿态表示
- 【Android 性能优化】布局渲染优化 ( 过渡绘制 | 背景设置产生的过度绘制 | Android 系统的渲染优化 | 自定义布局渲染优化 )
- Linux基础-2.目录文件的浏览、管理及维护
- logback日志pattern_@Slf4j 实现日志输入到外部文件
- Windows YII2安装
- 使用k-近邻算法改进约会网站的配对效果
- 【渝粤教育】电大中专金融与税收_1作业 题库
- 计算机视觉实战(二)图像基本操作
- JavaScript或MyEclipse—如何解决js文件导入到MyEclipse工程后出错?
- android for opencv (2) byte[] ,Bitmap 与 Mat 类型转换,Bitmap保存照片
- HAL层三类函数及其作用
- 物联网控制的智能LED灯带(1):WS2812灯带控制(WS2812/2811,ESP32,NODE-RED)
- ERROR:此文件包含病毒,已删除
- 26 王者荣耀刷金币脚本
- 网名闲话之“茶乡浪子”
- msgbox窗口学习总结窗体复合框
- root后手机银行用不了,root之后手机银行不能用
- Meta-DETR: Image-Level Few-Shot Detection with Inter-Class Correlation Exploitation
- 算法笔记——常见DP问题汇总
- SCAU华南农业大学-数电实验-用74LS283实现2*4乘法器