Framework 原始碼解析知識梳理(3) 應用程式之間的通訊實現

澤毛發表於2017-12-21

一、前言

Framework 原始碼解析知識梳理(1) - 應用程式與 AMS 的通訊實現Framework 原始碼解析知識梳理(2) - 應用程式與 WMS 的通訊實現 這兩篇文章中,我們介紹了應用程式與AMS以及WMS之間的通訊實現,但是邏輯還是比較繞的,為了方便大家更好地理解,我們介紹一下大家見得比較多的應用程式間通訊的實現。

二、例子

說起應用程式之間的通訊,相信大家都不陌生,應用程式之間通訊最常用的方式就是AIDL,下面,我們先演示一個AIDL的簡單例子,接下來,我們再分析它的內部實現。

2.1 服務端

2.1.1 編寫 AIDL 檔案

第一件事,就是服務端需要宣告自己可以為客戶端提供什麼功能,而這一宣告則需要通過一個.aidl檔案來實現,我們先簡要介紹介紹一下AIDL檔案:

  • AIDL檔案的字尾為*.aidl
  • 對於AIDL預設支援的資料型別,是不需要匯入包的,這些預設的資料型別包括:
  • 基本資料型別:byte/short/int/long/float/double/boolean/char
  • String/CharSequence
  • List<T>:其中T必須是AIDL支援的型別,或者是其它AIDL生成的介面,或者是實現了Parcelable介面的物件,List支援泛型
  • Map:它的要求和List類似,但是不支援泛型
  • Tag標籤:對於介面方法中的形參,我們需要用in/out/inout三種關鍵詞去修飾:
  • in:表示服務端會收到客戶端的完整物件,但是在服務端對這個物件的修改不會同步給客戶端
  • out:表示服務端會收到客戶端的空物件,它對這個物件的修改會同步到客戶端
  • inout:表示服務端會收到客戶端的完整物件,它對這個物件的修改會同步到客戶端

說了這麼多,我們最常見的需求無非就是兩個:讓複雜物件實現Parcelable介面實現傳輸以及定義介面方法。

(1) Parcelable 的實現

我們可以很方便地通過AS外掛來讓某個物件實現Parcelable介面,並自動補全要實現的方法:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
安裝完之後重啟,我們原本的物件為:

public class InObject {

    private int inData;

    public int getInData() {
        return inData;
    }

    public void setInData(int inData) {
        this.inData = inData;
    }
    
}
複製程式碼

在檔案的空白處,點選右鍵Generate -> Parcelable

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
它就會幫我們實現Parcelable中的介面:

public class InObject implements Parcelable {

    private int inData;

    public int getInData() {
        return inData;
    }

    public void setInData(int inData) {
        this.inData = inData;
    }

    public InObject() {}

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeInt(this.inData);
    }

    protected InObject(Parcel in) {
        this.inData = in.readInt();
    }

    public static final Parcelable.Creator<InObject> CREATOR = new Parcelable.Creator<InObject>() {
        @Override
        public InObject createFromParcel(Parcel source) {
            return new InObject(source);
        }

        @Override
        public InObject[] newArray(int size) {
            return new InObject[size];
        }
    };
}
複製程式碼

(2) 編寫 AIDL 檔案

點選File -> New -> AIDL -> AIDL File之後,會多出一個名叫aidl的資料夾,之後我們所有需要用到的aidl檔案都被存放在這裡:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
初始時候,AS為我們生成的AIDL檔案為:

// AIDLInterface.aidl
package com.demo.lizejun.binderdemoclient;

// Declare any non-default types here with import statements

interface AIDLInterface {
    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
            double aDouble, String aString);
}
複製程式碼

當我們編譯之後,就會在下面這個路徑中生成一個Java檔案:

/*
 * This file is auto-generated.  DO NOT MODIFY.
 * Original file: /home/lizejun/Repository/RepoGithub/BinderDemo/app/src/main/aidl/com/demo/lizejun/binderdemoclient/AIDLInterface.aidl
 */
package com.demo.lizejun.binderdemoclient;
// Declare any non-default types here with import statements

public interface AIDLInterface extends android.os.IInterface {
    /**
     * Local-side IPC implementation stub class.
     */
    public static abstract class Stub extends android.os.Binder implements com.demo.lizejun.binderdemoclient.AIDLInterface {
        private static final java.lang.String DESCRIPTOR = "com.demo.lizejun.binderdemoclient.AIDLInterface";

        /**
         * Construct the stub at attach it to the interface.
         */
        public Stub() {
            this.attachInterface(this, DESCRIPTOR);
        }

        /**
         * Cast an IBinder object into an com.demo.lizejun.binderdemoclient.AIDLInterface interface,
         * generating a proxy if needed.
         */
        public static com.demo.lizejun.binderdemoclient.AIDLInterface asInterface(android.os.IBinder obj) {
            if ((obj == null)) {
                return null;
            }
            android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
            if (((iin != null) && (iin instanceof com.demo.lizejun.binderdemoclient.AIDLInterface))) {
                return ((com.demo.lizejun.binderdemoclient.AIDLInterface) iin);
            }
            return new com.demo.lizejun.binderdemoclient.AIDLInterface.Stub.Proxy(obj);
        }

        @Override
        public android.os.IBinder asBinder() {
            return this;
        }

        @Override
        public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException {
            switch (code) {
                case INTERFACE_TRANSACTION: {
                    reply.writeString(DESCRIPTOR);
                    return true;
                }
                case TRANSACTION_basicTypes: {
                    data.enforceInterface(DESCRIPTOR);
                    int _arg0;
                    _arg0 = data.readInt();
                    long _arg1;
                    _arg1 = data.readLong();
                    boolean _arg2;
                    _arg2 = (0 != data.readInt());
                    float _arg3;
                    _arg3 = data.readFloat();
                    double _arg4;
                    _arg4 = data.readDouble();
                    java.lang.String _arg5;
                    _arg5 = data.readString();
                    this.basicTypes(_arg0, _arg1, _arg2, _arg3, _arg4, _arg5);
                    reply.writeNoException();
                    return true;
                }
            }
            return super.onTransact(code, data, reply, flags);
        }

        private static class Proxy implements com.demo.lizejun.binderdemoclient.AIDLInterface {
            private android.os.IBinder mRemote;

            Proxy(android.os.IBinder remote) {
                mRemote = remote;
            }

            @Override
            public android.os.IBinder asBinder() {
                return mRemote;
            }

            public java.lang.String getInterfaceDescriptor() {
                return DESCRIPTOR;
            }

            /**
             * Demonstrates some basic types that you can use as parameters
             * and return values in AIDL.
             */
            @Override
            public void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat, double aDouble, java.lang.String aString) throws android.os.RemoteException {
                android.os.Parcel _data = android.os.Parcel.obtain();
                android.os.Parcel _reply = android.os.Parcel.obtain();
                try {
                    _data.writeInterfaceToken(DESCRIPTOR);
                    _data.writeInt(anInt);
                    _data.writeLong(aLong);
                    _data.writeInt(((aBoolean) ? (1) : (0)));
                    _data.writeFloat(aFloat);
                    _data.writeDouble(aDouble);
                    _data.writeString(aString);
                    mRemote.transact(Stub.TRANSACTION_basicTypes, _data, _reply, 0);
                    _reply.readException();
                } finally {
                    _reply.recycle();
                    _data.recycle();
                }
            }
        }

        static final int TRANSACTION_basicTypes = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0);
    }

    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    public void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat, double aDouble, java.lang.String aString) throws android.os.RemoteException;
}
複製程式碼

整個結構圖為:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
有沒有感覺在 Framework 原始碼解析知識梳理(1) - 應用程式與 AMS 的通訊實現Framework 原始碼解析知識梳理(2) - 應用程式與 WMS 的通訊實現 中也見到過類似的東西 asInterface/asBinder/transact/onTransact/Stub/Proxy...,這個我們之後再來解釋,下面我們介紹服務端的第二步操作。

2.1.2 編寫 Service

既然服務端已經定義好了介面,那麼接下來就服務端就需要實現這些介面:

public class AIDLService extends Service {

    private final AIDLInterface.Stub mBinder = new AIDLInterface.Stub() {
        @Override
        public void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat, double aDouble, String aString) throws RemoteException {
            Log.d("basicTypes", "basicTypes");
        }
    };

    @Nullable
    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }
}
複製程式碼

在這個Service中,我們只需要實現AIDLInterface.Stub介面中的basicTypes介面就可以了,它就是我們在AIDL檔案中定義的介面,再把這個物件通過onBinde方法返回。

2.1.3 宣告 Service

最後一步,在AndroidManifest.xml檔案中宣告這個Service

        <service
            android:name=".server.AIDLService"
            android:enabled="true"
            android:exported="true">
        </service>
複製程式碼

2.2 客戶端

2.2.1 編寫 AIDL 檔案

和服務端類似,客戶端也需要和服務端一樣,生成一個相同的AIDL檔案,這裡就不多說了:

// AIDLInterface.aidl
package com.demo.lizejun.binderdemoclient;

// Declare any non-default types here with import statements

interface AIDLInterface {
    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
            double aDouble, String aString);
}
複製程式碼

和服務端類似,我們也會得到一個由aidl生成的Java介面檔案。

2.2.2 繫結服務,並呼叫

(1) 繫結服務

    private void bind() {
        Intent intent = new Intent();
        intent.setComponent(new ComponentName("com.demo.lizejun.binderdemo", "com.demo.lizejun.binderdemo.server.AIDLService"));
        boolean result = bindService(intent, mServiceConnection, BIND_AUTO_CREATE);
        Log.d("bind", "result=" + result);
    }

    private ServiceConnection mServiceConnection = new ServiceConnection() {

        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            mBinder = AIDLInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            mBinder = null;
        }
    };
複製程式碼

(2) 呼叫介面

    public void sayHello(View view) {
        try {
            if (mBinder != null) {
                mBinder.basicTypes(0, 0, false, 0, 0, "aaa");
            }
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }
複製程式碼

之後我們列印出響應的log

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現

三、實現原理

下面,我們就一起來分析一下通過AIDL實現的程式間通訊的原理。

**(1) 客戶端獲得服務端的遠端代理物件 IBinder **

我們從客戶端說起,當我們在客戶端呼叫了bindService方法之後,就會啟動服務端實現的AIDLService,而在該AIDLServiceonBind()方法中返回了AIDLInterface.Stub的實現類,繫結成功之後,客戶端就通過onServiceConnected的回撥,得到了它在客戶端程式的遠端代理物件IBinder

(2) AIDLInterface.Stub.asInterface(IBinder)

在拿到這個IBinder物件之後,我們通過AIDLInterface.Stub.asInterface(IBinder)方法,對這個IBinder進行了一層包裝,轉換成為AIDLInterface介面類,那麼這個AIDLInterface是怎麼來的呢,它就是通過我們在客戶端定義的aidl檔案在編譯時生成的,可以看到,最終asInterface方法會返回給我們一個AIDLInterface的實現類ProxyIBinder則被儲存為它內部的一個成員變數mRemote

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
也就是說,我們在客戶端中儲存的mBinder實際上是一個由AIDL檔案所生成的Proxy物件。

(3) 呼叫 AIDLInterface 的介面方法

Proxy實現了AIDLInterface中定義的介面方法,當我們呼叫它的介面方法時:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
實際上是通過它內部的mRemote物件的transact方法傳送訊息:
Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現

(4) 服務端接收訊息

那麼客戶端傳送的這一訊息去哪裡了呢,回想一下在服務端中通過onBind()放回的IBinder,它其實是由AIDL檔案生成的AIDLInterface.java中的內部類Stub的實現,而在Stub中有一個回撥函式onTransact,當我們通過客戶端傳送訊息之後,那麼服務端的Stub物件就會通過onTransact收到這一傳送的訊息:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現

(5) 呼叫子類的處理邏輯

onTransact方法中,又會去呼叫AIDLInterface定義的介面:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現

而我們在服務端AIDLService中實現了該介面,因此,最終就列印出了我們在上面所看到的文字:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現

四、進一步討論

現在,我們通過這一程式間的通訊過程來複習一下前面兩篇文章中討論的應用程式與AMSWMS之間的通訊實現。

Framework 原始碼解析知識梳理(1) - 應用程式與 AMS 的通訊實現 中,AMS所在程式在收到訊息之後,進行了下面的處理邏輯:

Framework 原始碼解析知識梳理(3)   應用程式之間的通訊實現
這裡面的處理邏輯就相當於我們在客戶端中onServiceConnected中做的工作一樣,IApplicationThread實際上是一個ApplicaionThreadProxy物件,和我們上面AIDLInterface實際上是一個AIDLInterface.Stub.Proxy的原理是一樣的。當我們呼叫了它的介面方法時,就是通過內部的mRemote傳送了訊息。

AMS通訊中,接收訊息的是應用程式中的ApplicationThread,而我們上面例子中接收訊息的是服務端程式的AIDLInterface.Stub的實現類mBinder,同樣是在onTransact()方法中接收訊息,再由子類去實現處理的邏輯。

Framework 原始碼解析知識梳理(2) - 應用程式與 WMS 的通訊實現 中的原理就更好解釋了,因為它就是通過AIDL來實現的,我們從客戶端向WMS所在程式建立會話時,是通過IWindowSession來實現的,會話過程中IWindowSession就對應於AIDLInterface,而WMS中的IWindowSession.Stub的實現類Session,就對應於上面我們在AIDLService中定義的AIDLInterface.Stub的實現類mBinder

五、小結

其實AIDL並沒有什麼神祕的東西,它的本質就是Binder通訊,我們定義aidl檔案的目的,主要有兩個:

  • 為了讓應用程式間通訊的實現者不用再去編寫transact/onTransact裡面的程式碼,因為這些東西和業務邏輯是無關的,只不過是簡單的傳送訊息、接收訊息。
  • 讓服務端、客戶端只關心介面的定義。

如果我們明白了AIDL的原理,那麼我們完全可以不用定義AIDL檔案,自己去參考由AIDL檔案所生成的Java檔案的邏輯,進行訊息的傳送和處理。


更多文章,歡迎訪問我的 Android 知識梳理系列:

相關文章