Activity 到 Android 库的通信选项 (IPC)

Posted 2023-02-16

【中文标题】Activity 到 Android 库的通信选项 (IPC)

【英文标题】：Activity to Android Library communication options (IPC)

【发布时间】：2018-05-18 13:37:04

【问题描述】：

假设我有一个 android 库 (aar) 形式的 SDK，它提供一些基本的媒体处理（它有自己的 UI 作为单个活动）。目前，任何客户端 Android 应用程序在调用我的 SDK 时都会通过 Bundle 发送所需的数据。

现在，由于各种原因，在调用我的 SDK 后可能需要一些额外信息来发送数据，因此我需要与调用方应用进行双向通信。

简而言之，在 SDK 中，我需要能够检查客户端应用程序是否已实现某些接口，以便 SDK 可以使用它与客户端应用程序通信（在这种情况下，客户端可能会选择不提供实现SDK 将回退到内部，默认实现..)。

无论如何，我最初的做法如下：

在 SDK 中，我公开了数据提供者接口：

public interface ISDKDataProvider 

    void getMeSomething(Params param, Callback callback);

    SomeData getMeSomethingBlocking(Params param);

应返回已实现接口实例的本地绑定器接口：

public interface LocalBinder 
   ISDKDataProvider getService();

然后，在客户端，使用 SDK 的应用程序必须提供完成这项工作并实现这些接口的服务：

public class SDKDataProviderService extends Service implements ISDKDataProvider 
    private final IBinder mBinder = new MyBinder();

    @Override
    public IBinder onBind(Intent intent) 
        return mBinder;
    

    @Override
    public void getMeSomething(Params param, Callback callback) 
        // ... do something on another thread
        // once done, invoke callback and return result to the SDK
    

    @Override
    public SomeData getMeSomethingBlocking(Params param);
        // do something..
        // return SomeData
    

    public class MyBinder extends Binder implements LocalBinder 
        @Override
        public ISDKDataProvider getService() 
            return ISDKDataProvider.this;
        
    

另外，在调用 SDK 时，clinet 应用通过捆绑选项传递 ComponentName：

sdkInvokationOptions.put("DATA_PROVIDER_EXTRAS", new ComponentName(getPackageName(), SDKDataProviderService.class.getName()));

..从 SDK 中，然后我检查服务是否存在以及我们是否可以绑定到它：

final ComponentName componentName = // get passed componentname "DATA_PROVIDER_EXTRAS"

if (componentName != null) 

    final Intent serviceIntent = new Intent(componentName.getClassName());
    serviceIntent.setComponent(componentName);
    bindService(serviceIntent, mConnection, Context.BIND_AUTO_CREATE);

mConnection 在哪里：

private boolean mBound;
private ISDKDataProvider mService;
private ServiceConnection mConnection = new ServiceConnection() 
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) 
       final LocalBinder binder = (LocalBinder) service;
       mService = binder.getService();
       mBound = true;
    

    @Override
    public void onServiceDisconnected(ComponentName name) 
      mBound = false;
    
;

这似乎工作正常，看起来很干净，但我的问题是有更好的方法\实践来完成相同类型的通信吗？

【参考方案1】：

您的 API 应该很简单，例如静态类/单例：

MyAPI.start()
MyAPI.stop()
MyAPI.sendMessgage(mgs,callback)
MyAPI.setCallback(callback)

关于服务，我认为你应该决定谁来负责。

如果是用户 - 让他执行，只需提供 API。

如果您始终希望 API 作为服务运行，请自行实现并在单例中处理消息传递（例如，您可以通过意图来实现）。

我也将这种架构用于图像处理服务:)

我的 API 包装类看起来像：

public class MyAPI 
    public static final String TAG = "MyAPI";

    public MyAPI() 
    

    public static MyAPI.Result startMyAPI(ScanParams scanParams) 
        try 
            Log.d("MyAPI", "in startMyAPI");
            if (scanParams.ctx == null || scanParams.appID == null || scanParams.api_key == null) 
                Log.d("MyAPI", "missing parameters");
                return MyAPI.Result.FAILED;
            

            if (scanParams.userID == null) 
                scanParams.userID = "no_user";
            

            if (scanParams.minBatteryThreshold == null) 
                scanParams.minBatteryThreshold = Consts.DEFAULT_BATTERY_THRESHOLD;
            

            if (scanParams.minCpuThreshold == null) 
                scanParams.minCpuThreshold = Consts.DEFAULT_CPU_THRESHOLD;
            

            if (!DeviceUtils.checkBatteryLevel(scanParams.ctx, (float)scanParams.minBatteryThreshold)) 
                ReportUtils.error("low battery");
                return MyAPI.Result.FAILED;
            

            if (MyAPIUtils.isRunning(scanParams.ctx)) 
                return MyAPI.Result.FAILED;
            

            Intent intent = new Intent(scanParams.ctx, MyAPIService.class);
            ServiceParams serviceParams = new ServiceParams(scanParams.appID, scanParams.api_key, scanParams.userID, scanParams.minBatteryThreshold, scanParams.minCpuThreshold);
            intent.putExtra("SERVICE_PARAMS", serviceParams);
            scanParams.ctx.startService(intent);
         catch (Exception var3) 
            var3.printStackTrace();
        

        return MyAPI.Result.SUCCESS;
    

    public static void getBestCampaignPrediction(Context ctx, String apiKey, String appID, String creativeID, AppInterface appInterface) 
        try 
            String deviceID = DeviceUtils.getDeviceID(ctx);
            GetBestCampaignTask getBestCampaignTask = new GetBestCampaignTask(ctx, apiKey, deviceID, appID, creativeID, appInterface);
            getBestCampaignTask.execute(new Void[0]);
         catch (Exception var7) 
            var7.printStackTrace();
        

    

    public static boolean sendAdEvent(Context ctx, String apiKey, Event event) 
        boolean res = false;

        try 
            boolean isValid = Utils.getIsValid(ctx);
            if (isValid) 
                Long timeStamp = System.currentTimeMillis();
                event.setTimeStamp(BigDecimal.valueOf(timeStamp));
                event.setDeviceID(DeviceUtils.getDeviceID(ctx));
                (new SendEventTask(ctx, apiKey, event)).execute(new Void[0]);
            
         catch (Exception var6) 
            var6.printStackTrace();
        

        return res;
    

    public static enum PredictionLevel 
        MAIN_CATEGORY,
        SUB_CATEGORY,
        ATTRIBUTE;

        private PredictionLevel() 
        
    

    public static enum Result 
        SUCCESS,
        FAILED,
        LOW_BATTERY,
        LOW_CPU,
        NOT_AUTHENTICATED;

        private Result() 
        
    

您可以看到 startMyAPI 实际上启动了一个服务，而 getBestCampaignPrediction 运行一个异步任务，该任务在后台与该服务通信并将其结果返回给 appInterface 回调。这样用户就可以得到一个非常简单的 API

【讨论】：

感谢您的回答，但我不太清楚。我的要求是在 AAR 中我定义一个接口，客户端应用程序（链接到该 AAR）有机会实现它并以某种方式将具体实现传递给 ARR，以便它可以使用它。通信需要是双向的：aar 调用异步调用，一旦完成，结果将返回给 aar。另外，我想避免任何单身人士:)

您描述的场景正是我编写此代码所需要的。我认为您应该自己实现服务和异步任务。在附加代码中，您可以看到 startMyAPI 实际上启动了一个服务，getBestCampaignPrediction 运行一个异步任务，该任务在后台与服务通信并将其结果返回给 appInterface 回调。这样用户就可以得到一个非常简单的 API。

您的实现在很多方面都是正确的。如果您确实需要调用者为您的 SDK 任务实现服务，那么您应该切换到 AIDL。例如，Google Play Billing 库做同样的事情。它公开并且 AIDL 和调用者客户端必须通过服务来实现它。但唯一的问题是 AIDL 的实施。它还允许 usr SDK 使用者在单独的进程中运行您的 SDK。因此，在某些不需要的情况下，如果您的 SDK 崩溃，它不会导致消费者应用程序崩溃。