自定义starter自动导入配置

一、先准备好项目

  • wx-spring-boot-starter-config: 处理自动配置的项目
  • wx-spring-boot-starter:空项目,引入wx-spring-boot-starter-config
  • test-my-starter:测试starter的项目,是一个web项目,引入wx-spring-boot-starter

二、准备 wx-spring-boot-starter-config项目

1、准备pom文件,引入spring boot ,lombok是为了减少gettersetter代码

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.wx.starter</groupId>
    <artifactId>wx-spring-boot-starter-config</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>wx-spring-boot-starter-config</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
        </dependency>
    </dependencies>
</project>

2、准备配置属性类,绑定前缀是my.config的配置

@Data
@ConfigurationProperties(prefix = "my.config")
public class MyProperties {
    private String name;
    private Integer age;
}

3、准备测试类,提供一个方法,供其它项目测试获取配置

@Setter
public class MyService {
    private MyProperties myProperties;
    public String findMyProperties() {
        return myProperties.getName() + "_" + myProperties.getAge();
    }
}

4、准备自动配置类,并将MyService注入容器,将MyProperties置入MyService

@Configuration
@ConditionalOnWebApplication //只有web项目才会生效
@EnableConfigurationProperties(MyProperties.class)
public class MyConfig {
    @Autowired
    private MyProperties myProperties;
    @Bean
    public MyService myService() {
        MyService myService = new MyService();
        myService.setMyProperties(myProperties);
        return myService;
    }
}

5、准备spring.factories文件,配置EnableAutoConfiguration使spring boot可以识别到自动配置类
resources下面建一个META-INF目录,在下面建一个spring.factories文件,配置如下代码:指向自己的自动配置类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.wx.starter.config.MyConfig

三、准备 wx-spring-boot-starter项目

1、pom文件引入 wx-spring-boot-starter-config项目

<dependencies>
    <dependency>
        <groupId>com.wx.starter</groupId>
        <artifactId>wx-spring-boot-starter-config</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

2、使用maven的installwx-spring-boot-starter-config安装到maven仓库中
3、使用maven的installwx-spring-boot-starter安装到maven仓库中,顺序不能反

四、准备test-my-starter项目

1、准备pom文件,需要准备一个web项目,因为上面自动配置类起作用的条件配置了@ConditionalOnWebApplication,并引入自定义的wx-spring-boot-starter

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.wx.starter</groupId>
        <artifactId>wx-spring-boot-starter-config</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

3、在application.properties文件中配置属性

my.config.name=aa
my.config.age=10

4、使用JUnit测试获取配置属性代码

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyServiceTest {
    @Autowired
    private MyService myService;
    @Test
    public void testHello() {
        System.out.println(myService.findMyProperties());
    }
}

控制台输出:


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