Spring Boot 自定义 Starter

最新推荐文章于 2024-08-24 17:09:16 发布

weixin_34408624

最新推荐文章于 2024-08-24 17:09:16 发布

阅读量65

点赞数

文章标签： java

原文链接：https://my.oschina.net/ruoli/blog/1609545

版权

为什么80%的码农都做不了架构师？>>>

需要创建两个工程，一个是 starter 的定义文件，一个是 starter的调用项目，具体实现逻辑为：边写好starter项目后打包至本地仓库，调用项目通过 maven starter的形式进行调用，此处两个项目分别定义为 hello_starer、hello_starer_test

1、整体目录结构

以下为分步操作

2、创建starter定义

创建Spring Boot 工程 hello_starter

1、 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>ruoli</groupId>
    <artifactId>hellostarter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>hello-spring-boot-starter</name>
    <description>测试自定义starter</description>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2、HelloServiceProperteis.java

创建HelloServiceProperteis.java 文件，用于接收配置文件中配置的内容，

@ConfigurationProperties：用来标识这个pojo是一个用来接收指定前缀的资源配置值
prefix：表示在配置文件中配置项前缀

如下：

package modules;                                                                                                      

import org.springframework.boot.context.properties.ConfigurationProperties;                                               
                                                                                                                          
@ConfigurationProperties(prefix = "hello")                                                                                
public class HelloServiceProperteis {                                                                                     
                                                                                                                          
    private String msg;                                                                                                   
                                                                                                                          
    public String getMsg() {                                                                                              
        return msg;                                                                                                       
    }                                                                                                                     
                                                                                                                          
    public void setMsg(String msg) {                                                                                      
        this.msg = msg;                                                                                                   
    }                                                                                                                                                                                                                                          
}

3、编写服务类

HelloService.java

package modules;
public class HelloService {
    private String msg;
    public String sayHello() {
        return "Hello " + msg;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

4、配置读取类

HelloServiceProperteis.java ，用来读取配置

package modules;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties(value = HelloServiceProperteis.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", value = "enable", matchIfMissing = true)
public class HelloAutoConfiguration {
	@Autowired
    private HelloServiceProperteis helloServiceProperteis;
    @Bean
    @ConditionalOnMissingBean(HelloService.class)
    public HelloService helloService() {
        HelloService helloService = new HelloService();
        helloService.setMsg(helloServiceProperteis.getMsg());
        return helloService;
    }
}

@Configuration：标识此类为一个spring配置类
@EnableConfigurationProperties(value = HelloServiceProperteis.class):启动配置文件，value用来指定我们要启用的配置类，可以有多个，多个时我们可以这么写value={xxProperties1.class,xxProperteis2.class....}

@ConditionalOnClass(HelloService.class):表示当classPath下存在HelloService.class文件时改配置文件类才有效

@ConditionalOnProperty(prefix = "hello", value = "enable", matchIfMissing = true):表示只有我们的配置文件是否配置了以hello为前缀的资源项值，并且在该资源项值为enable，如果没有配置我们默认设置为enable

5、配置 spring.factories

src/main/resources 文件夹下新建文件夹 META-INF，在新建的META-INF文件夹下新建 spring.factories

此文件配置这个starter模块被加载后需要自动启动的类为：HelloAutoConfiguration

内容为：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=modules.HelloAutoConfiguration

6、打包只本地仓库

mvn install

此时本地仓库中已经有我们刚才写的这个starter jar文件了。

3、创建starter调用工程

创建Spring Boot 工程 hello_starer_test

1、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>ruoli</groupId>
    <artifactId>hellostarter.test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>hello-spring-boot-starter-test</name>
    <description>测试自定义starter</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>ruoli</groupId>
            <artifactId>hellostarter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

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


</project>

2、创建服务调用Controller

创建HelloController 用与调用上面定义的starter提供的HelloService

package modules;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
	 @Autowired
	 private HelloService helloService;

	 @RequestMapping("/")
	 public String index() {
	    return helloService.sayHello();
	 }
}