在上一篇文章中 Android AIDL 教程 (一）—— 簡單的示例，我們介紹了怎樣使用 AIDL 進行程序間的通訊，並簡單寫了一個 Demo，今天，讓我們一起來學習怎樣在 AIDL 中傳遞物件。

回顧，在上一篇部落格中，我們講到 AIDL 支援以下型別。

• Java 程式語言中的所有原語型別（如 int、long、char、boolean 等等）
• String
• CharSequence
• List
  List 中的所有元素都必須是以上列表中支援的資料型別、其他 AIDL 生成的介面或您宣告的可打包型別。 可選擇將 List 用作“通用”類（例如，List）。另一端實際接收的具體類始終是 ArrayList，但生成的方法使用的是 List 介面。
• Map
  Map 中的所有元素都必須是以上列表中支援的資料型別、其他 AIDL 生成的介面或您宣告的可打包型別。 不支援通用 Map，如 Map

Server (服務端的實現）

在上一篇部落格已經說到，服務端主要有三個步驟

• 將請求抽象成介面，並編寫 aidl 檔案；
• 編寫一個 Service，實現介面，處理客戶端的請求，並將 binder 返回回去；
• 在 AndroidManifet 配置 Service，將我們的 Service 暴露出去。

將請求抽象成介面，並編寫 aidl 檔案

首先我們先來看一下 IPlayService aidl 檔案，下面的程式碼中，我們定義了一個 play 方法，有兩個引數，name 是代表歌曲的名字，IPlayListener 是一個介面。需要注意的是它不是一個 java 類，是 aid 檔案l

package xj.musicserver;

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

import xj.musicserver.IPlayListener;

interface IPlayService {
    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
   void play(String name,IPlayListener iPlayListener);

}
 

package xj.musicserver;

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

import xj.musicserver.MusicInfo;

interface IPlayListener {
    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void onError(int code);
    void onSuccess(int code,in MusicInfo musicInfo);


 }

接下來我們再來看一下我們的實體類 MusicInfo，實現了 Parceable 介面

//下面是自定義的一個MusicInfo子類，實現了Parcelable
public class MusicInfo implements Parcelable {
    private long id;
    private String title;
    private String album;
    private int duration;
    private long size;
    private String artist;
    private String url;
    private String displayName;

    public MusicInfo(long id, String title, String album, int duration, long size, String artist,
                     String url, String displayName) {
        this.id = id;
        this.title = title;
        this.album = album;
        this.duration = duration;
        this.size = size;
        this.artist = artist;
        this.url = url;
        this.displayName = displayName;
    }

    public MusicInfo(){

    }


    protected MusicInfo(Parcel in) {
        id = in.readLong();
        title = in.readString();
        album = in.readString();
        duration = in.readInt();
        size = in.readLong();
        artist = in.readString();
        url = in.readString();
        displayName = in.readString();
    }

    //必須提供一個名為CREATOR的static final屬性 該屬性需要實現android.os.Parcelable.Creator<T>介面
    public static final Creator<MusicInfo> CREATOR = new Creator<MusicInfo>() {
        @Override
        public MusicInfo createFromParcel(Parcel in) {
            return new MusicInfo(in);
        }

        @Override
        public MusicInfo[] newArray(int size) {
            return new MusicInfo[size];
        }
    };

    public MusicInfo(long id, String title) {
        this.id=id;
        this.title=title;
    }



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

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeLong(id);
        dest.writeString(title);
        dest.writeString(album);
        dest.writeInt(duration);
        dest.writeLong(size);
        dest.writeString(artist);
        dest.writeString(url);
        dest.writeString(displayName);
    }

    public void readFromParcel(Parcel reply) {
        id=reply.readLong();
        title=reply.readString();
        album=reply.readString();
        duration=reply.readInt();
        size=reply.readLong();
        artist=reply.readString();
        url=reply.readString();
        displayName=reply.readString();

    }
}

接下來看 writeToParcel 和 readFromParcel 方法，需要注意的是 writeToParcel 和 readFromParcel 方法讀寫的順序是一一對應的。

這裡有一點要提醒大家的是 AndroidStudio 中，我們通過外掛會自動幫我們生成 writeToParcel 方法及 CREATOR，通常 readFromParcel 方法是不會自動生成的，需要我們自己手動編寫，不然會編譯不過。

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeLong(id);
        dest.writeString(title);
        dest.writeString(album);
        dest.writeInt(duration);
        dest.writeLong(size);
        dest.writeString(artist);
        dest.writeString(url);
        dest.writeString(displayName);
    }

    public void readFromParcel(Parcel reply) {
        id=reply.readLong();
        title=reply.readString();
        album=reply.readString();
        duration=reply.readInt();
        size=reply.readLong();
        artist=reply.readString();
        url=reply.readString();
        displayName=reply.readString();

    }

注意了，接下來我們需要寫一個 MusicInfo.aidl 檔案

package xj.musicserver;

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

parcelable MusicInfo;

指定包名，並宣告 MusicInfo 是 parcelable，注意 parcelable 是小寫的 p，不是大寫的 P。這是一個規範，google 官方指定需要的。同時 MusicInfo.aidl 和 MusicInfo.java 需要放置在同個包中。

第二步編寫一個 Service，實現介面，處理客戶端的請求，並將 binder 返回回去；

IPlayService.Stub mIPlayService=new IPlayService.Stub() {
    @Override
    public void play(String name, final IPlayListener iPlayListener) throws RemoteException {
        MusicTask musicTask = new MusicTask(getApplicationContext(), name, "");
        musicTask.setIResultListener(new MusicTask.IResultListener() {
            @Override
            public void onSuccess(MusicInfo musicInfo) {
                try {
                    iPlayListener.onSuccess(0,musicInfo);
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }

            @Override
            public void onFail(int code, MusicInfo musicInfo) {
                try {
                    iPlayListener.onError(0);
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });
        musicTask.execute();
    }
};



@Nullable
@Override
public IBinder onBind(Intent intent) {
    LogUtil.i(TAG, "onBind: intent = " +intent.toString());
    return mIPlayService;
}

這裡我們所做的工作就是到資料庫裡面查詢看是否有相應的歌曲，如果有，通過 aidl 回撥，告訴客戶端我們查詢成功，呼叫 onSuccess 方法，沒有找到，呼叫客戶端的 onError 方法。

package xj.musicserver;

import android.content.ContentResolver;
import android.content.Context;
import android.database.Cursor;
import android.net.Uri;
import android.os.AsyncTask;
import android.provider.MediaStore;
import android.support.annotation.NonNull;
import android.text.TextUtils;
import android.util.Log;

import java.util.ArrayList;

/**
 * @author meitu.xujun  on 2017/10/17
 * @version 0.1
 */
public class MusicTask extends AsyncTask<Void,Void,Integer> {

    // 這裡只貼出主要程式碼，詳細程式碼可到文章的末尾下載。

    public MusicTask(Context context, String name, String artist){
        mContext = context.getApplicationContext();
        mName = name;
        mArtist = artist;
    }


    @Override
    protected Integer doInBackground(Void... params) {
        LogUtil.i(TAG,"doInBackground:   mName="+mName +"  mArtist"+mArtist);

        mResult = "";
        ContentResolver contentResolver = mContext.getContentResolver();

        Cursor cursor;
        if (TextUtils.isEmpty(mArtist)) {
            cursor = contentResolver.query(contentUri, projection, where_title, new String[]{getFixName(mName)},null);
        }else{
            cursor=contentResolver.query(contentUri, projection,
                    where_title_and_artist, new String[]{getFixName(mName),getFixName(mArtist)},null);
            if(cursor==null || cursor.getCount()<=0){
                cursor = contentResolver.query(contentUri, projection,
                        where_title, new String[]{getFixName(mName)},null);
            }
        }
        if(cursor==null || cursor.getCount()<=0){
            return RESULT_FAIL_MUSIC_NULL;
        }

        int displayNameCol = cursor.getColumnIndex(MediaStore.Audio.Media.DISPLAY_NAME);
        int albumCol = cursor.getColumnIndex(MediaStore.Audio.Media.ALBUM);
        int idCol = cursor.getColumnIndex(MediaStore.Audio.Media._ID);
        int durationCol = cursor.getColumnIndex(MediaStore.Audio.Media.DURATION);
        int sizeCol = cursor.getColumnIndex(MediaStore.Audio.Media.SIZE);
        int artistCol = cursor.getColumnIndex(MediaStore.Audio.Media.ARTIST);
        int urlCol = cursor.getColumnIndex(MediaStore.Audio.Media.DATA);
        int titleCol = cursor.getColumnIndex(MediaStore.Audio.Media.TITLE);

        mMusicInfos = new ArrayList<>();
        String songName="";
        while (cursor.moveToNext()){
            songName = cursor.getString(titleCol);
            MusicInfo musicInfo = getMusicInfo(cursor, displayNameCol, albumCol, idCol,
                    durationCol, sizeCol, artistCol, urlCol,titleCol);
            mMusicInfos.add(musicInfo);
            if(songName.equals(mName)){
                mResult =mName;
                mMusicInfo=musicInfo;
                break;
            }

        }
        if(mMusicInfo==null){
            mMusicInfo =mMusicInfos.get(0);
        }
        return RESULT_SUCUESS;
    }

    @Override
    protected void onPostExecute(Integer result) {
        super.onPostExecute(result);
        Log.i(TAG, "onPostExecute: result =" +result);
        if(mIResultListener==null){
            return;
        }
        if(result==RESULT_SUCUESS){
            mIResultListener.onSuccess(mMusicInfo);
        }else{
            mIResultListener.onFail(result,mMusicInfo);
        }

    }

    -----

    public void setIResultListener(IResultListener IResultListener) {
        mIResultListener = IResultListener;
    }

    public interface IResultListener{
        void onSuccess(MusicInfo musicInfo);
        void onFail(int code, MusicInfo musicInfo);
    }
}

在 AndroidManifet 配置 Service，將我們的 Service 暴露出去。

<service
    android:name=".PlayService"
    android:exported="true"
    android:process=":remote">
    <intent-filter>
        <action android:name="xj.musicserver.IPlayService"/>
    </intent-filter>
</service>

到這裡我們服務端的配置就完成了

Client(客戶端） 的實現

在上一篇部落格的時候，我們有講到實現客戶端大概需要幾個步驟：

• 將服務端的 aidl 檔案 copy 過來，注意要放在同一個包下。
• 通過服務端 Service 的 Action 啟動， 當啟動 Service 成功的時候，將服務端返回的 Binder 儲存下來並轉化成相應的例項。
• 之後如果想與服務端通訊，通過儲存下來的 Binder，即可呼叫服務端的方法。

第一步：將服務端的 aidl 檔案 copy 過來，注意要放在同一個包下。

如下圖所示，我們將 IPlayListener.aidl,IPalyService.aidl,MusicInfo.aidl 和 MuicInfo.java copy 到客戶端

第二步：通過服務端 Service 的 Action 啟動， 當啟動 Service 成功的時候，將服務端返回的 Binder 儲存下來並轉化成相應的例項。

這裡的 Action 是與服務端一一對應的。

case R.id.btn_start_service:
    LogUtil.i(TAG,"onButtonClick:   btn_start_service=");
    Intent intent = new Intent(ACTION);
    intent.setPackage(XJ_MUSICSERVER);
    bindService(intent,mServiceConnection, Context.BIND_AUTO_CREATE);


    public static final String ACTION = "xj.musicserver.IPlayService";
    public static final String XJ_MUSICSERVER = "xj.musicserver";

第三步：通過第二步儲存下來 的 mIBinder，與服務端進行通訊。

當我們呼叫 mIPlayService.play 方法的時候，服務端會去查詢本地是否存在 醜八怪 這首歌，查詢到的時候會回撥 onSuccess 方法，查詢不到的時候會回撥 onError 方法。

case R.id.btn_contact:
    LogUtil.i(TAG,"onButtonClick:   btn_contact=");
    if(mIPlayService!=null){
        mIPlayService.play("醜八怪", mPlayListener);
    }


IPlayListener.Stub mPlayListener=new IPlayListener.Stub(){

    @Override
    public void onError(int code) throws RemoteException {
        LogUtil.i(TAG,"onError:   code = "+code);
    }

    @Override
    public void onSuccess(int code, MusicInfo musicInfo) throws RemoteException {
        LogUtil.i(TAG,"onSuccess:   code = "+code+ " musicInfo" + musicInfo.toString());
    }
};

到此這篇部落格為止。

最後的最後，賣一下廣告，歡迎大家關注我的微信公眾號，掃一掃下方二維碼或搜尋微訊號 stormjun，即可關注。 目前專注於 Android 開發，主要分享 Android開發相關知識和一些相關的優秀文章，包括個人總結，職場經驗等。