AIDL 传递对象（Parceable）、传递接口

通常，AIDL 支持以下类型。

  • Java 编程语言中的所有原语类型（如 int、long、char、boolean 等等）
  • String
  • CharSequence
  • List
    List 中的所有元素都必须是以上列表中支持的数据类型、其他 AIDL 生成的接口或您声明的可打包类型。 可选择将 List 用作“通用”类（例如，List）。另一端实际接收的具体类始终是 ArrayList，但生成的方法使用的是 List 接口。
  • Map
    Map 中的所有元素都必须是以上列表中支持的数据类型、其他 AIDL 生成的接口或您声明的可打包类型。 不支持通用 Map，如 Map

注意事项

在 aidl 文件中，除了 Java 编程语言中的所有原语类型、String、CharSequence、List、Map,其他在 AIDL 文件中用到的类，你必须使用 import 语句导入，否则会报错。
当你使用实现Parceable 的自定义类型的时候，当其作为参数的时候，你必须为其制定是输入或者是输出参数。

in 表示输入参数，即服务端可以修改该类型
out 表示输出参数，即客户端可以修改该类型，客户端不行
inout 表示客户端和服务端都可以修改该类型

如: void onSuccess(int code,in MusicInfo musicInfo);

Server (服务端的实现）

服务端主要有三个步骤

  • 将请求抽象成接口，并编写 aidl 文件；
  • 编写一个 Service，实现接口，处理客户端的请求，并将 binder 返回回去；
  • 在 AndroidManifet 配置 Service，将我们的 Service 暴露出去。
一、将请求抽象成接口，并编写 aidl 文件

首先我们先来看一下 IPlayService aidl 文件，下面的代码中，我们定义了一个 play 方法，有两个参数，name 是代表歌曲的名字，IPlayListener 是一个接口。需要注意的是它不是一个 java 类，是 aidl 文件 。这样才能在服务端和客户端之间传递

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);

}

要手动添加 import xj.musicserver.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);
 }

要手动添加 import xj.musicserver.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 方法是不会自动生成的，需要我们自己手动编写，不然会编译不过。

注意了，接下来我们需要写一个 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 需要放置在同个包中。

image.png

二、第二步,编写一个 Service，实现接口，处理客户端的请求，并将 binder 返回回去；

（以下代码涉及到两个接口的传递，过程大致如此，即自定义动作IPlayListener接口从客户端传递到服务端，服务端再将动作传递到任务类MusicTask.IResultListener接口中。）

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 到客户端


image.png
二、第二步：通过服务端 Service 的 Action 启动， 当启动 Service 成功的时候，将服务端返回的 Binder 保存下来并转化成相应的实例。

(注意在 Android 5.0以后，不能通过隐式 Intent 启动 service，必须制定包名)
这里的 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());
    }
};

全文结束。
感谢：
Android AIDL 传递对象（Parceable）

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 219,427评论 6赞 508
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,551评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 165,747评论 0赞 356
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,939评论 1赞 295
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,955评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,737评论 1赞 305
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,448评论 3赞 420
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,352评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,834评论 1赞 317
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3赞 338
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1赞 351
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,815评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,477评论 3赞 331
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1赞 272
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3赞 373
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2赞 355