在 OSGi 包中添加第三方 Maven 依赖项的最佳方法

Posted 2023-02-22

【中文标题】在 OSGi 包中添加第三方 Maven 依赖项的最佳方法

【英文标题】：Best way to add Third party maven dependencies in OSGi bundle

【发布时间】：2013-08-30 20:00:49

【问题描述】：

我刚刚开始进行 OSGI 开发，正在努力了解处理依赖/第三方 JAR 或 maven 依赖项的最佳方式。

即如果我正在创建一个捆绑包，那么很可能我将使用一些 3rd 方 JAR。当我创建我的包 JAR 以部署到 OSGI 时，显然这些 3rd 方 JAR 不包括在内，因此包将不会运行。

我了解一种选择是将这些 JAR 转换为捆绑包并将它们部署到 OSGI 容器。但是我不能为我将要使用的每一个 maven 依赖项都这样做。

处理这种情况的最佳解决方案是什么？有什么办法可以将 jar 文件直接嵌入到包中？

下面是我的 java 主应用程序，它正在启动 OSGi 框架，然后尝试安装一个依赖于 Log4j 的简单包。将来，我也可以拥有其他第三方 maven 依赖项..

public class OSGiTest 

    private static Framework framework;

    public static void main(String[] args) 

        try 
            FileUtils.deleteDirectory(new File("felix-cache"));
            FrameworkFactory frameworkFactory = ServiceLoader.load(FrameworkFactory.class).iterator().next();

            framework = frameworkFactory.newFramework(new HashMap<String, String>());
            framework.start();

            installAndStartBundle("DependencyBundle", "1.0.0");

         catch (IOException e) 
            e.printStackTrace();
         catch (BundleException e) 
            e.printStackTrace();
         catch (Exception e) 
            e.printStackTrace();
        
    

    public static void installAndStartBundle(final String name, final String version) throws BundleException, Exception 

        final String basePath = "S:\\maven.repo\\dependency\\DependencyBundle\\1.0.0";
        final BundleContext bundleContext = framework.getBundleContext();
        final List<Bundle> installedBundles = new LinkedList<Bundle>();

        BundleActivator b = new org.ops4j.pax.url.mvn.internal.Activator();
        b.start(bundleContext);

        String filename = name + ModelConstants.DASH + version + ModelConstants.DOTJAR;
        String localFilename = ModelConstants.FILE_PROTOCOL + basePath+ File.separatorChar + filename;

        installedBundles.add(bundleContext.installBundle(localFilename));

        for (Bundle bundle : installedBundles) 
            bundle.start();
        
    

下面是我的 OSGi 包的 pom.xml 文件DependencyBundle-

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!-- POM Information about the Project -->
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.host.personalize.goldeneye.dependency</groupId>
    <artifactId>DependencyBundle</artifactId>
    <version>1.0.0</version>
    <!-- Packing Type is bundle for OSGI Library Bundle -->
    <packaging>bundle</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>org.springframework.beans</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>org.springframework.context</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>org.springframework.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.servicemix.bundles</groupId>
            <artifactId>org.apache.servicemix.bundles.cglib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
            <version>4.3.0</version><!--$NO-MVN-MAN-VER$ -->
            <type>jar</type>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
            <version>4.3.0</version><!--$NO-MVN-MAN-VER$ -->
            <type>jar</type>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

    <!-- Build Configration -->
    <build>
        <plugins>
            <!-- Apache Felix Bundle Plugin - For Generation of Manifest after Compile 
                phase -->
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <!-- Configuration for generating the Manifest.mf -->
                <configuration>
                    <manifestLocation>src/main/resources/META-INF</manifestLocation>
                    <!-- Manifest Headers which need to customized during manifest generation -->
                    <instructions>
                        <Bundle-SymbolicName>DependencyBundle</Bundle-SymbolicName>
                        <Bundle-Activator>com.host.personalize.goldeneye.dependency.dependencybundle.Activator</Bundle-Activator>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

【参考方案1】：

如果您刚刚开始，为什么要通过管理框架运行时的复杂性来深入了解？

采取更简单、可以说更短的路线，并从预构建运行时开始，例如Apache Karaf，您可以使用pax-url 项目的maven url handler from the command line 简单地安装捆绑包，也可以使用wrap: protocol 来安装包为依赖项动态添加有效的 OSGi 清单。

一旦您知道自己在做什么，就可以了解并构建自己的。

【讨论】：

不错的答案，Karaf 还支持使用功能文件配置多个捆绑包：karaf.apache.org/manual/latest-2.3.x/users-guide/…

感谢earcam 的建议。现在写，我使用 Felix 作为 OSGi 容器，如果我需要使用 Karaf，那么如何通过 Java 代码以编程方式启动 OSGi 容器？如果可能，您能否提供一个使用 Apache Karaf 作为 OSGi 容器并像我上面的用例一样安装捆绑包的简单示例？

这可能会很困难，但是如果您打算从一开始就嵌入，您可以使用具有最小依赖项（没有？）的 pax-url maven 处理程序和 Felix/Equinox。

所以你是说我应该像我目前正在做的那样将 Felix 作为容器，但我可以使用 pax-url maven 处理程序安装 Log4j 依赖项？如果是，你能提供一个简单的例子吗？我不知道 pax-url maven 处理程序以及如何使用它..

不 - 我是说像 Karaf 这样对初学者友好的运行时学习。一旦你掌握了这些概念，那么对于你正在尝试做的很多事情，你会找到一种更好、不同的方法。例如，您会发现另一个 pax 项目 pax-logging 为所有不同的日志记录提供程序提供了一个很好的包装器。