自定義starter

SpringBoot中的starter是一種非常重要的機(jī)制，能夠拋棄以前繁雜的配置，將其統(tǒng)一集成進(jìn) starter，應(yīng)用者只需要在maven中引入starter依賴，SpringBoot就能自動(dòng)掃描到要加載的信息并啟 動(dòng)相應(yīng)的默認(rèn)配置。starter讓我們擺脫了各種依賴庫(kù)的處理，需要配置各種信息的困擾。 SpringBoot會(huì)自動(dòng)通過(guò)classpath路徑下的類發(fā)現(xiàn)需要的Bean，并注冊(cè)進(jìn)IOC容器。SpringBoot提供 了針對(duì)日常企業(yè)應(yīng)用研發(fā)各種場(chǎng)景的spring-boot-starter依賴模塊。所有這些依賴模塊都遵循著約定 成俗的默認(rèn)配置，并允許我們調(diào)整這些配置，即遵循“約定大于配置”的理念。

為什么要自定義starter

在我們的日常開(kāi)發(fā)工作中，經(jīng)常會(huì)有一些獨(dú)立于業(yè)務(wù)之外的配置模塊，我們經(jīng)常將其放到一個(gè)特定的 包下，然后如果另一個(gè)工程需要復(fù)用這塊功能的時(shí)候，需要將代碼硬拷貝到另一個(gè)工程，重新集成一 遍，麻煩至極。如果我們將這些可獨(dú)立于業(yè)務(wù)代碼之外的功能配置模塊封裝成一個(gè)個(gè)starter，復(fù)用的時(shí) 候只需要將其在pom中引用依賴即可，SpringBoot為我們完成自動(dòng)裝配，簡(jiǎn)直不要太爽。

自定義starter的命名規(guī)則

SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建議自定義的starter使用 xxx-spring-boot-starter命名規(guī)則。以區(qū)分SpringBoot生態(tài)提供的starter。

有了以上的了解后，來(lái)創(chuàng)建 Maven 項(xiàng)目，目錄結(jié)構(gòu)如下：

實(shí)現(xiàn)方法

實(shí)現(xiàn)自定義starter大致分一下幾步：

1.引入pom依賴

2.編寫測(cè)試用例類

3.創(chuàng)建自動(dòng)配置類

4.在resources包下增加配置文件

引入依賴

<?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>cn.mystylefree</groupId>
    <artifactId>custom-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.7.0</version>
        </dependency>
    </dependencies>
</project>

這里引入了自動(dòng)配置類

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

編寫測(cè)試類

在使用Spring官方的Starter時(shí)通?？梢栽赼pplication.properties中來(lái)配置參數(shù)覆蓋掉默認(rèn)的值。即name的值會(huì)被配置文件中的值替換掉。

@EnableConfigurationProperties({PersonProperties.class}) //開(kāi)啟ConfigurationProperties注解
@ConfigurationProperties(prefix = "person")
public class PersonProperties {
    private int id;
    private String name="章三";
}

省略set/get方法和toString方法

創(chuàng)建配置類

@Configuration
//當(dāng)類路徑classpath下有指定當(dāng)類   (SimpleBean)  的情況下進(jìn)行自動(dòng)配置
@ConditionalOnClass(PersonProperties.class)
public class MyAutoConfiguration {
    static {
        System.out.println("MyAutoConfiguration init ...");
    }
    @Bean
    public PersonProperties personProperties(){
        return new PersonProperties();
    }
}

創(chuàng)建spring.factories文件

/META-INF/spring.factories文件放在/src/main/resources目錄下
注意：META-INF是自己手動(dòng)創(chuàng)建的目錄，spring.factories也是自己手動(dòng)創(chuàng)建的文件，在該文件中配置自己的自動(dòng)配置類。

一定要按照下面的位置結(jié)構(gòu)添加

文件中的內(nèi)容如下

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.mystylefree.config.MyAutoConfiguration

這時(shí)配置都加好了

只需從新打下包就行

mvn clean install 

我們自己設(shè)置的starter包就保存到本地的maven倉(cāng)庫(kù)了

接下來(lái)我們就能使用剛剛自定義的jar包實(shí)現(xiàn)pom依賴引用了

這是我的maven依賴地址

將這個(gè)依賴加入到新的項(xiàng)目中引入即可

這是我的一個(gè)新springboot項(xiàng)目

1.加入依賴

根據(jù)自己的名稱添加

         <dependency>
            <groupId>cn.mystylefree</groupId>
            <artifactId>custom-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

2.設(shè)置application.properties

person.id=1
person.name=小米

由于設(shè)置的前綴名上person

3.添加測(cè)試用例

@SpringBootTest
class SpringBootDemoApplicationTests {
    @Autowired
    private PersonProperties personProperties;
    @Test
    void contextLoads() {
        int id = personProperties.getId();
        String name = personProperties.getName();
        System.out.println(id+name);
    }
}

這時(shí) 調(diào)試就能使用自定義的starter了

但是發(fā)現(xiàn)出現(xiàn)中文亂嗎了，不慌設(shè)置一下編碼格式

重新啟動(dòng)項(xiàng)目

亂碼問(wèn)題

發(fā)現(xiàn)還是亂碼？？？

在Spring Boot項(xiàng)目中，有時(shí)候需要自定義一些配置，如果使用中文值并使用注解讀取時(shí)就會(huì)出現(xiàn)亂碼。

原因： Spring Boot注解讀取application.properties或者application-{profile}.properties文件時(shí)默認(rèn)的是ISO_8859_1編碼。

解決方案：

1. 使用yml配置文件進(jìn)行配置。

Spring Boot在讀取yaml配置文件時(shí)使用的是UTF-8的編碼方式。

2. 使用自定義配置文件如：

custom.properties配置中文屬性，并使用@PropertySource(value="classpath:custom.properties", encoding="UTF-8")注解指定讀取的文件和編碼。代碼如下：

@Data
@ConfigurationProperties(prefix = "custom.user")
@PropertySource(value="classpath:custom.properties", encoding="UTF-8")
public class UserProperties {
//	@Value("${custom.user.name}")
	private String name;
//	@Value("${custom.user.sex}")
	private String sex;
}

使用@ConfigurationProperties和@Value均可以正常讀取。

3. 把中文換成對(duì)應(yīng)的ASCII碼。

custom.user.sex=男
換成：

custom.user.sex=\u7537
以上三種方法均可以正常讀取配置文件中的中文字符。

參考文檔：

Spring Boot使用@ConfigurationProperties或者@Value讀取properties文件中文亂碼

到此這篇關(guān)于SpringBoot自定義Starter組件開(kāi)發(fā)實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot自定義Starter組件開(kāi)發(fā)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論