JAR清单文件 - 规范和实现之间的差异

时间:2014-01-08 11:46:39

标签: java jar manifest.mf

我想在我创建的库的jar中添加版本信息(可能还有一些关于jar的其他元数据)。但是,我不确定使用什么属性。我发现specification以及documentation说明可以有Specification-VersionImplementation-Version(以及两者的标题和供应商)。但是没有正确解释规范和实现之间的区别。

我也看了不同的例子。

  • 来自documentation的那个使用人类可读的名称标题和实施标题的包名称。点分隔版本号用于规范版本,而简单版本号用于实现版本。
  • gradle教程似乎只是使用Implementation-Version和一个人类可读的字符串来实现Title-Title
  • another question中,我找到了一个示例,其中针对不同的包有几个实现版本。

规范和实施元数据之间究竟有什么区别?应该如何使用这些不同的属性(尤其是版本号)?规范和实现的供应商是如何有所不同的呢?

它甚至扮演了我放在那里的角色吗?

3 个答案:

答案 0 :(得分:12)

每个的含义在documentation of java.lang.Package中解释。

Specification-Version必须由ASCII数字序列组成,由ASCII句点分隔。不允许使用其他字符,句点不能位于值的开头或结尾,也不允许连续句点。

Implementation-Version是一个自由格式的字符串。它可以有任何格式。

规范 - 版本始终与包相关联。如果为整个清单而不是特定包指定它,它将应用于.jar文件中的所有包。

规范版本被许多Java技术用作解决依赖关系的手段。如果某个程序说它需要,比如版本2.1或更高版本的JMF库,一些Java环境将使用匹配的Specification-Title分析每个清单的Specification-Version中的数字,并确保正确的版本(和没有其他版本)在运行时在类路径中可用。

事实上,Package.isCompatibleWith方法非常有效。您甚至可以使用它来检查最低Java版本:

if (System.class.getPackage().isCompatibleWith("1.6")) {
    System.out.println("Running in Java 1.6 or later.");
}

更新

以上内容在Java 9模块化应用程序中不起作用。来自documentation for java.lang.Package

  

为命名模块中的类自动定义的包具有以下属性:
  ...
  •未指定规范和实现标题,版本和供应商。

     

为未命名模块中的类自动定义的包具有以下属性:
  ...
  •未指定规范和实现标题,版本和供应商。

作为模块运行的Java 9程序应该使用ModuleDescriptor.version()。请注意,ModuleDescriptor.Version class是可比的:

Module libraryModule = SomeLibraryClass.class.getModule();
Optional<ModuleDescriptor.Version> libraryVersion =
    libraryModule.getDescriptor().version();

ModuleDescriptor.Version minimumRequiredVersion =
    ModuleDescriptor.Version.parse("2.0");

if (libraryVersion.isPresent() &&
    minimumRequiredVersion.compareTo(libraryVersion.get()) >= 0) {

    System.out.println(libraryModule + " is version " +
        minimumRequiredVersion + " or later.");
}

答案 1 :(得分:6)

嗯,规范就是你的合同,例如:

  • 标准,例如JAXB,JDBC或各种Java EE标准之一(例如EJB 2.x,EJB 3.0,EJB 3.1)
  • 您的图书馆,框架或服务的API

实施就是该规范的实施。

虽然规范的API(以及规范版本)可能不会改变,但实施版本可能会随着您修复错误等而改变。

答案 2 :(得分:3)

考虑Apache Tomcat的servlet-api.jar清单:

Manifest-Version: 1.0
Ant-Version: Apache Ant 1.8.4
Created-By: 1.7.0_40-b43 (Oracle Corporation)
X-Compile-Source-JDK: 1.7
X-Compile-Target-JDK: 1.7

Name: javax/servlet/
Specification-Title: Java API for Servlets
Specification-Version: 3.1
Specification-Vendor: Sun Microsystems, Inc.
Implementation-Title: javax.servlet
Implementation-Version: 3.1.FR
Implementation-Vendor: Apache Software Foundation

Apache是​​由the JCP(由Sun创建)定义的Servlet 3.1规范的几个实现者之一。