SpringBoot中的自定义starter详解

 更新时间:2024年01月27日 10:54:11   作者:魅Lemon  
这篇文章主要介绍了SpringBoot中的自定义starter详解,SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,需要的朋友可以参考下

一、starter简介

1、SpringBoot starter机制

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

2、为什么要自定义starter

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

3、自定义starter命名规范

官方命名:

  • 前缀:spring-boot-starter-xxx
  • 比如:spring-boot-starter-web…

自定义命名:

  • xxx-spring-boot-starter
  • 比如:mybatis-spring-boot-starter

二、starter实现

1、新建工程

这里我命名为shawn-spring-boot-starter

在这里插入图片描述

2、添加pom.xml依赖

这里需要注意spring版本,太高可能会导致install失败

<?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.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.shawn</groupId>
    <artifactId>shawn-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>shawn-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <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>

3、定义一个实体类映射配置信息

@ConfigurationProperties(prefix = "shawn.hello")它可以把相同前缀的配置信息通过配置项名称映射成实体类,可以直接在yml文件进行配置

// 前缀 shawn.hello
@ConfigurationProperties(prefix = "shawn.hello")
public class ShawnProperties {
    /**
     * 前缀
     */
    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;
    }
}

4、编写自己的服务

public class ShawnService {
    ShawnProperties ShawnProperties;
    public ShawnProperties getShawnProperties() {
        return ShawnProperties;
    }
    public void setShawnProperties(ShawnProperties ShawnProperties) {
        this.ShawnProperties = ShawnProperties;
    }
    public String sayHello(String name){
        return ShawnProperties.getPrefix() + name + ShawnProperties.getSuffix();
    }
}

5、定义配置类

这里,我们将ShawnService类定义为一个Bean,交给Ioc容器。 @Configuration 配置注解 @EnableConfigurationProperties。该注解是用来开启对@ConfigurationProperties 注解配置Bean的支持。当然了,也可以在 @ConfigurationProperties 注解的类上添加 @Configuration 或者 @Component注解

@Configuration
@ConditionalOnWebApplication //web应用生效
@EnableConfigurationProperties(ShawnProperties.class)
public class ShawnServiceAutoConfiguration {
    @Autowired
    ShawnProperties shawnProperties;
    @Bean
    public ShawnService shawnService(){
        ShawnService service = new ShawnService();
        service.setShawnProperties(shawnProperties);
        return service;
    }
}

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

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.shawn.ShawnServiceAutoConfiguration

7、打包到Maven仓库

在这里插入图片描述

三、测试starter

1、新建项目,引入依赖

<dependency>
     <groupId>com.shawn</groupId>
     <artifactId>shawn-spring-boot-starter</artifactId>
     <version>0.0.1-SNAPSHOT</version>
</dependency>

2、编写测试类

@RestController
public class ShawnCOntroller {
    @Autowired
    ShawnService shawnService;
    @GetMapping("/hello")
    public String hello(){
        return shawnService.sayHello("shawn");
    } 
}

3、配置

在application.yml中进行配置

shawn:
  hello:
    prefix: prefix
    suffix: suffix

4、测试

成功打印

在这里插入图片描述

到此这篇关于SpringBoot中的自定义starter详解的文章就介绍到这了,更多相关自定义starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Cloud OpenFeign实例介绍使用方法

    Spring Cloud OpenFeign实例介绍使用方法

    Spring Cloud OpenFeign 对 Feign 进行了二次封装,使得在 Spring Cloud 中使用 Feign 的时候,可以做到使用 HTTP 请求访问远程服务,就像调用本地方法一样的,开发者完全感知不到这是在调用远程访问,更感知不到在访问 HTTP 请求
    2022-09-09
  • Java花式解决'分割回文串 ii'问题详解

    Java花式解决'分割回文串 ii'问题详解

    最学习动态规划思想的路上,遇见了‘分割回文串问题’,如临大敌啊,题目听起来蛮简单,思考起来却也没那么容易,本文将为大家详细介绍几种解决分割回文串 ii问题的办法,需要的可以参考一下
    2021-12-12
  • MyBatis Dynamic SQL 入门指南

    MyBatis Dynamic SQL 入门指南

    本文主要介绍了MyBatis Dynamic SQL 入门指南,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2026-02-02
  • Mybatis-Plus的多数据源你了解吗

    Mybatis-Plus的多数据源你了解吗

    这篇文章主要为大家详细介绍了Mybatis-Plus的多数据源,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java生成的随机数靠谱吗?多少次会重复?

    Java生成的随机数靠谱吗?多少次会重复?

    今天给大家带来的是关于Java的相关知识,文章围绕着Java生成的随机数靠不靠谱展开,文中有非常详细的介绍,需要的朋友可以参考下
    2021-06-06
  • Monaco Editor实现sql和java代码提示实现示例

    Monaco Editor实现sql和java代码提示实现示例

    这篇文章主要为大家介绍了Monaco Editor代码提示sql和java实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • springboot项目中常用的工具类和api详解

    springboot项目中常用的工具类和api详解

    在Spring Boot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖 Spring 原生工具、第三方库(如Hutool、Guava) 和 Java 自带工具,本文给大家介绍springboot项目中常用的工具类和api,感兴趣的朋友一起看看吧
    2025-04-04
  • Java事务@Transactional 、@GlobalTransactional使用步骤

    Java事务@Transactional 、@GlobalTransactional使用步骤

    这篇文章主要介绍了使用@Transactional和@GlobalTransactional注解进行事务管理的区别和应用场景,@Transactional用于单个服务内的本地事务管理,而@GlobalTransactional用于跨服务的分布式事务管理,文中给出了详细的代码示例,需要的朋友可以参考下
    2025-05-05
  • SpringBoot @ComponentScan扫描的局限性方式

    SpringBoot @ComponentScan扫描的局限性方式

    文章总结:SpringBoot的@ComponentScan注解在扫描组件时存在局限性,只能扫描指定的包及其子包,无法扫描@SpringBootApplication注解自动配置的组件,使用@SpringBootApplication注解可以解决这一问题,它集成了@Configuration、@EnableAutoConfiguration
    2025-01-01
  • Maven项目如何在pom文件中引入lib下的第三方jar包并打包进去

    Maven项目如何在pom文件中引入lib下的第三方jar包并打包进去

    在使用Maven进行项目开发时,引入第三方私有的Jar包可能会遇到问题,一种常见的解决方案是将Jar包添加到项目的lib目录,并通过IDE进行配置,但这需要每个开发者单独操作,效率低下,更好的方法是通过Maven的pom.xml文件管理这些Jar包
    2024-09-09

最新评论