SpringBoot项目开发技巧一:自动装配

SpringBoot项目开发技巧一:自动装配

SpringBoot自动装配是springboot重要的功能点。Boot系列、其它框架与Boot的整合很多是基于自动装配的。 我们在写SpringBoot项目时,Maven的pom依赖能看到很多的starter 都是基于自动装配的

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>

自动装配的原理 网上已经有很多的讲解了,这里不再冗余了。

引入依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure-processor</artifactId>
        </dependency>
        <!-- 用来生成spring-configuration-metadata.json -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>

编写自动装配类

ProviderConfigration

@Slf4j
@Configuration
public class ProviderConfigration {

    /**
     * properties
     */
    @Bean
    public ProviderProperties providerHpProperties(){
        return new ProviderProperties();
    }
    @Bean
    @ConditionalOnProperty(prefix = "hp.provider",value = "switchs",havingValue = "SWITCH-1",matchIfMissing = true)
    public ProviderSwitch providerSwitchOneOrDefault(){
        log.info("ProviderConfigration providerSwitchOneOrDefault start, [] ");
        return ProviderSwitch.builder().switchs("SWITCH-1").build();
    }

    @Bean
    @ConditionalOnProperty(prefix = "hp.provider",value = "switchs",havingValue = "SWITCH-2")
    public ProviderSwitch providerSwitchTwo(){
        log.info("ProviderConfigration providerSwitchTwo start, [] ");
        return ProviderSwitch.builder().switchs("SWITCH-2").build();
    }
}

@Configuration注解在类上表示此类为自动装配类。@Bean通常与@Configuration 一起使用,将方法的返回值注入到spring的bean容器中

@Bean 注解的方法是将方法名做为beanName。上面ProviderProperties这个Bean 在spring容器中的beanName为providerHpProperties(作者工作中踩过这个坑)

@ConditionalOnProperty 不讲解。SpringBoot有很多的@ConditionalXXX 实现条件式注入bean。感兴趣的可以下去了解一下

@Data
@ConfigurationProperties(prefix = "hp.provider",ignoreInvalidFields = true)
public class ProviderProperties {

    private String switchs;

    private String appName;
}

@ConfigurationProperties 将配置文件的符合规则的key 对应的映射到文件中。

prefix :前缀

ignoreInvalidFields :配置true时不能被正常解析的属性会忽略,spring正常启动。默认为false,解析失败时报错。简单来说就是类型不匹配。

ignoreUnknownFields:配置true时属性未找到时会忽略,spring正常启动。默认为false,未找到时报错。简单来说就是没找到。

@Data
public class ProviderSwitch {

    private String switchs;
}

对应的配置文件

hp:
  provider:
    switchs: SWITCH-1
    appName: DEMO-HP 

Bean使用

此时我们已经通过自动装配的方式向Spring的bean容器中注册了两个bean,分别为:ProviderProperties、ProviderSwitch

使用和其它bean一样,@Autowired即可。

    @Autowired
    private ProviderProperties properties;
    
    @Autowired
    private ProviderSwitch providerSwitch;

本项目使用自动装配

如果你写的自动装配类是用于本项目的。那么需要注意@Configuration注解的类需要在scanBasePackages扫包的路径内,否则spring无法加载到自动装配类。更别谈自动装配了(如果在spring.factories文件中配了,可以不用扫包操作。见下文)。

其它项目使用自动装配

很多时候我们需要编写像SDK这样供外界系统使用的包。我们又想最小程度上减轻引入方的配置(不想让三方去添加扫包操作),那么此时自动装配就起到了关键性的作用(SpringBoot很多的starter都是这样)。下面来说一下具体的流程

编写spring.factories文件(Spring的SPI文件)

在resources目录下创建META-INF/spring.factories文件。


image-20211102230022883.png

文件内容

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.hp.demo.provider.config.ProviderConfigration

文件结构key,value的形式。key为EnableAutoConfiguration(因为我们这章将的是自动装配),value为我们编写的Configration类全路径

SPI文件有很多的扩展点(很多的配置项key),不在一一叙述。可以在idea中直接搜索spring.factories,可以看到有很多。

image-20211102230638377.png

SpringBoot在启动中会找到Path下面的所有spring.factories文件,并使用SpringFactoriesLoader将文件加载解析为K,V的形式。

在按照key分发至对应的扩展点,将配置的value(就是class全路径)加载解析到Spring中,实现SPI。

在我们完成了以上几步后,我们的sdk包中的自动装配就完成啦。三方引入时也不用扫包啦。

偷偷告诉大家:@Configuration 可以和 @ComponentScan一起使用,如下:

@Configuration
@ComponentScan(basePackages = {
        "com.hp.config"
})
public class ProviderConfigration {

}

这样com.hp.config包及子目录 也会被spring扫描到。作为一个SDK 既不用三方去扫包,又可以自己扫描一些特定包,岂不是美哉!

扩展

在引入了以下依赖后

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>

直接mvn package 命令后,在target目录下可以找到以下文件


image-20211102231820624.png

将spring-configuration-metadata.json 拷贝到resources的META-INF目录下。

之后在编写配置文件的时候就会有提示,如下


image-20211102232022600.png

作为一个sdk包,三方在使用的时候一定会对你竖起大拇指的。心想:这个人真强!

结尾

好的以上就是分享的内容啦。希望大家看了后会有收获,对编码上会有帮助!

11点了,该睡觉了。

对了,今天三妹说我有点小帅(我老婆,我是二哥她是三妹)!哈哈哈!今晚睡觉怕是要笑出声了 QAQ

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,039评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,426评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,417评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,868评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,892评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,692评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,416评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,326评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,782评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,957评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,102评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,790评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,442评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,996评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,113评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,332评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,044评论 2 355

推荐阅读更多精彩内容