美文网首页
AIDL基本使用

AIDL基本使用

作者: GrapeX | 来源:发表于2020-05-06 10:45 被阅读0次

    概括:

    • 简单介绍
    • 使用步骤

    简单介绍

    AIDL:Android 跨进程通信方法之一,底层通过 “ Binder ” 实现

    使用步骤

    主要服务端和客户端:

    1. 服务端
    • 新建 “Person” 类
    • 新建 “Aidl” 文件
    • 新建服务
    1. 客户端
    • 复制 “Person” 类和 “Aidl” 文件
    • 连接服务

    1. 服务端

    1.1. 新建“Person”类,实现“Parcelable”接口
    public class Person implements Parcelable {
        private String name;
    
        public Person() {
        }
    
        protected Person(Parcel in) {
            name = in.readString();
        }
    
        public static final Creator<Person> CREATOR = new Creator<Person>() {
            @Override
            public Person createFromParcel(Parcel in) {
                return new Person(in);
            }
    
            @Override
            public Person[] newArray(int size) {
                return new Person[size];
            }
        };
    
        @Override
        public int describeContents() {
            return 0;
        }
    
        @Override
        public void writeToParcel(Parcel dest, int flags) {
            dest.writeString(name);
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }
    

    代码虽多,但都是实现接口后自动生成的,这里仅仅定义了一个属性“name”,然后实现 “get/set” 方法,Parcelable 接口是什么应该不用多说了,数据跨进程传输需要序列化。

    1.2. 新建“AIDL”文件

    app右键 -> New -> AIDL -> AIDL File

    此时我的工程结构如下:


    目录.png

    注意的是:Person.java 和 PersonAidl.aidl 我没有放在相同的包名下

    1. Person.java:com.fan.aidl.bean
    2. PersonAidl.aidl:com.fan.aidl

    但是一般相同比较好(系统能默认识别),我在这里演示一下不相同怎么做

    PersonAidl.aidl 文件原代码大概如下

    // PersonAidl.aidl
    package com.fan.aidl;
    
    interface PersonAidl {
        //默认方法,介绍 AIDL 的基本类型
        void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
                double aDouble, String aString);
    }
    

    删除默认方法,我们定义一个自己的方法

    // PersonAidl.aidl
    // 1. 看我,包名加 bean
    package com.fan.aidl.bean;
    
    //2. 声明 java 的 person 类
    parcelable Person;
    
    interface PersonAidl {
        // in:数据流向的定义之一,可另行了解
        void addOne(in Person person);
    
    }
    

    在AIDL里面,除了基本类型,其他类型在使用前是需要定义的。

    所以,我们要使用 “Person.java” 就需要先声明,看上面的 “第2点”

    但是若 “java” 与 “aidl” 的包名不一致,系统是无法自动找到的,这时我们需要手动修改包名,设置为 “Person.java” 的包名路径,看 “ 第1点 ”

    此时我们 “PersonAidl.aidl” 里面就可以使用 “Person.java” 了

    一个验证 aidl 有没有引用到 Person.java 的方法,对 “parcelable Person” 的
    “Person” 使用 “Ctrl + 左键” 查看引用,没有引用到是点击没反应的,就像点击 java 方法看引用一样

    此时 “Build -> Make Project” ,系统会自动生成一些跨进程需要的文件

    1.3. 新建服务

    服务代码:

    public class PersonService extends Service {
    
        /**
         * PersonAidl是 make project后生成的 java代码
         */
        private final PersonAidl.Stub mPerson = new PersonAidl.Stub() {
            @Override
            public void addOne(Person person) throws RemoteException {
                Log.e("TAG", "我是服务器,我收到了客户端发的一个人名:" + person.getName());
            }
        };
    
        /**
         * 开头说的 Aidl 的底层实现是 binder,所以直接返回
         */
        @Nullable
        @Override
        public IBinder onBind(Intent intent) {
            return mPerson;
        }
    }
    

    比较简单,然后在 manifests 声明

    <?xml version="1.0" encoding="utf-8"?>
    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.fan.aidl">
        
        <!--自定义权限,name 随便写,对应服务的权限就好-->
        <permission
            android:name="com.permission.aidl"
            android:protectionLevel="normal" />
    
        <application>
            ...
            <!-- 
            exported = "true":可让其他 app 使用服务
            permission: 若 exported = "true",则需要给这个服务一个自定义的权限
            使用方若调用该服务就要声明这个权限,否则报错  
            -->
            <service
                android:name=".PersonService"
                android:exported="true"
                android:permission="com.permission.aidl">
                <intent-filter>
                    <!--定义action给客户端隐式调用,可随便写-->
                    <action android:name="com.fan.action.aidl" />
                    <category android:name="android.intent.category.DEFAULT" />
                </intent-filter>
            </service>
        </application>
    </manifest>
    

    最后,在“MainActivity”开启服务

    public class MainActivity extends AppCompatActivity {
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            startService(new Intent(this, PersonService.class));
        }
    }
    

    2. 客户端

    既然是跨进程通信,那肯定就要有第二个进程,新建一个“Module”,当然新建 “Project” 也行。

    2.1. 复制服务端的 Person.java 和 PersonAidl.idl

    开头就先来个梅开二度,将文件复制到客户端

    注:包名和文件内容必须与服务端一致,否则抛如下异常

    Binder invocation to an incorrect interface readException

    我的目录结构:


    客户端结构.png

    可以看到 Person.java 和 PersonAidl.aidl 与服务端是一致的

    1. Person.java:com.fan.aidl.bean
    2. PersonAidl.aidl:com.fan.aidl

    惯例, “Make Project” 系统自动生成需要的代码

    2.2. 连接服务

    连接之前需要声明服务端定义的权限

    <uses-permission android:name="com.permission.aidl" />
    

    连接代码:

    public class MainActivity extends AppCompatActivity {
        private PersonAidl aidl;
    
        private ServiceConnection connection = new ServiceConnection() {
            @Override
            public void onServiceConnected(ComponentName name, IBinder service) {
                aidl = PersonAidl.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();
            //服务端包名
            intent.setPackage("com.fan.aidl");
            //服务端设置的 action
            intent.setAction("com.fan.action.aidl");
            bindService(intent, connection, BIND_AUTO_CREATE);
    
            findViewById(R.id.main_btn).setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    try {
                        Person person = new Person();
                        person.setName("小红");
                        aidl.addOne(person);
                    } catch (RemoteException e) {
                        e.printStackTrace();
                    }
                }
            });
        }
    }
    

    打印:

    E/TAG: 我是服务器,我收到了客户端发的一个人名:小红

    AIDL的使用到此结束


    参考文章:https://www.jianshu.com/p/a8e43ad5d7d2

    相关文章

      网友评论

          本文标题:AIDL基本使用

          本文链接:https://www.haomeiwen.com/subject/vfubghtx.html