简介
starter即场景启动器，其主要作用为帮助我们声明依赖，并且做到自动装配第三方实例，将第三方实例纳入IOC中。
命名规范
一般官方的starter是spring-boot-starter-{name} 这种命名，而第三方建议是{name}-spring-boot-starter。
自定义starter步骤
- 创建一个maven工程，声明相关依赖及构建配置，其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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zouuo.starter</groupId>
<artifactId>minio-spring-boot-starter</artifactId>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<sourceEncoding>UTF-8</sourceEncoding>
<project.compiler.source>1.8</project.compiler.source>
<project.compiler.target>1.8</project.compiler.target>
<java.version>1.8</java.version>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<spring.boot.version>2.5.6</spring.boot.version>
<minio.version>8.1.0</minio.version>
</properties>
<developers>
<developer>
<name>zhouhuo</name>
<email>zhouhuoya@gmail.com</email>
<organizationUrl>https://www.zouuo.com</organizationUrl>
</developer>
</developers>
<!-- maven依赖管理，此部分一般会定义在一个parent项目中，用于管理依赖 -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring.boot.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<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>
<dependency>
<groupId>io.minio</groupId>
<artifactId>minio</artifactId>
<version>${minio.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
</dependency>
</dependencies>
<!-- 构建相关配置 -->
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadoc</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<charset>UTF-8</charset>
<encoding>UTF-8</encoding>
<docencoding>UTF-8</docencoding>
<additionalJOptions>
<additionalJOption>-Xdoclint:none</additionalJOption>
</additionalJOptions>
</configuration>
</plugin>
</plugins>
</build>
</project>
-
添加配置类
package com.zouuo.starter.minio.autoconfigure; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; import org.springframework.boot.context.properties.ConfigurationProperties; import java.io.Serializable; /** * Minio配置类 * * @author zhouhuo */ @Data @EqualsAndHashCode @ToString @ConfigurationProperties(prefix = "com.zouuo.minio") public class MinioProperties implements Serializable { private static final long serialVersionUID = -327308677102789463L; /** * minio 端点，例：http://localhost:9000 */ private String endpoint = "http://localhost:9000"; /** * minio accessKey 即 用户名 */ private String accessKey = "minio"; /** * minio secretKey 即 密码 */ private String secretKey = "minio"; /** * 地域 */ private String region; } -
添加自动状态配置类
package com.zouuo.starter.minio.autoconfigure; import io.minio.MinioClient; import org.apache.commons.lang3.StringUtils; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import java.util.Optional; /** * Minio自动装配类 * * @author zhouhuo */ @ConditionalOnClass(MinioClient.class) @EnableConfigurationProperties(MinioProperties.class) public class MinioAutoConfigure { /** * 纳入spring管理配置，定义MinioClient实例如何初始化 * * */ @Bean @ConditionalOnMissingBean(MinioClient.class) public MinioClient minioClient(MinioProperties minioProperties) { MinioClient.Builder builder = MinioClient.builder(); builder.endpoint(minioProperties.getEndpoint()) .credentials(minioProperties.getAccessKey(), minioProperties.getSecretKey()); // 当配置了region并且不为空时设置 Optional.ofNullable(minioProperties.getRegion()) .filter(StringUtils::isNotBlank) .ifPresent(builder::region); return builder.build(); } } -
在resources路径下创建META-INF目录，创建spring.factories文件,此文件为自动引导文件，文件内容如下
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zouuo.starter.minio.autoconfigure.MinioAutoConfigure -
构建
通过如下命令构建starter
mvn clean install -
自此，自定义spring boot starter 步骤完成。
使用自定义starter
在我们需要使用此starter的项目中，添加此starter–>在配置文件中配置此starter需要的配置项–>在代码中通过@Autowired注解或者构造函数的方式注入实例–>使用相关实例。
评论区