使用AIDL實現跨程式介面回掉

H.Y.發表於2019-05-07

        同一個程式內實現介面回掉很簡單,這裡不做敘述,本文主要講的是跨程式的介面回掉實現方式。有一種跨程式通訊的方式就是使用AIDL,但是單純的AIDL通訊只可以實現客戶端訪問服務端主動獲取Binder物件,如果服務端有變化無法及時通知客戶端。現在可以通過跨程式的介面回掉來解決服務端發生變化通知客戶端的問題。

         可以使用使用RemoteCallbackList來實現對IInterface的管理。public class RemoteCallbackList<E extends IInterface>

首先定義兩個AIDL檔案:

  1. ITestCallBack.aidl
    interface ITestCallBack {
        /**
         * Demonstrates some basic types that you can use as parameters
         * and return values in AIDL.
         */
        void onTagValid(in String tag);
    
    }
    複製程式碼
  2. ITestInterface.aidl    在註冊和反祖冊方法中,需要傳入ITestCallBack的物件
    interface ITestInterface {
        /**
         * Demonstrates some basic types that you can use as parameters
         * and return values in AIDL.
         */
         boolean isTagValid(in String tag);
    
         void registerCallback(in String tag, in ITestCallBack callback);
    
         void unRegisterCallback(in String tag, in ITestCallBack callback);
    }複製程式碼

服務端:

         建立Service,並且在service中定義RemoteCallbackList集合,實現ITestInterface.Stub,在registerCallback,和unRegisterCallback中,分別將ITestCallBack物件註冊和反註冊進RemoteCallbackList中。RemoteCallbackList提供了獲取註冊進去的IInterface物件方法。

//其實RemoteCallbackList類似於java中{@link java.util.Observable},用來批量處理介面回撥物件,
//其實如果確保只有一個客戶端會bind到這個服務,只需要儲存一個IMyAidlInterfaceCallback即可。
//但是如果有多個,強烈推薦使用其實RemoteCallbackList

public void callBack() {
    if (mCallBacks == null) {
        return;
    }
    int num = mCallBacks.beginBroadcast();
    for (int i = 0; i < num; i++) {
        try {
            mCallBacks.getBroadcastItem(i).onTagValid("congratulation callback success " + tag);
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }
    //結束後一定要使用finsh,否則下次執行beginBroadcast會丟擲IllegalStateException異常
    mCallBacks.finishBroadcast();
}複製程式碼

在isTagValid中可以呼叫callBack方法去遍歷註冊的介面物件,也可以當服務端有變化時主動呼叫callBack方法去通知客戶端,這樣就實現了服務端變化主動通知客戶端。可根據實際方法修改。

在service的onBind方法中,返回ITestInterface.Stub的物件即可,等待客戶端繫結服務端。

下面是服務端Service的程式碼:

public class TestService extends Service {

    private RemoteCallbackList<ITestCallBack> mCallBacks = new RemoteCallbackList<>();
    private String tag = "hy";

    public TestService() {
    }

    @Override
    public IBinder onBind(Intent intent) {
        // TODO: Return the communication channel to the service.
        return iTestInterface;
    }

    @Override
    public boolean onUnbind(Intent intent) {
        return super.onUnbind(intent);
    }

    ITestInterface.Stub iTestInterface = new ITestInterface.Stub() {
        @Override
        public boolean isTagValid(String tag) throws RemoteException {
            if (tag.equals(TestService.this.tag)) {
                callBack();
                return true;
            }
            return false;
        }

        @Override
        public void registerCallback(String tag, ITestCallBack callback) throws RemoteException {
            if (null != mCallBacks && null != callback) {
                mCallBacks.register(callback);
            }
        }

        @Override
        public void unRegisterCallback(String tag, ITestCallBack callback) throws RemoteException {
            if (null != mCallBacks && null != callback) {
                mCallBacks.unregister(callback);
            }
        }
    };

    public void callBack() {
        if (mCallBacks == null) {
            return;
        }
        int num = mCallBacks.beginBroadcast();
        for (int i = 0; i < num; i++) {
            try {
                mCallBacks.getBroadcastItem(i).onTagValid("congratulation callback success " + tag);
            } catch (RemoteException e) {
                e.printStackTrace();
            }
        }
        mCallBacks.finishBroadcast();
    }
}複製程式碼

客戶端:

        客戶端首先要做的是繫結服務端,實現AIDL的通訊,在客戶端建立繫結按鈕,解綁按鈕,和主動獲取資訊的通訊按鈕。在主動獲取資訊的通訊按鈕中實現iTestInterface物件的isTagValid方法可以主動去獲取服務端的資訊(服務端在isTagValid方法中呼叫了callBack方法)。

客戶端程式碼:

public class MainActivity extends AppCompatActivity {

    private String tag = "hy";
    private ITestInterface iTestInterface;
    private ServiceConnection connection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            iTestInterface = ITestInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            iTestInterface = null;
        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        bindService();
        ((Button) findViewById(R.id.buttonregister)).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    iTestInterface.registerCallback(tag, new ITestCallBack.Stub() {
                        @Override
                        public void onTagValid(String tag) throws RemoteException {
                            Log.e("test", "registerCallback: " + tag);
                        }
                    });
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });

        ((Button) findViewById(R.id.buttonunregister)).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    iTestInterface.unRegisterCallback(tag, new ITestCallBack.Stub() {
                        @Override
                        public void onTagValid(String tag) throws RemoteException {

                        }
                    });
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });

        ((Button) findViewById(R.id.buttonisvalid)).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    iTestInterface.isTagValid(tag);
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });
    }

    private void bindService() {
        Intent intent = new Intent();
        intent.setAction("com.example.heyang.myapplication.TestService");
        intent.setPackage("com.example.heyang.myapplication");
        boolean success = bindService(intent, connection, Context.BIND_AUTO_CREATE);
        if (success) {
            Log.e("test ", "bindService OK");
        } else {
            Log.e("test ", "bindService Fail");
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        unBindeService();
    }

    private void unBindeService() {
        try {
            unbindService(connection);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
複製程式碼


相關文章