SpringBoot自定义starter

r囧r小猫 2021-12-11 09:45 454阅读 0赞

## SpringBoot自定义starter ##

按照一般的模式, 我们创建一个启动器, 但是该启动器只用来做依赖导入

然后创建另外一个自动配置模块, 用来定义自动配置

启动器依赖自动配置, 别人只需要引入启动器

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FuZ2VyV2luZA_size_16_color_FFFFFF_t_70]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FuZ2VyV2luZA_size_16_color_FFFFFF_t_70 1]

我们可以看到, 在mybatis-spring-boot-starter中没有任何java代码,只是在pom文件中定义了依赖, 而自动配置的代码都在mybatis-spring-boot-autoconfiguration中

### 1. 创建自动配置模块 ###

我们来创建一个springboot项目, pom.xml如下

<?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>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.6.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <groupId>com.sqt.starter</groupId>
        <artifactId>sqt-spring-boot-autoconfigurer</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
        </dependencies>
    </project>

我们只需要在其中引入spring-boot-starter依赖, 其他可以删除

在其中创建HelloProperties.java

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

创建HelloService.java

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();
        }
    }

创建自动配置类

@Configuration
    @ConditionalOnWebApplication  //只在web环境中起作用
    @EnableConfigurationProperties({ HelloProperties.class})
    public class HelloServiceAutoConfiguraion { 
    
        @Autowired
        HelloProperties helloProperties;
    
        @Bean
        public HelloService helloService(){ 
            HelloService helloService = new HelloService();
            helloService.setHelloProperties(helloProperties);
            return helloService;
    
        }
    }

在resources目录下创建META-INF/spring.factories

#定义自动配置类
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
      com.sqt.starter.HelloServiceAutoConfiguraion

目录如下:  
![在这里插入图片描述][20190708212508742.png]

其他没用的东西可以删掉

## 创建starter工程 ##

我们创建一个starter工程, 因为这个工程只用来做依赖管理和导入, 所以我们可以创建一个空的maven工程

在pom.xml文件中引入我们的自动配置工程

<?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>com.sqt.starter</groupId>
        <artifactId>sqt-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    
    
        <dependencies>
            <dependency>
                <groupId>com.sqt.starter</groupId>
                <artifactId>sqt-spring-boot-autoconfigurer</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </project>

然后分别将我们的autoConfiguration模块和starter模块install到本地仓库

## 编写测试 ##

我们创建一个springboot项目, 在其中引入我们的starter项目

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

在application.properties配置文件中编写配置

这个配置是在我们autoConfiguration工程中定义的

sqt.hello.suffix = hello world
    sqt.hello.prefix = zhangsan

我们来创建一个测试类

@Controller
    @ResponseBody
    public class LoginController { 
    
        @Autowired
        HelloService helloService;
    
        @GetMapping("/login")
        public String login(){ 
            String s = helloService.sayHello("张三");
            return s;
        }
    }

启动项目

![在这里插入图片描述][20190708212528238.png]

可以看到, 我们在autoConfiguration工程中配置的HelloService被@Autowired了进来, 而不需要我们自动配置.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FuZ2VyV2luZA_size_16_color_FFFFFF_t_70]: /images/20211211/557b1a4fd2424bebb4a9afea2e2938c9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FuZ2VyV2luZA_size_16_color_FFFFFF_t_70 1]: /images/20211211/35b5e567ca964383b5e18f94eeeb855e.png
[20190708212508742.png]: /images/20211211/f1543f4e7d314937b9a15d617d65610f.png
[20190708212528238.png]: /images/20211211/454c48f696b14a17ba22ee4edfafc12d.png