基于SpringBoot编写starter,自己写个类库引入使用


    我们在做springboot项目的时候经常会创建项目后先引入各种starter,比如操作数据库的mybatis-plus-boot-starter,数据源的druid-spring-boot-starter等等。引入starter的好处就是可以将第三方的依赖库快速的整合到我们自己的springboot项目中,只需要在.yml配置文件中编写配置就能自动创建对象实例完成操作。

1:SpringBoot将常见的开发功能,分成了不同的starter,在开发功能的时候只需要引入对应的starter,减少引入大量的依赖。

2:starter可以理解成一个依赖组,其主要功能就是完成引入依赖和初始化配置。

3:Spring官方提供的starter命名规范为spring-boot-starter-xxx,第三方提供的starter命名规范为xxx-spring-boot-starter。

快速搭建自己的starter

首先打开IDEA创建一个SpringBoot项目,项目名为:my-starter,这里Java版本选择Java1.8、注意版本不要选太高的,SpringBoot版本不要选择3.x:

453b87c6682e477495eb1ee536ab0370.png

初始化好项目后,在pom文件中引入核心依赖文件:

<!--optional=true:取消依赖传递-->
        <!--自动加载配置-->
        <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>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

 spring-boot-autoconfigure用于自动加载配置

 spring-boot-configuration-processor用于自动生成配置文件的自动提示

 optional=true:默认为false,设置为true取消依赖传递,避免依赖版本冲突

而后需要把pom文件中下面这段代码给删除掉,因为这种打包方式会把springboot的内置服务器tomcat/netty打包到jar中。

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

编写一个逻辑实现的类

这里创建一个LogService编写我们的功能逻辑:

public class LogService {

    public String logInfo(String appId) {
        System.out.println("打印了appId:" + appId);
        return appId;
    }
}

编写一个自动配置类

@Configuration // 这是一个配置类
//@ConfigurationProperties(prefix = "sinder") // 和配置文件绑定,映射对应属性名
public class StarterConfig {

    @Bean
    public LogService logService() {
        return new LogService();
    }
}

写完这个配置类后,还需要将它进行注册,创建一个配置文件:

resources/META_INF/spring.factories,将自动化配置类写到文件中,相当于给项目一个入口,编写如下代码:

# spring boot starter
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.mystarter.StarterConfig

到这里一个基本的starter就编写完毕了,执行 mvn clean install 命令,将项目打包推送到本地maven仓库,然后新建一个测试项目,引入打包好的依赖进行使用:

        <dependency>
            <groupId>com.example</groupId>
            <artifactId>my-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        LogService logService = new LogService();
        System.out.println(logService.logInfo("sinder"));

 


版权声明:本文为weixin_42009068原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。