SpringBoot_08_自定义starter

BroncLee

已于 2022-09-02 17:32:45 修改

阅读量105

点赞数

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

于 2022-08-28 17:18:56 首次发布

本文链接：https://blog.youkuaiyun.com/ayoM_/article/details/126571881

版权

SpringBoot 专栏收录该内容

15 篇文章

订阅专栏

本文介绍如何创建自定义Spring Boot Starter，包括启动器模块的作用、命名规范、编写步骤及自动配置实现过程。通过实例演示了如何自定义服务、配置属性及自动配置类。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot_08_自定义start

自定义Starter

自定义Starter

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

说明

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

命名归约：

官方命名：

前缀：spring-boot-starter-xxx
比如：spring-boot-starter-web…

自定义命名：

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

编写启动器

在IDEA中新建一个空项目 spring-boot-starter-diy
新建一个普通Maven模块：bronc-spring-boot-starter
新建一个Springboot模块：bronc-spring-boot-starter-autoconfigure
点击apply即可，基本结构

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

<!-- 启动器 -->
<dependencies>
    <!--  引入自动配置模块 -->
    <dependency>
        <groupId>com.bronc</groupId>
        <artifactId>bronc-spring-boot-starter-autoconfigure</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

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

我们编写一个自己的服务

package com.lee;

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

}

编写HelloProperties 配置类

package com.lee;

import org.springframework.boot.context.properties.ConfigurationProperties;

// 前缀 bronc.hello
@ConfigurationProperties(prefix = "bronc.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;
    }
}

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

package com.lee;

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

}

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

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

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

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

新建一个SpringBoot 项目

导入我们自己写的启动器

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

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

package com.lee.controller;

@RestController
public class HelloController {

    @Autowired
    HelloService helloService;

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

}

编写配置文件 application.properties

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

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

学完的东西一定要多下去实践！