目录
- 一、新建项目,完善pom文件
- 二、编写业务逻辑
- 三、编写自动配置类AutoConfig
- 四、编写spring.factories文件加载自动配置类
- 五、maven打包
- 六、推送到远端仓库,使用JitPack
- 七、使用案例
- 八、相关问题
一、新建项目,完善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>
七、使用案例
GitHub项目地址:GitHub - Vmetrio/tools: Spring Boot Starter
八、相关问题
maven报错
Cannot resolve com.github.xxx
在当前项目的maven对应的 setting.xml 中,修改一下镜像的配置
<mirrorOf>*,!jitpack.io</mirrorOf>