OSGI传递依赖管理及Spark Servlet在Karaf部署依赖问题咨询

我完全理解你手动解决OSGi包依赖wiring问题的痛苦——这种逐个踩坑的方式确实效率极低。下面是一套更高效的方法，帮你在Karaf中正确使用Spark Servlet构建REST服务：

1. 优先使用OSGi适配版的Spark依赖 #

OSGi的类加载模型和普通Java应用完全不同，直接用Maven中央仓库的普通spark-core依赖很容易触发包冲突或wiring错误。你应该优先选择已经被OSGi化的Spark包，比如Apache ServiceMix提供的适配bundle：

<dependency>
    <groupId>org.apache.servicemix.bundles</groupId>
    <artifactId>org.apache.servicemix.bundles.spark-core</artifactId>
    <version>2.4.8_1</version> <!-- 选择对应Spark版本的适配版 -->
    <scope>provided</scope> <!-- 让Karaf容器来提供这个bundle，避免嵌入 -->
</dependency>

这类适配包已经正确配置了Export-Package和Import-Package声明，Karaf能直接识别并处理依赖关系，不用你手动调整。

2. 用Maven Bundle插件生成合规的OSGi Bundle #

如果你需要把自己的代码打包成OSGi Bundle，一定要用maven-bundle-plugin来生成正确的MANIFEST.MF文件，这是OSGi Bundle的核心配置。关键配置要点：

• 只导出你自己的业务包：不要导出Spark相关的包，避免和容器中的其他bundle冲突
• 自动分析导入包：用*让插件自动扫描代码依赖的包，对非必须的依赖添加resolution:=optional标记，减少强制依赖导致的wiring问题
• 谨慎嵌入依赖：除非完全没有OSGi适配版的依赖，否则不要轻易嵌入。如果必须嵌入，只嵌入小依赖并关闭传递嵌入，避免引入整个依赖树

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.felix</groupId>
            <artifactId>maven-bundle-plugin</artifactId>
            <version>4.2.1</version>
            <extensions>true</extensions>
            <configuration>
                <instructions>
                    <Bundle-SymbolicName>com.yourcompany.osgi-spark-rest</Bundle-SymbolicName>
                    <Bundle-Name>OSGi Spark REST Service</Bundle-Name>
                    <Export-Package>com.yourcompany.spark.rest.api</Export-Package>
                    <Import-Package>
                        spark.*,
                        javax.servlet.*,
                        org.osgi.service.http.*,
                        *;resolution:=optional
                    </Import-Package>
                    <!-- 仅在必要时嵌入非OSGi依赖 -->
                    <Embed-Dependency>your-custom-lib;scope=compile</Embed-Dependency>
                    <Embed-Transitive>false</Embed-Transitive>
                </instructions>
            </configuration>
        </plugin>
    </plugins>
</build>

3. 利用Karaf工具快速定位和解决依赖问题 #

不要盲目手动排查依赖，Karaf提供了实用工具帮你快速定位问题：

• bundle:diagnose <bundle-id>：运行这个命令，Karaf会详细告诉你bundle缺少哪些导入包、版本不匹配等问题，直接根据提示安装对应的bundle即可
• 使用Karaf Feature：很多流行库（包括Spark）有对应的Karaf Feature，你可以通过feature:repo-add添加对应的feature仓库，然后用feature:install spark一键安装所有依赖的bundle，完全不用手动处理依赖链

4. 正确集成Spark Servlet到Karaf的Web容器 #

Spark Servlet本质是一个Servlet，在OSGi环境下，不要让Spark自己启动嵌入式服务器，而是把它注册到Karaf内置的Http Service（比如Pax Web）：

1. 在你的bundle中获取OSGi的HttpService实例
2. 创建Spark的SparkServlet实例，绑定你的路由逻辑
3. 通过HttpService.registerServlet()方法将Spark Servlet注册到Karaf的Web容器中

这种方式可以复用Karaf的Web服务，避免端口冲突和类加载隔离问题。

内容的提问来源于stack exchange，提问作者John Lippson