SpringCloud开发-Spring Boot Starter包

最新推荐文章于 2024-06-18 04:38:26 发布
最新推荐文章于 2024-06-18 04:38:26 发布
阅读量584 收藏
点赞数
分类专栏： Starter包制作 SpringBoot SpringCloud
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhenghui317/article/details/103552341
版权

前言

制定starter包目的为，约束和统一企业内的开发组件的版本，减少应用代码的配置内容。使得我们在开发业务代码时能够非常方便的、不需要过多关注框架的配置，而只需要关注业务即可。

原理

我们知道使用一个公用的starter的时候，只需要将相应的依赖添加的Maven的配置文件当中即可，免去了自己需要引用很多依赖类，并且SpringBoot会自动进行类的自动配置。那么 SpringBoot 是如何知道要实例化哪些类，并进行自动配置的呢？ 下面简单说一下。

首先，SpringBoot 在启动时会去依赖的starter包中寻找 resources/META-INF/spring.factories 文件，然后根据文件中配置的Jar包去扫描项目所依赖的Jar包，这类似于 Java 的 SPI 机制。

第二步，根据 spring.factories配置加载AutoConfigure类。

最后，根据 @Conditional注解的条件，进行自动配置并将Bean注入Spring Context 上下文当中。

我们也可以使用@ImportAutoConfiguration({MyServiceAutoConfiguration.class}) 指定自动配置哪些类。

实现

创建一个SpringBoot 项目，并添加下面两个依赖到pom.xml文件当中

<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-autoconfigure</artifactId>
</dependency>

其中 spring-boot-configuration-processor 的作用是编译时生成 spring-configuration-metadata.json ，此文件主要给IDE使用。如当配置此jar相关配置属性在 application.yml ，你可以用ctlr+鼠标左键点击属性名，IDE会跳转到你配置此属性的类中。

我们日常使用的Spring官方的Starter一般采取spring-boot-starter-{name} 的命名方式，如 spring-boot-starter-web 。

而非官方的Starter，官方建议 artifactId 命名应遵循{name}-spring-boot-starter 的格式。

因需制作的Starter包比较多，在这里我制作了starter-parent包，pom文件如下：

<?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>

	<groupId>com.phenix</groupId>
	<artifactId>phenix-spring-boot-starter-parent</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<name>phenix-spring-boot-starter-parent</name>
	<description>定制加启动包</description>
	<packaging>pom</packaging>

	<properties>
		<java.version>1.8</java.version>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
		<spring.boot.version>2.1.9.RELEASE</spring.boot.version>
		<spring-cloud.version>Greenwich.SR3</spring-cloud.version>
		<spring-cloud-stream.version>Germantown.RELEASE</spring-cloud-stream.version>
		<spring-cloud-alibaba.version>0.9.0.RELEASE</spring-cloud-alibaba.version>

		<lombok.version>1.18.10</lombok.version>
		<commons-lang.version>3.9</commons-lang.version>
		<fastjson.version>1.2.62</fastjson.version>
		<starter.version>2.2.1.RELEASE</starter.version>
		<!-- aop -->
		<spring-boot-starter-aop.version>2.0.1.RELEASE</spring-boot-starter-aop.version>
		<javax.el.version>3.0.1-b08</javax.el.version>

		<hutool-all.version>5.0.3</hutool-all.version>
		<!--starter版本 -->
		<phenix-spring-boot-starter-parent.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-parent.version>
		<phenix-spring-boot-starter-admin.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-admin.version>
		<phenix-spring-boot-starter-feign.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-feign.version>
		<phenix-spring-boot-starter-logging.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-logging.version>
		<phenix-spring-boot-starter-mybatis-plus.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-mybatis-plus.version>
		<phenix-spring-boot-starter-mysql.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-mysql.version>
		<phenix-spring-boot-starter-nacos.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-nacos.version>
		<phenix-spring-boot-starter-rabbitmq.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-rabbitmq.version>
		<phenix-spring-boot-starter-redis.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-redis.version>
		<phenix-spring-boot-starter-swagger.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-swagger.version>
		<phenix-spring-boot-starter-web.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-web.version>
		<phenix-spring-boot-starter-security.version>1.0.0-SNAPSHOT</phenix-spring-boot-starter-security.version>
	</properties>

	<dependencies>
		<!-- spring-boot-starter -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<!-- commons-tool  -->
		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-lang3</artifactId>
			<version>${commons-lang.version}</version>
		</dependency>
		<!-- test  -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- 健康检查  -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<!-- configuration-processor  -->
		<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-autoconfigure</artifactId>
        </dependency>
		<!-- lombok -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<scope>provided</scope>
			<version>${lombok.version}</version>
		</dependency>

		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>${fastjson.version}</version>
		</dependency>

		<dependency>
			<groupId>cn.hutool</groupId>
			<artifactId>hutool-all</artifactId>
			<version>${hutool-all.version}</version>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-dependencies</artifactId>
				<version>${spring.boot.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
			<!-- lombok -->
			<dependency>
				<groupId>org.projectlombok</groupId>
				<artifactId>lombok</artifactId>
				<scope>provided</scope>
				<version>${lombok.version}</version>
			</dependency>

			<dependency>
				<groupId>com.alibaba</groupId>
				<artifactId>fastjson</artifactId>
				<version>${fastjson.version}</version>
			</dependency>

			<dependency>
				<groupId>cn.hutool</groupId>
				<artifactId>hutool-all</artifactId>
				<version>${hutool-all.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-web</artifactId>
				<version>${phenix-spring-boot-starter-web.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-logging</artifactId>
				<version>${phenix-spring-boot-starter-logging.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-swagger</artifactId>
				<version>${phenix-spring-boot-starter-swagger.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-nacos</artifactId>
				<version>${phenix-spring-boot-starter-nacos.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-mysql</artifactId>
				<version>${phenix-spring-boot-starter-mysql.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-mybatis-plus</artifactId>
				<version>${phenix-spring-boot-starter-mybatis-plus.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-admin</artifactId>
				<version>${phenix-spring-boot-starter-admin.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-redis</artifactId>
				<version>${phenix-spring-boot-starter-redis.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-rabbitmq</artifactId>
				<version>${phenix-spring-boot-starter-rabbitmq.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-feign</artifactId>
				<version>${phenix-spring-boot-starter-feign.version}</version>
			</dependency>
			<dependency>
				<groupId>com.phenix</groupId>
				<artifactId>phenix-spring-boot-starter-security</artifactId>
				<version>${phenix-spring-boot-starter-security.version}</version>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<finalName>${project.artifactId}</finalName>
		<pluginManagement>
			<plugins>
				<!-- 发布插件 -->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-release-plugin</artifactId>
					<configuration>
						<!--<preparationGoals>clean package</preparationGoals>-->
						<autoVersionSubmodules>true</autoVersionSubmodules>
						<!-- 不使用默认的profile -->
						<tagNameFormat>v@{project.version}</tagNameFormat>
						<useReleaseProfile>false</useReleaseProfile>
						<!--  在发布时不检查是否提交 git 的文件过滤配置 -->
						<allowReleasePluginSnapshot>true</allowReleasePluginSnapshot>
						<allowTimestampedSnapshots>true</allowTimestampedSnapshots>
						<checkModificationExcludes>
							<checkModificationExclude>.project</checkModificationExclude>
							<checkModificationExclude>.settings</checkModificationExclude>
							<checkModificationExclude>.classpath</checkModificationExclude>
							<checkModificationExclude>**\.project</checkModificationExclude>
							<checkModificationExclude>**\.settings</checkModificationExclude>
							<checkModificationExclude>**\.classpath</checkModificationExclude>
						</checkModificationExcludes>
						<!--<commitByProject>true</commitByProject>-->
					</configuration>
					<dependencies>
						<dependency>
							<groupId>org.apache.maven.scm</groupId>
							<artifactId>maven-scm-provider-gitexe</artifactId>
							<version>1.9.4</version>
						</dependency>
					</dependencies>
				</plugin>
				<!-- 生成sources源码包的插件 -->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-source-plugin</artifactId>
					<executions>
						<execution>
							<goals>
								<goal>jar</goal>
							</goals>
						</execution>
					</executions>
				</plugin>
			</plugins>
		</pluginManagement>

		<plugins>
			<!-- maven-enforcer-plugin 这个插件会对项目环境进行检查 -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-enforcer-plugin</artifactId>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.8.0</version>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
		</plugins>
	</build>

	<distributionManagement>
		<repository>
			<id>phoenix-releases</id>
			<url>https://repo.rdc.aliyun.com/repository/114773-release-m6CZw0/</url>
		</repository>
		<snapshotRepository>
			<id>phoenix-snapshots</id>
			<url>https://repo.rdc.aliyun.com/repository/114773-snapshot-Hz4DGO/</url>
		</snapshotRepository>
	</distributionManagement>

	<modules>
		<module>phenix-spring-boot-starter-web</module>
		<module>phenix-spring-boot-starter-logging</module>
		<module>phenix-spring-boot-starter-swagger</module>
		<module>phenix-spring-boot-starter-mysql</module>
		<module>phenix-spring-boot-starter-redis</module>
		<module>phenix-spring-boot-starter-nacos</module>
		<module>phenix-spring-boot-starter-admin</module>
        <module>phenix-spring-boot-starter-rabbitmq</module>
		<module>phenix-spring-boot-starter-mybatis-plus</module>
		<module>phenix-spring-boot-starter-feign</module>
		<module>phenix-spring-boot-starter-security</module>
		<module>phenix-spring-boot-starter-all</module>
	</modules>
</project>

为了避免需要每个包都引用，使用phenix-spring-boot-starter-all来引用所有的子starter包。也可以根据需要自行搭配。

注意：distributionManagement 需配置私有仓库地址，本文采用阿里云效的私有仓库，使用私有仓库需申请开通云效。并下载私有仓库提供的settings.xml文件，覆盖本地settings.xml。

 

源码地址： https://github.com/zhenghui317/phenix-spring-boot-starter-parent

Silent_ZH
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringCloud中24个很重要的Starter
诗和远方，任重道远
11-12 3173
Netflix SpringCloud中几个很重要的组件写在前面一、Eureka二、Turbine三、Ribbon四、Hystrix 写在前面 其实在这些个Starter之上，是一个团队的努力结果，从下图可以看出，每个Starter都是基于相应的Starter-Netflix-XX，开发，团队会根据需要，在Starter-Netflix-XXX中封装SDK，最后整合使用在Starter中，需要注意...
(七) 跟我学习SpringCloud-Spring Boot Starter的介绍及使用
iteye_3750的博客
03-27 280
Spring Boot 的便利性体现在，它简化了很多烦琐的配置，这对于开发人员来说是一个福音，通过引入各种 Spring Boot Starter 包可以快速搭建出一个项目的脚手架推荐分布式架构源码。 目前提供的 Spring Boot Starter 包有： spring-boot-starter-web：快速构建基于 Spring MVC 的 Web 项目，使用 Tomcat 做默认嵌入式容器。 spring-boot-starter-data-redis：操作 Redis。 spring-boot-s
《SpringCloud超级入门》Spring Boot Starter的介绍及使用《七》
2401_85767200的博客
06-18 935
自动配置非常方便，当我们要操作 Mongodb 的时候，只需要引入 spring-boot-starter-data-mongodb 的依赖，然后配置 Mongodb 的链接信息 spring.data.mongodb.uri=mongodb：//localhost/test 就可以使用 MongoTemplate 来操作数据，MongoTemplate 的初始化工作全部交给 Starter 来完成。创建一个项目 spring-boot-starter-demo，pom.xml 配置代码如下所示。
（五）Alian 的 Spring Cloud DB Starter（第一个Spring Cloud starter）
嘉禾嘉宁papa
07-19 5690
一、创建maven工程 二、maven依赖 三、编码 3.1、配置类 3.2、Ebean封装类 四、配置spring.factories 五、打包发布脚本 六、使用 七、验证 7.1、验证 7.2、配置文件 7.3、service层 7.4、controller层
Spring-Cloud-Starter-${module-name}
Knowlege的专栏
05-21 130
使用一个公用的starter的时候，只需要将相应的依赖添加的Maven的配置文件当中即可，免去了自己需要引用很多依赖类。将很多依赖整理成一个依赖。
oss-spring-boot-starter-1.0.3-API文档-中英对照版.zip
05-04
赠送jar包：oss-spring-boot-starter-1.0.3.jar； 赠送原API文档：oss-spring-boot-starter-1.0.3-javadoc.jar； 赠送源代码：oss-spring-boot-starter-1.0.3-sources.jar； 赠送Maven依赖信息文件：oss-spring-boot...
oss-spring-boot-starter-1.0.3-API文档-中文版.zip
03-30
赠送jar包：oss-spring-boot-starter-1.0.3.jar 赠送原API文档：oss-spring-boot-starter-1.0.3-javadoc.jar 赠送源代码：oss-spring-boot-starter-1.0.3-sources.jar 包含翻译后的API文档：oss-spring-boot-...
spring-boot-starter-axon:Spring Boot Axon 启动器
07-05
Spring Boot是由Pivotal团队开发的框架，旨在简化Spring应用的初始搭建以及开发过程。它通过自动配置和“起步依赖”（starters）使得开发者可以快速启动项目，无需过多关注配置细节。 接下来，我们来看看Axon框架。...
bucket4j-spring-boot-starter：Bucket4j的Spring Boot Starter
01-30
综上所述，`bucket4j-spring-boot-starter`为Spring Boot开发者提供了一个易于使用的限流解决方案，它可以无缝集成到Spring MVC或Spring WebFlux的应用中，并且可以应用于Spring Cloud Netflix Zuul的API网关场景，...
excel-spring-boot-starter-1.1.1-API文档-中英对照版.zip
05-04
赠送jar包：excel-spring-boot-starter-1.1.1.jar； 赠送原API文档：excel-spring-boot-starter-1.1.1-javadoc.jar； 赠送源代码：excel-spring-boot-starter-1.1.1-sources.jar； 赠送Maven依赖信息文件：excel-...
SpringCloud与SpringBoot版本匹配关系
web18296061989的博客
03-23 828
记录一下, 将SpringBoot改造成SpringCloud项目第一步遇到的问题就是选择什么版本. Spring Cloud与Spring Boot版本匹配关系 Spring Cloud Spring Boot Finchley 兼容Spring Boot 2.0.x, 不兼容Spring Boot 1.5.x Dalston和Edgware 兼容Spring Boot 1.5.x, 不兼容Spring Boot 2.0.x Camden 兼容Spring Boot 1.4.x, 也兼容Spring Bo
从零开始SpringCloud Alibaba实战（32）——spring-cloud-starter-oauth2认证授权服务
liuerchong的博客
08-14 2614
OAuth2.0介绍 OAuth（开放授权）是一个开放标准，允许用户授权第三方应用访问他们存储在另外的服务提供者上的信息，而不需要将用户名和密码提供给第三方应用或分享他们数据的所有内容。OAuth2.0是OAuth协议的延续版本，但不向后兼容OAuth 1.0即完全废止了OAuth1.0。很多大公司如Google，Yahoo，Microsoft等都提供了OAUTH认证服务，这些都足以说明OAUTH标准逐渐成为开放资源授权的标准。 Oauth协议目前发展到2.0版本，1.0版本过于复杂，2.0版本已得到广泛应
Spring项目&spring-boot-starter组件&Spring Cloud生态圈以及微服务简介
lonelymanontheway的博客
06-27 2982
Spring 顶级项目介绍 Spring boot starter组件介绍 Spring cloud组件介绍
spring-boot-starter和spring-cloud-starter-gateway冲突问题
qq_43470725的博客
06-27 1400
这两个版本可以匹配： org.springframework.boot spring-boot-starter 2.2.2.RELEASE <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version
spring-cloud-starter-security和spring-cloud-starter-oauth2
热门推荐
qq_30359369的博客
12-02 2万+
之前学过spring-security,最近又在学习spring-cloud-starter-security和spring-cloud-starter-oauth2, 脑子里顿时冒出一个问题: 之前学的spring-security和最近学的spring-cloud-starter-security有什么关系, spring-cloud-starter-security和spring-clou......
spring-cloud-starter-openfeig断路器实现
奋斗中的老青年
03-19 538
依赖： <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> 相对于Ribbon搭配使用来说，Feign实现...
【Spring-boot】自己开发一个SpringBoot的starter--＞原理详解
weixin_38538285的博客
08-29 1114
文章目录一、前言1.1 starter的作用二、原理2.1 概述2.2 什么是spi2.3 Spring的SPI2.4 Springboot中对spring SPI的使用三、扒一扒一个springBoot starter的源码3.1 引入依赖3.2 druid-spring-boot-starter jar包的基本结构3.3 源码3.4 在项目中的使用四、总结 一、前言 在日常开发中springboot是我们应用非常普遍的开发框架。springboot可以帮助我们快速的开发一个后端应用，我们只需引入依赖，添
spring-cloud-starter-netflix-hystrix使用详解
若鱼的专栏
08-24 1万+
前面文中我们学习了hystrix的原生使用（hystrix入门-原生API使用）和注解使用（hystrix进阶-注解hystrix-javanica使用），本文来看下hystrix在spring-boot中的使用。 首先还是先看个最简单的demo 第一步：添加依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netf
spring-boot-starter和spring-cloud-starter-bootstarp
最新发布
08-10
例如，如果你添加`spring-boot-starter-web`，系统就会自动包含Tomcat或Jetty容器以及相关的处理HTTP请求的模块。 2. **Spring Cloud Starter Bootstrap**：这个模块通常出现在Spring Cloud框架中，它是Spring ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值