React Native Android原生模块compileOnly可选依赖实现求助

这个问题我之前也踩过坑——纯Android项目里用compileOnly做可选依赖非常顺畅，但放到React Native模块里就直接触发了运行时ClassNotFoundException。核心原因是RN的打包机制和纯Android不同：你的RN模块会被打包成AAR，主应用依赖这个AAR时，如果主应用没有显式引入compileOnly标记的SDK，运行时虚拟机就找不到对应的类，直接抛出异常。

要在不拆分插件的前提下实现可选SDK支持，核心思路是用反射安全访问可选SDK的API，同时在代码里做存在性检查，避免直接引用导致的运行时错误。下面是具体的实现步骤：

1. 保留compileOnly依赖，同时添加代码安全防护 #

在你的RN模块的build.gradle里，继续用compileOnly声明这两个Firebase SDK：

dependencies {
    compileOnly 'com.google.firebase:firebase-messaging:23.0.0'
    compileOnly 'com.google.firebase:firebase-inappmessaging-display:20.3.0'
    // 其他依赖...
}

注意：所有涉及这两个SDK的代码，绝对不能直接import或者硬引用类，必须通过反射来访问。

2. 封装工具类做SDK存在性检查与反射调用 #

创建一个工具类，专门处理可选SDK的检测和方法调用，比如FirebaseOptionalUtils.java：

import com.facebook.react.bridge.Promise;
import java.lang.reflect.Method;
import com.google.android.gms.tasks.Task;

public class FirebaseOptionalUtils {

    // 检查Firebase Messaging是否可用
    public static boolean isMessagingAvailable() {
        try {
            Class.forName("com.google.firebase.messaging.FirebaseMessaging");
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }

    // 检查In-App Messaging是否可用
    public static boolean isInAppMessagingAvailable() {
        try {
            Class.forName("com.google.firebase.inappmessaging.FirebaseInAppMessaging");
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }

    // 反射获取FCM Token（示例）
    public static void getFCMToken(Promise promise) {
        if (!isMessagingAvailable()) {
            promise.reject("MESSAGING_UNAVAILABLE", "Firebase Messaging is not included in the app");
            return;
        }

        try {
            // 通过反射获取FirebaseMessaging实例
            Class<?> messagingClass = Class.forName("com.google.firebase.messaging.FirebaseMessaging");
            Method getInstanceMethod = messagingClass.getMethod("getInstance");
            Object messagingInstance = getInstanceMethod.invoke(null);

            // 调用getToken方法
            Method getTokenMethod = messagingClass.getMethod("getToken");
            Task<String> tokenTask = (Task<String>) getTokenMethod.invoke(messagingInstance);

            // 处理Task的回调，将结果返回给JS
            tokenTask.addOnCompleteListener(task -> {
                if (task.isSuccessful()) {
                    promise.resolve(task.getResult());
                } else {
                    promise.reject("TOKEN_ERROR", task.getException());
                }
            });

        } catch (Exception e) {
            promise.reject("REFLECTION_ERROR", e);
        }
    }

    // 同理，可以封装In-App Messaging的相关方法
}

3. 在RN原生模块中调用工具类，暴露给JS端 #

在你的RN模块类里，调用工具类的方法，给JS端提供功能入口和可用性检查：

import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;
import com.facebook.react.bridge.Promise;

public class FirebaseNativeModule extends ReactContextBaseJavaModule {

    public FirebaseNativeModule(ReactApplicationContext reactContext) {
        super(reactContext);
    }

    @Override
    public String getName() {
        return "FirebaseNativeModule";
    }

    // 给JS端提供检查Messaging是否可用的方法
    @ReactMethod
    public void isMessagingAvailable(Promise promise) {
        promise.resolve(FirebaseOptionalUtils.isMessagingAvailable());
    }

    // 给JS端提供获取FCM Token的方法
    @ReactMethod
    public void getFCMToken(Promise promise) {
        FirebaseOptionalUtils.getFCMToken(promise);
    }

    // 同理添加In-App Messaging的相关方法...
}

4. 给主应用提供清晰的使用文档 #

一定要在插件的README里明确说明：

• 如果需要使用Firebase Messaging功能，主应用必须在自己的app/build.gradle里添加：

  implementation 'com.google.firebase:firebase-messaging:23.0.0'
  

• 如果需要使用In-App Messaging功能，主应用必须添加：

  implementation 'com.google.firebase:firebase-inappmessaging-display:20.3.0'
  

• JS端在调用功能前，建议先调用isMessagingAvailable()或isInAppMessagingAvailable()检查可用性，避免无意义的错误。

额外优化：动态注册模块（可选） #

如果你的两个SDK对应不同的RN模块，还可以在Package类里动态注册模块——只有当检测到SDK存在时，才注册对应的模块：

import com.facebook.react.ReactPackage;
import com.facebook.react.bridge.NativeModule;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.uimanager.ViewManager;
import java.util.ArrayList;
import java.util.List;

public class FirebasePackage implements ReactPackage {

    @Override
    public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
        List<NativeModule> modules = new ArrayList<>();
        // 不管有没有SDK，都添加基础模块
        modules.add(new FirebaseNativeModule(reactContext));

        // 如果Messaging可用，注册专门的Messaging模块
        if (FirebaseOptionalUtils.isMessagingAvailable()) {
            modules.add(new FirebaseMessagingModule(reactContext));
        }

        // 如果In-App Messaging可用，注册专门的InAppMessaging模块
        if (FirebaseOptionalUtils.isInAppMessagingAvailable()) {
            modules.add(new FirebaseInAppMessagingModule(reactContext));
        }

        return modules;
    }

    // 其他方法...
}

这样做的好处是，主应用没引入对应SDK时，JS端甚至看不到对应的模块，减少了混淆。

这种方案既能让你的单个插件支持多个可选SDK，又能让不需要某些功能的主应用避免引入额外体积，完美解决你遇到的问题。

内容的提问来源于stack exchange，提问作者Piyush Kukadiya