SpringBoot的自动配置玩法,学会写自己的starter

我们以一个简单的例子来谈谈组件中的一个Bean,可以通过怎样的方式注册到业务方的Spring容器中;
首先我们来回顾下以前常用的配置方式,然后尝试着结合@EnableConfiguration达成全自动配置,顺带了解条件注解@ConditionalOnXXX,最后看看开启注解@EnableXXX的玩法。相信大家看完后,会对SpringBoot相关组件的自动化配置有个大概的了解。(demo源码)

1.需求

需求非常简单:我们提供一个组件(lib-user.jar),主要用于拉取用户信息。
里面有个Bean(接口为UserService),我们希望其他项目引入jar包后,可以使用到这个Bean(@Autowire)。

2. 传统的配置方式

2.1 先建个项目lib-user

先看看pom.xml,只需要满足组件需求即可(本例依赖了SpringBoot):

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>demo</groupId>
    <artifactId>lib-user-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.2 核心功能

(1)接口 UserService

public interface UserService {
    User getByToken(String token);
}

(2)默认实现 DefaultUserServiceImpl

package demo.lib.user.service;

@Service
public class DefaultUserServiceImpl implements UserService {
    @Override
    public User getByToken(String token) {
        System.out.println("UserService----in---" + token);
        return new User();
    }
}

好了,打包、deploy完事。业务方的大佬们可以使用了。

2.3 业务方使用

假如我们有个支付组的项目demo-pay,是个springBoot项目,启动类为demo.pay.PayApplication。
接入时,我们需要在pom.xml加入依赖:

<dependency>
    <groupId>demo</groupId>
    <artifactId>lib-user</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

引入依赖后,尽管组件中DefaultUserServiceImpl@Service注解,但是我们支付项目默认情况下是扫描不到这个bean的(默认扫描的包为:demo.pay)。只能自己去配置了,以下配置方式只需选一种即可:
(1)xml

  <context:component-scan base-package="demo.lib.user.service" />

(2)@ComponentScan

package demo.pay.config;

@Configuration
@ComponentScan("demo.lib.user.service")
public class UserConfig {
    
}

(3)@Bean

package demo.pay.config;

@Configuration
public class UserConfig {
    @Bean
    public UserService userService() {
        return new DefaultUserServiceImpl();
    }
}

3. SpringBoot全自动配置

3.1 spring.factories 借助@EnableAutoConfiguration的魔法

我们再建一个项目:lib-user-starter,这个项目和一般的starter一样,只做两件事:

(1)引入相关的依赖
就如下面的pom.xml,我们这个starter需要引入lib-user依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>

    <groupId>demo</groupId>
    <artifactId>lib-user-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>demo</groupId>
            <artifactId>lib-user</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

(2)帮助自动化配置
先把配置类写了:

package demo.lib.user.starter.autoconfig;

@Configuration
public class UserAutoConfiguration {
    @Bean
    public UserService userService() {
        return new DefaultUserServiceImpl();
    }
}

重点来了,我们需要在resource目录下,新建一个/META-INF/spring.factories


把我们的配置类加上去,类似Properties的key=value写法,“\”用于为换行(实际上key还是上面那个的意思)


org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
demo.lib.user.starter.autoconfig.UserAutoConfiguration

多个可以使用“,”隔开,参考spring-boot-autoconfigure下的spring.factories:

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
....

好了,已经完事,lib-user-starter进行deploy一下,业务大佬们改用这个吧,我们都配置好了。
这时候业务方只需加入starter依赖,不需要任何配置,可以直接@Autowire UserService这个bean了。

<dependency>
    <groupId>demo</groupId>
    <artifactId>lib-user-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

拓展阅读:原理简单地讲,SpringBoot启动类上往往会有@SpringBootApplication注解,而这个注解包含了@EnableAutoConfiguration,项目启动后,当解析@EnableAutoConfiguration时,会通过org.springframework.core.io.support.SpringFactoriesLoader将META-INF/spring.factories中的key为EnableAutoConfiguration的所有value加载出来(一堆配置类),然后就可以进行常规的@Configuration配置类解析了。

3.2 条件注解@ConditionalOnClass、@ConditionalOnMissingBean

在我们的@Configuration的配置类中,我们可以根据当前项目的环境做出一些特定配置、或者不做配置。
举个例子,UserAutoConfiguration,我们希望我们业务方项目里面有一个demo.base.UserInfo的类才进行配置,否则当spring你就忽视我这个配置类吧:

@Configuration
@ConditionalOnClass(UserInfo.class)
public class  UserAutoConfiguration {
    @Bean
    public UserService userService() {
        return new DefaultUserServiceImpl();
    }
}

还有一种情况,有时候业务方不希望用我们的DefaultUserServiceImpl,而是用自己整的UserService实现,这时候我们那个DefaultUserServiceImpl就不应该注册成bean了,否则可能会报冲突,@ConditionalOnMissingBean可以帮助我们避免这样情况:

@Configuration
public class  UserAutoConfiguration {

    // 没发现UserService的bean才注册DefaultUserServiceImpl
    @Bean
    @ConditionalOnMissingBean
    public UserService userService() {
        return new DefaultUserServiceImpl();
    }
}

除此之外,还有其他许多类似的注解,比如只有某个存在Bean才进行配置的@ConditionalOnBean、根据不同环境(比如测试和生产环境)进行不同配置的@Profile 等等。

3.3 属性配置与提示

假如UserService需要有用户中心分配一个appId和appSecret才能使用,这时候组件应该支持配置。
新增UserProperties:

@ConfigurationProperties(prefix = "user")
public class UserProperties {

    private String appId = "123456"; // 默认值
    private String appSecret;

    // getter、setter
}

修UserAutoConfiguration修改为:

@Configuration
@EnableConfigurationProperties(UserProperties.class)
public class UserAutoConfiguration {

    @Bean
    public UserService userService(UserProperties userProperties) {
        DefaultUserServiceImpl userService = new DefaultUserServiceImpl();
        // DefaultUserServiceImpl 新增两个属性AppId和AppSecret用于组装数据
        userService.setAppId(userProperties.getAppId());
        userService.setAppSecret(userProperties.getAppSecret());
        return userService;
    }
}

新增提示文件:META-INF/spring-configuration-metadata.json,用于ide提示用户(注:仅仅是起提示作用,没有也不会影响组件正常运作):

{
  "properties": [
    {
      "name": "user.appId",
      "type": "java.lang.String",
      "description": "用户中心分配的appId",
      "defaultValue": "123456"
    },
    {
      "name": "user.appSecret",
      "type": "java.lang.String",
      "description": "用户中心分配的appSecret."
    }
  ]
}

这时候,当我们在demo-pay的项目输入配置时:


springboot配置提示

除了@ConfigurationProperties外,@Value同样可以达到加载配置的作用。

3.4 @EnableXXX,开启类配置

在spring.factories中指定EnableAutoConfiguration=配置类,一旦引入lib包,就会自动启动该配置(因为@EnableAutoConfiguration通常是默认开启的),这也是我们SpringBoot AutoConfig的常规操作。但是有时候我们希望把这个开关交给具体的项目来管理,这也是为什么还有其他一些诸如@EnableXXX这类注解的存在(如:@EnableAsync)。
首先我们先把spring.factories删掉,再新建一个@EnableUser注解以及对应的ImportSelector :

// EnableUser.java
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import(UserConfigSelector.class})
public @interface EnableUser {
}

// UserConfigSelector.java
public class UserConfigSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        // 返回配置类的全类名
        return new String[]{"demo.lib.user.starter.autoconfig.UserAutoConfiguration"};
    }
}

我们来到demo-pay项目启动类,如果我们需要这个配置:

@SpringBootApplication
@EnableUser // 开启配置
public class DemoPayApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoPayApplication.class, args);
    }
}

拓展阅读:
关于@Import注解,其value可以指定为:

  1. @Configuration配置类;
  2. 实现ImportSelector的类;其接口方法声明:String[] selectImports(AnnotationMetadata importingClassMetadata);,入参是@EnableXXX中相关属性,返回是一个字符串数组(@Configuration配置类全类名),这些配置类会被加载解析;
  3. 实现ImportBeanDefinitionRegistrar的类,该接口方法声明:void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);入参第一个为@EnableXXX中相关属性,第二个则为SpringIOC容器中用于注册Bean(配置)的接口BeanDefinitionRegistry,可以手动地注册一些Bean(配置)。比如:@EnableAspectJAutoProxy中的AspectJAutoProxyRegistrar,Mybatis中@MapperScan中的MapperScannerRegistrar等。相对而言这个有更加强的控制权(为所欲为)。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容