spring boot 的自定义starter

最新推荐文章于 2024-11-10 13:47:39 发布

MG-net

最新推荐文章于 2024-11-10 13:47:39 发布

阅读量118

点赞数 1

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

本文链接：https://blog.csdn.net/liming0025/article/details/121024225

版权

spring boot 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

本文介绍了如何创建自定义的Spring Boot Starter，包括启动器和自动配置的实现步骤。通过创建一个名为mg-hello-spring-boot-starter的启动器，包含了HelloService功能，自动配置了HelloProperties，并在其他项目中成功引用并使用。详细阐述了启动过程、自动配置的条件注解以及配置文件的使用。

摘要由CSDN通过智能技术生成

虽然spring boot 会给使用者准备很多的starter，但是在某些情况还是需要开发一些公共的相关功能，去让团队其他人使用。

一、启动原理

想要其他人引用starter，就需要一个场景启动器。如：

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

场景启动器，只是引入一些该场景下使用的依赖，然后引入自动配置 autoconfigure。自动配置包引入所有启动器都引用的 spring-boot-starter

二、自定义starter

1、创建两个项目，一个启动器，一个自动装配：

启动器中引入自动装配：

<?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>org.example</groupId>
    <artifactId>mg-hello-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.mg</groupId>
            <artifactId>mg-hello-spring-boot-start-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

在自动装配中编写提供功能、自动装配属性类、自动装配类

提供功能：

package com.mg.service;

import org.springframework.beans.factory.annotation.Autowired;

/**
 * 默认不要放在容器中
 */
public class HelloService {

    @Autowired
    HelloProperties helloProperties;

    public String sayHello(String userName){
        return helloProperties.getPrefix() + "：" + userName + "》" + helloProperties.getSuffix();
    }

}

配置类：

package com.mg.service;

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

@ConfigurationProperties("mg.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;
    }
}

自动装配：

package com.mg.service.auto;


import com.mg.service.HelloProperties;
import com.mg.service.HelloService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 默认放入容器中
 * 查看是否使用者自己注入 hellloservice
 * 同时查看配置文件是否可用
 */
@Configuration
@ConditionalOnMissingBean(HelloService.class)
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfigurtion {

    @Bean
    public HelloService helloService(){
        HelloService helloService = new HelloService();
        return helloService;
    }

}

PS：pom文件中不要引入maven打包插件，否则其引入的时候，无法import功能类

安装到本地仓库即可。

在另一个项目中引入：

        <dependency>
            <groupId>org.example</groupId>
            <artifactId>mg-hello-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

编写业务类：

package com.wjf.boot.controller;

import com.mg.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Administrator
 */
@RestController
public class HelloController {

    @Autowired
    HelloService helloService;

    @GetMapping("/")
    public String hello(){
        return helloService.sayHello("张三");
    }

}

配置文件：

mg.hello.prefix = WJF
mg.hello.suffix = LMR

运行后可以看到：

三、spring boot 原理

1、启动过程

创建SpringApplication
- 保存相关信息
- 判断当前应用的类型 - servlet
- bootstrappers 初始启动引导器从spring.factories中寻找 org.springframework.Bootstrapper
- 在spring.factories寻找初始化器，ApplicationContextInitializer
- 在spring.factories寻找监听器，ApplicationListener
运行SpringApplication