手写springboot属于自己的starter源码

灰太狼 2023-03-04 11:29 3阅读 0赞

### 文章目录 ###

*   *  1，前言
     *   *  （1）SpringBoot的优点
         *  （2）SpringBoot-starter的作用
     *  2，为什么要自定义starter？
     *  3，自定义starter的实现方式
     *   *  （1）引入自动配置依赖和自动提示依赖
         *  （2）写一个TestBean，装载信息
         *  （3）写一个Properties类
         *  （4）写一个自动配置类 MyAutoConfiguration
         *  （5）把本maven项目打包，上传到maven私服
         *  （6）测试

## 1，前言 ##

### （1）SpringBoot的优点 ###

SpringBoot是新一代流行的Spring应用开发框架，它具有更多的优点：

*  创建独立的Spring应用
 *  内嵌Tomcat、Jetty或Undertow（无需部署war包）
 *  提供自用的starter来简化构建配置
 *  提供指标监控、运行状况检查和外部化配置
 *  没有代码生成，也不需要XML配置（约定大于配置）

### （2）SpringBoot-starter的作用 ###

SpringBoot拥有很多方便使用的starter（Spring提供的starter命名规范spring-boot-starter-xxx.jar，第三方提供的starter命名规范xxx-spring-boot-starter.jar），比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等，各自都代表了一个相对完整的功能模块。

SpringBoot-starter是一个集成接合器，完成两件事：

*  引入模块所需的相关jar包
 *  自动配置各自模块所需的属性

## 2，为什么要自定义starter？ ##

在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个`starter`，复用的时候只需要将其在`pom`中引用依赖即可，`SpringBoot`为我们完成自动装配，简直不要太爽。

## 3，自定义starter的实现方式 ##

首先新建一个`maven`工程，切记，只是一个`maven`工程而已，并非`springboot`工程！

### （1）引入自动配置依赖和自动提示依赖 ###

自动提示就是在properties或yml配置文件中输入时自动提示！

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-autoconfigure</artifactId>
                <version>2.0.3.RELEASE</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <version>2.1.3.RELEASE</version>
            </dependency>

### （2）写一个TestBean，装载信息 ###

public class TestBean { 
        private String msg;
        public String getMsg() { 
            return msg;
        }
        public void setMsg(String msg) { 
            this.msg = msg;
        }
        @Override
        public String toString() { 
            return "TestBean{" +
                    "msg='" + msg + '\'' +
                    '}';
        }
    }

### （3）写一个Properties类 ###

该类上面的注解`@ConfigurationProperties(prefix = "hello")`是获取配置文件的配置前缀为`hello`的值，然后赋值给`msg`变量

@ConfigurationProperties(prefix = "hello")
    public class HelloServiceProperties { 
        private static final String MSG="hello world";
        private String msg=MSG;
        public static String getMSG() { 
            return MSG;
        }
        public String getMsg() { 
            return msg;
        }
        public void setMsg(String msg) { 
            this.msg = msg;
        }
    }

### （4）写一个自动配置类 MyAutoConfiguration ###

引用定义好的配置信息；在`AutoConfiguration`中实现所有`starter`应该完成的操作，并且把这个类加入`spring.factories`配置文件中进行声明

@Configuration
    @ConditionalOnClass({ TestBean.class})//判断当前classpath下是否存在指定类，若是则将当前的配置装载入spring容器
    @EnableConfigurationProperties(HelloServiceProperties.class)//激活自动配置（指定文件中的配置）
    public class MyAutoConfiguration { 
        @Autowired
        HelloServiceProperties helloServiceProperties;//注入测试的配置信息类
        @Bean
        @ConditionalOnMissingBean(TestBean.class) //当前上下文中没有TestBean实例时创建实例
        public TestBean getTestService(){ 
            TestBean testBean=new TestBean();
            testBean.setMsg(helloServiceProperties.getMsg());
            return testBean;
        }
    }

完成上面的操作还不够，最重要的一步是接下来的一步  
在`resources`文件夹下新建文件夹`META-INF/spring.factories`，将上面的自定义配置类`MyAutoConfiguration`的全路径名+类名配置到该文件中（遵循`spring.factories`的格式），这样随着项目的启动就可以实现自动装配！  
文件内容

# Auto Configure
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.ftx.tomcat.bean.MyAutoConfiguration

### （5）把本maven项目打包，上传到maven私服 ###

使用`maven`构建工具打包自定义starter项目

mvn clean install

然后上传到`maven`私服上，再新建一个`springboot`项目，把私服和`starter`项目的`maven`依赖配置到`pom`文件中

<dependency>
                <groupId>com.ftx.starter</groupId>
                <artifactId>write-starter</artifactId>
                <version>1.3</version>
            </dependency>
    <repositories>
            <repository>
                <id>nexus</id>
                <name>nexus</name>
                <url>http://nexus.tiger2.cn/nexus/content/groups/public/</url>
                <releases>
                    <enabled>true</enabled>
                </releases>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
        </repositories>

可以找到对应的jar包  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70]

### （6）测试 ###

在新建的`springboot`项目中写一个`TestController`进行测试  
注入`TestBean`，并使用`TestBean`

@RestController
    @RequestMapping("/test")
    public class TestController { 
        @Autowired
        TestBean testBean;
        @RequestMapping("/user")
        public String user(){ 
            User user=new User();
            user.setName(testBean.getMsg());
            return user.toString();
        }
    }

然后启动项目，访问http://localhost:8080/test/user  
![在这里插入图片描述][20200803172333625.png]  
因为`TestBean`的`msg`默认是`hello world`，可以在配置文件中自定义`TestBean`的`msg`信息

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70 1]  
这就是自动提示的效果  
![在这里插入图片描述][20200803172541328.png]  
然后重启项目，重新访问http://localhost:8080/test/user  
![在这里插入图片描述][20200803172625830.png]  
到这里就已经结束了！还没看出来`starter`的好处吗？

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70]: /images/20230208/9d05c24b75984351bae5fb4dafc6e27c.png
[20200803172333625.png]: /images/20230208/27a727d12d344563a19e5708fbe245e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwMTk2NQ_size_16_color_FFFFFF_t_70 1]: /images/20230208/d441c1c3963848f0992d5fe07f38c7a6.png
[20200803172541328.png]: /images/20230208/857671b56db24826bcb7c276358b99a6.png
[20200803172625830.png]: /images/20230208/eb6ca27769b84a949eae93210cd36c7f.png