Spring Boot自定义starters

最新推荐文章于 2024-03-28 16:01:59 发布

从头再来_f

最新推荐文章于 2024-03-28 16:01:59 发布

阅读量375

点赞数 1

分类专栏： SpringBoot 文章标签： spring spring boot java

本文链接：https://blog.csdn.net/weixin_42128429/article/details/120850431

版权

SpringBoot 专栏收录该内容

10 篇文章 3 订阅

订阅专栏

一、简介

SpringBoot 最强大的功能就是把我们常用的场景抽取成了一个个starter（场景启动器），我们通过引入springboot 为我提供的这些场景启动器，我们再进行少量的配置就能使用相应的功能。即使是这样，springboot也不能囊括我们所有的使用场景，往往我们需要自定义starter，来简化我们对springboot的使用。

二、如何自定义starter

1.实例

如何编写自动配置？

我们参照@WebMvcAutoConfiguration为例，我们看看们需要准备哪些东西，下面是WebMvcAutoConfiguration的部分代码：

@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
		ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {

    @Import({WebMvcAutoConfiguration.EnableWebMvcConfiguration.class})
    @EnableConfigurationProperties({WebMvcProperties.class, ResourceProperties.class})
    public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {

        @Bean
        @ConditionalOnBean({View.class})
        @ConditionalOnMissingBean
        public BeanNameViewResolver beanNameViewResolver() {
            BeanNameViewResolver resolver = new BeanNameViewResolver();
            resolver.setOrder(2147483637);
            return resolver;
        }
    }
}

我们可以抽取到我们自定义starter时同样需要的一些配置。

@Configuration //指定这个类是一个配置类

@ConditionalOnXXX //指定条件成立的情况下自动配置类生效

@AutoConfigureOrder //指定自动配置类的顺序

@Bean //向容器中添加组件

@ConfigurationProperties //结合相关xxxProperties来绑定相关的配置

@EnableConfigurationProperties //让xxxProperties生效加入到容器中

自动配置类要能加载需要将自动配置类，配置在META-INF/spring.factories中 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

2.模式

我们参照 mybatis-spring-boot-starter 我们发现其中没有代码：

我们在看它的pom中的依赖中有个 mybatis-spring-boot-autoconfigure

关于mybatis的一些自动配置都写在了这里，所以我们有总结：

启动器（starter）是一个空的jar文件，仅仅提供辅助性依赖管理，这些依赖可能用于自动装配或其他类库。
需要专门写一个类似spring-boot-autoconfigure的配置模块
用的时候只需要引入启动器starter，就可以使用自动配置了

命名规范

官方命名空间

前缀：spring-boot-starter-
模式：spring-boot-starter-模块名
举例：spring-boot-starter-web、spring-boot-starter-jdbc

自定义命名空间

后缀：-spring-boot-starter
模式：模块-spring-boot-starter
举例：mybatis-spring-boot-starter

三、自定义starter实例

我们需要先创建一个父maven项目:springboot_custome_starter

两个Module: fztx-spring-boot-starter 和 fztx-spring-boot-starter-autoconfigurer

springboot_custome_starter

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <modules>
        <module>fztx-spring-boot-starter-autoconfigurer</module>
        <module>fztx-spring-boot-starter</module>
    </modules>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <packaging>pom</packaging>
    <groupId>com.springboot</groupId>
    <artifactId>springboot_custome_starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot_custome_starter</name>
    <description>SpringBoot自定义starter</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>


</project>

1. fztx-spring-boot-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">
    <parent>
        <artifactId>springboot_custome_starter</artifactId>
        <groupId>com.springboot</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>fztx-spring-boot-starter</artifactId>

    <description>
        启动器（starter）是一个空的jar文件，
        仅仅提供辅助性依赖管理，
        这些依赖需要自动装配或其他类库。
    </description>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--引入autoconfigure-->
        <dependency>
            <groupId>com.springboot</groupId>
            <artifactId>fztx-spring-boot-starter-autoconfigurer</artifactId>
        </dependency>
    </dependencies>

    <!--如果当前starter 还需要其他的类库就在这里引用-->
</project>

如果使用spring Initializr创建的需要删除启动类、resources下的文件，test文件。

2. fztx-spring-boot-starter-autoconfigurer

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">
    <parent>
        <artifactId>springboot_custome_starter</artifactId>
        <groupId>com.springboot</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>fztx-spring-boot-starter-autoconfigurer</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--‐导入配置文件处理器，配置文件进行绑定就会有提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

2. FztxProperties

@ConfigurationProperties("fztx.hello")
public class FztxProperties {

        private String name;

        public String getName() {
        return name;
    }

        public void setName(String name) {
        this.name = name;
    }

}

3. IndexController

@RestController
public class IndexController {

    private FztxProperties fztxProperties;

    public IndexController(FztxProperties fztxProperties) {
        this.fztxProperties = fztxProperties;
    }

    @RequestMapping("/")
    public String index(){
        return fztxProperties.getName()+"欢迎您";
    }
}

4. FztxAutoConfitguration

/**
 * 给web应用自动添加一个首页
 */
@Configuration
@ConditionalOnProperty(value = "fztx.hello.name")
@EnableConfigurationProperties(FztxProperties.class)
public class FztxAutoConfitguration {
    @Autowired
    FztxProperties fztxProperties;

    @Bean
    IndexController indexController(FztxProperties fztxProperties){
        return new IndexController(fztxProperties);
    }
}

5. spring.factories

在 resources 下创建文件夹 META-INF 并在 META-INF 下创建文件 spring.factories ，内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.fztx.FztxAutoConfitguration

到这儿，我们的配置自定义的starter就写完了，我们fztx-spring-boot-starter-autoconfigurer、fztx-spring-boot-starter 安装成本地jar包。

三、测试自定义starter

我们创建个Module: springboot_starter，来测试系我们写的stater。

1. pom.xml

        <dependency>
            <groupId>com.springboot</groupId>
            <artifactId>fztx-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

2.浏览

http://localhost:8080/

由于在自动配置上设置了

@ConditionalOnProperty(value = "fztx.hello.name")

但我们还没有配置。so......

3. application.properties

fztx.hello.name="CSDN"

再次访问：http://localhost:8080/

从头再来_f

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring Boot自定义starters

一、简介SpringBoot 最强大的功能就是把我们常用的场景抽取成了一个个starter（场景启动器），我们通过引入springboot 为我提供的这些场景启动器，我们再进行少量的配置就能使用相应的功能。即使是这样，springboot也不能囊括我们所有的使用场景，往往我们需要自定义starter，来简化我们对springboot的使用。二、如何自定义starter1.实例如何编写自动配置？我们参照@WebMvcAutoConfiguration为例，我们看看们需要准备哪些东西，下面
复制链接

扫一扫