Tycho 2.5.0中获取ServiceReference始终为null的JUnit插件测试问题

问题根源分析 #

服务引用返回null通常由类型不匹配、依赖缺失、启动时机错误、类加载器不一致等原因导致，结合你的代码逐一排查：

1. 修正服务注册与获取的类型一致性 #

第一个插件注册的服务类型是IFileAidExUiApiService，但第二个插件尝试获取的是XYZ.class或当前Activator类，类型完全不匹配，这是核心问题。必须使用注册时的服务接口类来获取：

// 第二个插件Activator的start方法中修正获取逻辑
@Override
public void start(BundleContext bundleContext) throws Exception {
    super.start(bundleContext);
    // 用注册时的接口类获取服务引用
    ServiceReference<IFileAidExUiApiService> faUiApiServiceRef = 
        bundleContext.getServiceReference(IFileAidExUiApiService.class);
    if (faUiApiServiceRef != null) {
        IFileAidExUiApiService service = bundleContext.getService(faUiApiServiceRef);
        // 处理服务实例
    }
    plugin = this;
}

2. 确保插件间依赖声明正确 #

• 第一个插件：在MANIFEST.MF中导出服务接口所在的包：

  Export-Package: com.your.package.api;version="1.0.0"
  

• 第二个插件：在MANIFEST.MF中导入该接口包：

  Import-Package: com.your.package.api;version="[1.0.0,2.0.0)"
  

3. 处理服务获取的时机问题 #

OSGi插件启动顺序不固定，第二个插件的start方法执行时，第一个插件可能还未完成服务注册。推荐使用以下两种方式替代同步获取：

方式一：使用ServiceTracker监听服务 #

private ServiceTracker<IFileAidExUiApiService, IFileAidExUiApiService> serviceTracker;

@Override
public void start(BundleContext bundleContext) throws Exception {
    super.start(bundleContext);
    serviceTracker = new ServiceTracker<>(bundleContext, IFileAidExUiApiService.class, null);
    serviceTracker.open();
    // 后续可通过serviceTracker.get()获取服务，或自定义ServiceTrackerCustomizer处理注册事件
}

@Override
public void stop(BundleContext bundleContext) throws Exception {
    if (serviceTracker != null) {
        serviceTracker.close();
    }
    super.stop(bundleContext);
}

方式二：使用Declarative Services（DS，推荐） #

在组件类中通过注解自动注入服务：

@Component
public class YourBusinessComponent {
    private IFileAidExUiApiService uiApiService;

    @Reference
    public void setUiApiService(IFileAidExUiApiService service) {
        this.uiApiService = service;
        // 服务可用时执行逻辑
    }

    public void unsetUiApiService(IFileAidExUiApiService service) {
        this.uiApiService = null;
        // 服务注销时执行清理逻辑
    }
}

4. 验证Tycho构建配置 #

• 确保两个插件在Tycho的pom.xml中被正确纳入构建范围，依赖关系声明正确。
• 检查target platform包含Equinox等必要的OSGi基础bundle，保证服务注册/获取API正常工作。

5. 排查类加载器问题 #

确保IFileAidExUiApiService接口在两个插件中是同一个类实例：

• 不要将接口类同时打包在两个插件中，仅由第一个插件导出，第二个插件导入。
• 保证导入/导出的包版本一致，避免类加载器隔离导致的类型不匹配。

内容的提问来源于stack exchange，提问作者Birudeo Garande