专栏首页丑胖侠SpringBoot2.x系列教程(八)SpringBoot常用注解汇总

SpringBoot2.x系列教程(八)SpringBoot常用注解汇总

随着Spring及Spring Boot的发展,基于Java的配置已经慢慢替代了基于xml的配置形式。本篇文章为大家整理和简介Spring Boot中常用的注解及其功能。

SpringBoot注解

@SpringBootApplication:开启Spring Boot自动配置的核心注解,相关等同于@Configuration,@EnableAutoConfiguration和@ComponentScan三个注解同时使用。

@EnableAutoConfiguration:SpringBoot自动配置开启注解。开启之后,会尝试根据添加到classpath中jar依赖自动配置相关组件。是Spring Boot自动配置机制的核心注解之一。

@ConditionalOnXXXX:Spring Boot基于@Conditional扩展出的衍生注解,根据是否满足某一个特定条件来决定是否加载指定的Bean。比如扩展出的注解有:@ConditionalOnBean、@ConditionalOnClass等。

@ConfigurationProperties:基于类型安全的属性配置注入,可以将properties属性和一个Bean及其属性关联,从而实现类型安全配置。

Spring基础注解

@Conditional:是Spring Boot中大量使用的注解之一,它可以根据是否满足某一个特定条件来决定是否加载指定的Bean。

@ComponentScan:该注解默认会扫描该类所在的包下所有的配置类,相当于xml中的context:component-scan。如果扫描到有@Component、@Controller、@Service等注解的类,将其注册为Bean,也可以自动收集所有的Spring组件,包括@Configuration类。Spring Boot中会扫描启动类所在包下以及子包下的使用了以上注解的类。

@Configuration:用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法。

@Profile:提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记,从而限制加载它的时机。

@Import:用来导入其他配置类,作用就是和xml配置的import标签作用一样,允许通过它引入@Configuration注解的类(java config),Spring4.2以后也可以导入普通的Java并将其声明为一个bean。

@ImportResource:用来导入一个传统的xml配置文件。

@Autowired:自动导入依赖的bean,可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。与@Resource功能相似,但默认根据类型进行自动装配的,如果需要按名称进行装配,则需要配合@Qualifier。

@Service:一般用于标注业务层组件,表示定义一个bean,自动根据bean的类名实例化一个首写字母为小写的bean。

@Component:泛指组件,当组件不好归类的时候,可以使用这个注解进行标注。

@Repository:持久层组件,用于标注数据访问组件,即DAO组件。

@Bean:用@Bean标注方法等价于XML中配置的bean。

@Value:将配置文件中key对应的值赋值给它标注的属性。

@Inject:是JSR330中的规范,等价于默认的@Autowired。根据类型进行自动装配的,如果需要按名称进行装配,则需要配合@Named。

@Bean:相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。

@AutoWired:自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者。

@Resource:JSR250规范的实现,根据名称进行自动装配的,一般会指定一个name属性。

@JsonBackReference:jackson框架注解,解决嵌套外链问题。

@PropertySource:加载指定配置文件,通常为自定义properties文件。

Spring Web注解

@ResponseBody:表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据或接口交互时使用,用于构建RESTful的api。一般情况下会将返回的类转为Json字符串的形式返回给客户端。

@Controller:将被修饰的类被实例化并注入Spring IOC容器中。语义化的作用,即代表该类是充当Controller的作用。一般由该类(控制器)负责将用户发来的URL请求转发到对应的服务接口(service层)。

@RestController:用于标注控制层组件,@ResponseBody和@Controller的合集。

@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射。

@GetMapping:是一个组合注解,是@RequestMapping(method=RequestMethod.GET)的缩写。

@PostMapping是一个组合注解,是@RequestMapping(method=RequestMethod.POST)的缩写。

@PathVariable:spring3.0的一个新功能,用于接收请求路径中占位符的值。通过@PathVariable可以将URL中占位符参数绑定到控制器处理方法的入参中:URL中的{xxx}占位符可以通过@PathVariable(“xxx“)绑定到操作方法的入参中。

@RequestParam:将请求参数绑定到控制器的方法参数上。

@ControllerAdvice:一个增强的Controller,常用于全局异常处理、全局数据绑定、全局数据预处理等。

@ExceptionHandler:与@ControllerAdvice结合使用,用于统一异常处理。

JPA注解

@Entity:表明这是一个实体类,比如实体类UserEntity,默认对应数据库中的表名是user_entity。一般与@Table结合使用,是如果表名和实体类名相同的话,@Table可以省略。

@Table:当实体类与其映射的数据库表名不同名时需要使用@Table注解说明,该标注与@Entity注解并列使用,置于实体类声明语句之前,可写于单独语句行,也可与声明语句同行。

@MappedSuperClass:注解使用在父类上面,标识的类表示其不能映射到数据库表,被标识的类不能再使用@Entity或@Table注解。

@NoRepositoryBean:一般用作父类的repository,告诉JPA不要创建对应接口的bean对象就在类上加@NoRepositoryBean注解。

@Column:用来标识实体类中属性与数据表中字段的对应关系,如果字段名与列名相同,则可以省略。

@Id:表示该属性为主键。

@GeneratedValue:为实体生成唯一标识的主键提供生成策略。主键生成策略包括sequence,Auto、IDENTITY、native等,Auto表示可在多个数据库间切换。

@Transient:表示该属性不进行数据库表的字段映射,ORM框架将忽略该属性。

@JsonIgnore:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn:用来指定与所操作实体或实体集合相关联的数据库表中的列字段。一对一,本表中指向另一个表的外键;一对多,另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManyToOne:对应hibernate配置文件中的一对一,一对多,多对一。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Spring Boot2.x系列教程(七)条件注解@Conditional详解及实战

    @Conditional是Spring Boot中大量使用的注解之一,它可以根据是否满足某一个特定条件来决定是否加载指定的Bean。本文带领大家详细了解该注解的...

    用户1161110
  • SpringBoot2.x系列教程(二十)自定义参数校验注解

    在SpringBoot的使用过程中,默认使用hibernate-validator作为参数校验的框架,但某些业务场景或校验比较复杂,通过默认提供的注解已经无法满...

    用户1161110
  • SpringBoot2.x系列教程(四十)SpringBoot中@ControllerAdvice使用详解

    @ControllerAdvice,是Spring3.2提供的新注解,顾名思义是对控制器(Controller)的增强。

    用户1161110
  • Spring中的@Qualifier注解你会用吗

    本文小胖哥将带你来了解一下Spring中的@Qualifier注解,它解决了哪些问题,以及如何使用它。我们还将了解它与@Primary注解的不同之处。

    码农小胖哥
  • Spring Boot从入门到精通-注解详解

    -Documented:Documented注解表明这个注释是由 javadoc记录的。 以上是三个公共注解,基本上所有的注解都会继承这三个注解。

    我的小熊不见了丶
  • 10分钟教你用Python实现微信自动回复

    相信大家都有忙碌的时候,不可能一直守在微信上及时回复消息。但微信又不能像QQ一样设置自动回复。无妨,今天,我们就来用Python实现微信的自动回复功能吧,并且把...

    短短的路走走停停
  • 【网站架构运维丨主题周】业务中台如何提升研发效率

    说到研发效率还真不仅仅就是如何写代码这么简单,读过《人月神话》一书的人都知道,要开发一个产品,并不是人越多越好,而是涉及人与人之间的信息传递成本,有时候人与人的...

    博文视点Broadview
  • vue之滑块验证码

    帮助文档:https://help.aliyun.com/document_detail/66318.html?spm=a2c4g.11186623.4.2.K...

    陨石坠灭
  • 计算机网络原理梳理丨链路层

    香农信道编码定理:理论上可以通过编码使得数据传输过程不发生错误,或者将错误概率控制在很小的数值之下

    码脑
  • ajax+json实现echarts多个统计图显示

    前端时常会遇到这样的问题,有一个单独的模块用作统计图,将多个折线或者柱状图,混合使用,下面的例子是用ajax+json模拟了调用接口实现echarts多个统计图...

    祈澈菇凉

扫码关注云+社区

领取腾讯云代金券