1

我的团队有两个团队:服务器团队和客户端团队。我们服务器团队将提供 API 供客户端团队调用。API 有很多版本,因此我们需要匹配服务器构建和各自的客户端构建 - 例如,如果服务器构建号远大于其支持版本并需要更新,旧客户端将拒绝工作。

由于上述原因,我们需要将服务器的构建版本发送回客户端。目前我们通过在 Config 类中添加一个静态字段来做到这一点。但我担心每次构建新服务器时我们都必须手动增加它——尤其是在我们进行日常构建时。这个过程很容易出错,也不是很优雅。

在我的搜索中,我看到许多建议使用 maven 插件来管理构建版本。尽管我非常感谢自动进程,但它仍然不会让服务器知道内部版本号。服务器应用程序应该能够通过 API 调用将其构建版本返回给客户端。

我曾想过在某处写数字版本(远程数据库,服务器上的文件)。 有没有办法让构建过程自动增加构建版本,但应用程序本身也可以在运行时检索这个数字?

我们正在使用 Maven 构建并将 Jenkins 作为集成构建服务器。

4

1 回答 1

1

MANIFEST.MF我通常从Maven 打包在 JAR 中的文件中读取版本。默认情况下,它看起来像这样:

Manifest-Version: 1.0
Built-By: user
Build-Jdk: 1.6.0_35
Created-By: Apache Maven 3.0.4
Archiver-Version: Plexus Archiver

Name: Artifact
Implementation-Build: 1.14-SNAPSHOT
Version: 1.14-SNAPSHOT

从这个文件中,我读取了 Version 元素并使用它来显示应用程序的构建版本(例如,以及 WAR/EAR 中打包 jar 的所有版本)。像这样的代码应该可以工作:

public static String getApplicationVersion() {
        String version = null;
        try {
            final List<VersionsUtil.Version> moduleVersions = VersionsUtil.getModuleVersions(Thread.currentThread().getContextClassLoader());
            for (VersionsUtil.Version moduleVersion : moduleVersions) {
                if (moduleVersion.name.equals("<NAME OF ARTIFACT TO GET>")) {
                    version = moduleVersion.version;
                    break;
                }
            }
        } catch (IOException e) {
            // We'll return null...
        }
        return version;
    }


public class VersionsUtil {
    private static final Logger LOG = LoggerFactory.getLogger(VersionsUtil.class);

    /**
     * Returns a list of the module versions available for the given class loader.
     *
     * @param classLoader the class loader to return module versions for
     * @return a list of module versions
     * @throws IOException in case there's an error reading the manifest
     */
    public static List<Version> getModuleVersions(final ClassLoader classLoader) throws IOException {
        return processResources(classLoader.getResources("META-INF/MANIFEST.MF"));
    }

    private static List<Version> processResources(final Enumeration<URL> resources) throws IOException {
        final List<Version> moduleVersions = new ArrayList();
        while (resources.hasMoreElements()) {
            URL resource = resources.nextElement();
            Version v = process(resource);
            if (v != null) {
                moduleVersions.add(v);
            }
        }
        return moduleVersions;
    }

    private static Version process(final URL resource) {
        try {
            Properties p = readResource(resource);
            return createVersion(p);
        } catch (IOException e) {
            LOG.warn("Failed to read resource: " + resource, e);
            return null;
        }
    }

    private static Version createVersion(final Properties p) {
        Object name = p.get("Name");
        if (name != null) {
            return new Version((String) name, (String) p.get("Version"));
        }
        return null;
    }

    private static Properties readResource(final URL resource) throws IOException {
        LOG.trace("Reading resource: " + resource);
        InputStream is = resource.openStream();
        Properties p = new Properties();
        p.load(is);
        is.close();
        return p;
    }

    public static final class Version {
        String name;
        String version;

        private Version(final String name, final String version) {
            this.name = name;
            this.version = version;
        }

    }
}

更新:如果您想要 Jenkins 内部版本号,MANIFEST.MF您可以使用以下内容进行配置POM.XML

  ...
  <plugin>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.2</version>
    <configuration>
      <archive>
        <manifestSections>
          <manifestSection>
            <name>${project.name} (${project.artifactId})</name>
            <manifestEntries>
              <Version>${project.version}${build.number}</Version>
            </manifestEntries>
          </manifestSection>
        </manifestSections>
      </archive>
    </configuration>
  </plugin>
  ...
  <properties>
     <build.number />
  </properties>
  ...

如果您对标记 WAR/EAR 文件感兴趣,则必须相应地添加清单配置。然后在您的 Jenkins 作业配置中,只需将BUILD_NUMBER参数传递给 maven 进程,如下所示-Dbuild.number=$BUILD_NUMBER

于 2012-10-09T06:13:34.193 回答