2.4 Android中的IPC方式(二)

1. AIDL简介

Messenger是串行处理客户端发来的消息，如果大量的消息同时发送到服务端，服务端只能一个个处理，如果有大量的并发请求，Messenger就不合适。
同时，Messenger的作用是传递消息，很多时候我们需要跨进程调用服务端的方法，这里使用AIDL合适。

2. AIDL支持的数据类型

• 基本数据类型(int long char boolean double等)
• String和CharSequence
• List：只支持ArrayList，里面每个元素都必须被AIDL持有。
• Map：只支持HashMap，里面的每个元素都必须被AIDL持有。
• Parcelable：所有实现了Parcelable接口的对象。
• AIDL：所有的AIDL接口本身也可以在AIDL文件中使用。

3. 注意事项

• Parcelable对象和AIDL对象必须要显式的import进来，不管是否是同一包。
• 如果AIDL文件中用到了自定义的Parcelable对象，那么必须新建一个和它同包同名的AIDL文件，并在其中声明它为Parcelable类型。如Book.java。它的AIDL文件内容如下:

package qingfengmy.developmentofart._2activity.aidl;

parcelable Book;

• AIDL中除了基本数据类型，其他类型的参数都必须标上方向：in/out/inout。in表示输入型参数，out表示输出型参数，inout表示输入输出型参数。要根据实际需求去定义，不能一概使用inout，因为在底层实现都是有开销的。如：

package qingfengmy.developmentofart._2activity.aidl;

import qingfengmy.developmentofart._2activity.aidl.Book;
interface IBookManager {
     List getBookList();
     void addBook(in Book book);
}

• AIDL接口中只支持方法，不支持声明静态常量。
• 为了开发方便，建议所有和AIDL有关的类和文件都放入一个包中，这样的好处是，当客户端是另外一个应用时，我们可以整包复制过去。因为客户端和服务端的包结构和类名要完全一样，否则会出错。这是因为客户端需要反序列化服务端中和AIDL接口相关的所有类， 如果路径不一样，就无法反序列化成功。
• 同一工程中，客户端标明别的进程，和服务器交互，也是跨进程的，和跨应用效果一样。

4. 远程服务端Service的实现

public class BookService extends Service {
    private Binder mBinder = new IBookManager.Stub() {
        @Override
        public List getBookList() throws RemoteException {
            return mBookList;
        }

        @Override
        public void addBook(Book book) throws RemoteException {
            mBookList.add(book);
        }
    };
    private CopyOnWriteArrayList mBookList = new CopyOnWriteArrayList<>();

    @Override
    public void onCreate() {
        super.onCreate();
        mBookList.add(new Book(1, "古文观止"));
        mBookList.add(new Book(2, "天下小品"));
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }
}

服务端的List采用的是CopyOnWriteArrayList，这个支持并发读写，因为AIDL方法实在服务端的Binder线程池中执行的，因此当多个客户端同时连接的时候，会存在多线程访问的情形，所以这里使用CopyOnWriteArrayList。

前文说AIDL中能够使用的List只有ArrayLis，这里用CopyOnWriteArrayList没问题吗？这是因为AIDL中所支持的是抽象的List，而List是个接口。服务端返回的CopyOnWriteArrayList在Binder中会按照List规范去访问数据并生成一个ArrayList给客户端。此类似的还有ConcurrentHashMap。

5. 客户端的实现

public class BookActivity extends AppCompatActivity {
    IBookManager iBookManager;
    ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            iBookManager = IBookManager.Stub.asInterface(service);
            iBookManager.addBook(new Book(4, "倚天屠龙记"));
            List li = iBookManager.getBookList();
            Log.e("aaa", li.toString());
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {

        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_book);
        Intent intent = new Intent(this, BookService.class);
        bindService(intent, serviceConnection, Service.BIND_AUTO_CREATE);
    }

    // destory
}

6. 实现新书推送服务

定义AIDL接口

package qingfengmy.developmentofart._2activity.aidl;

import qingfengmy.developmentofart._2activity.aidl.Book;

interface IOnNewBookArrivedListener {
    void onNewBookArrived(in Book book);
}

在原IBookManager接口中增加注册和解绑两个接口

package qingfengmy.developmentofart._2activity.aidl;

import qingfengmy.developmentofart._2activity.aidl.Book;
import qingfengmy.developmentofart._2activity.aidl.IOnNewBookArrivedListener;
interface IBookManager {
     List getBookList();
     void addBook(in Book book);
     void registerListener(IOnNewBookArrivedListener listener);
     void unRegisterListener(IOnNewBookArrivedListener listener);
}

改写Service

public class BookService extends Service {

    // 原子性boolean值，防多线程读写操作
    private AtomicBoolean mIsServiceDestoryed = new AtomicBoolean();
    // 放多线程读写List
    private CopyOnWriteArrayList mBookList = new CopyOnWriteArrayList<>();
    // 注册的Listener的List
    private CopyOnWriteArrayList mListenerList = new CopyOnWriteArrayList<>();

    private Binder mBinder = new IBookManager.Stub() {
        @Override
        public List getBookList() throws RemoteException {
            return mBookList;
        }

        @Override
        public void addBook(Book book) throws RemoteException {
            mBookList.add(book);
            for (IOnNewBookArrivedListener listener : mListenerList){
                listener.onNewBookArrived(book);
            }
        }

        @Override
        public void registerListener(IOnNewBookArrivedListener listener) throws RemoteException {
            if (!mListenerList.contains(listener)) {
                mListenerList.add(listener);
            }
        }

        @Override
        public void unRegisterListener(IOnNewBookArrivedListener listener) throws RemoteException {
            if (mListenerList.contains(listener)) {
                mListenerList.remove(listener);
            }
        }
    };

    @Override
    public void onCreate() {
        super.onCreate();
        mBookList.add(new Book(1, "古文观止"));
        mBookList.add(new Book(2, "天下小品"));
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }

    @Override
    public void onDestroy() {
        mIsServiceDestoryed.set(true);
        super.onDestroy();
    }
}

改写Activity

public class BookActivity extends AppCompatActivity {
    IBookManager iBookManager;
    IOnNewBookArrivedListener onNewBookArrivedListener = new IOnNewBookArrivedListener.Stub() {
        @Override
        public void onNewBookArrived(Book book) throws RemoteException {
            Log.e("aaa", "新添加的书为：" + book.toString());
            Log.e("aaa", "current thread:" + Thread.currentThread().getName());
        }
    };
    ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            iBookManager = IBookManager.Stub.asInterface(service);
            try {
                iBookManager.registerListener(onNewBookArrivedListener);
            } catch (RemoteException e) {
                e.printStackTrace();
            }
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {

        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_book);
        Intent intent = new Intent(this, BookService.class);
        bindService(intent, serviceConnection, Service.BIND_AUTO_CREATE);

        findViewById(R.id.click).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    iBookManager.addBook(new Book(2, "神奇的一天"));
                } catch (RemoteException e) {
                    e.printStackTrace();
                }
            }
        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (iBookManager != null && iBookManager.asBinder().isBinderAlive()) {
            try {
                iBookManager.unRegisterListener(onNewBookArrivedListener);
            } catch (RemoteException e) {
                e.printStackTrace();
            }
        }
        unbindService(serviceConnection);
    }
}

当添加Book时，IOnNewBookArrivedListener接口中的onNewBookArrived回调打印的线程名称是：main thread，而书上是子线程。这是因为我的onNewBookArrived实在addBook方法中执行的，而addBook是在button的click方法中调的，所以是主线程。而书上是在服务端开线程去加的书，所以是子线程。

7. 解绑的问题

虽然我们在Activity的onDestroy方法中调用了解绑方法

iBookManager.unRegisterListener(onNewBookArrivedListener);

但实际上是解绑失败的。这种解绑用在一般的观察者模式的代码中是没问题的，这里的问题是因为Binder。Binder会把客户端传来的对象重新转化并生成一个新的对象。通过Binder传递是要序列化的，Binder的onTransact方法是拿到Parcelable反序列化成对象的。所以对象不对，无法移除。
解决方法是RemoteCallList，使用如下：

// listener的列表
private RemoteCallbackList mListenerList = new RemoteCallbackList<>();
// 注册和解绑
@Override
public void registerListener(IOnNewBookArrivedListener listener) throws RemoteException {
    mListenerList.register(listener);
}

@Override
public void unRegisterListener(IOnNewBookArrivedListener listener) throws RemoteException {
    mListenerList.unregister(listener);
}
// 添加书时发通知
@Override
public void addBook(Book book) throws RemoteException {
    mBookList.add(book);
    // begin和finish是成对出现的，即使只查个size，也要配对出现。
    int N = mListenerList.beginBroadcast();
    for (int i = 0; i < N; i++) {
        IOnNewBookArrivedListener listener = mListenerList.getBroadcastItem(i);
        if (listener != null) {
            listener.onNewBookArrived(book);
        }
    }
    mListenerList.finishBroadcast();
}

RemoteCallbackList是系统专门提供的用于删除跨进程Listenner的接口。其定义是

public class RemoteCallbackList {
    /*package*/ ArrayMap mCallbacks
            = new ArrayMap();
}

他不是一个List，他的泛型是AIDL，AIDL接口继承IInterface。他内部有一个Map，key是IBinder，value是listener。虽然跨进程的listenner是不同的，但key，Binder是一个。所以依据此来移除。而且他在客户端进程结束后，会自动移除listener。而且他内部实现了线程同步的功能，我们不用考虑多线程问题。

8. ANR问题

• 客户端调服务端的方法时，被调用的方法在服务端的Binder池中，同时客户端线程被挂起，如果此时客户端是主线程，则主线程挂起，如果服务端那里有耗时操作，就很容易出现ANR问题。
• 另外onServiceConnected和onServiceDisconnected都是在主线程，里面也不能进行耗时操作。
• 服务端的Listener回调，如果是主线程(如我上面的例子)，也不能进行耗时操作。如果是子线程(书中的例子)，客户端回调的方法是在子线程，不能操作UI，这里要注意。

9. Binder的意外死亡问题

第一种方法，设置DeathRecipient.发生在子线程。

IBinder.DeathRecipient deathRecipient = new IBinder.DeathRecipient() {
    @Override
    public void binderDied() {
        // 重连
    }
};

第二种方法，在onServiceDisconnected中重连，发生在主线程。

ServiceConnection serviceConnection = new ServiceConnection() {
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) {
        iBookManager = IBookManager.Stub.asInterface(service);
        try {
            iBookManager.registerListener(onNewBookArrivedListener);
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

    @Override
    public void onServiceDisconnected(ComponentName name) {
        // 重连
    }
};

10. 权限验证问题

定义权限

Service的onBind时校验

@Override
public IBinder onBind(Intent intent) {
    int check = checkCallingOrSelfPermission("qingfengmy.developmentofart.book");
    if (check == PackageManager.PERMISSION_DENIED) {
        // 权限拒绝
        Log.e("aaa","拒绝");
        return null;
    }
    return mBinder;
}

如果想拥有该权限，在自己的manifest中加

还有一种方法是在onTransact方法中进行权限验证，验证失败返回false。可以验证permission，也可以验证uid和pid，或者验证包名。如下：

private Binder mBinder = new IBookManager.Stub() {
    ...

    @Override
    public boolean onTransact(int code, Parcel data, Parcel reply, int flags) throws RemoteException {
        int check = checkCallingOrSelfPermission("qingfengmy.developmentofart.book");
        if (check == PackageManager.PERMISSION_DENIED) {
            // 权限拒绝
            return false;
        }
        String packageName = null;
        String[] packages = getPackageManager().getPackagesForUid(getCallingUid());
        if (packages != null && packages.length > 0) {
            packageName = packages[0];
        }
        if (!packageName.startsWith("qingfengmy")) {
            return false;
        }
        return super.onTransact(code, data, reply, flags);
    }
}