使用 gradle 显示第一个 OSGi 构建 - 从 ant 迁移到 Gradle

Question

先有manifest吗 http://wiki.osgi.org/wiki/Tooling_Approaches OSGi 的 gradle 插件？或者用gradle怎么做？

OSGi 容器有一个很大的旧项目，其中许多项目在 MANIFEST.MF 中声明了复杂的关系。构建很长。 现在我们想简化事情并采用 Gradle。但首先不要破坏东西并保持 ant 和 gradle 并行构建一段时间。 但是我看到的是 gradle 建议在 build.gradle 中定义 MANIFEST。 https://docs.gradle.org/current/userguide/osgi_plugin.html
那会做很多复制工作。

更新有近 100 个模块，其中包含模块之间和嵌套 jar 的大量依赖关系信息。 MANIFEST.MF 的平均长度约为 50 行（从 20 到 300 行不等）。 如何捆绑嵌套 jar 是other question。 这个问题是关于使用现有的 MANIFEST.MF 文件。我看到的所有插件都使用bnd，这与manifest first 方法完全相反。

Answer 1

Gradle 有一个 OsgiManifest 类，它是一个扩展的 jar 清单：

https://docs.gradle.org/current/javadoc/org/gradle/api/plugins/osgi/OsgiManifest.html

StackOverflow 上有一篇帖子显示了类似的用法：

How to add Import-Package instructions for runtime dependencies?

相关的 gradle 块如下所示：

apply plugin: 'java'
apply plugin: 'osgi'

jar {
    baseName = 'awesome'
    manifest {
        name = 'An Awesome Application'
        symbolicName = 'com.example.awesome'
        instruction 'Import-Package', 'org.springframework.orm', '*'
    }
}

如果您有现有的清单并希望使用自己的自定义文件，您可以通过在 jar 闭包中设置清单文件位置来做到这一点：

jar {
    manifest {
        def manif = "${resourcesDir}/MANIFEST.MF"
        if (new File(manif).exists()) {
            from file(manif)
        }
        else{
            name = 'overwrittenSpecialOsgiName'
            instruction 'Private-Package', 'org.mycomp.somepackage'
            instruction 'Bundle-Vendor', 'MyCompany'
            instruction 'Bundle-Description', 'Platform2: Metrics' 
        }
    }
}

可以在此处找到 Gradle 清单的文档： https://docs.gradle.org/current/javadoc/org/gradle/api/java/archives/Manifest.html

对于您的“其他问题”：

还有其他用于构建 OSGI 包的 Gradle 插件，在某些情况下，包括来自其他 OSGI 包的依赖项。

例如，Gradle Bundle Plugin，它使用 bnd 工具并允许您指定包含传递依赖，甚至排除不需要的依赖。 举个例子：

jar {
    manifest {
        attributes 'Implementation-Title': 'Bundle Quickstart',     // Will be added to manifest
                     'Import-Package': '*'  // Will be overwritten by the instuctions below
    }
}

bundle {
    includeTransitiveDependencies = true

    instructions << [
        'Bundle-Activator': 'foo.bar.MyBundleActivator',
        'Import-Package': 'foo.*',
        '-sources': true
    ]

    instruction 'Export-Package', '*' // Specify an individual instruction
    instruction '-wab', ''
}

还有Gradle osgi-run plugin，默认包含传递依赖：

dependencies {
    // all your usual dependencies
    ...

    osgiRuntime( "your:dependency:1.0" ) {
        transitive = false // transitive dependencies not included in OSGi runtime
    }
}

希望这足以让你继续前进。

Answer 2

截至 2016 年 4 月，用于 OSGi 的 Maven 或 Gradle 构建工具中没有清单优先的方法。

虽然对于 Eclipse 插件（也是有效的 OSGi 包）有 maven/tycho 构建，这是 Eclipse Foundation 中的标准，但它对一般的 OSGi 项目并没有真正的帮助。

与Manifest-first相反的是Manifest generation，只有一个工具bnd，最初用于创建manifest，然后发展为完整的bundle jar builder，现在有BndTools Eclipse integration，看起来类似于Maven/Gradle集成管理依赖关系。

我建议将bnd 指令保留在外部标准bnd.bnd 文件中，而不是将其放在构建脚本中。 *.bnd 文件类似于通常的 Java .properties 文件，因此在 Eclipse IDE 中右键单击，打开方式 -> 其他 ... 选择 Properties File Editor 选中“将此编辑器用于..”并选中“将此编辑器用于所有“*.nbd”文件”

对于 Gradle

• [Gradle OSGi Plugin] (standard, built-in)(https://docs.gradle.org/current/userguide/osgi_plugin.html) 只提供清单操作，所以GRADLE-1107 "OSGi instruction Include-Resource not working" 是 自 2010 年以来的未决问题
• Gradle Bundle Plugin 允许您创建 OSGI 包。它与 Gradle OSGI 插件的主要区别在于，它使用 bnd 工具不仅生成清单，而且生成整个 jar。
• osgi-run "Osgi-Run - 一个 Gradle 插件，让使用 OSGi 开发模块化应用程序完全无痛"

对于行家

• maven-bundle-plugin 又名Apache Felix Maven Bundle Plugin (BND) 是“Maven first” approach
• bnd-maven-pluginannounce and 2 plugins comparison

所有基于 bnd 的工具现在都在 collected http://bnd.bndtools.org/chapters/700-tools.html 上

https://github.com/paulvi/OSGiBuildExamples中有一些例子

注意：链接http://wiki.osgi.org/wiki/Tooling_Approaches 已在“不幸的是，OSGi 社区 Wiki 被黑，目前不可用。 " 状态超过一周，而这个问题被打开了。

遗憾的是，@Richard 放弃得太早了，也没有收到一些感谢（因为提到了 maven）