Spring Boot自定義 Starter並推播到遠端公服的詳細程式碼

2022-09-05 14:01:39

一、新建專案，完善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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>org.meng</groupId>
    <artifactId>tools-spring-boot-starter</artifactId>
    <version>v1.0.0</version>
    <name>tools</name>
    <description>tools</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <!--表示兩個專案之間依賴不傳遞；不設定optional或者optional是false，表示傳遞依賴-->
        <!--例如：project1依賴a.jar(optional=true),project2依賴project1,則project2不依賴a.jar-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <!-- 打包時需要注意一下，SpringBoot專案打包的JAR是可執行JAR，它的類放在BOOT-INF目錄下，
                如果直接作為其他專案的依賴，會找不到類，以下設定解決此問題 -->
                <configuration>
                    <classifier>exec</classifier>
                </configuration>
            </plugin>
        </plugins>
    </build>
 
</project>

PS：打包時需要注意一下，SpringBoot專案打包的JAR是可執行JAR，它的類放在BOOT-INF目錄下，如果直接作為其他專案的依賴，會找不到類，可以通過修改pom檔案來解決。

二、編寫業務邏輯

package org.meng.tools.service;
 
import org.meng.tools.utils.MD5Util;
 
/**
 * @Description: MD5Service
 * @create by meng on 17:10 2022/9/2
 */
public class MD5Service {
	public String getMD5(String input) {
		return MD5Util.getMD5(input.getBytes());
	}
}

package org.meng.tools.utils;
 
/**
 * @Description: MD5加密
 * @create by meng on 17:09 2022/9/2
 */
public class MD5Util {
 
	public static String getMD5(String source) {
		return getMD5(source.getBytes());
	}
 
	public static String getMD5(byte[] source) {
		String s = null;
		char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};
		try {
			java.security.MessageDigest md = java.security.MessageDigest.getInstance("MD5");
			byte tmp[];
			synchronized (MD5Util.class) {
				md.update(source);
				tmp = md.digest();
			}
			char str[] = new char[16 * 2];
			int k = 0;
			for (int i = 0; i < 16; i++) {
				byte byte0 = tmp[i];
				str[k++] = hexDigits[byte0 >>> 4 & 0xf];
				str[k++] = hexDigits[byte0 & 0xf];
			}
			s = new String(str);
 
		} catch (Exception e) {
			e.printStackTrace();
		}
		return s;
	}
 
}

三、編寫自動設定類AutoConfig

package org.meng.tools.config;
 
import org.meng.tools.service.MD5Service;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
/**
 * @Description: AutoConfiguration
 * @create by meng on 17:11 2022/9/2
 */
@Configuration
@ConditionalOnClass(MD5Service.class)
public class AutoConfiguration {
	@Bean
	MD5Service md5Service() {
		return new MD5Service();
	}
}

四、編寫spring.factories檔案載入自動設定類

在resources下新建META-INF資料夾，然後建立spring.factories檔案

在該檔案中加入如下設定

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
  org.meng.tools.config.AutoConfiguration

五、maven打包

同一個環境下的maven，可提供給其他專案使用

mvn clean install

pom檔案引入

<dependency>
    <groupId>org.meng</groupId>
    <artifactId>tools-spring-boot-starter</artifactId>
    <version>v1.0.0</version>
</dependency>

六、推播到遠端倉庫，使用JitPack

專案上傳到GitHub，並建立版本

JitPack連結：JitPack | Publish JVM and Android libraries

Look up 自己專案的GitHub地址

欄位含義version指你在github上釋出專案時候填寫的release taglogjitpack編譯你的專案生成的紀錄檔，綠色表示ok，紅色表示編譯錯誤status表示當前專案的狀態，如果編譯通過顯示的是綠色的get it，表示可以使用，如果編譯有問題，那麼則顯示report，你可以點選report去提交你的log並描述一下你的問題，jitpack會給你答覆

pom檔案引入

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
 
    <dependencies>
        <dependency>
            <groupId>com.github.Vmetrio</groupId>
            <artifactId>tools</artifactId>
            <version>v1.0.0</version>
        </dependency>
    </dependencies>