Springboot常用注解及作用说明

 更新时间:2023年08月17日 10:52:03   作者:信仰_273993243  
这篇文章主要介绍了Springboot常用注解及作用说明,Springboot开发中注解是非常重要的不可或缺的,那么Springboot中有哪些常用的注解呢,今天我们就来看一下这些注解和其作用,需要的朋友可以参考下

Springboot常用注解

在开发中看到一些定义的启动器Configuration

@Configuration
@ConditionalOnClass(JestClient.class)
@EnableConfigurationProperties(ConfigBean.class)
@AutoConfigureAfter(GsonAutoConfiguration.class)
public class JestAutoConfiguration {
}

或者我们经常使用的PageHelper

@Configuration
@ConditionalOnBean(SqlSessionFactory.class)
@EnableConfigurationProperties(PageHelperProperties.class)
@AutoConfigureAfter(MybatisAutoConfiguration.class)
public class PageHelperAutoConfiguration {
}

其实上面的注解都是为了设置某某Configuration加载到项目所需要的一些条件,或者是设计该Configuration加载的先后顺序,下面看下这些注解的含义

1、@ConditionalOnClass(KafkaTemplate.class)

这个注解通俗的说就是Spring工程中引用了KafkaTemplate类的包,才会构建这个bean

2、@AutoConfigureBefore 和 @AutoConfigureAfter

//使用方式
@AutoConfigureBefore(AAAA.class)
public class CCCC {
	//说明 CCCC将会在AAAA之前加载
}
@AutoConfigureAfter(AAAA.class)
public class CCCC {
	//说明 CCCC将会在AAAA之后加载
}

3、@EnableConfigurationProperties

//使用方式
@ConfigurationProperties(prefix = "spring.elasticsearch.jest")
public class ConfigBean {
}
//仅通过@ConfigurationProperties是⽆法完成ConfigBean在spring中使⽤的
@Configuration
@EnableConfigurationProperties({ConfigBean.class}) 
public class JestAutoConfiguration {	
}

⼀句话描述@EnableConfigurationProperties的作用:把jar里面的@ConfigurationProperties的类注⼊到spring中使⽤

4、@ConditionalOnProperty注解

//使用方式
@ConditionalOnProperty(prefix = "email",name= "enable",havingValue = "true")
//必须yml中必须包含 prefix.enable=true 才会生效

一般修饰在带有@Configuration注解的类上面,控制配置类是否生效,可以使用@ConditionalOnProperty注解来控制

  1. name或value是必填项
  2. matchIfMissing:当未找到对应配置是否匹配(默认不匹配)
  3. 常用组合:prefix+name+havingValue 判断是否包含某属性且属性值与havingValue一致

例如:

//nacos的配置
@ConditionalOnProperty(name = "spring.cloud.nacos.config.enabled", matchIfMissing = true)

查询包含有spring.cloud.nacos.config.enabled配置项,如果没有找到,默认还是开启。

5、@Profile注解

//使用方式
@Configuration
public class MainConfigOfProfile{
	//@Profile关联Yellow类,当容器环境包含该"test",才激活此注解,Yellow这个bean才会注册到容器
	@Profile("test") 
	@Bean
	public Yellow yellow(){
		return new Yellow();
	}
}
//2.设置需要激活对应的@Profile
applicationContext.getEnvironment().setActiveProfiles("test1");

@Profile的作用:当容器根据“标识”激活对应的@Profile注解时,其所关联的bean类才会注册到容器。

但如果容器不存在在对应的@Profile所配置的值时,就不生成bean实例。

6、@ConditionalOnWebApplication

当前项目是Web项目的条件下。

7、@ConditionalOnMissingBean 注解的作用

它是修饰bean的一个注解,主要实现的是,当你的bean被注册之后,如果而注册相同类型的bean就不会成功,它会保证Bean在容器中只有一个

到此这篇关于Springboot常用注解及作用说明的文章就介绍到这了,更多相关Springboot常用注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈springcloud常用依赖和配置

    浅谈springcloud常用依赖和配置

    鉴于很多小伙伴常问spring cloud常用依赖和配置,今天特地整理了本篇文章,文中有非常详细的代码示例,对正在学习的小伙伴们很有帮助,需要的朋友可以参考下
    2021-05-05
  • Java集合之同步容器详解

    Java集合之同步容器详解

    这篇文章主要为大家详细介绍了Java集合之同步容器,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-08-08
  • Spring中的@RestControllerAdvice注解使用解析

    Spring中的@RestControllerAdvice注解使用解析

    这篇文章主要介绍了Spring中的@RestControllerAdvice注解使用解析,@RestControllerAdvice 是 Spring 框架中一个用于统一处理控制器异常和返回结果的注解,它可以被用来定义全局异常处理程序和全局响应结果处理程序,需要的朋友可以参考下
    2024-01-01
  • Java日期操作方法工具类实例【包含日期比较大小,相加减,判断,验证,获取年份等】

    Java日期操作方法工具类实例【包含日期比较大小,相加减,判断,验证,获取年份等】

    这篇文章主要介绍了Java日期操作方法工具类,结合完整实例形式分析了java针对日期的各种常见操作,包括日期比较大小,相加减,判断,验证,获取年份、天数、星期等,需要的朋友可以参考下
    2017-11-11
  • Java业务中台确保数据一致性的解决方案

    Java业务中台确保数据一致性的解决方案

    数据一致性通常指关联数据之间的逻辑关系是否正确和完整。而数据存储的一致性模型则可以认为是存储系统和数据使用者之间的一种约定。如果使用者遵循这种约定,则可以得到系统所承诺的访问结果
    2021-10-10
  • Java实现将枚举类转为json并返回给前端

    Java实现将枚举类转为json并返回给前端

    这篇文章主要为大家详细介绍了Java实现将枚举类转为json并返回给前端的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-12-12
  • Java面向对象程序设计:继承,多态用法实例分析

    Java面向对象程序设计:继承,多态用法实例分析

    这篇文章主要介绍了Java面向对象程序设计:继承,多态用法,结合实例形式分析了java继承与多态的相关概念、原理、实现方法与操作注意事项,需要的朋友可以参考下
    2020-04-04
  • Java实现可配置换肤的方法示例

    Java实现可配置换肤的方法示例

    本文主要介绍了Java实现可配置换肤的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • eclipse中自动生成构造函数的两种方法

    eclipse中自动生成构造函数的两种方法

    下面小编就为大家带来一篇eclipse中自动生成构造函数的两种方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Zookeeper事务日志预分配空间解读

    Zookeeper事务日志预分配空间解读

    这篇文章主要介绍了Zookeeper事务日志预分配空间解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04

最新评论