AIDL结合Binder跨进程通信实例分析

AIDL结合Binder跨进程通信实例分析

一、Demo目录截图

二、在src/main目录下新建aidl文件夹用于存放aidl接口类(Book.aidl和IBookManger.aidl)

// Book.aidl
package com.test.aidl.bean;
parcelable Book;

// IBookManager.aidl
package com.test.binderdemo;
import com.test.aidl.bean.Book;//一定要导入Book,哈哈
// Declare any non-default types here with import statements

interface IBookManager {
    List<Book> getBookList();
    void addBook(in Book book);
}

二、在src/main目录下java文件夹写好实现了Parcelable接口的Book作为传输类

package com.test.aidl.bean;

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

public class Book implements Parcelable {
    private  int bookId;
    private  String bookName;

    public Book(int bookId, String bookName) {
        this.bookId = bookId;
        this.bookName = bookName;
    }

    /**1、描述內容類型***/
    @Override
    public int describeContents() {
        return 0;
    }

    /**2、写入Paercel**/
    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeInt(bookId);
        dest.writeString(bookName);
    }

    /**3、创建Book成员**/
    public static final Creator<Book> CREATOR = new Creator<Book>() {
        /***3.1从一个Parcel中创建一个Book ***/
        @Override
        public Book createFromParcel(Parcel in) {
            return new Book(in);
        }
        /***3.2从一个Parcel中创建一个Book数组 ***/
        @Override
        public Book[] newArray(int size) {
            return new Book[size];
        }
    };

    /**4、从parcel中读取Book的属性**/
    protected Book(Parcel in) {
        bookId = in.readInt();
        bookName = in.readString();
    }

}

三、写好远程进程AidlTestService

里边有个IBookManager.Stub成员。方便添加添加书本或获取图书列表

package com.test.aidlserver;

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

import com.test.aidl.bean.Book;

import java.util.ArrayList;
import java.util.List;

public class AidlTestService extends Service {

    private List<Book> bookList;

    @Override
    public void onCreate() {
        super.onCreate();
        bookList = new ArrayList<>();
        initData();
    }

    private void initData() {
        Book book1 = new Book(1,"活着");
        Book book2 = new Book(2,"或者");
        Book book3 = new Book(3,"叶应是叶");
        bookList.add(book1);
        bookList.add(book2);
        bookList.add(book3);
    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        // TODO Auto-generated method stub
        return super.onStartCommand(intent, flags, startId);
    }




    @Override
    public IBinder onBind(Intent intent) {
        Log.i(TAG, "onBind: ");
        return stub;
    }

    /**存根、树桩**/
    private final IBookManager.Stub stub= new IBookManager.Stub() {
        @Override
        public List<Book> getBookList() throws RemoteException {
            return bookList;
        }

        @Override
        public void addBook(Book book) throws RemoteException {
            if (book != null) {
                bookList.add(book);
            } else {
                Log.e(TAG, "接收到了一个空对象 InOut");
            }
        }
    };

    private static final String TAG = "AidlTestService";
}

五、主进程调用

主要是实现ServiceConnection接口，服务连接时IBookManager.Stub.asInterface(service)获得BookManager的实体类

package com.test.binderdemo;

import android.app.Service;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.IBinder;
import android.os.RemoteException;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;

import com.test.aidl.bean.Book;
import com.test.aidlserver.AidlTestService;

import java.util.List;

public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    private int bookId = 1;
    private static final String TAG = "MainActivityTag";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        findViewById(R.id.btn_getBookList).setOnClickListener(this);
        findViewById(R.id.btn_addBook_inOut).setOnClickListener(this);
        bindService();
    }

    private void bindService() {
        Intent intent = new Intent(MainActivity.this, AidlTestService.class);
        /**绑定服务的时候，会回到ServiceConnection**/
        bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE);
    }

    private IBookManager bookManager;
    private boolean connected = false;
    private ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            /***1、获取服务端Service端的图书管理接口对象**/
            bookManager = IBookManager.Stub.asInterface(service);
            connected = true;
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            connected = false;
        }
    };


    private List<Book> bookList;

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.btn_getBookList:
                if (connected) {
                    try {
                        /***2、调用服务端Service端的图书管理接口的方法获取所有图书**/
                        bookList = bookManager.getBookList();
                        Log.i(TAG, "onClick: bookList =" + bookList.toString());
                        bookId = bookList.size();
                    } catch (RemoteException e) {
                        e.printStackTrace();
                    }
                }
                break;
            case R.id.btn_addBook_inOut:
                if (connected) {
                    Book book = new Book(++bookId, "这是一本新书 bookId=" + bookId);
                    try {
                        /***3、调用服务端Service端的图书管理接口的方法添加书本**/
                        bookManager.addBook(book);
                        Log.i(TAG, "onClick: " + book.toString());
                    } catch (RemoteException e) {
                        e.printStackTrace();
                    }
                }
                break;
        }
    }
}

六、Build的时候会在build/generated/source/aidl/debug/com.test.binderdemo目录下生成IBookManager类

/*
 * This file is auto-generated.  DO NOT MODIFY.
 * Original file: D:\\app\\demo\\BaseDemo\\binderdemo\\src\\main\\aidl\\com\\test\\binderdemo\\IBookManager.aidl
 */
package com.test.binderdemo;
//一定要导入Book,哈哈
// Declare any non-default types here with import statements

public interface IBookManager extends android.os.IInterface {
    /**
     * Local-side IPC implementation stub class.
     */
    public static abstract class Stub extends android.os.Binder implements IBookManager {
        /**当前Binder的唯一标识**/
        private static final String DESCRIPTOR = "com.test.binderdemo.IBookManager";

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

        /** 将服务端的Binder对象转换成客户端所需要的AIDL接口类型的对象。
         * Cast an IBinder object into an com.test.binderdemo.IBookManager interface,
         * generating a proxy if needed.
         */
        public static IBookManager asInterface(android.os.IBinder obj) {
            if ((obj == null)) {
                return null;
            }
            android.os.IInterface iin = obj.queryLocalInterface(DESCRIPTOR);
            if (((iin != null) && (iin instanceof IBookManager))) {
                /***如果客户端和服务端位于同一进程，此方法返回的就是服务端的Stub对象本身**/
                return ((IBookManager) iin);
            }
            /**否则返回的是系统的封装后的Stub.proxy对象**/
            return new Proxy(obj);
        }

        /****
         * 此方法返回当前Binder对象
         * @return
         */
        @Override
        public android.os.IBinder asBinder() {
            return this;
        }

        /***该方法时运行在服务端的Binder线程池中transact会被调起，**/
        @Override
        public boolean onTransact(int code, android.os.Parcel data, android.os.Parcel reply, int flags) throws android.os.RemoteException {
            switch (code) {/**通过code来确定目标方法**/
                case INTERFACE_TRANSACTION: {
                    reply.writeString(DESCRIPTOR);
                    return true;
                }
                case TRANSACTION_getBookList: {
                    data.enforceInterface(DESCRIPTOR);
                    /**获取图书列表**/
                    java.util.List<com.test.aidl.bean.Book> _result = this.getBookList();
                    /**将图书列表写入reply返回**/
                    reply.writeNoException();
                    /***目标执行完将结果返回到result中**/
                    reply.writeTypedList(_result);
                    return true;
                }
                case TRANSACTION_addBook: {
                    data.enforceInterface(DESCRIPTOR);
                    com.test.aidl.bean.Book _arg0;
                    if ((0 != data.readInt())) {/**从data中获取参数**/
                        _arg0 = com.test.aidl.bean.Book.CREATOR.createFromParcel(data);
                    } else {
                        _arg0 = null;
                    }
                    this.addBook(_arg0);
                    /**添加图书是没有reply返回**/
                    reply.writeNoException();
                    return true;
                }
            }
            return super.onTransact(code, data, reply, flags);
        }

        /****
         * IBookManager代理类Proxy
         */
        private static class Proxy implements IBookManager {
            private android.os.IBinder mRemote;

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

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

            public String getInterfaceDescriptor() {
                return DESCRIPTOR;
            }

            /****
             * 获取图书接口 供客户端调用，
             * @return
             * @throws android.os.RemoteException
             */
            @Override
            public java.util.List<com.test.aidl.bean.Book> getBookList() throws android.os.RemoteException {
                /**输入型data Parcel***/
                android.os.Parcel _data = android.os.Parcel.obtain();
                /**输出型reply Parcel**/
                android.os.Parcel _reply = android.os.Parcel.obtain();
                /**返回值对象result List**/
                java.util.List<com.test.aidl.bean.Book> _result;
                try {
                    _data.writeInterfaceToken(DESCRIPTOR);
                    /**transact发起远程RPC调用,当前线程挂起，**/
                    mRemote.transact(Stub.TRANSACTION_getBookList, _data, _reply, 0);
                    _reply.readException();
                    _result = _reply.createTypedArrayList(com.test.aidl.bean.Book.CREATOR);
                } finally {
                    _reply.recycle();
                    _data.recycle();
                }
                return _result;
            }

            @Override
            public void addBook(com.test.aidl.bean.Book book) throws android.os.RemoteException {
                android.os.Parcel _data = android.os.Parcel.obtain();
                android.os.Parcel _reply = android.os.Parcel.obtain();
                try {
                    _data.writeInterfaceToken(DESCRIPTOR);
                    if ((book != null)) {
                        _data.writeInt(1);
                        book.writeToParcel(_data, 0);
                    } else {
                        _data.writeInt(0);
                    }
                    mRemote.transact(Stub.TRANSACTION_addBook, _data, _reply, 0);
                    _reply.readException();
                } finally {
                    _reply.recycle();
                    _data.recycle();
                }
            }
        }

        static final int TRANSACTION_getBookList = (android.os.IBinder.FIRST_CALL_TRANSACTION + 0);
        static final int TRANSACTION_addBook = (android.os.IBinder.FIRST_CALL_TRANSACTION + 1);
    }

    /****
     * 获取图书接口
     * @return
     * @throws android.os.RemoteException
     */
    public java.util.List<com.test.aidl.bean.Book> getBookList() throws android.os.RemoteException;

    public void addBook(com.test.aidl.bean.Book book) throws android.os.RemoteException;
}