springboot常用注解作用解析

@Configuration

表示这是一个配置类,是@Component的派生类,扫描到这个类时会它加入到IOC容器中

@ConfigurationProperties

将配置文件中对应的值和加了这个注解的类绑定起来
比如下面的HelloProperties类,初始化时会读取配置文件的spring.hello为前缀的属性与自己定义的字段关联

@ConfigurationProperties(prefix = "spring.hello")
//@Component
public class HelloProperties {
    private String name;
    private Integer age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}
spring.hello.name=b
spring.hello.age=1

@EnableConfigurationProperties

比如上面HelloProperties类,只加了@ConfigurationProperties注解,是不会被扫描加载到IOC容器中的,只有在HelloProperties类上加上@Component注解,或者使用@EnableConfigurationProperties(HelloProperties.class)注解HelloProperties类才会被IOC容器加载
@EnableConfigurationProperties(HelloProperties.class)作用
启动指定类的@ConfigurationProperties功能,将配置文件中对应的值和HelloProperties类绑定起来,并把HelloProperties加入到ioc容器中
@EnableConfigurationProperties需要加在配置类上(加了@Configuration的类,或@Component和其派生类上)
当HelloConfig类被容器扫描时,就会将HelloProperties加载到IOC容器中

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
public class HelloConfig{
}

@Conditional注解的派生注解根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效
拿springboot中自动配置类,HttpEncodingAutoConfiguration做例子

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(HttpProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {

    private final HttpProperties.Encoding properties;

    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }

    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }
...
}
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

判断当前应用是否是web应用,如果是,当前配置类生效(加载到IOC容器中),如果不是web应用,HttpEncodingAutoConfiguration类就不会被加载到IOC容器中

@ConditionalOnClass(CharacterEncodingFilter.class)

判断当前项目有没有CharacterEncodingFilter这个类(存不存在CharacterEncodingFilter.class文件),如果有,则Conditional条件判断为true(成立),当前HttpEncodingAutoConfiguration配置类生效

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)

//判断配置文件中是否存在spring.http.encoding.enabled配置,matchIfMissing = true表示如果没有配置spring.http.encoding.enabled,也是满足Conditional的条件,HttpEncodingAutoConfiguration配置类生效也生效

@ConditionalOnMissingBean

上面的HttpEncodingAutoConfiguration把@ConditionalOnMissingBean用在加上@Bean的characterEncodingFilter方法上表示:如果当前项目中没有CharacterEncodingFilter这个bean(CharacterEncodingFilter类没有被初始化、未被加入到IOC容器中),则执行characterEncodingFilter方法初始化characterEncodingFilter,将其加入到IOC容器中


@ConditionalOnClass(CharacterEncodingFilter.class)和@ConditionalOnMissingBean的区别是
@ConditionalOnClass(CharacterEncodingFilter.class)是判断项目中是否存在CharacterEncodingFilter的类路径(是否存在CharacterEncodingFilter.class这个文件)
@ConditionalOnMissingBean是判断CharacterEncodingFilter这个类是否已经初始化了(是否已经加入到IOC容器中)

这里记录一些@Conditional派生的注解

@Conditional派生注解(Spring注解版原生的@Conditional作用)

作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;

@Conditional扩展注解 作用(判断是否满足当前指定条件)
@ConditionalOnJava 系统的java版本是否符合要求
@ConditionalOnBean 容器中存在指定Bean;
@ConditionalOnMissingBean 容器中不存在指定Bean;
@ConditionalOnExpression 满足SpEL表达式指定
@ConditionalOnClass 系统中有指定的类
@ConditionalOnMissingClass 系统中没有指定的类
@ConditionalOnSingleCandidate 容器中只有一个指定的Bean,或者这个Bean是首选Bean
@ConditionalOnProperty 系统中指定的属性是否有指定的值
@ConditionalOnResource 类路径下是否存在指定资源文件
@ConditionalOnWebApplication 当前是web环境
@ConditionalOnNotWebApplication 当前不是web环境
@ConditionalOnJndi JNDI存在指定项
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容

  • 一,入口文件注解 @SpringBootApplication:用在项目入口文件三个注解的集合,(默认属性)@Co...
    竹海涛阅读 318评论 1 1
  • 功能分析 传统的Spring项目会有很多的配置文件,比如我们要使用Redis,一般除了对应的依赖的jar包我们还需...
    黄靠谱阅读 3,276评论 1 7
  • SpringMVC原理分析 Spring Boot学习 5、Hello World探究 1、POM文件 1、父项目...
    jack_jerry阅读 1,265评论 0 1
  • 本文我们来梳理一下Spring的那些注解,如下图所示,大概从几方面列出了Spring的一些注解: 如果此图看不清楚...
    Java自闭师阅读 724评论 0 1
  • 刚才接到一位在南京工作的老同学电话,她说过几个月就退休了,然后还想找事情做做。她是学法律的,当然找工作不成问题。还...
    蒋坤元阅读 3,878评论 48 179