自定义Spring Starter

简单介绍

Spring Starter 自定义思路本质上是把实现功能实例对象变成Spring Bean,放到Spring IoC容器。里面所谓的约定大于配置,是指我这个Bean的实现依赖于配置,如果用户没有配置这个,则使用默认的配置。 非官方 starter 命名应遵循 {name}-spring-boot-starter 的格式。

手写一个没有配置项的Starter

这里写一个数据库事物为例

第一步: 引入maven依赖。把starter解析逻辑放置进去

xml 复制代码
	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <scope>provided</scope>
        </dependency>

第二步: 编写核心功能Java对象,这里只管逻辑实现,不考虑和Spring IoC无关

java 复制代码
@Slf4j
public class DefaultYnTransactionManager implements YnTransactionManager {

    @Setter
    private DataSourceTransactionManager transactionManager;

    public final static DefaultYnTransactionManager build(org.springframework.jdbc.datasource.DataSourceTransactionManager manager) {
        DefaultYnTransactionManager obj = new DefaultYnTransactionManager();
        obj.setTransactionManager(manager);
        return obj;
    }

    @Override
    public <T> T execute(Supplier<T> supplier) {
        T result = null;
        TransactionStatus transaction = null;
        try {
            transaction = transactionManager.getTransaction(new DefaultTransactionDefinition());
            result = supplier.get();
            transactionManager.commit(transaction);
        } catch (BusinessException e) {
            log.warn("DefaultYnTransactionManager[]execute BusinessException fail",e);
            transactionManager.rollback(transaction);
        } catch (Throwable e) {
            log.error("DefaultYnTransactionManager[]execute Throwable fail",e);
            transactionManager.rollback(transaction);
        }
        return result;
    }

    @Override
    public void submit(Function0 function0) {
        TransactionStatus transaction = null;
        try {
            transaction = transactionManager.getTransaction(new DefaultTransactionDefinition());
            function0.exec();
            transactionManager.commit(transaction);
        } catch (BusinessException e) {
            log.warn("DefaultYnTransactionManager[]execute BusinessException fail",e);
            transactionManager.rollback(transaction);
        } catch (Throwable e) {
            log.error("DefaultYnTransactionManager[]execute Throwable fail",e);
            transactionManager.rollback(transaction);
        }
    }
}

第三步: 自动配置,生成SpringBean 注入到IoC中

  1. 自动配置类
java 复制代码
@Configuration
@ConditionalOnMissingBean(value = YnTransactionManager.class)
public class YnTransactionManagerAutoConfiguration {

    @Bean
    @ConditionalOnBean(value = org.springframework.jdbc.datasource.DataSourceTransactionManager.class)
    public YnTransactionManager ynTransactionManager(org.springframework.jdbc.datasource.DataSourceTransactionManager
                                                                 transactionManager) {
        return DefaultYnTransactionManager.build(transactionManager);
    }
}
  • @Configuration 声明这个类配置类
  • @Bean 在方法上声明一个bean
  • @ConditionalOnXX 系列,只有当条件满足时候才会生成bean
  1. 在resource/META-INF/spring.factoris添加,Spring 可以解析这个配置
properties 复制代码
org.springframework.boot.autoconfigure.EnableAutoConfiguration =\
 com.xxx.yn.framework.core.transaction.YnTransactionManagerAutoConfiguration,\
  1. ok,后面就可以映入依赖去使用了

有配置项

这里已自定义线程池为例

  • 第一步: 引入Maven依赖,同上

第二步: 编写核心功能Java对象,这里只管逻辑实现,不考虑是否注入到springIOC中。但是这里要考虑用户可以自定的配置

java 复制代码
@Data
@ConfigurationProperties(prefix = "yn.thread")
public class ThreadPoolProperties {

    /**
     * 核心线程数量
     */
    private Integer corePoolSize = 2 * Runtime.getRuntime().availableProcessors();
    /**
     * 最大线程数量
     */
    private Integer maxPoolSize = 3 * Runtime.getRuntime().availableProcessors();
    /**
     * 线程保持时间,一般是任务的执行时间 加点buffer,单位秒
     */
    private Long keepAliveTimeForSeconds = 10L;

}

第三步: 自动配置,生成SpringBean

  1. 配置类
java 复制代码
@Configuration
@EnableConfigurationProperties({ThreadPoolProperties.class})
public class ThreadPoolAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean({ThreadPoolExecutor.class})
    public ThreadPoolExecutor threadPoolExecutor(ThreadPoolProperties properties) {
        ThreadPoolExecutor threadPoolExecutor
                = new ThreadPoolExecutor(properties.getCorePoolSize(),
                properties.getMaxPoolSize(),
                properties.getKeepAliveTimeForSeconds(),
                TimeUnit.SECONDS,
                new LinkedBlockingQueue<>()
                );
        threadPoolExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        return threadPoolExecutor;
    }
}
  • @EnableConfigurationProperties 启动属性配置类也变成一个bean注入到IoC中,在不同的starter中可以同时使用,不会冲突

2.在resource/META-INF/spring.factoris添加

properties 复制代码
org.springframework.boot.autoconfigure.EnableAutoConfiguration =\
 com.gitub.yn.framework.core.thread.ThreadPoolAutoConfiguration,\
  1. 引入java包就可以生效了
相关推荐
lb291713 分钟前
关于golang热加载安装,实时响应
开发语言·后端·golang·热加载
羊小猪~~44 分钟前
数据库学习笔记(十五)--变量与定义条件与处理程序
数据库·人工智能·笔记·后端·sql·学习·mysql
墨家巨子@俏如来1 小时前
一.干货干货!!!SpringAI入门到实战-小试牛刀
后端·springai·ai人工智能
ahhhhaaaa-1 小时前
【AI图像生成网站&Golang】部署图像生成服务(阿里云ACK+GPU实例)
开发语言·数据仓库·人工智能·后端·阿里云·golang
jdyzzy1 小时前
从0到1做一个“任务管理系统”:Spring Boot + Vue 实战教程(含源码)
vue.js·spring boot·后端
愚农搬码2 小时前
LangChain 调用不同类型的多MCP服务
人工智能·后端
我会冲击波2 小时前
推荐一款让代码命名变得轻松高效的idea插件
后端
楽码2 小时前
安装和编写grpc协议文件
服务器·后端·grpc
码农之王2 小时前
(二)TypeScript前置编译配置
前端·后端·typescript
一眼万年042 小时前
Kafka LogManager 深度解析
后端·kafka