gradle 构建项目添加版本信息

gradle 构建项目添加版本信息，打包使用 spring boot 的打包插件
  build.gradle 设置文件

1. bootJar {
2.     manifest {
3.         attributes(
4.                 'Project-Name': project.name,
5.                 'Project-Version': project.version,
6.                 "project-Vendor": "XXX Corp",
7.                 "Built-By": "Gradle ${gradle.gradleVersion}",
8.                 "Built-At": new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()),
9.                 'Git-Branch': getGitBranch(),
10.                 'Git-Commit': getGitCommit(),
11.                 'Git-Commit-Time': getGitCommitTime()
12.         )
14.     }
15. }
17. // 获取当前分支名称
18. static def getGitBranch() {
19.     try {
20.         def branch = 'git rev-parse --abbrev-ref HEAD'.execute().text.trim()
21.         return branch ?: 'unknown'
22.     } catch (Exception e) {
23.         System.err.println("fail to get branch, errMsg:" + e.getMessage())
24.         return 'unknown'
25.     }
26. }
28. // 获取当前提交的记录的commitId
29. static def getGitCommit() {
30.     try {
31.         def commit = 'git rev-parse  HEAD'.execute().text.trim()
32.         return commit ?: 'unknown'
33.     } catch (Exception e) {
34.         System.err.println("fail to get commit id, errMsg:" + e.getMessage())
35.         return 'unknown'
36.     }
37. }
39. // 获取当前Git提交的时间
40. static def getGitCommitTime() {
41.     try {
42.         def commitTime = 'git show -s --format=%ct HEAD'.execute().text.trim()
43.         return commitTime ? new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(Long.parseLong(commitTime) * 1000L)) : 'unknown'
44.     } catch (Exception e) {
45.         System.err.println("fail to get commit time, errMsg:" + e.getMessage())
46.         return 'unknown'
47.     }
48. }

复制代码

版本信息模型

1. public class VersionModel {
2.     private String projectName;
3.     private String projectVersion;
4.     private String projectVendor;
5.     private String builtBy;
6.     private String builtAt;
7.     private String gitBranch;
8.     private String gitCommit;
9.     private String gitCommitTime;
11.     public String getProjectName() {
12.         return projectName;
13.     }
15.     public void setProjectName(String projectName) {
16.         this.projectName = projectName;
17.     }
19.     public String getProjectVersion() {
20.         return projectVersion;
21.     }
23.     public void setProjectVersion(String projectVersion) {
24.         this.projectVersion = projectVersion;
25.     }
27.     public String getProjectVendor() {
28.         return projectVendor;
29.     }
31.     public void setProjectVendor(String projectVendor) {
32.         this.projectVendor = projectVendor;
33.     }
35.     public String getBuiltBy() {
36.         return builtBy;
37.     }
39.     public void setBuiltBy(String builtBy) {
40.         this.builtBy = builtBy;
41.     }
43.     public String getBuiltAt() {
44.         return builtAt;
45.     }
47.     public void setBuiltAt(String builtAt) {
48.         this.builtAt = builtAt;
49.     }
51.     public String getGitBranch() {
52.         return gitBranch;
53.     }
55.     public void setGitBranch(String gitBranch) {
56.         this.gitBranch = gitBranch;
57.     }
59.     public String getGitCommit() {
60.         return gitCommit;
61.     }
63.     public void setGitCommit(String gitCommit) {
64.         this.gitCommit = gitCommit;
65.     }
67.     public String getGitCommitTime() {
68.         return gitCommitTime;
69.     }
71.     public void setGitCommitTime(String gitCommitTime) {
72.         this.gitCommitTime = gitCommitTime;
73.     }
75.     @Override
76.     public String toString() {
77.         return "VersionModel{" +
78.                 "projectName='" + projectName + '\'' +
79.                 ", projectVersion='" + projectVersion + '\'' +
80.                 ", implementationVendor='" + projectVendor + '\'' +
81.                 ", builtBy='" + builtBy + '\'' +
82.                 ", builtAt='" + builtAt + '\'' +
83.                 ", gitBranch='" + gitBranch + '\'' +
84.                 ", gitCommit='" + gitCommit + '\'' +
85.                 ", gitCommitTime='" + gitCommitTime + '\'' +
86.                 '}';
87.     }
88. }

复制代码

版本工具类

1. import com.alibaba.fastjson.JSONObject;
2. import org.slf4j.Logger;
3. import org.slf4j.LoggerFactory;
5. import java.io.IOException;
6. import java.util.jar.Attributes;
7. import java.util.jar.Manifest;
9. public class BuildUtils {
10.     public static final String projectName = "Project-Name";
11.     public static final String projectVersion = "Project-Version";
12.     public static final String projectVendor = "Project-Vendor";
13.     public static final String builtBy = "Built-By";
14.     public static final String builtAt = "Built-At";
15.     public static final String gitBranch = "Git-Branch";
16.     public static final String gitCommit = "Git-Commit";
17.     public static final String gitCommitTime = "Git-Commit-Time";
18.     private static final Logger log = LoggerFactory.getLogger(BuildUtils.class);
20.     public static String getManifestAttribute(String attributeName) {
21.         try {
22.             Manifest manifest = new Manifest(BuildUtils.class.getResourceAsStream("/META-INF/MANIFEST.MF"));
23.             Attributes attributes = manifest.getMainAttributes();
24.             return attributes.getValue(attributeName);
25.         } catch (IOException e) {
26.             log.warn("fail to get info from manifest file, errMsg:{}", e.getMessage(), e);
27.             return "unknown";
28.         }
29.     }
31.     public static Attributes getManifestAttribute() {
32.         try {
33.             Manifest manifest = new Manifest(BuildUtils.class.getResourceAsStream("/META-INF/MANIFEST.MF"));
34.             return manifest.getMainAttributes();
35.         } catch (IOException e) {
36.             log.warn("fail to get info from manifest file, errMsg:{}", e.getMessage(), e);
37.             return new Attributes();
38.         }
39.     }
41.     public static String getManifestAttributeJsonFormat() {
42.         return JSONObject.toJSONString(getVersionModel(), true);
43.     }
45.     public static VersionModel getVersionModel() {
46.         VersionModel versionModel = new VersionModel();
47.         try {
48.             Manifest manifest = new Manifest(BuildUtils.class.getResourceAsStream("/META-INF/MANIFEST.MF"));
49.             versionModel.setBuiltAt(manifest.getMainAttributes().getValue(builtAt));
50.             versionModel.setBuiltBy(manifest.getMainAttributes().getValue(builtBy));
51.             versionModel.setProjectName(manifest.getMainAttributes().getValue(projectName));
52.             versionModel.setProjectVersion(manifest.getMainAttributes().getValue(projectVersion));
53.             versionModel.setProjectVendor(manifest.getMainAttributes().getValue(projectVendor));
54.             versionModel.setGitBranch(manifest.getMainAttributes().getValue(gitBranch));
55.             versionModel.setGitCommit(manifest.getMainAttributes().getValue(gitCommit));
56.             versionModel.setGitCommitTime(manifest.getMainAttributes().getValue(gitCommitTime));
57.         } catch (IOException e) {
58.             log.warn("fail to get info from manifest file, errMsg:{}", e.getMessage(), e);
59.         }
60.         return versionModel;
61.     }
62. }

复制代码

方法1 controller 示例

1. @RestController
2. @RequestMapping("/version")
3. public class VersionController {
4.     @GetMapping("/build")
5.     public VersionModel getVersionModel(){
6.         return BuildUtils.getVersionModel();
7.     }
8. }

复制代码

方法2 实验 jar 包中的类实验获取版本信息

1. package com.version;
2. public class Version {
3.     public static void main(String[] args) {
4.         System.out.println(BuildUtils.getManifestAttributeJsonFormat());
5.     }
6. }

复制代码

  java -cp you-app.jar -Dloader.main=com.version.Version org.springframework.boot.loader.PropertiesLauncher
  参考毗连

https://blog.csdn.net/russle/article/details/130658805

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。