【建议收藏】Spring Boot注解全梳理!
一、注解(annotations)列表
@SpringBootApplication
:包含了**@ComponentScan**、「@Configuration」 和 「@EnableAutoConfiguration」 注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。
@Configuration
等同于spring的XML配置文件;使用Java代码可以检查类型安全。
@EnableAutoConfiguration
自动配置。
@ComponentScan
组件扫描,可自动发现和装配一些Bean。
@Component
可配合 CommandLineRunner
使用,在程序启动后执行一些基础任务。
@RestController
注解是 「@Controller」 和 「@ResponseBody」 的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。
@Autowired
自动导入。
@PathVariable
获取参数。
@JsonBackReference
解决嵌套外链问题。
@RepositoryRestResourcepublic
配合 「spring-boot-starter-data-rest」 使用。
二、注解(annotations)详解
@SpringBootApplication
:申明让spring boot自动给程序进行必要的配置,这个配置等同于:「@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。」
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
@ResponseBody
:表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。
在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody
后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。示例代码:
@RequestMapping(“/test”)
@ResponseBody
public String test(){return”ok”;
}
@Controller
:用于定义控制器类,在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法 「需要配合注解@RequestMapping」。示例代码:
@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {@Autowiredprivate DemoInfoService demoInfoService;@RequestMapping("/hello")public String hello(Map<String,Object> map){System.out.println("DemoController.hello()");map.put("hello","from TemplateController.helloHtml");//会使用hello.html或者hello.ftl模板进行渲染显示.return"/hello";}
}
@RestController
:用于标注控制层组件(如struts中的action),@ResponseBody和@Controller的合集。示例代码:
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {@RequestMapping("/test")public String test(){return"ok";}
}
@RequestMapping
:提供路由信息,负责URL到Controller中的具体函数的映射。
@EnableAutoConfiguration
:Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。
@ComponentScan
:表示将该类自动发现扫描组件。个人理解相当于,如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。
@Configuration
:相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。
@Import
:用来导入其他配置类。
@ImportResource
:用来加载xml配置文件。
@Autowired
:自动导入依赖的bean。公众号搜索 [Java学习之道],回复 '福利',3T资料等你来拿。
@Service
:一般用于修饰service层的组件
@Repository
:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
@Bean
:用@Bean标注方法等价于XML中配置的bean。
@Value
:注入Spring boot application.properties配置的属性的值。示例代码:
private String message;
@Inject
:等价于默认的@Autowired,只是没有required属性;
@Component
:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@Bean
:相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。
@AutoWired:自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。
@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:
@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;
@Resource(name=”name”,type=”type”):没有括号内内容的话,默认byName。与@Autowired干类似的事。
三、JPA注解
@Entity
:@Table(name=”“):表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略
@MappedSuperClass
:用在确定是父类的entity上。父类的属性子类可以继承。
@NoRepositoryBean
:一般用作父类的repository,有这个注解,spring不会去实例化该repository。
@Column
:如果字段名与列名相同,则可以省略。
@Id
:表示该属性为主键。
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)
:表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq。
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)
:name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。
@Transient
:表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式
@JsonIgnore
:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。
@JoinColumn(name=”loginId”)
:一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。
@OneToOne
、@OneToMany
、@ManyToOne
:对应hibernate配置文件中的一对一,一对多,多对一。
四、springMVC相关注解
@RequestMapping
:@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性:params:指定request中必须包含某些参数值是,才让该方法处理。headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。value:指定请求的实际地址,指定的地址可以是URI Template 模式 method:指定请求的method类型, GET、POST、PUT、DELETE等 consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html; produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回
@RequestParam
:用在方法的参数前面。
@RequestParam
String a =request.getParameter(“a”)。
@PathVariable
:路径变量。如
RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){//do something;
}
参数与大括号里的名字一样要相同。
五、全局异常处理
@ControllerAdvice
:包含@Component。可以被扫描到。统一处理异常。
@ExceptionHandler(Exception.class)
:用在方法上面表示遇到这个异常就执行以下方法。
【建议收藏】Spring Boot注解全梳理!相关推荐
- 《Spring Boot+Vue全栈开发实战》读书笔记
写在前面 嗯,回家处理一些事,所以离职了,之前的公司用开源技术封装了一套自己的低代码平台,所以之前学的spring Boot之类的东西都忘了很多,蹭回家的闲暇时间复习下. 笔记整体以 Spring B ...
- 读书笔记《Spring Boot+Vue全栈开发实战》(下)
本书将带你全面了解Spring Boot基础与实践,带领读者一步步进入 Spring Boot 的世界. 前言 第九章 Spring Boot缓存 第十章 Spring Boot安全管理 第十一章 S ...
- Spring Boot 专栏全栈开发实战
2020 年 11 月 12 日,Spring 官方发布了 Spring Boot 2.4.0 GA 的公告,链接为 Spring Boot 2.4.0 available now.为了让大家能够学习 ...
- Spring Boot注解
文章目录 简介 @SpringBootApplication @EnableAutoConfiguration 条件自动配置 @ConditionalOnClass 和 @ConditionalOnM ...
- 超级详细的Spring Boot 注解总结
日常编程中我相信大家肯定都用过spring,也用过spring的注解,哪怕面试的时候也经常会被问到一些spring和spring boot注解的作用和含义等,那么这篇就带大家来看看超级详细的Sprin ...
- Spring Boot 注解原理
Spring Boot 注解原理 首先,先看SpringBoot的主配置类: @SpringBootApplication public class StartEurekaApplication {p ...
- Spring Boot+Vue全栈开发实战——花了一个礼拜读懂了这本书
很幸运能够阅读王松老师的<Spring Boot+Vue全栈开发实战>这本书!之前也看过Spring Boot与Vue的相关知识,自己也会使用了Spring Boot+Vue进行开发项目. ...
- Spring Boot注解的运行原理
Spring Boot 是一个基于 Spring Framework 的开源框架,通过简化配置和开发过程,使 Spring 应用程序的开发变得更加快速和便捷.在 Spring Boot 中,注解是非常 ...
- Spring Boot注解大全,一键收藏了!
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 来源:www.cnblogs.com/tanwei81/p/681 ...
最新文章
- 用jQuery实现文件的上传,后台为spring+mybatis
- 套接字选项SO_LINGER
- Java设计模式分为创建模式, 结构模式, 行为模式 3种类型
- linux与windows双系统保持时间同步
- Nginx多进程高并发、低时延、高可靠机制在缓存(redis、memcache)twemproxy代理中的应用...
- minheight能继承吗_民法典亮点盘点 | 侄子能继承叔叔的遗产吗?
- 关于JSP与Int不得不说的故事
- ubuntu下安装 memecache
- Java 算法 等差数列
- 【方案分享】华为智慧农业解决方案.pdf(附下载链接)
- set集合判断集合中是否有无元素_第八章 集合
- JAVA 蓝桥杯 第十届 省赛 C组 之 [等差数列]
- 离线pandas安装教程
- kappa一致性检验教程_R语言中的试验一致性检验分析 kappa检验和McNemar检验
- 利用注册表更改文件默认打开方式及图标
- [Azure]使用Powershell输出某台ARM虚拟机的NSG
- MyEclipse10激活方法
- iOS GPUImage研究六:为视频添加图片水印
- centos7安装dos2unix
- 【Java】练习题库 单选题
热门文章
- vc richedit 指定光标位置_机械图纸·每日一符:位置度
- java中unknown source_java中GUI编程中的unknown source问题
- 251f与ips屏显示器对比_同样是240Hz高刷新率 有了VA屏你还会选择TN?
- 从命令行使用 wget 调试网页错误
- Java 对象初始化的过程介绍
- 是什么轮胎_为什么现在的车轮胎轮毂尺寸越来越大
- android 图片过滤,android 图片转为bitmap,黑白镜过滤
- python是什么时候出现的_python什么时候发明的
- 最小生成树(Kruskal )
- oracle bulk collect