手寫(xiě)Spring Boot Starter起步依賴(lài)demo

以下例子代碼在github中,代碼鏈接

Spring Boot起步依賴(lài)(starter)大大簡(jiǎn)化了項(xiàng)目構(gòu)建中的依賴(lài)配置唁情,利用了傳遞依賴(lài)解析椅亚,把常用庫(kù)聚合在一起荆萤,組成了幾個(gè)為特定功能而定制的依賴(lài),這些依賴(lài)項(xiàng)是使項(xiàng)目快速啟動(dòng)和運(yùn)行所需的依賴(lài)項(xiàng),如spring-boot-starter-web起步依賴(lài)痹愚,聚合了spring-boot-starter憎瘸、spring-boot-starter-json入篮、spring-boot-starter-tomcat、spring-web幌甘、spring-webmvc等依賴(lài)潮售,使得我們的web項(xiàng)目無(wú)需引入多個(gè)web相關(guān)的依賴(lài)項(xiàng)以及為了解決版本沖突等問(wèn)題。

官方starter命名的格式是spring-boot-starter-*锅风,如spring-boot-starter-actuator酥诽、spring-boot-starter-web、spring-boot-starter-test等官方starter皱埠,平常我們自己定義的starter一般命名格式是thirdProject-spring-boot-starter

  • 本文示例代碼項(xiàng)目結(jié)構(gòu)是寫(xiě)一個(gè)自定義的demo-spring-boot-starter引入兩個(gè)jar包demo1和demo2肮帐,然后在project項(xiàng)目中引入demo-spring-boot-starter,項(xiàng)目結(jié)構(gòu)如圖所示:


    項(xiàng)目結(jié)構(gòu).png
一、demo1項(xiàng)目

(1)pom文件如下:

<?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>

    <groupId>com.fiuty</groupId>
    <artifactId>demo1</artifactId>
    <version>1.0-SNAPSHOT</version>

</project>

(2)demo1只有一個(gè)Student類(lèi):

@Data
public class Student {

    private String name;

    private Integer age;
}
二训枢、demo2

(1)pom文件如下:

<?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>

    <groupId>com.fiuty</groupId>
    <artifactId>demo2</artifactId>
    <version>1.0-SNAPSHOT</version>

</project>

(2)同樣托修,demo2也只有一個(gè)類(lèi)Teacher:

@Data
public class Teacher {

    private String name;

    private Integer age;

}
三、demo-spring-boot-starter項(xiàng)目

(1)定義starter需要引入spring-boot-starter依賴(lài)恒界、spring-boot-autoconfigure依賴(lài)以及第三方j(luò)ar demo1和demo2的依賴(lài)睦刃,如果需要配置元信息的話,還需引入spring-boot-configuration-processor依賴(lài)十酣。
(2)引入demo1和demo2的pom文件:

        <dependency>
            <groupId>com.fiuty</groupId>
            <artifactId>demo1</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>com.fiuty</groupId>
            <artifactId>demo2</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

完整的pom文件如下:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.fiuty</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

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

        <dependency>
            <groupId>com.fiuty</groupId>
            <artifactId>demo1</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>com.fiuty</groupId>
            <artifactId>demo2</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

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

</project>

(3)demo-spring-boot-starter的代碼結(jié)構(gòu)如下圖所示涩拙,有一個(gè)DemoConfiguration配置類(lèi)(注入了兩個(gè)bean,demo1的student和demo2的teacher)耸采,還有兩個(gè)properties配置類(lèi)用于讀取yaml文件的配置值兴泥,還有自動(dòng)裝配類(lèi)DemoAutoConfiguration和自動(dòng)裝配配置文件spring.factories,用于項(xiàng)目啟動(dòng)時(shí)初始化bean并且被spring容器管理:

demo-spring-boot-starter的代碼結(jié)構(gòu).png
  • TeacherProperties配置類(lèi):
@ConfigurationProperties(prefix = "com.demo2")
@Configuration
@Data
public class TeacherProperties {

    private String name = "defaultTeacher";

    private Integer age = 30;
}
  • StudentProperties配置類(lèi)
@ConfigurationProperties(prefix = "com.demo1")
@Configuration
@Data
public class StudentProperties {

    private String name = "defaultStudent";

    private Integer age = 10;
}
  • DemoConfiguration配置類(lèi)洋幻,將yaml文件的配置值賦值到兩個(gè)bean郁轻,demo1的student和demo2的teacher:
@Configuration
//允許導(dǎo)入配置類(lèi),配置類(lèi)bean被spring容器管理
@EnableConfigurationProperties({StudentProperties.class, TeacherProperties.class})
@Slf4j
public class DemoConfiguration {

    @Bean
    public Student getStudent(StudentProperties studentProperties) {
        Student student = new Student();
        log.info("初始化student");
        student.setName(studentProperties.getName());
        student.setAge(studentProperties.getAge());
        return student;
    }

    @Bean
    public Teacher getTeacher(TeacherProperties teacherProperties) {
        Teacher teacher = new Teacher();
        teacher.setName(teacherProperties.getName());
        teacher.setAge(teacherProperties.getAge());
        return teacher;
    }
}
  • DemoAutoConfiguration自動(dòng)裝配類(lèi)
//自動(dòng)裝配,項(xiàng)目啟動(dòng)即在spring容器中注冊(cè)管理相關(guān)bean
@Import(DemoConfiguration.class)
@Configuration
public class DemoAutoConfiguration {
}
  • META-INF spring.factories配置自動(dòng)裝配類(lèi),需要注意的是spring.factories需放在resource
    的目錄下文留,在引入starter的時(shí)候spring容器會(huì)注冊(cè)相關(guān)自動(dòng)裝配bean好唯。
# Auto Confiure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.fiuty.demo.spring.boot.starter.configure.DemoAutoConfiguration,\
com.fiuty.demo.spring.boot.auto.assemble.AssembleAutoConfiguration
四、project項(xiàng)目

(1)project項(xiàng)目結(jié)構(gòu)如下燥翅,引入自定義starter骑篙,在yaml文件配置starter的兩個(gè)配置類(lèi),最后注入demo1的student bean和demo2的teacher bean森书,獲取其name和age的值:


project項(xiàng)目結(jié)構(gòu).png

(2)引入自定義的starter的pom文件如下:

        <dependency>
            <groupId>com.fiuty</groupId>
            <artifactId>demo-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

完整的pom文件:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.fiuty</groupId>
    <artifactId>project</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>project</name>
    <description>Demo project for Spring Boot</description>

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

    <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>com.fiuty</groupId>
            <artifactId>demo-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

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

</project>

(3)代碼如下

  • DemoController
@RestController
@RequestMapping("/api")
public class DemoController {

    @Autowired
    private DemoService demoService;

    @GetMapping("/student/info")
    public String studentInfo() {
        return demoService.studentInfo();
    }

    @GetMapping("/teacher/info")
    public String info() {
        return demoService.teacherInfo();
    }
}
  • DemoService
public interface DemoService {

    String studentInfo();

    String teacherInfo();

}
  • DemoServiceImpl
@Service
public class DemoServiceImpl implements DemoService {

    @Autowired
    private Student student;

    @Autowired
    private Teacher teacher;

    @Override
    public String studentInfo() {
        return student.getName() + ":" + student.getAge();
    }

    @Override
    public String teacherInfo() {
        return teacher.getName() + ":" + teacher.getAge();
    }
}
  • application.yaml
com:
  demo1:
    age: 18
    name: zhangsan
  demo2:
    name: lili
    age: 25

在寫(xiě)yaml文件的時(shí)候可以看到有相關(guān)提示靶端,如下圖所示:

發(fā)現(xiàn)配置前綴.gif
發(fā)現(xiàn)配置1.png
發(fā)現(xiàn)配置2.png
  • 最后項(xiàng)目跑起來(lái),瀏覽器訪問(wèn):


    瀏覽器1.png
瀏覽器2.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末凛膏,一起剝皮案震驚了整個(gè)濱河市杨名,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌猖毫,老刑警劉巖台谍,帶你破解...
    沈念sama閱讀 217,657評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異吁断,居然都是意外死亡趁蕊,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,889評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén)仔役,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)掷伙,“玉大人,你說(shuō)我怎么就攤上這事又兵∪喂瘢” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,057評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)宙地。 經(jīng)常有香客問(wèn)我升熊,道長(zhǎng),這世上最難降的妖魔是什么绸栅? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,509評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮页屠,結(jié)果婚禮上粹胯,老公的妹妹穿的比我還像新娘。我一直安慰自己辰企,他們只是感情好风纠,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,562評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著牢贸,像睡著了一般竹观。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上潜索,一...
    開(kāi)封第一講書(shū)人閱讀 51,443評(píng)論 1 302
  • 那天臭增,我揣著相機(jī)與錄音,去河邊找鬼竹习。 笑死誊抛,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的整陌。 我是一名探鬼主播拗窃,決...
    沈念sama閱讀 40,251評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼泌辫!你這毒婦竟也來(lái)了随夸?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,129評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤震放,失蹤者是張志新(化名)和其女友劉穎宾毒,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體澜搅,經(jīng)...
    沈念sama閱讀 45,561評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡伍俘,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,779評(píng)論 3 335
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了勉躺。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片癌瘾。...
    茶點(diǎn)故事閱讀 39,902評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖饵溅,靈堂內(nèi)的尸體忽然破棺而出妨退,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 35,621評(píng)論 5 345
  • 正文 年R本政府宣布咬荷,位于F島的核電站冠句,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏幸乒。R本人自食惡果不足惜懦底,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,220評(píng)論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望罕扎。 院中可真熱鬧聚唐,春花似錦、人聲如沸腔召。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,838評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)臀蛛。三九已至亲桦,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間浊仆,已是汗流浹背客峭。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,971評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留抡柿,地道東北人桃笙。 一個(gè)月前我還...
    沈念sama閱讀 48,025評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像沙绝,于是被迫代替她去往敵國(guó)和親搏明。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,843評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容