SpringBoot自定义starter方式

 更新时间:2025年02月18日 11:00:26   作者:Exill  
本文介绍了如何创建一个自定义的Spring Boot Starter,以实现日志功能,通过使用SPI机制,可以在不修改启动类的情况下,实现自动配置和功能导入,同时,还讨论了如何在自定义Starter中编写必要的配置文件和注解,以确保功能的正确实现和配置的智能提示

命名

推荐以xxx-spring-boot-starter命名

原理

引入spring-boot-starter-jdbc后可直接使用DataSource

1.加载自动配置类

通过SPI(Service Provider Interface,Java提供的服务发现机制,用于框架拓展和组件替换)原理

(1)@SpringBootApplication->@EnableAutoConfiguration->@Import

(2)@Import通过AutoConfigurationImportSelector::selectImports方法导入自动配置类

(3)在AutoConfigurationImportSelector::getCandidateConfigurations方法中得知导入的自动配置类在从META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件读取

(4)其中包含DataSourceAutoConfiguration类

2.通过xxxAutoConfiguration再导入功能所需的bean

(1)

DataSourceAutoConfiguration->@EnableConfigurationProperties(DataSourceProperties.class)

将Properties类生效,读取application.yml中数据(url、username、password...)

(2)

@Import({ DataSourceConfiguration.Hikari.class... }) 

导入各种连接池,根据条件注解生效不同连接池

自定义starter

示例:@Log的添加日志功能封装成starter

1.创建标准SpringBoot项目引入所需依赖

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

2.编写Properties类

@Data
@Component
@ConfigurationProperties("log")
public class LogProperties{
    private Boolean classFullName= true; //日志展示全类名
    private Boolean showUseTime= true; //日志展示方法执行时间
}

3.编写application.yml配置文件

log:
    class-full-name: true #展示全类名
    show-use-time: true #展示方法执行时间

4.编写@Log注解

@Target(METHOD) //该注解只能用于方法上
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Log{}

5.编写AOP实现具体功能

@Slf4j
@Aspect
@Component
public class LogAop {
    @Resource
    private LogProperties logProperties;

    @Around("@annotation(com.gok.log.annotation.Log)")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        long beginTime = System.currentTimeMillis();
        Class targetClass = joinPoint.getSignature().getDeclaringType();
        String functionName = joinPoint.getSignature().getName();
        String name = (logProperties.getClassFullName() ? targetClass.getName() : targetClass.getSimpleName()) + "#" + functionName;
        try {
            log.info("{}开始", name);
            Object res = joinPoint.proceed(joinPoint.getArgs());
            log.info("{}结束", name);
            return res;
        } catch (Throwable t) {
            log.info("{}异常," + t.getMessage(), name);
            throw t;
        } finally {
            if (logProperties.getShowUseTime()) {
                log.info("{}执行时间:{}ms", name, System.currentTimeMillis() - beginTime);
            }
        }
    }
}

SpringBoot默认只扫描启动类所在目录,而Log实现所在的包不会扫描,有@Component也无效

所以通过原理中的SPI机制导入

6.删除LogProperties类和LogAop类的@Component注解

统一在LogAutoConfiguration导入

@Configuration
//引入Properties类
@EnableConfigurationProperties(LogProperties.class)
//引入Aop
@Import(LogAop.class)
public class LogAutoConfiguration  {
}

7.编写文件

编写META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件

引入自动配置类com.gok.logstarter.config.LogAutoConfiguration

8.删除SpringBoot启动类(main方法所在类)、删除pom.xml<build>标签

原因:作为starter不需要启动类

9.补充

(1)自定义starter的application.yml可以删除,最终生效的是引入starter项目中application.yml

(2)如果希望实现编写application.yml文件智能提示,需要在自定义starter的pom.xml添加如下依赖

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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • JAVA判断空值方法原理解析

    JAVA判断空值方法原理解析

    这篇文章主要介绍了JAVA判断空值方法原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05
  • sonar-scanner连接sonarquebe7的sonar.java.binaries问题的解决方案

    sonar-scanner连接sonarquebe7的sonar.java.binaries问题的解决方案

    今天小编就为大家分享一篇关于sonar-scanner连接sonarquebe7的sonar.java.binaries问题的解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • idea中Stash与Unstash的使用及说明

    idea中Stash与Unstash的使用及说明

    这篇文章主要介绍了idea中Stash与Unstash的使用及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • SpringBoot集成使用Redis及搭建过程

    SpringBoot集成使用Redis及搭建过程

    jackson-json 工具提供了 javabean 与 json 之 间的转换能力,可以将 pojo 实例序列化成 json 格式存储在 redis 中,也可以将 json 格式的数据转换成 pojo 实例,本文给大家介绍SpringBoot集成使用Redis及搭建过程,感兴趣的朋友一起看看吧
    2022-01-01
  • 一文带你了解Java8 Stream流处理中的收集器技巧

    一文带你了解Java8 Stream流处理中的收集器技巧

    Java 8 引入的 Stream 极大地简化了集合数据的处理,提供了一种现代、函数式的方式来处理数据,本文将深入探讨 Java 8 Stream 中的收集器,希望对大家有所帮助
    2023-08-08
  • SpringBoot优化接口响应时间的九个技巧

    SpringBoot优化接口响应时间的九个技巧

    在实际开发中,提升接口响应速度是一件挺重要的事,特别是在面临大量用户请求的时候,本文为大家整理了9个SpringBoot优化接口响应时间的技巧,希望对大家有所帮助
    2024-01-01
  • Java中的关键字volatile详解

    Java中的关键字volatile详解

    这篇文章主要介绍了Java中的关键字volatile,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Spring切面优先级与基于xml的AOP实现方法详解

    Spring切面优先级与基于xml的AOP实现方法详解

    这篇文章主要介绍了Spring切面的优先级与基于xml的AOP的详细步骤,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-11-11
  • Java设计模式中的适配器模式

    Java设计模式中的适配器模式

    这篇文章主要介绍了Java设计模式中的适配器模式,适配器模式(Adapter Pattern)将某个类的接口转换成客户端期望的另一个接口表示,主的目的是兼容性,让原本因接口不匹配不能一起工作的两个类可以协同工作。其别名为包装器
    2022-07-07
  • springboot~ObjectMapper~dto到entity的自动赋值

    springboot~ObjectMapper~dto到entity的自动赋值

    这篇文章主要介绍了springboot~ObjectMapper~dto到entity的自动赋值,本文分三种情况给大家介绍,需要的朋友可以参考下
    2018-08-08

最新评论