技术标签: spring boot java Spring
SpringBoot Starter
简介SpringBoot Starter
SpringBoot 的出现让我们能够抛弃以前复杂繁杂的配置,转而将组件各种配置统一集成进 starter
中,在使用的使用只需要在 maven 中引入 starter 依赖,SpringBoot 就能自动扫描到要加载的信息并启动相应的默认配置。
Starter 让我们摆脱了各种依赖库的处理以及需要配置各种信息的困扰。因为 SpringBoot 会自动通过 classpath 路径下的类发现需要的 Bean,对其进行自动装配并注册进 IOC 容器。
SpringBoot 提供了许多我们日常开发中在各种场景所需的 spring-boot-starter
依赖模块。所有这些依赖模块都会遵循着约定成俗的默认配置,并允许我们调整这些配置,即遵循约定大于配置的理念。
想了解更多关于 SpringBoot 的知识以及 SpringBoot 是如何进行自动装配组件的,可以参考我的另一篇博客:SpringBoot】之自动配置原理分析(源码级别)
Starter
在日常的开发工作中,经常会有一些独立于业务之外的配置模块,如果我们将其放到一个特定的包下,然后另一个工程需要复用这块功能的时候,就需要将代码硬拷贝到另一个工程,重新集成一遍,这样做非常的麻烦。
但如果我们将这些可独立于业务代码之外的功配置模块封装成独立的 Starter,复用的时候只需要将其在 pom 中引用依赖即可,因为 SpringBoot 的自动装配会为我们完成模块的装配,极大地方便了我们开发。
常见场景如下:
jackson2/fastjson
解决精度问题SpringBoot Starter
Starter
命令规范每个 Starter 都会遵循标准的命名规范,其中分为官方 Starter 的命名方法和自定义 Starter 的命名方式:
SpringBoot 官方命名方式:
自定义命名方式:
Starter
创建步骤我们先回顾一下 SpringBoot 的自动装配原理:
spring.factories
配置加载 AutoConfigure 类;@Conditional
注解的条件,进行自动配置并将 Bean 注入 Spring Context。这个原理相当于给了我们一个借鉴,只要我们遵循了这个规范我们就可以很简单的进行创建自定义的 Starter。
1)创建 Maven 项目
创建一个空的 Maven 项目:
Starter 不需要 main 启动类,一般创建空的 Maven 项目最合适,如果有生成启动类,直接删除掉。
2)添加依赖
下面市场完整的依赖:
<?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 http://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.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.wty</groupId>
<artifactId>email-spring-boot-starter</artifactId>
<version>1.0.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<!--包含自动配置的代码-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<!--非必须:编写配置文件时会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<!--下面就是按照自己项目所需,引入相关依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
</project>
这里需要注意两点:
<optional>
标签的值为 true 表示,两个项目直接依赖不传递,例如:项目A依赖 a.jar,项目B依赖项目A,则项目B不依赖 a.jar;2)编写相关属性配置类
@Data
@ConfigurationProperties(prefix = "email.config")
public class EmailProperties {
private String username = "";
private String password = "";
private String host = "smtp.163.com";
private Integer port = 25;
}
3)编写 Starter 的功能类
@Data
public class EmailService {
private EmailProperties emailProperties;
/**
* 模拟邮件发送功能
*/
public void sendEmail() {
System.out.println("Sending email... \n" +
"username: " + emailProperties.getUsername() + "\n" +
"password: " + emailProperties.getPassword() + "\n" +
"host: " + emailProperties.getHost() + "\n" +
"port: " + emailProperties.getPort());
}
}
4)编写自动配置类
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({
EmailService.class})
@EnableConfigurationProperties({
EmailProperties.class})
public class EmailAutoConfiguration {
@Autowired
private EmailProperties emailProperties;
@Bean
@ConditionalOnMissingBean
public EmailService emailService() {
EmailService emailService = new EmailService();
emailService.setEmailProperties(emailProperties);
return emailService;
}
}
解析:
@Configuration
注解修饰表示该类为配置类,会注入到容器中,proxyBeanMethods = false
表示使用 Lite 轻量级模式;@ConditionalOnClass
注解表示只有存在 EmailService.class 类时才生效自动配置类;@EnableConfigurationProperties
注解使我们定义的 EmailProperties.class 属性配置类生效。扩展知识:Full 全模式和 Lite 轻量级模式
@Configuration 注解的参数 proxyBeanMethods 表示设置 Bean 的代理模式:
注意: proxyBeanMethods 只是为了让使用 @Bean 注解的方法被代理,而不是对 @Bean 设置其为单例还是多例。
什么时候用Full全模式,什么时候用Lite轻量级模式:
5)编写 spring.factories
文件
在 src/main/resources 下添加 META-INF/spring.factories 文件
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.wty.starter.config.EmailAutoConfiguration
把自动配置类 EmailAutoConfiguration 配置到org.springframework.boot.autoconfigure.EnableAutoConfiguration 的 key 下,SpringBoot 会自动加载该文件并根据条件装配。
6)打包
在 Maven 插件的 Lifecycle 下点击 install,对项目进行打包生成 starter 包:email-spring-boot-starter
。
在另一个项目中引入我们自定义的 starter 依赖:
<dependency>
<groupId>com.wty</groupId>
<artifactId>email-spring-boot-starter</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
在 yml 配置相应的属性(编写的过程中会弹出属性配置提示):
email:
config:
username: [email protected]
password: 123456
host: smtp.163.com
port: 25
编写测试接口:
@RestController
@RequestMapping("/starter")
public class StarterController {
@Autowired
private EmailService emailService;
@GetMapping("/email")
public void testEmail() {
emailService.sendEmail();
}
}
得到结果:
Sending email...
username: [email protected]
password: 123456
host: smtp.163.com
port: 25
文章浏览阅读2.5w次,点赞6次,收藏50次。官方解释是,docker 容器是机器上的沙盒进程,它与主机上的所有其他进程隔离。所以容器只是操作系统中被隔离开来的一个进程,所谓的容器化,其实也只是对操作系统进行欺骗的一种语法糖。_docker菜鸟教程
文章浏览阅读5.7k次,点赞3次,收藏14次。该如何避免的,今天小编给大家推荐两个下载Windows系统官方软件的资源网站,可以杜绝软件捆绑等行为。该站提供了丰富的Windows官方技术资源,比较重要的有MSDN技术资源文档库、官方工具和资源、应用程序、开发人员工具(Visual Studio 、SQLServer等等)、系统镜像、设计人员工具等。总的来说,这两个都是非常优秀的Windows系统镜像资源站,提供了丰富的Windows系统镜像资源,并且保证了资源的纯净和安全性,有需要的朋友可以去了解一下。这个非常实用的资源网站的创建者是国内的一个网友。_msdn我告诉你
文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_
文章浏览阅读4.7k次,点赞5次,收藏6次。MFC 文本框换行 标签: it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行
文章浏览阅读832次。检查Linux是否是否开启所需端口,默认为6379,若未打开,将其开启:以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决,修改redis.conf,修改主机地址:bind 192.168.85.**;然后使用该配置文件,重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try
文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用
文章浏览阅读236次。1研究内容消费在生产中占据十分重要的地位,是生产的最终目的和动力,是保持省内经济稳定快速发展的核心要素。预测河南省社会消费品零售总额,是进行宏观经济调控和消费体制改变创新的基础,是河南省内人民对美好的全面和谐社会的追求的要求,保持河南省经济稳定和可持续发展具有重要意义。本文建立灰色预测模型,利用MATLAB软件,预测出2019年~2023年河南省社会消费品零售总额预测值分别为21881...._灰色预测模型用什么软件
文章浏览阅读1.2k次。12.4-在Qt中使用Log4Qt输出Log文件,看这一篇就足够了一、为啥要使用第三方Log库,而不用平台自带的Log库二、Log4j系列库的功能介绍与基本概念三、Log4Qt库的基本介绍四、将Log4qt组装成为一个单独模块五、使用配置文件的方式配置Log4Qt六、使用代码的方式配置Log4Qt七、在Qt工程中引入Log4Qt库模块的方法八、获取示例中的源代码一、为啥要使用第三方Log库,而不用平台自带的Log库首先要说明的是,在平时开发和调试中开发平台自带的“打印输出”已经足够了。但_log4qt
文章浏览阅读786次。全局观思维模型,一个教我们由点到线,由线到面,再由面到体,不断的放大格局去思考问题的思维模型。_计算机中对于全局观的
文章浏览阅读330次。一、CountDownLatch介绍CountDownLatch采用减法计算;是一个同步辅助工具类和CyclicBarrier类功能类似,允许一个或多个线程等待,直到在其他线程中执行的一组操作完成。二、CountDownLatch俩种应用场景: 场景一:所有线程在等待开始信号(startSignal.await()),主流程发出开始信号通知,既执行startSignal.countDown()方法后;所有线程才开始执行;每个线程执行完发出做完信号,既执行do..._countdownluach于cyclicbarrier的用法
文章浏览阅读508次。Prometheus 算是一个全能型选手,原生支持容器监控,当然监控传统应用也不是吃干饭的,所以就是容器和非容器他都支持,所有的监控系统都具备这个流程,_-自动化监控系统prometheus&grafana实战
文章浏览阅读4.7k次。输入关键字,可以通过键盘的搜索按钮完成搜索功能。_react search