狂神说SpringBoot06：自定义starter

分手后的思念是犯贱 2021-09-24 09:46 276阅读 0赞

> 狂神说SpringBoot系列连载课程，通俗易懂，基于SpringBoot2.2.5版本，欢迎各位狂粉转发关注学习。未经作者授权，禁止转载

![format_png][]

自定义Starter

我们分析完毕了源码以及自动装配的过程，我们可以尝试自定义一个启动器来玩玩！

## 说明 ##

启动器模块是一个 空 jar 文件，仅提供辅助性依赖管理，这些依赖可能用于自动装配或者其他类库；

**命名归约：**

官方命名：

*  前缀：spring-boot-starter-xxx
 *  比如：spring-boot-starter-web....

自定义命名：

*  xxx-spring-boot-starter
 *  比如：mybatis-spring-boot-starter

## 编写启动器 ##

1、在IDEA中新建一个空项目 spring-boot-starter-diy

2、新建一个普通Maven模块：kuang-spring-boot-starter

![format_png 1][]

3、新建一个Springboot模块：kuang-spring-boot-starter-autoconfigure

![format_png 2][]

4、点击apply即可，基本结构

![format_png 3][]

5、在我们的 starter 中 导入  autoconfigure 的依赖！

<dependencies>
        
        <dependency>
            <groupId>com.kuang</groupId>
            <artifactId>kuang-spring-boot-starter-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

6、将 autoconfigure 项目下多余的文件都删掉，Pom中只留下一个 starter，这是所有的启动器基本配置！

![format_png 4][]

7、我们编写一个自己的服务

package com.kuang;
    
    
    public class HelloService {
    
    
        HelloProperties helloProperties;
    
    
        public HelloProperties getHelloProperties() {
            return helloProperties;
        }
    
    
        public void setHelloProperties(HelloProperties helloProperties) {
            this.helloProperties = helloProperties;
        }
    
    
        public String sayHello(String name){
            return helloProperties.getPrefix() + name + helloProperties.getSuffix();
        }
    
    
    }

8、编写HelloProperties 配置类

package com.kuang;
    
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    
    // 前缀 kuang.hello
    @ConfigurationProperties(prefix = "kuang.hello")
    public class HelloProperties {
    
    
        private String prefix;
        private String suffix;
    
    
        public String getPrefix() {
            return prefix;
        }
    
    
        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }
    
    
        public String getSuffix() {
            return suffix;
        }
    
    
        public void setSuffix(String suffix) {
            this.suffix = suffix;
        }
    }

9、编写我们的自动配置类并注入bean，测试！

package com.kuang;
    
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    
    @Configuration
    @ConditionalOnWebApplication //web应用生效
    @EnableConfigurationProperties(HelloProperties.class)
    public class HelloServiceAutoConfiguration {
    
    
        @Autowired
        HelloProperties helloProperties;
    
    
        @Bean
        public HelloService helloService(){
            HelloService service = new HelloService();
            service.setHelloProperties(helloProperties);
            return service;
        }
    
    
    }

10、在resources编写一个自己的 META-INF\\spring.factories

# Auto Configure
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.kuang.HelloServiceAutoConfiguration

11、编写完成后，可以安装到maven仓库中！

![format_png 5][]

## 新建项目测试我们自己写的启动器 ##

1、新建一个SpringBoot 项目

2、导入我们自己写的启动器

<dependency>
        <groupId>com.kuang</groupId>
        <artifactId>kuang-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>

3、编写一个 HelloController  进行测试我们自己的写的接口！

package com.kuang.controller;
    
    
    @RestController
    public class HelloController {
    
    
        @Autowired
        HelloService helloService;
    
    
        @RequestMapping("/hello")
        public String hello(){
            return helloService.sayHello("zxc");
        }
    
    
    }

4、编写配置文件 application.properties

kuang.hello.prefix="ppp"
    kuang.hello.suffix="sss"

5、启动项目进行测试，结果成功 !

![format_png 6][]

**小狂神温馨提示：学完的东西一定要多下去实践！**

每日更新，记得关注转发

![format_png 7][]

![format_png 8][]

[format_png]: /images/20210923/0e894515ba5c4f98af62a6bdbdc26626.png
[format_png 1]: /images/20210923/63a483e1ef3c42c2958f1df92d39fbd0.png
[format_png 2]: /images/20210923/cf9e3732372644108d6fb95ece87784f.png
[format_png 3]: /images/20210923/9664c5c52289483ab93da21b953d7008.png
[format_png 4]: /images/20210923/45f8d180fae142adbbc72d9d55c0cb4d.png
[format_png 5]: /images/20210923/592c2fc6487a46cbb11406c2f1db7fb7.png
[format_png 6]: /images/20210923/e67d5d00a3b745a69d7052766e711607.png
[format_png 7]: /images/20210923/fcee982923e544be84ad74c9a82a41a9.png
[format_png 8]: /images/20210923/17631e32c66b412684199601d7211af5.png