SpringBoot中自定义Starter

于 2025-02-15 18:14:13 发布
阅读量1.1k 收藏 25
点赞数 15
分类专栏： 面试 学习路线 阿里巴巴 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/m0_74823561/article/details/145654369
版权
SpringBoot中自定义Starter

1. 前置知识

在我们自定义starter的时候，先要了解 Springboot自动装配原理。
我们可以参照 mybatis-plus-boot-starter源码来实现我们的自定义starter功能。

1-1 什么是Starter？

Starter是一种用于简化依赖管理和配置的方式。
		它是一个预定义的依赖关系集合， 包含了一组常用的依赖和配置，
		以便于快速启动和构建特定类型的应用程序。

使用Starter可以大大简化项目的依赖管理和配置工作，
		提供了一种快速启动和构建特定类型应用程序的方式。
		例如，Spring Boot提供了spring-boot-starter-web用于快速构建Web应用程序，
		它包含了常用的Web依赖（如Spring MVC、Tomcat等）和相关的自动配置。

开发者也可以自定义自己的Starter，将常用的依赖和配置打包为一个Starter，
		方便在复用和共享。自定义Starter可以提供一组特定领域的依赖和配置，以满足开发需求。

1-2 常用的Condition注解说明

在加载自动配置类的时候，
		并不是将spring.factories的配置全部加载进来，
		而是通过@Conditional等注解的判断进行动态加载

@Conditional其实是spring底层注解，
		意思就是根据不同的条件，来进行自己不同的条件判断，
		如果满足指定的条件，那么配置类里边的配置才会生效。
常用的Conditional注解：

@ConditionalOnClass ： classp ath中存在该类时起效
@ConditionalOnMissingClass ： classpath中不存在该类时起效
@ConditionalOnBean ： DI容器中存在该类型Bean时起效
@ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或 @Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ： 参数设置或者值一致时起效
@ConditionalOnResource ： 指定的文件存在时起效
@ConditionalOnJndi ： 指定的JNDI存在时起效
@ConditionalOnJava ： 指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ： 非Web应用环境下起效

1-3 Starter的命名规范

Spring官方Starter通常命名为 spring-boot-starter-{name}
		如：spring-boot-starter-web
Spring官方建议非官方Starter命名应遵循 {name}-spring-boot-starter的格式：
		如 mybatis-spring-boot-starter。

2. 自定义自己的Starter示例

2-1 创建Starter项目

自定义一个starter，名字是demo-spring-boot-starter, 结构如下图：
在这里插入图片描述

2-2 Pom.Xml【示例引入了spring-boot-starter和lombok】

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zhaof</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-spring-boot-starter</name>
    <description>demo-spring-boot-starter</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

2-3 几个Class内容如下：

2-3-1 配置类：PersonProperties
package com.zhaof.demospringbootstarter.config;

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

import java.io.Serializable;

@Data
//@Component   注：这里无需使用@Component
@ConfigurationProperties(prefix = "sea.person")
public class PersonProperties implements Serializable {
    private String name;
    private int age;
}
2-3-2 业务类：PersonService
package com.zhaof.demospringbootstarter.service;

import com.zhaof.demospringbootstarter.config.PersonProperties;
import org.springframework.beans.factory.annotation.Autowired;

//@Component   注：这里无需使用@Component
public class PersonService {

    @Autowired
    private PersonProperties personProperties;

    public String sayHello() {
        return "Hello, name is "+ personProperties.getName() + ", age is " + personProperties.getAge();
    }
}
2-3-3 自动配置类：PersonAutoConfiguration
package com.zhaof.demospringbootstarter.autoconfig;

import com.zhaof.demospringbootstarter.config.PersonProperties;
import com.zhaof.demospringbootstarter.service.PersonService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(PersonProperties.class)
@ConditionalOnClass(PersonService.class)
public class PersonAutoConfiguration {

    @Bean
    public PersonService personService(){
        return new PersonService();
    }
}

2-4 创建spring.factories文件

//	spring.factoryes文件如下：
//		如下内容中，反斜杠表示换行，太长了可以换到下一行。


org.springframework.beans.autoconfig.EnableAutoConfiguration=

com.zhaof.demospringbootstarter.autoconfig.PersonAutoConfiguration

在这里插入图片描述

1. 注意：

  • spring boot 2.7后不再推荐使用META-INF/spring.factories自动装配
  • 推荐使用META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports来自动装配。
    当然为了向后兼容，spring.factories还是会继续支持

2. 注意：
springboot 3.0之后自动配置文件，
只能使用META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
使用如下：

1. 在resources目录下建立
		META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件
2. 内容可参考如下，可发现
		可以明显的看到使用org.springframework.boot.autoconfigure.AutoConfiguration.imports
		的内容更加直观，
		不需要再去指定EnableAutoConfiguration这个固定的字符串
		然后多个配置之间也无需再用,来换行，直接换行即可
com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

在这里插入图片描述

2-5 项目打成jar，发布到maven仓库

直接使用idea的maven功能进行打包
在这里插入图片描述

2-6 其他项目使用自定义的Starter

2-6-1 创建一个SpringBoot项目，Pom.Xml中使用自定义的Starter
<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zhaof</groupId>
    <artifactId>springboot-rundemo1</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-rundemo1</name>
    <description>springboot-rundemo1</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 自定义Starter工程 -->
        <dependency>
            <groupId>com.zhaof</groupId>
            <artifactId>demo-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
2-6-2 在配置文件application.yml中写入配置
spring:
  application:
    name: springboot-rundemo1

# 自定义Starter使用的配置信息
sea:
  person:
    name: 测试
    age: 11
2-6-3 使用自定义Starter
package com.zhaof.controller;

import com.zhaof.demospringbootstarter.service.PersonService;
import com.zhaof.dto.ResponseDto;
import com.zhaof.utils.ResponseUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/Api2/v1.0")
public class Demo2Controller {

    @Autowired
    private PersonService personService2;

	// 示例中用到的返回结果类、包装类代码在下方
    @GetMapping("/sayHello")
    public ResponseDto sayHello(){
        String said = personService2.sayHello();
        return ResponseUtil.success(said);
    }

}



package com.zhaof.dto;

import lombok.AllArgsConstructor;
import lombok.Data;

@AllArgsConstructor
@Data
public class ResponseDto<T> {
    private int code;
    private String message;
    private T data;
}


package com.zhaof.utils;

import com.zhaof.dto.ResponseDto;

public class ResponseUtil {

    public static  <T> ResponseDto success(T data){
        return new ResponseDto(200,"success",data);
    }

    public static <T> ResponseDto fail(T data){
        return new ResponseDto(-1,"fail",data);
    }
}
2-6-4 发起请求测试

在这里插入图片描述

最详细的自定义Spring Boot Starter开发教程
chongmu2584的博客
08-19 2215
1. 前言 随着Spring的日渐臃肿，为了简化配置、开箱即用、快速集成，Spring Boot 横空出世。 目前已经成为 Java 目前最火热的框架了。平常我们用Spring Boot开发web应用。Spring mvc 默认使用tomcat servlet容器， 因为Spring mvc组...
教你如何实现自定义SpringBootStarter
热门推荐
qq_42394044的博客
04-01 1万+
教你如何实现自定义SpringBootStarter
springboot自定义starter
最新发布
weixin_74261199的博客
08-12 2344
配置类是通过无参构造创建出来，在通过set方法属性注入的，所以一定要保证无参构造器和对应set方法存在@Data即使用时要通过如下配置信息设置bean的属性值（yml格式）student:name: zsage: 18@Autowired@Bean标注这是一个配置类条件注入，代表Student类存在时才会创建对应bean指出配置文件读取类。
springboot 自定义starter
不懂一休
08-20 1万+
文章目录一、starter启动原理二、自定义starter1、say-spring-boot-starter-autoconfigure（自动配置包）①、项目结构②、pom文件③、实体类 DialogBean④、业务类 SayService⑤、自动配置类 SayServiceAutoConfiguration⑥、配置使用 META-INF/spring.factories2、say-spring-boot-starter（启动器）①、项目结构②、pom 文件三、测试自定义 starter1、项目结构2、 p
【SpringBoot】自定义Starter
观止study
03-13 4452
本篇详细介绍了如何自定义一个Starter并导入到其他项目进行使用，已经一些相关注意事项
Springboot之自定义starter
星海IT学习之路
08-09 1425
分析自动装配原理。并实现自定义starter功能，包含代码实现。
如何在SpringBoot中自定义starter
常备不懈
06-25 680
Spring Boot 提供了一种简便的方法来创建自定义的 starter，从而帮助开发者封装常用的配置和依赖。本文将介绍如何在 Spring Boot 中自定义一个 starter。
SpringBoot3自定义Starter步骤
simpleGq的专栏
11-19 471
SpringBoot3自定义Starter
SpringBoot之自定义starter
qq_52445443的博客
01-16 1万+
目录 一、什么是SpringBoot starter机制 二、为什么要自定义starter 三、什么时候需要创建自定义starter 四、自动加载核心注解说明 五、自定义starter的开发流程 案例一：为短信发送功能创建一个starter 案例二：AOP方式统一服务日志 一、什么是SpringBoot starter机制 SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入sta.
SpringBoot的自动配置、配置文件
ilove_story的博客
09-27 1519
1、自动配置 主程序类、主入口类 @SpringBootApplication //标注这是一个主程序类 public class MainApplication { public static void main(String[] args) { //启动Spring应用 //无需将项目打包成war并且部署到tomcat上运行 //无需配置视图解析器等等 SpringApplication.run(MainApplication.c
SpringBoot之自定义Starter
孙小鸿的博客
12-04 389
SpringBoot之自定义Starter。完整演示如何自定义SpringBoot的场景启动器startr
Spring Boot之自定义Starter
积跬步，至千里。
12-02 4434
在Spring Boot中，自定义Starter是一种方便的方式来封装和共享一组相关的依赖项和配置。自定义Starter可以简化应用程序的配置，并提供一致的依赖项管理。
SpringBoot-自定义Starter
有一种信仰叫海阔天空
07-29 317
                                  SpringBoot-自定义Starter 项目参考：https://github.com/xwbGithub/SpringBoot-starter 分析源码： @Configuration //指定这个类是一个配置类 @ConditionalOnXXX //在指定条件成立的情况下自动配置类生效 @AutoConfigur...
springboot自定义自定义starter流程
05-27
Spring Boot是一个快速开发微服务的框架，它提供了大量的自动化配置和快速开发的工具。在Spring Boot中，我们可以使用Starter来快速集成一些常用的功能，如数据库、缓存、web等。而自定义Starter则可以让我们将自己的功能快速集成到Spring Boot中，下面是自定义Starter的流程： 1. 创建Maven项目 首先，我们需要创建一个Maven项目作为我们自定义Starter的项目。在项目的pom.xml中添加Spring Boot的依赖，以及其他需要集成的依赖。 2. 编写自动配置类 自动配置类是自定义Starter的核心，它负责将我们自定义的功能集成到Spring Boot中。在自动配置类中，我们可以使用@Conditional注解来判断是否需要进行配置。 3. 编写Starter类 Starter类是我们自定义Starter的入口，它负责将自动配置类注入到Spring容器中。在Starter类中，我们需要使用@EnableAutoConfiguration注解来启用自动配置。 4. 打包和发布Starter 当我们完成了自动配置类和Starter类的编写后，我们需要将自定义Starter打包成jar包，并发布到Maven仓库中，以便其他项目可以通过Maven依赖的方式使用我们的Starter。 5. 在项目中使用自定义Starter 在其他项目中使用自定义Starter非常简单，只需要在项目中的pom.xml中添加我们自定义Starter的依赖即可。Spring Boot会自动将我们的自定义Starter集成到项目中，并进行自动配置。 以上就是自定义Starter的流程，通过自定义Starter，我们可以将自己的功能快速集成到Spring Boot中，提高开发效率。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值