Android笔记-AIDL使用详解

概述

AIDL 的全称是 Android Interface Definition Language ，即Android 接口定义语言，其主要用于APP之间通讯，即一个APP与其他APP里的Service进行通讯，因为在Android里面一个独立的APP就是一个独立的进程，所以这也是传说中的Android跨进程通讯（即IPC: Inter-Process Communication）方式之一。

工作原理

AIDL定义了一套基于Server/Client模型的自定义语法的多进程通讯方式，通过该语法最终编译器自动生成基于Binder机制的通讯方式。

使用步骤

AIDL是工作于C/S模式下的，因此在多进程中至少存在两个角色——服务端和客户端，以下是这个两个角色使用的大概步骤：

  • 服务端（Server）：

    第1步：新建AIDL文件，并声明可以向客户端提供的接口方法；
    第2步：新建一个Service，实现AIDL中定义的接口方法，通过Binder与该Service进行绑定；
    第3步：在manifest文件中注册该服务并声明为远程服务。

  • 客户端（Client）：
    第1步：拷贝服务器端的AIDL文件到main目录下；
    第2步：通过AIDL定义的接口的Stub.asInterface(service)方法获取服务器端的AIDL类型实例，然后通过ServiceConnection与Activity进行关联，绑定服务后便可以通过该实例根据需要调用服务器端提供的接口方法了；
    第3步：通过Intent指定服务端的服务器名称和包名，与远程Service进行绑定。

实例

该实例展示了客户端如何通过AIDL与远程Service进行通讯的，首先展示的是基本的数据类型的传递，最后使用自定义数据类型的传递。

因为是跨进程通讯，所以需要新建两个APP，一个作为服务端，一个作为客户端，该实例中服务端APP名称：AidlServer，包名：com.example.study.aidl.aidlserver；客户端APP名称：AidlClient，包名：com.example.study.aidl.aidlclient。

基本数据类型

  • 服务端（Server）：

第1步：新建AIDL文件，右键新建文件，选择AIDL，文件名称为IMyAidlInterface，Android Studio自动生产文件如下：

// IMyAidlInterface.aidl
package com.example.study.aidl.aidlserver;

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

interface IMyAidlInterface {
    /**
     * 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只支持6种基本数据类型，即int、long、boolean、float、double和String。

第2步：在该AIDL文件中定义自己的可以向客户端提供的接口方法；

// IMyAidlInterface.aidl
package com.example.study.aidl.aidlserver;

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

interface IMyAidlInterface {
     String getName();
}

第3步：Sync整个工程（Build --> make project），然后在java目录下新建一个Service，取名MyService；

package com.example.study.aidl.aidlserver;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;

public class MyService extends Service {
    public MyService() {
    }

    @Override
    public IBinder onBind(Intent intent) {
        // TODO: Return the communication channel to the service.
        throw new UnsupportedOperationException("Not yet implemented");
    }
}

第4步：定义一个AIDL接口类型的Stub实例，并实现接口方法；

package com.example.study.aidl.aidlserver;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;

public class MyService extends Service {

    private IMyAidlInterface.Stub myBinder = new IMyAidlInterface.Stub() {
        @Override
        public String getName() throws RemoteException {
            return "HSG --- AIDL --- Okay!";
        }
    };

    public MyService() {
    }

    @Override
    public IBinder onBind(Intent intent) {
        // TODO: Return the communication channel to the service.
        throw new UnsupportedOperationException("Not yet implemented");
    }
}

第5步：将上述AIDL接口类型的Stub实例通过onBinder()方法返回，即与当前Service建立绑定关系，并根据需要重写其他生命周期方法;

package com.example.study.aidl.aidlserver;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;

public class MyService extends Service {
    private static final String TAG = "MyService";

    private IMyAidlInterface.Stub myBinder = new IMyAidlInterface.Stub() {
        @Override
        public String getName() throws RemoteException {
            return "HSG --- AIDL --- Okay!";
        }
    };

    public MyService() {
    }

    @Override
    public void onCreate() {
        super.onCreate();
        Log.d(TAG, "onCreate() called");
    }


    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        Log.d(TAG, "onStartCommand() called with: intent = [" + intent + "], flags = [" + flags + "], startId = [" + startId + "]");
        return super.onStartCommand(intent, flags, startId);
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        Log.d(TAG, "onDestroy() called");
    }

    @Override
    public IBinder onBind(Intent intent) {
        Log.d(TAG, "onBind() called with: intent = [" + intent + "]");
        return this.myBinder;
    }

    @Override
    public boolean onUnbind(Intent intent) {
        Log.d(TAG, "onUnbind() called with: intent = [" + intent + "]");
        return super.onUnbind(intent);
    }
}

第5步：在Manifest.xml文件中，注册并声明为远程服务。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.study.aidl.aidlserver">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

        <service
            android:name=".MyService"
            android:enabled="true"
            android:exported="true"
            android:process=":remote"> 
            <intent-filter>
                <action android:name="com.example.study.aidl.MyServer" />
            </intent-filter>
        </service>
    </application>

</manifest>

说明：

  1. android:process=":remote"将该服务设置成远程服务;
  2. android:exported="true"将该服务设置成可被其他进程调用;
  3. intent-filter标签中的<action android:name="com.example.study.aidl.MyServer" />这个后面会通过Intent与该服务进行绑定会用到。
  • 客户端（Client）：

第1步：将服务端aidl目录下的文件全部拷贝到客户端app/src/main目录下；

注意：记得是原封不动地拷贝，什么都不要改，切记！切记！切记！

第2步：Sync整个工程（Build --> make project），然后在MainActivity中定义ServiceConnection实例，以便与该Activity进行关联，在onServiceConnected()方法中，通过Stub.asInterface(service)接口获取服务端的AIDL接口类型实例；

package com.example.study.aidl.aidlclient;

import android.content.ComponentName;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;

import com.example.study.aidl.aidlserver.IMyAidlInterface;

public class MainActivity extends AppCompatActivity {

    private IMyAidlInterface myAidlInterface;
    private ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            myAidlInterface = IMyAidlInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {

        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

第3步：通过Intent指定服务端的服务名称和服务所在的包名，并通过bindService()方法进行Service绑定。

package com.example.study.aidl.aidlclient;

import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;

import com.example.study.aidl.aidlserver.IMyAidlInterface;

public class MainActivity extends AppCompatActivity {

    private IMyAidlInterface myAidlInterface;
    private ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            myAidlInterface = IMyAidlInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {

        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Intent intent = new Intent("com.example.study.aidl.MyServer");
        intent.setPackage("com.example.study.aidl.aidlserver");

        bindService(intent, serviceConnection, BIND_AUTO_CREATE);
    }
}

注意：

  1. 这里Intent构造方法里的action字符串一定要与服务端在manifest文件中通过intent-filter标签声明的action name的值保持一直；
  2. Android5.0后无法只通过隐式Intent绑定远程Service，还需要通过setPackage()方法指定远程服务所在的包名，本人当时就这里报错，说找不到对应的Service，折腾了好久。

第4步：根据需要通过AIDL接口实例调用AIDL提供的接口方法，此处通过在客户端布局文件中添加一个按钮，并添加点击事件监听，在点击事件中调用getName()方法，从而获取服务端返回信息。

package com.example.study.aidl.aidlclient;

import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Toast;

import com.example.study.aidl.aidlserver.IMyAidlInterface;

public class MainActivity extends AppCompatActivity {

    private IMyAidlInterface myAidlInterface;
    private ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            myAidlInterface = IMyAidlInterface.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {

        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Intent intent = new Intent("com.example.study.aidl.MyServer");
        intent.setPackage("com.example.study.aidl.aidlserver");

        bindService(intent, serviceConnection, BIND_AUTO_CREATE);

        findViewById(R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    String name = myAidlInterface.getName();
                    Toast.makeText(MainActivity.this, name, Toast.LENGTH_SHORT).show();
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });
    }
}

至此，一个最简单支持基本类型数据传递的通过AIDL方式进行多进程通讯就完成了，先运行服务端APP，再运行客户端APP，然后点击客户端APP屏幕中间的按钮就会弹出“HSG --- AIDL --- Okay!”字样的toast信息了。

自定义数据类型

在实际应用场景下，很大可能性，不可以只支持基本数据类型的数据传递，还需要支持自定义数据类型的数据传递，其大概步骤如下：

  • 服务端（Server）：

    第1步：自定义类型要实现Parcelable接口；
    第2步：新建一个同名AIDL文件对自定义类型进行声明；
    第3步：AIDL接口中导入我们的AIDL类型；
    第4步：在接口文件中定义支持自定义类型的接口方法；
    第5步：Sync整个工程（Build --> make project），在service中实现刚添加的支持自定义类型的接口方法。

  • 客户端（Client）：

    第1步：拷贝自定义类型文件和AIDL目录下所有文件到客户端目录下，包名需要完全和服务端保持一致；
    第2步：Sync整个工程（Build --> make project），其他步骤与基本数据类型相同，然后便可以调用支持自定义类型的接口方法了。

代码实例如下：

  • 服务端（Server）：

    第1步：自定义User类型并实现Parcelable接口；

package com.example.study.aidl.demo;

import android.os.Parcel;
import android.os.Parcelable;

public class User implements Parcelable {
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    protected User(Parcel in) {
        name = in.readString();
        age = in.readInt();
    }

    public static final Creator<User> CREATOR = new Creator<User>() {
        @Override
        public User createFromParcel(Parcel in) {
            return new User(in);
        }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }


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


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

第2步：在AIDL目录下新建一个同名AIDL文件对自定义类型进行声明；

// User.aidl
package com.example.study.aidl.demo;

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

parcelable User;

注意： 自定义类型对应的AIDL文件包名与自定义Java文件包名保持一致。

第3步：AIDL接口文件中导入自定义类型对应的AIDL类型；

// IMyAidlInterface.aidl
package com.example.study.aidl.aidlserver;

// Declare any non-default types here with import statements
import com.example.study.aidl.demo.User;

interface IMyAidlInterface {
    String getName();
}

第4步：在接口文件中定义支持自定义类型的接口方法；

// IMyAidlInterface.aidl
package com.example.study.aidl.aidlserver;

// Declare any non-default types here with import statements
import com.example.study.aidl.demo.User;

interface IMyAidlInterface {
    String getName();
    User getUser();
}

第5步：Sync整个工程（Build --> make project），在service中实现刚添加的支持自定义类型的接口方法。

package com.example.study.aidl.aidlserver;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;

import com.example.study.aidl.demo.User;

public class MyService extends Service {
    private static final String TAG = "MyService";

    private IMyAidlInterface.Stub myBinder = new IMyAidlInterface.Stub() {
        @Override
        public String getName() throws RemoteException {
            return "HSG --- AIDL --- Okay!";
        }

        @Override
        public User getUser() {
            return new User("Jack", 89);
        }
    };

    public MyService() {
    }

    @Override
    public void onCreate() {
        super.onCreate();
        Log.d(TAG, "onCreate() called");
    }


    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        Log.d(TAG, "onStartCommand() called with: intent = [" + intent + "], flags = [" + flags + "], startId = [" + startId + "]");
        return super.onStartCommand(intent, flags, startId);
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        Log.d(TAG, "onDestroy() called");
    }

    @Override
    public IBinder onBind(Intent intent) {
        Log.d(TAG, "onBind() called with: intent = [" + intent + "]");
        return this.myBinder;
    }

    @Override
    public boolean onUnbind(Intent intent) {
        Log.d(TAG, "onUnbind() called with: intent = [" + intent + "]");
        return super.onUnbind(intent);
    }
}

  • 客户端（Client）：

    第1步：拷贝自定义类型文件和AIDL目录下所有文件到客户端目录下，包名需要完全和服务端保持一致；

    注意是同时拷贝自定义类型Java文件和AIDL目录下所有文件，路径包名完全一致。

    第2步：Sync整个工程（Build --> make project），其他步骤与基本数据类型相同，然后便可以调用支持自定义类型的接口方法了。

package com.example.study.aidl.aidlclient;

import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Toast;

import com.example.study.aidl.aidlserver.IMyAidlInterface;

public class MainActivity extends AppCompatActivity {

   private IMyAidlInterface myAidlInterface;
   private ServiceConnection serviceConnection = new ServiceConnection() {
       @Override
       public void onServiceConnected(ComponentName name, IBinder service) {
           myAidlInterface = IMyAidlInterface.Stub.asInterface(service);
       }

       @Override
       public void onServiceDisconnected(ComponentName name) {

       }
   };

   @Override
   protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);

       Intent intent = new Intent("com.example.study.aidl.MyServer");
       intent.setPackage("com.example.study.aidl.aidlserver");

       bindService(intent, serviceConnection, BIND_AUTO_CREATE);


       findViewById(R.id.button).setOnClickListener(new View.OnClickListener() {
           @Override
           public void onClick(View v) {
               try {
                   String name = myAidlInterface.getName();
                   String user = myAidlInterface.getUser().toString();

                   Toast.makeText(MainActivity.this, name + ", " + user, Toast.LENGTH_SHORT).show();
               } catch (RemoteException e) {
                   e.printStackTrace();
               }
           }
       });
   }
}

至此，一个简单支持基本类型和自定义类型数据传递的通过AIDL方式进行多进程通讯的实例就完成了，先运行服务端APP，再运行客户端APP，然后点击客户端APP屏幕中间的按钮就会弹出“HSG --- AIDL --- Okay!，User{name='Jack', age=89}”字样的toast信息了。

总结

AIDL是Android中多进程通讯的一种方式，其本质就是起一个可被多个APP共享的远程Service作为服务端，然后其他APP作为客户端，通过binder方式与其进行信息交互，AIDL定义了一套自己的语法规则而已。

代码传送门:

参考

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

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,444评论 25赞 707
  • Android Service基本用法、AIDL、Binder连接池详解
    本文介绍Service与Activity之间的通信，文章包含以下内容： 一、Service基本用法 二、通过AID...
    developerzjy阅读 10,223评论 7赞 27
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,596评论 18赞 139
  • 246#「勇」之小大
    齐宣王问曰：“交邻国有道乎？”孟子对曰：“有。惟仁者为能以大事小，是故汤事葛，文王事昆夷；惟智者为能以小事大，故大...
    295442de7134阅读 653评论 0赞 0
  • 不要做装在套子里的人
    “一个人走在漫长的街道上，风从耳边略过，我把双手交叉抱在胸前，感受到一丝丝暖意。看到街上川流不息的车辆和陌生的面孔...
    Nancy_a955阅读 639评论 0赞 0