【SpringBoot框架篇】8.搭建自己的spring-boot-starter

浅浅的花香味﹌ 2023-02-10 03:49 7阅读 0赞

### 文章目录 ###

*  简述
 *  创建starter服务
 *   *  引入构建starter的核心依赖
     *  创建配置类
     *  封装服务提供者
     *  注册Bean对象
     *  暴露需要被装配的类
     *  发布jar包到本地仓库
 *  引入我的my-spring-boot-starter依赖
 *   *  引入依赖
     *  测试接口
     *  修改配置文件
     *  启动程序
 *  项目配套代码

# 简述 #

我们可以认为starter是一种服务,在使用某个功能的开发者不需要关注各种依赖库的处理，不需要具体的配置信息，由Spring Boot自动注入的bean。

我们在开发springboot项目的时候,经常会引用spring-boot-starter-web,spring-boot-starter-data-jpa等一些常用的依赖,我们也可以自己封装一个服务,然后再需要用的项目中引入依赖即可使用.

# 创建starter服务 #

首先先创建一个Maven项目

## 引入构建starter的核心依赖 ##

<properties>
            <srping.boot.version>2.3.0.RELEASE</srping.boot.version>
            <slf4j.version>1.7.25</slf4j.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-autoconfigure</artifactId>
                <version>${srping.boot.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot</artifactId>
                <version>${srping.boot.version}</version>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <version>${srping.boot.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
                <version>${slf4j.version}</version>
            </dependency>
        </dependencies>

## 创建配置类 ##

通过@ConfigurationProperties注解绑定前缀是my.db得属性

@ConfigurationProperties(prefix = "my.db")
    public class DbConfig { 
        private String username;
        private String password;
        //省略get,set方法
    }

## 封装服务提供者 ##

该类只有一个toString方法输出属性信息

public class DbServer { 
    
        private String username;
        private String password;
        //省略get,set方法
     	@Override
        public String toString(){ 
            return "DbServer{username=" + username + " ,password=" + password + "}";
        }

## 注册Bean对象 ##

下面代码通关EnableConfigurationProperties注入了DbConfig对象,然后把属性赋值给了  
DbServer对象,最后调用了print打印方法.

@Configuration
    @EnableConfigurationProperties(DbConfig.class)
    public class DbAutoConfiguration { 
        Logger logger= LoggerFactory.getLogger(this.getClass());
        @Bean
        public DbServer getBean(DbConfig dbConfig) { 
            //创建组件实例
            logger.info("开始注册我的Bean对象");
            DbServer dbServer = new DbServer();
            dbServer.setUsername(dbConfig.getUsername());
            dbServer.setPassword(dbConfig.getPassword());
            return dbServer;
        }
    }

## 暴露需要被装配的类 ##

在resources目录下新建META-INF/spring.factories文件  
![在这里插入图片描述][2020051923085575.png]  
第**2**行添加需要暴露的类的名称(包含包名)

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.ljm.boot.starter.config.DbAutoConfiguration

该文件会被 **@SpringBootApplication**注解中会下面被扫描并加载.

*  @SpringBootApplication
    
     *  @EnableAutoConfiguration
        
         *  @Import(\{AutoConfigurationImportSelector.class\})
            
             *  getCandidateConfigurations()
                
                 *  loadFactoryNames() 中被扫描到并加载  
                    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21pbmcxOTk1MTIyNA_size_16_color_FFFFFF_t_70]

## 发布jar包到本地仓库 ##

在程序的跟路径执行

mvn clean install

看到下面的**SUCCESS**就代表发布成功了  
![在这里插入图片描述][20200519231253421.png]

# 引入我的my-spring-boot-starter依赖 #

创建一个springboot项目，然后引入刚发布的jar包

## 引入依赖 ##

<dependency>
          <groupId>com.ljm.boot</groupId>
          <artifactId>my-spring-boot-starter</artifactId>
          <version>v1.0</version>
    </dependency>

## 测试接口 ##

@RestController
    public class TestController { 
    
        @Autowired
        DbServer dbServer;
    
        @RequestMapping("/test")
        public String test(){ 
            return dbServer.toString();
        }
    }

## 修改配置文件 ##

my:
      db:
        username: test
        password: 123456
    server:
      port: 8008

由于我们在DbConfig中声明过这2个属性,所以在yml文件中能通过提示补齐属性  
![在这里插入图片描述][20200519231751770.png]

## 启动程序 ##

能够看到控制台输出了my-spring-boot-starter依赖中的 ‘开始注册我的Bean对象‘ log信息.,  
重下面日志信息打印中可以看到我们创建的starter中注册bean的类是EnhancerBySpringCGLIB动态代理生成的。  
![在这里插入图片描述][202005192334467.png]  
**测试接口**  
可以看到接口也正常的返回了注入bean对象的属性信息  
![在这里插入图片描述][20200519233524605.png]

# 项目配套代码 #

[github地址][github]

创作不易,要是觉得我写的对你有点帮助的话,麻烦在github上帮我点下 **Star**

【SpringBoot框架篇】其它文章如下,后续会继续更新。

*  [1.搭建第一个springboot项目][1._springboot]
 *  [2.Thymeleaf模板引擎实战][2.Thymeleaf]
 *  [3.优化代码,让代码更简洁高效][3.]
 *  [4.集成jta-atomikos实现分布式事务][4._jta-atomikos]
 *  [5.分布式锁的实现方式][5.]
 *  [6.docker部署,并挂载配置文件到宿主机上面][6.docker]
 *  [7.项目发布到生产环境][7.]
 *  [8.搭建自己的spring-boot-starter][8._spring-boot-starter]
 *  [9.dubbo入门实战][9.dubbo]
 *  [10.API接口限流实战][10.API]
 *  [11.Spring Data Jpa实战][11.Spring Data Jpa]
 *  [12.使用druid的monitor工具查看sql执行性能][12._druid_monitor_sql]
 *  [13.使用springboot admin对springboot应用进行监控][13._springboot admin_springboot]
 *  [14.mybatis-plus实战][14.mybatis-plus]
 *  [15.使用shiro对web应用进行权限认证][15._shiro_web]
 *  [16.security整合jwt实现对前后端分离的项目进行权限认证][16.security_jwt]
 *  [17.使用swagger2生成RESTful风格的接口文档][17._swagger2_RESTful]
 *  [18.使用Netty加websocket实现在线聊天功能][18._Netty_websocket]
 *  [19.使用spring-session加redis来实现session共享][19._spring-session_redis_session]
 *  [20.自定义@Configuration配置类启用开关][20._Configuration]
 *  [21.对springboot框架编译后的jar文件瘦身][21._springboot_jar]
 *  [22.集成RocketMQ实现消息发布和订阅][22._RocketMQ]

[2020051923085575.png]: https://img-blog.csdnimg.cn/2020051923085575.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21pbmcxOTk1MTIyNA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200519225023897.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21pbmcxOTk1MTIyNA==,size_16,color_FFFFFF,t_70
[20200519231253421.png]: https://img-blog.csdnimg.cn/20200519231253421.png
[20200519231751770.png]: https://img-blog.csdnimg.cn/20200519231751770.png
[202005192334467.png]: https://img-blog.csdnimg.cn/202005192334467.png
[20200519233524605.png]: https://img-blog.csdnimg.cn/20200519233524605.png
[github]: https://github.com/Dominick-Li/springboot-master
[1._springboot]: https://blog.csdn.net/ming19951224/article/details/106159309
[2.Thymeleaf]: https://blog.csdn.net/ming19951224/article/details/106160322
[3.]: https://blog.csdn.net/ming19951224/article/details/106173840
[4._jta-atomikos]: https://blog.csdn.net/ming19951224/article/details/105753333
[5.]: https://blog.csdn.net/ming19951224/article/details/106205332
[6.docker]: https://blog.csdn.net/ming19951224/article/details/105923548
[7.]: https://blog.csdn.net/ming19951224/article/details/106212271
[8._spring-boot-starter]: https://blog.csdn.net/ming19951224/article/details/106224172
[9.dubbo]: https://blog.csdn.net/ming19951224/article/details/106225928
[10.API]: https://blog.csdn.net/ming19951224/article/details/106227451
[11.Spring Data Jpa]: https://blog.csdn.net/ming19951224/article/details/106308544
[12._druid_monitor_sql]: https://blog.csdn.net/ming19951224/article/details/106317893
[13._springboot admin_springboot]: https://blog.csdn.net/ming19951224/article/details/107138845
[14.mybatis-plus]: https://blog.csdn.net/ming19951224/article/details/107145780
[15._shiro_web]: https://blog.csdn.net/ming19951224/article/details/107192585
[16.security_jwt]: https://blog.csdn.net/ming19951224/article/details/107733689
[17._swagger2_RESTful]: https://blog.csdn.net/ming19951224/article/details/107741541
[18._Netty_websocket]: https://blog.csdn.net/ming19951224/article/details/108555917
[19._spring-session_redis_session]: https://blog.csdn.net/ming19951224/article/details/112758560
[20._Configuration]: https://blog.csdn.net/ming19951224/article/details/112759717
[21._springboot_jar]: https://dominick-li.blog.csdn.net/article/details/119024251
[22._RocketMQ]: https://dominick-li.blog.csdn.net/article/details/119523197