Java：自定义实现SpringBoot Starter

目录

    • 1、自定义Starter
      • 1.1、项目结构
      • 1.2、代码实现
      • 1.3、测试
      • 1.4、打包
    • 2、引用Starter
      • 2.1、项目结构
      • 2.2、引入starter
    • 3、重写默认配置
    • 4、重写默认实现
    • 5、实现`@Enable`注解
      • 5.1、starter项目创建注解
      • 5.2、业务工程使用注解
    • 6、元数据
    • 7、参考文章

1、自定义Starter

1.1、项目结构

$ tree
.
├── pom.xml
└── src├── main│   ├── java│   │   └── com│   │       └── example│   │           └── demo│   │               ├── ReadingConfiguration.java│   │               ├── config│   │               │   └── ReadingConfig.java│   │               └── service│   │                   ├── ReadingService.java│   │                   └── impl│   │                       └── ReadingServiceImpl.java│   └── resources│       ├── META-INF│       │   └── spring.factories│       └── application.properties└── test├── java│   └── com│       └── example│           └── demo│               └── ReadingServiceTests.java└── resources└── application.yml

1.2、代码实现

pom.xml maven依赖

<?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.7.7</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>thinking-starter</artifactId><version>0.0.1-SNAPSHOT</version><name>demo</name><description>Demo project for Spring Boot</description><packaging>jar</packaging><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><!-- lombok依赖 --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId></dependency><!-- 自动配置 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>2.22.2</version><configuration><!-- 不会编译测试 --><skipTests>true</skipTests></configuration></plugin><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><skip>true</skip><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build>
</project>

application.properties 默认值

# 注意：该文件名只能是application.properties
# 实践发现：该文件不能出现，否则业务工程的application.yml文件无法覆盖默认值
# 设置默认的值
reading.type=txt

ReadingConfig.java 配置映射

package com.example.demo.config;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;/*** 读取application.properties中reading相关的配置*/
@Data
@ConfigurationProperties(prefix = "reading")
public class ReadingConfig {// 类型private String type;
}

ReadingService.java 接口

package com.example.demo.service;public interface ReadingService {void reading();
}

ReadingServiceImpl.java 接口实现类

package com.example.demo.service.impl;import com.example.demo.config.ReadingConfig;
import com.example.demo.service.ReadingService;
import lombok.extern.slf4j.Slf4j;@Slf4j
public class ReadingServiceImpl implements ReadingService {/*** reading相关配置类*/private ReadingConfig readingConfig;public ReadingServiceImpl(ReadingConfig readingConfig) {this.readingConfig = readingConfig;}@Overridepublic void reading() {log.info("reading type: {}", this.readingConfig.getType());}
}

ReadingConfiguration.java 自动装配的核心

package com.example.demo;import com.example.demo.config.ReadingConfig;
import com.example.demo.service.ReadingService;
import com.example.demo.service.impl.ReadingServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
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(ReadingConfig.class)
// 当存在reading.enable属性，且其值为true时，才初始化该Bean
@ConditionalOnProperty(name = "reading.enable", havingValue = "true")
public class ReadingConfiguration {@Autowiredprivate ReadingConfig readingConfig;// 若当前IOC容器中没有Reading接口实现时，提供一个默认的Reading实现@Bean@ConditionalOnMissingBean(ReadingService.class)public ReadingService readingService() {return new ReadingServiceImpl(this.readingConfig);}
}

spring.factories 自动装配注册

# 提醒SpringBoot在启动时，自动装配ReadingConfiguration
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.demo.ReadingConfiguration

1.3、测试

ReadingServiceTests.java

package com.example.demo;import com.example.demo.service.ReadingService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;@SpringBootTest(classes = ReadingConfiguration.class)
class ReadingServiceTests {@Autowiredprivate ReadingService readingService;@Testvoid testReadingService() {readingService.reading();}
}

application.yml

reading:enable: true

1.4、打包

将项目安装到本地maven仓库

mvn install

2、引用Starter

新建一个业务工程

2.1、项目结构

$ tree
.
├── pom.xml
└── src└── main├── java│   └── com│       └── example│           └── demo│               ├── Application.java│               └── controller│                   └── IndexController.java└── resources└── application.yml

2.2、引入starter

<!-- 引入自定义starter -->
<dependency><groupId>com.example</groupId><artifactId>thinking-starter</artifactId><version>0.0.1-SNAPSHOT</version>
</dependency>

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 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.7.7</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>demo</artifactId><version>0.0.1-SNAPSHOT</version><name>demo</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-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><!-- 引入自定义starter --><dependency><groupId>com.example</groupId><artifactId>thinking-starter</artifactId><version>0.0.1-SNAPSHOT</version></dependency><!-- test --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build></project>

application.yml

reading:type: jsonenable: true

IndexController.java

package com.example.demo.controller;import com.example.demo.service.ReadingService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class IndexController {@Autowired(required = false)private ReadingService readingService;@GetMapping("/")public String index(){if(this.readingService != null){this.readingService.reading();}return "Hello";}
}

Application.java

package com.example.demo;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}}

3、重写默认配置

修改项目配置文件application.yml

reading:  enable: true  type: json # 重写starter默认配置

4、重写默认实现

默认提供的实现

public class ReadingConfiguration {@Bean@ConditionalOnMissingBean(ReadingService.class)public ReadingService readingService() {return new ReadingServiceImpl(this.readingConfig);}
}

若当前IOC容器中没有Reading接口实现时，提供一个默认的Reading实现

@ConditionalOnMissingBean(ReadingService.class)

可以自行实现ReadingService

package com.example.web.service;import com.example.demo.config.ReadingConfig;
import com.example.demo.service.ReadingService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Slf4j
@Service
public class MyReadingService implements ReadingService {@Autowiredprivate ReadingConfig readingConfig;@Overridepublic void reading() {log.info("my reading service start reading... type is {}", this.readingConfig.getType());}}

5、实现@Enable注解

类似的注解

@EnableScheduling
@EnableAsync
@EnableCaching

5.1、starter项目创建注解

创建注解

package com.example.demo.annotation;import com.example.demo.ReadingSelector;
import org.springframework.context.annotation.Import;import java.lang.annotation.*;@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
// @Import作用是往SpringIOC中导入一个类，这里即导入ReadingSelector
@Import(ReadingSelector.class)
public @interface EnableReading {}

创建 ReadingSelector类取代 ReadingConfiguration

package com.example.demo;
import com.example.demo.config.ReadingConfig;
import com.example.demo.service.ReadingService;
import com.example.demo.service.impl.ReadingServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@EnableConfigurationProperties(ReadingConfig.class)
public class ReadingSelector {@Autowiredprivate ReadingConfig readingConfig;// 当SpringIOC容器中不存在Reading实现时，才往Spring中初始化ReadingService作为Reading接口的实现@Bean@ConditionalOnMissingBean(ReadingService.class)public ReadingService readingService() {return new ReadingServiceImpl(this.readingConfig);}}

5.2、业务工程使用注解

修改配置文件 application.yml

reading:# enable: truetype: json

启动类增加注解@EnableReading

package com.example.web;import com.example.demo.annotation.EnableReading;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@EnableReading
@SpringBootApplication
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}}

6、元数据

元数据描述后,开发者便能通过IDE提示看到此配置属性的默认值/值类型等信息

引入依赖

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

重新打包，会自动生成spring-configuration-metadata.json

7、参考文章

  1. 分分钟！手写一个自己的springboot starter
  2. 好好地说一次,自定义springboot-starter开发(从配置到单元测试)

项目代码：https://github.com/mouday/spring-boot-demo

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/109714.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

三维地图开发三维地图服务器

三维地图开发三维地图服务器

三维地图开发三维地图服务器 发布时间&#xff1a;2020-03-03 版权&#xff1a; 搭建离线地图服务主要是两个步骤&#xff1a;一是&#xff1a;下载离线地图服务需要的地图数据&#xff1b;二是&#xff1a;将下载的离线地图数据发布成地图服务&#xff1b;只有做好这两步&…
阅读更多...
ChatGPT-GPT4：将AI技术融入科研、绘图与论文写作的实践

ChatGPT-GPT4：将AI技术融入科研、绘图与论文写作的实践

2023年我们进入了AI2.0时代。微软创始人比尔盖茨称ChatGPT的出现有着重大历史意义&#xff0c;不亚于互联网和个人电脑的问世。360创始人周鸿祎认为未来各行各业如果不能搭上这班车&#xff0c;就有可能被淘汰在这个数字化时代&#xff0c;如何能高效地处理文本、文献查阅、PPT…
阅读更多...
出差学小白知识No5：ubuntu连接开发板|上传源码包|板端运行的环境部署

出差学小白知识No5：ubuntu连接开发板|上传源码包|板端运行的环境部署

1、ubuntu连接开发板&#xff1a; 在ubuntu终端通过ssh协议来连接开发板&#xff0c;例如&#xff1a; ssh root<IP_address> 即可 这篇文章中也有关于如何连接开发板的介绍&#xff0c;可以参考SOC侧跨域实现DDS通信总结 2、源码包上传 通过scp指令&#xff0c;在ub…
阅读更多...
python使用dataset快速使用SQLite

python使用dataset快速使用SQLite

目录 一、官网地址 二、安装 三、 快速使用 一、官网地址 GitHub - pudo/dataset: Easy-to-use data handling for SQL data stores with support for implicit table creation, bulk loading, and transactions. 二、安装 pip install dataset 如果是mysql&#xff0c;则…
阅读更多...
R语言有关模型方面的函数（model.）介绍-model.matrix

R语言有关模型方面的函数（model.）介绍-model.matrix

R语言有关模型方面的函数（model.）介绍-model.matrix 引言model.matrix简单作用提取设计矩阵对有序因子与无序因子的处理（模型相关）手动编写contr.系列的函数写在最后引言 最近闲暇时间大量阅读了一些机器学习方面的R包源码，在此对阅读过程中的一些实用但是不常见的函数进行…
阅读更多...
堆/二叉堆详解[C/C++]

堆/二叉堆详解[C/C++]

前言 堆是计算机科学中-类特殊的数据结构的统称。实现有很多,例如:大顶堆,小顶堆&#xff0c;斐波那契堆&#xff0c;左偏堆&#xff0c;斜堆等等。从子结点个数上可以分为二汊堆&#xff0c;N叉堆等等。本文将介绍的是二叉堆。 二叉堆的概念 1、引例 我们小时候&#xff0c;基…
阅读更多...
left join时筛选条件对查询结果的

left join时筛选条件对查询结果的

-- 创建表 CREATE TABLE table1 (id int(11) NOT NULL AUTO_INCREMENT,card_num varchar(60) DEFAULT NULL,customer_id varchar(60) DEFAULT NULL,PRIMARY KEY (id) ) ENGINE InnoDBAUTO_INCREMENT 12DEFAULT CHARSET utf8mb4 COMMENT 测试表1;-- 创建表 CREAT…
阅读更多...
[OpenCV-dlib]人脸识别功能拓展-通过随机要求头部动作实现活体检测

[OpenCV-dlib]人脸识别功能拓展-通过随机要求头部动作实现活体检测

引言 在现代计算机视觉中&#xff0c;面部检测和姿势识别是一个重要的领域&#xff0c;它在各种应用中发挥着关键作用&#xff0c;包括人脸解锁、表情识别、虚拟现实等。本文将深入探讨一个使用Python编写的应用程序&#xff0c;该应用程序结合了多个库和技术&#xff0c;用于…
阅读更多...
44springboot摄影跟拍预定管理系统

44springboot摄影跟拍预定管理系统

大家好✌&#xff01;我是CZ淡陌。一名专注以理论为基础实战为主的技术博主&#xff0c;将再这里为大家分享优质的实战项目&#xff0c;本人在Java毕业设计领域有多年的经验&#xff0c;陆续会更新更多优质的Java实战项目&#xff0c;希望你能有所收获&#xff0c;少走一些弯路…
阅读更多...
basic_sr介绍

basic_sr介绍

文章目录 pytorch基础知识和basicSR中用到的语法1.Sampler类与4种采样方式2.python dict的get方法使用3.prefetch_dataloader.py4. pytorch 并行和分布式训练4.1 选择要使用的cuda4.2 DataParallel使用方法常规使用方法保存和载入 4.3 DistributedDataParallel 5.wangdb 入门5.…
阅读更多...
详解js数组操作——filter()方法

详解js数组操作——filter()方法

引言 在JavaScript中&#xff0c;我们经常需要对数组进行筛选&#xff0c;以便根据特定的条件获取所需的元素。而JavaScript的filter()方法就是一个非常有用的工具&#xff0c;它可以帮助我们轻松地筛选数组中的元素。本文将介绍如何使用filter()方法&#xff0c;以及一些实用…
阅读更多...
react+antd+Table实现表格初始化勾选某条数据，分页切换保留上一页勾选的数据

react+antd+Table实现表格初始化勾选某条数据，分页切换保留上一页勾选的数据

加上rowKey这个属性 <Table rowKey{record > record.id} // 加上rowKey这个属性rowSelection{rowSelection}columns{columns}dataSource{tableList}pagination{paginationProps} />
阅读更多...
众佰诚：抖音小店的体验分什么时候更新

众佰诚：抖音小店的体验分什么时候更新

随着移动互联网的发展&#xff0c;越来越多的电商平台开始涌现&#xff0c;其中抖音小店作为一种新型的电商模式&#xff0c;受到了许多用户的欢迎。然而&#xff0c;对于抖音小店的体验分更新时间&#xff0c;很多用户并不是很清楚。本文将对此进行详细的解答。 首先&#xff…
阅读更多...
SimpleCG图像操作基础

SimpleCG图像操作基础

上一篇我们介绍了程序的交互功能&#xff0c;就可以编写一些简单的游戏了&#xff0c;例如贪吃蛇、扫雷、俄罗斯方块、五子棋等&#xff0c;都可以使用图形函数直接绘制&#xff0c;在后续文章中将逐一展示。不过编写画面丰富游戏离不开图像&#xff0c;所以本篇我们介绍一下基…
阅读更多...
智能合同和TikTok：揭示加密技术的前景

智能合同和TikTok：揭示加密技术的前景

在当今数字化时代&#xff0c;智能合同和加密技术都成为了技术和商业世界中的热门话题。它们代表了一个崭新的未来&#xff0c;有着潜在的巨大影响。 然而&#xff0c;你或许从未想过将这两者联系在一起&#xff0c;直到今天。本文将探讨智能合同和TikTok之间的联系&#xff0…
阅读更多...
代码随想录算法训练营Day56|动态规划14

代码随想录算法训练营Day56|动态规划14

代码随想录算法训练营Day56|动态规划14 文章目录 代码随想录算法训练营Day56|动态规划14一、1143.最长公共子序列二、 1035.不相交的线三、53. 最大子序和 动态规划 一、1143.最长公共子序列 class Solution {public int longestCommonSubsequence(String text1, String text2…
阅读更多...
sql聚合函数嵌套问题 aggregate function cannot contain aggregate parameters

sql聚合函数嵌套问题 aggregate function cannot contain aggregate parameters

在需求的应用场景&#xff0c;需要对create_time字段求最小值并求和&#xff0c;刚开始理所当然写成像下面这样&#xff1a; SUM(COALESCE (CASE WHEN MIN(crl.create_time) BETWEEN date_add(date_sub(current_date(), 1), -1 * (open_case_day_num % 6)) AND current_date()…
阅读更多...
辉视IP对讲与SIP视频对讲：革新的通信技术与应用领域的开启

辉视IP对讲与SIP视频对讲：革新的通信技术与应用领域的开启

辉视IP对讲与辉视SIP视频对讲系统&#xff0c;不仅在技术上实现了一次革新&#xff0c;更在应用领域上开启了新的篇章。它们不仅仅是一种通信工具&#xff0c;更是一种集成了先进技术和多种功能的高效解决方案&#xff0c;为各领域提供了一种安全、便捷、高效的通信体验。 辉视…
阅读更多...
5. 函数式接口

5. 函数式接口

5.1 概述 只有一个抽象方法的接口我们称之为函数接口。 JDK的函数式接口都加上了 FunctionalInterface 注解进行标识。但是无论是否加上该注解只要接口中只有一个抽象方法&#xff0c;都是函数式接口。 在Java中&#xff0c;抽象方法是一种没有方法体&#xff08;实现代码&a…
阅读更多...
【AOP系列】6.缓存处理

【AOP系列】6.缓存处理

在Java中&#xff0c;我们可以使用Spring AOP&#xff08;面向切面编程&#xff09;和自定义注解来做缓存处理。以下是一个简单的示例&#xff1a; 首先&#xff0c;我们创建一个自定义注解&#xff0c;用于标记需要进行缓存处理的方法&#xff1a; import java.lang.annotat…
阅读更多...
最新文章

Copyright @ 2022~2023