四 Sringboot 自定义starter

最新推荐文章于 2024-06-03 23:41:03 发布
最新推荐文章于 2024-06-03 23:41:03 发布
阅读量374 收藏
点赞数
分类专栏： springboot 文章标签： spring boot spring java maven
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yhp0607/article/details/109115415
版权

1 springboot starter机制概述

​ SpringBoot中的starter是一种非常重要的机制，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。

2 springboot starter机制原理

​ 当我们引入了starter，就会使用springboot自动配置原理，对这种场景进行配置。

在这里插入图片描述

①Springboot应用入口类通过@SpringBootApplication注解简介使用@EnableAutoConfiguration（是父注解）

②使用@EnableAutoConfiguration后，会扫描所有jar中的spring.factories文件，加载所有的配置类（加了 @Configuration的类）

③配置类（加了@Configuration的类）使用XxxProperties以@Bean的方式完成对应场景的配置

④XxxPropereis里面的配置信息有默认值，但是我们可以在application.properties/application.yml中获取

3 自定义springboot starter步骤分析

3.1 一个springboot starter的组成

1 一个@Configuration的配置类
  1.1 @Configuration依赖XxxProperties类
  1.2 XxxProperties可以通过application.properties/yml来定制配置
2 META-INF/spring.factories
  2.1 spring.factories有准备好的配置类的配置

3.2 编写springboot starter的步骤

1 新建一个springboot starter的模块
2 准备@Configuration的配置类
3 META-INF/spring.factories里面配置配置类
4 把starter进行打包 mvn clean install
5 新建模块使用配置类里面配置好的一些东西

4 自定义Springboot-starter实现

4.1 准备starter模块

4.1.1 新建starter模块

​ SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建议自定义的starter使用xxx-spring-boot-starter命名规则。以区分SpringBoot生态提供的starter。

例如：spring-boot-starter-yhptest

4.1.2 导入jar

​

<?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>cn.itsource</groupId>
    <artifactId>spring-boot-starter-yhptest</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--导入springboot相关的jar包-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
</project>

4.2 准备配置类

4.2.1 准备XxxProperties
package cn.itsource.properties;

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

@ConfigurationProperties(prefix = "yhptest")
public class YhptestProperties {
    private String yhptest = "yhptest";

    public String getYhptest() {
        return yhptest;
    }

    public void setYhptest(String yhptest) {
        this.yhptest = yhptest;
    }
}
4.2.2 准备XxxAutoConfiguration
package cn.itsource.config;

import cn.itsource.properties.YhptestProperties;
import cn.itsource.service.YhptestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
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(YhptestProperties.class) //加载配置Properties
@ConditionalOnClass(YhptestAutoConfiguration.class) // 触发配置条件
public class YhptestAutoConfiguration {

    //注入
    @Autowired
    private YhptestProperties yhptestProperties;


    @Bean
    //使用YhptestProperties进行配置
    public YhptestService yhptestService(){
        return new YhptestService(yhptestProperties.getYhptest());
    }
}
4.2.3 准备要配置的类
package cn.itsource.service;

//给其他模块注入使用的
public class YhptestService {
    private String yhptest;

    public YhptestService(String yhptest) {
        this.yhptest = yhptest;
    }

    public String getYhptest(){
        return this.yhptest;
    }
}

4.3 spring.factories里面配置配置类

4.3.1 创建META-INF/spring.factories
在resource目录创建META-INF文件夹，并且在文件夹里面创建名为spring.factories的文件
4.3.2 配置配置类

​

#-------starter自动装配---------
org.springframework.boot.autoconfigure.EnableAutoConfiguration=cn.itsource.config.YhptestAutoConfiguration

4.4 starter打包

​ 在项目路径使用mvn clean install

在这里插入图片描述

5 模块使用自定义starter

5.1 步骤分析

1 创建springboot项目
  创建maven并准备pom.xml
  yml配置
  入口类
  启动测试
2 依赖自定义starter
3 测试测试注入自定义starter的自动配置里面配置的bean

5.2 测试自定义starter

5.2.1 创建springboot项目

  1. 创建maven项目并准备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>cn.itsource</groupId>
    <artifactId>yhpteststarter-test</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--导入springboot相关的jar包-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.RELEASE</version>
    </parent>

    <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>
        </dependency>
    </dependencies>

</project>

  2. yml配置

    server:
  port: 9999

  3. 入口类

    package cn.itsource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class,args);
    }
}

  4. 启动测试

    运行App.java main不报错就ok

5.2.2 依赖自定义starter
 <!--依赖自定义stater-->
        <dependency>
            <groupId>cn.itsource</groupId>
            <artifactId>spring-boot-starter-yhptest</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
5.2.3 使用自定义stater里面配置的bean进行测试
package cn.itsource;

import cn.itsource.service.YhptestService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = App.class)
public class Yhptest {

    @Autowired
    private YhptestService yhptestService;
    @Test
    public void test() throws Exception{
        System.out.println(yhptestService.getYhptest());
    }
}

​ 也可以修改application.yml中的配置进行修改

application.yml

server:
  port: 9999
yhptest:
  yhptest: zs
姚桑带你学Java与架构
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【springboot】接口多实现类，选择性注入的4种解决方案
字母哥博客
03-03 1万+
在SpringBoot环境下，当一个接口有多个实现类，怎么样根据配置方便快捷的切换实现类，并实现依赖注入？欢迎大家点击进来学习！
SpringBoot自定义starter
桐花思雨
03-01 1098
目录前言`SpringBoot` 自定义 `starter`创建多模块项目项目编码`custom-spring-boot-starter` 父模块依赖`hello-spring-boot-starter-autoconfigure` 子模块 前言 今天看到了一道面试题，如何实现一个自定义的 SpringBoot starter，或者说，SpringBoot 如何加载我们自己的 jar 包？其实，仔细想想本质是考察 SpringBoot 的自动配置原理，了解了其自动配置原理即可实现 SpringBoot 自定
springboot一个接口多个实现类的调用方式
易雁的博客
01-03 1535
1.2、创建多个实现类 1.3、指定限定名注入实现类 2、Map名注入实现类 2.1、定义一个接口 2.2、创建多个实现类 2.3、枚举 2.4、指定限定名注入实现类
[SpringBoot]接口的多实现:选择性注入SpringBoot接口的实现类
Jim.kk的笔记
01-07 2009
SpringBoot的Service是否可以有多个实现类呢？该如何确定我要注入的那一个实现类呢？
SpringBoot 中同一个接口有多个实现类的配置
ningziwen的博客
04-11 1688
1.先定义一个服务接口类： public interface InterfaceService { String start(String key); } 2.定义第一个实现类： @Configuration @ConditionalOnProperty(name="action.type",havingValue = "ALIYUN") public class AliyunServiceImpl implements InterfaceService { public St
spring（spring boot）一个接口多个实现类的配置使用
qice675563721的专栏
07-23 8654
参考文章：https://blog.csdn.net/mazuyu408/article/details/79629846 https://blog.csdn.net/kzcming/article/details/84333799 先说明下场景,代码如下： 有如下接口： public interface EmployeeService { public EmployeeDto...
SpringBoot自定义starter实例代码
08-26
SpringBoot 自定义 Starter 实例代码 SpringBoot 自定义 Starter 实例代码是指通过自定义 Starter 来简化 SpringBoot 的使用。SpringBoot 的强大功能之一是 把常用的场景抽取成了一个个 Starter（场景启动器），...
springboot自定义starter
01-15
在Spring Boot框架中，自定义Starter是一种非常实用的技术，它允许开发者创建可重用的模块，以便在多个项目间快速引入和配置依赖。通过创建自定义Starter，我们可以简化项目构建过程，提高代码的可维护性和一致性。...
springboot自定义Starter的具体流程
08-25
SpringBoot自定义Starter的具体流程 SpringBoot自定义Starter是一种特殊的starter，它可以根据项目的需求进行自定义和配置，从而满足不同的业务需求。在 본节中，我们将详细介绍SpringBoot自定义Starter的具体流程...
springboot自定义starter实现redis-starter
confusingggg的博客
03-13 1134
springboot自定义starter实现redis缓存自启动全过程指导，同时对于项目可能的运行错误提供解决方案，100%没有问题。
优雅解决service有多个实现类，要使用哪个【这方法也太好用了叭！】
01-21
Hi，大家好，我是一个爱冒泡的程序猿 有事情耽搁的好几天没更新了，每日一更计划又泡汤了(灬ꈍ ꈍ灬) 小编今天最近遇到的一个问题就是，有一个水果的Service，它的实现类中，同样方法名的有两个，一个是“榴莲”，一个是“苹果”（万一榴莲坏了，还有苹果吃٩(๑❛ᴗ❛๑)۶），如何优雅的决定它的出现。 有几个解决方法，顺序：从差到优~ 方法一： 由于“榴莲”和“苹果”都在这个实现类里，方法名相同，所以只能把一方先注掉 这个方法最烂也最不友好，小编是由于忙于开发，就先这样跳过去了做其他的了，大家不要学我(´•༝•`) 优点：只是实现需求，无任何优点可言，无任何美感可言 缺点：每次都得手动改代码，想吃
springboot结合策略模式实现一个接口多个实现类动态切换
最新发布
qq_31405077的博客
06-03 373
使用这种写法未来要是扩展一个支付方式的话，就要修改这个switch判断里面的内容，往里面添加一个分支，这样是有违背开闭原则，而且未来要是支付方式越来越多代码看上去也不美观。最近碰到个需求需要实现多种不一样的第三方支付，目前是支付宝微信，像这种支付一般在系统中的流程不会变只是要对接不同的支付api。这样就改造完了，改造完后的代码之后要扩展或者减少支付方式的话就不用修改原来的支付方法，只要创建新的支付方式实现类就能轻松实现扩展支付方式，代码入侵小。1、首先先写个接口，限制实现类的方法。4、在原来的代码中使用。
在SpringBoot框架下，接口有几个实现类，在不改变任何源码的情况下，SpringBoot怎么知道给接口注入哪个实现类的依赖呢？
sinian_sinian的博客
09-08 1044
1.使用条件注解（如@ConditionalOnProperty）来根据应用程序的配置动态选择要注入的实现类是一种非常灵活的方法，它允许你根据配置文件中的属性值来决定要使用的实现类。首先，在实现类上使用@Component或@Service等注解进行标记，然后在依赖注入点使用@Qualifier注解来指定要注入的实现类的名称。在这个示例中，MyServiceConsumer通过自动注入MyService来获取实现类，根据配置中的属性值，将注入MyServiceImpl1或MyServiceImpl2。
SpringBoot同一接口多个实现类配置
qq_42026590的博客
11-12 2396
SpringBoot项目中可能出现一个接口有多个实现类的情况，如果不进行配置，注入接口时编译器不知道要注入哪个实现类就会报错，因此需要进行配置。以下进行举例： 接口如下： public interface NoticeService { public String noticeUser(Long id); } 两个实现类如下： @Service public class NoticeServiceImpl1 implements NoticeService { public String.
springboot使用策略模式中一个接口配置多个策略实现类
toString的博客
11-29 1990
最近有一个需求 根据不同的地区的类型 返回不同医保地址 常规做法就是使用if来判断不同的地区类型 然后做对应的医保地址返回，例如: if("类型1".equals("地区类型")){ return 地区类型1的url; }else if("类型2".equals("地区类型")){ return 地区类型2的url; }else if("类型3".equals("地区类型")){ return 地区类型3的url; } ...... ...
springboot中一个service接口多个实现类，如何注入
AntKengElephant的博客
08-23 9506
一般来说我们的service接口都是只有一个实现类而已，但有些时候，确实会有两个实现类的情况，那这个时候我们怎么自动注入这个接口呢？ 1、首先，有一个接口PersonService,然后再写两个实现类PersonServiceImp1、PersonServiceImp2 2、进行测试 如果我们直接注入接口的话，idea就会给我们报错 3、解决办法 其实自动注入时，它首先会先根据class类型来找到相应的实现类，如果这里有两个相同类型的实现类时，那我们可以通过实现类的id来找，比如说PersonS
Springboot 获取接口多个实现类bean 并调用的方式
qq_43180307的博客
01-10 3710
针对以上替代switch-case形式的策略模式会产生很多接口的实现类，注入时需要确定bean的具体类型使用`@Qualifier+@Autowired` 或者 `@Resource (name="beanName")`的方式时均只能获得一个bean 不能满足使用接口去调用的方式；
SpringBoot根据配置注入接口的不同实现类
CodeXu-cyber的博客
06-28 3295
我们在使用springboot进行开发的时候经常用到@Autowired和@Resource进行依赖注入，但是当我们一个接口对应多个不同的实现类的时候如果不进行一下配置项目启动时就会报错，那么怎么根据不同的需求注入不同的类型就是一个值得考虑的问题，虽然@Autowired和@Resource就可以实现，但是我们也可以选择更加灵活的@ConditionalOnProperty注解来实现......
spring bean一个接口有多个实现类该怎么处理
m0_55832328的博客
04-22 249
定义接口 public interface HelloWorldService{ String doSth(); } 实现类 @Slf4j @Service("HelloWorld01Service") public class HelloWorld01ServiceImpl implements HelloWorldService{ @Override public String doSth(){ log.info("hello world 01 service"); return "he
SpringBoot自定义starter实战指南
"本文将深入探讨SpringBoot自定义starter的创建过程，旨在帮助开发者更好地理解和实践这一技术，以便在实际项目中实现个性化需求。" 在SpringBoot框架中，starter是预配置的模块，用于简化应用的初始化和配置。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值