Параметры связи с Android-библиотекой - PullRequest
0 голосов
/ 18 мая 2018

Допустим, у меня есть SDK в форме библиотеки Android (aar), который предлагает некоторую базовую обработку мультимедиа (он имеет свой собственный пользовательский интерфейс в виде отдельного действия).В настоящее время любое клиентское 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 Ответ

0 голосов
/ 22 мая 2018

Ваш 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 фактически запускаетservice и getBestCampaignPrediction запускают асинхронную задачу, которая связывается со службой за кулисами и возвращает ее результат в обратный вызов appInterface.Таким образом, пользователь получает очень простой API

...