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注解来控制

name或value是必填项
matchIfMissing：当未找到对应配置是否匹配(默认不匹配)
常用组合：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常用注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

Springboot常用注解及作用说明