首页 > 其他分享 >如何自定义starter

如何自定义starter

时间:2023-04-28 19:31:29浏览次数:35  
标签:自定义 Spring boot 如何 Boot spring public starter


如何自定义starter_ci

如何自定义starter_自定义_02

背景

使用过Spring Boot的小伙伴都应该知道,一个Spring Boot 项目就是由一个一个 starter 组成的,一个 starter 代表该项目的 Spring Boot 启动依赖,除了官方已有的 starter,我们可以根据自己的需要自定义新的starter。

我们经常会看到或者使用到各种***-starter。比如下面几种:

  1. spring-boot-starter-web:嵌入Tomcat和web开发需要的相关jar包
  2. spring-boot-starter-data-redis:redis数据库支持
  3. mybatis-spring-boot-starter:第三方的mybatis集成的starter
  4. spring-boot -starter-test:用于测试 Spring 引导应用程序
  5. spring-boot-starter-AOP :这个 starter 用于使用 AspectJ 和 Spring AOP 进行面向方面的编程

starter有何用呢?

在我们的日常开发工作中,经常会有一些独立于业务之外的配置模块,我们经常将其放到一个特定的包下,然后如果另一个工程需要复用这块功能的时候,需要将代码硬拷贝到另一个工程,重新集成一遍,麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter,复用的时候只需要将其在pom中引用依赖即可,Spring Boot为我们完成自动装配,简直不要太爽。

比如我们之前做MVC时要引入日志组件,那么需要去找到log4j的版本,然后引入,现在有了Starter之后,直接用这个之后,log4j就自动引入了,也不用关心版本这些问题。

比如我们要在Spring Boot中引入Web MVC的支持时,我们通常会引入这个模块spring-boot-starter-web,而这个模块如果解压包出来会发现里面什么都没有,只定义了一些POM依赖。

Spring Boot starter机制

  Spring Boot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,Spring Boot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰。Spring Boot会自动通过classpath路径下的类发现需要的Bean,并注册进IOC容器。Spring Boot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。所有这些依赖模块都遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循“约定大于配置”的理念。

自定义starter的条件

如果想自定义Starter,首选需要实现自动化配置,而要实现自动化配置需要满足以下两个条件:   

  1. 能够自动配置项目所需要的配置信息,也就是自动加载依赖环境;         
  2. 能够根据项目提供的信息自动生成Bean,并且注册到Bean管理容器中;

自定义starter代码部分

pom.xml依赖

<dependencies>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.0.0.RELEASE</version>
 </dependency>
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <version>2.0.0.RELEASE</version>
    <optional>true</optional>
  </dependency>
</dependencies>

根据需要自定义Starter的实现过程大致如下(以我定义的Starter为例):

如何自定义starter_spring_03

定义XxxProperties类,属性配置类,完成属性配置相关的操作,比如设置属性前缀,用于在application.properties中配置。

TianProperties代码:

import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "spring.tian")
public class TianProperties {
    // 姓名
    private String name;
    // 年龄
    private int age;
    // 性别
    private String sex = "M";

    //get and set
}

创建XxxService类,完成相关的操作逻辑 。

TianService代码:

public class TianService {

    private TianProperties properties;

    public TianService() {
    }

    public TianService(TianProperties userProperties) {
        this.properties = userProperties;
    }
    public void sayHello(){
        System.out.println("hi, 我叫: " + properties.getName() +
        ", 今年" + properties.getAge() + "岁"
         + ", 性别: " + properties.getSex());
    }
}

定义XxxConfigurationProperties类,自动配置类,用于完成Bean创建等工作。

TianServiceAutoConfiguration代码:

@Configuration
@EnableConfigurationProperties(TianProperties.class)
@ConditionalOnClass(TianService.class)
@ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true)
public class TianServiceAutoConfiguration {

    @Autowired
    private TianProperties properties;

    @Bean
    @ConditionalOnMissingBean(TianService.class)
    public TianService tianService() {
        return new TianService(properties);
    }
}

在resources下创建目录META-INF,在 META-INF 目录下创建 spring.factories,在SpringBoot启动时会根据此文件来加载项目的自动化配置类。

spring.factories中配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration

把上面这个starter工程打成jar包

如何自定义starter_spring_04

项目中使用自定义starter

创建一个Spring Boot项目test

如何自定义starter_spring_05

在项目中把自定义starter添加pom依赖

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

TestApplication启动类

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

application.properties中配置

spring.tian.name=tian
spring.tian.age=22
spring.tian.sex=M

写一个TestController.java

RestController
@RequestMapping("/my")
public class TestController {

    @Resource
    private TianService tianService;

    @PostMapping("/starter")
    public Object starter() {
        tianService.sayHello();
        return "ok";
    }
}

jar以来进来后,可以看到

如何自定义starter_自定义_06

多了一个json的文件

如何自定义starter_ci_07

最后启动项目,输入

http://localhost:9091/my/starter

如何自定义starter_自定义_08

后台打印

hi, 我叫: tian, 今年22岁, 性别: M

这就成功的现实了自定义的starter。

总结

  1. Spring Boot在启动时扫描项目所依赖的JAR包,寻找包含spring.factories文件的JAR包,
  2. 然后读取spring.factories文件获取配置的自动配置类AutoConfiguration,
  3. 然后将自动配置类下满足条件(@ConditionalOnXxx)的@Bean放入到Spring容器中(Spring Context)
  4. 这样使用者就可以直接用来注入,因为该类已经在容器中了

 

标签:自定义,Spring,boot,如何,Boot,spring,public,starter
From: https://blog.51cto.com/u_11702014/6235420

相关文章

  • 汇编_如何暂存数据
    由双重循环引发的思考内存中定义了二维字符串数组,使用双重循环完成字符遍历。由于loop指令只认cx寄存器,在循环的过程中为了避免cx值被覆写,需要在内层循环前,将外层循环的cx值暂存起来。使用寄存器完成大小写转换assumecs:codesg,ds:datasgdatasgsegmentdb'ibm......
  • 如何避免跨越红线?——安全管理的重要性
    在现代社会中,安全管理已经成为了一个非常重要的话题。尤其是在一些危险行业中,如建筑、化工等领域,安全管理更是至关重要。然而,很多人并不知道如何有效地避免跨越红线,从而导致了许多不必要的安全事故。因此,如何避免跨越红线成为了每个人都应该关注的问题。首先,要明确什么是“红线”。......
  • Eclipse中如何修改SVN的地址
    Eclipse中如何修改SVN的地址在工作环境调整时,有的时候SVN服务器的地址需要修改,而正在开发中的项目在Eclipse中有些代码没有提交,此时怎么修改SVN的地址呢?以下有一个简单的办法:一、在Eclipse中选择Windows->ShowView->others就会出现如图:选中SVN资源库,会出现如下图所示的画面然后......
  • 小鹅通视频课件课程下载工具,如何在电脑端下载小鹅通频课件PDF,PPT到本地
    一.安装小鹅通下载器1.获取学无止下载器https://www.xuewuzhi.cn/xiaoetech_downloader2.下载安装后,然后点击桌面快捷方式运行即可。注意:杀毒软件可能会阻止外部exe文件运行,并将其当做成病毒,直接添加信任即可,本软件绝对没有木马病毒。二.使用说明1.学无止下载器介绍学无......
  • Spring 实现自定义 bean 的扩展
    Springmvc提供了扩展xml的机制,用来编写自定义的xmlbean,例如dubbo框架,就利用这个机制实现了好多的dubbobean,比如 <dubbo:application>、<dubbo:registry> 等等,只要安装这个标准的扩展方式实现配置即可。扩展自定义bean的意义何在假设我们要使用一个开源框架或者一套......
  • 你一直在用的 Spring Boot Starters 究竟是怎么回事
    SpringBoot对比SpringMVC最大的优点就是使用简单,约定大于配置。不会像之前用SpringMVC的时候,时不时被xml配置文件搞的晕头转向,冷不防还因为xml配置上的一点疏忽,导致整个项目莫名其妙的不可用,顿感生活无所依恋,简称生无可恋。这要归功于组成了SpringBoot的各种各样的......
  • Vue项目如何配置、切换主题颜色(mixin + scss方式,简单高效)
    Action一.首先,引入scss依赖(node-sass,sass-loader)npminstallnode-sasssass-loader--save-dev1二.项目样式文件目录介绍1.此处我将项目中的公共样式文件放到了src/style目录下,其中index.scss是以供全局使用的一些基本样式,在main.js文件中引入即可全局使用(图2)。_theme.scs......
  • c++中如何强制访问类的保护(protected)/私有(private)性质的成员函数和成员变量
    在使用第三方代码库时,有时候需要访问某个类的函数或者变量,但该对象是保护或者私有的,导致无法正常访问。其实,通过一个简单的友元friend类或函数,可以轻松突破编译器的限制。下面是代码实例。假设第三方库有person类,定义如下。classPerson{private:intage=18;}那么如果强......
  • 如何更改 git 仓库的远端地址
    首先使用gitremote-v来查看当前仓库关联的远端地址 然后使用gitremoteset-urlorigin<git>,来更新本地仓库关联的远端代码 ......
  • vue3自定义指令实现el-select下拉加载更多
    1.新建js文件exportdefault(app)=>{app.directive('loadmore',{beforeMount(el,binding){constelement=el.querySelector('.t-select__dropdown');element.addEventListener('scroll',()=>{co......