AndroidStudio下使用 AIDL 构建跨进程 Service( 详细代码贴图 ), 填补网上的大多数坑
现在百度一下 AIDL/跨进程 Service, 文章一大堆, 然而都是千篇一律, 存在很多同样模棱两可的坑, 而且没有AndroidStudio的最终目录树, 做起来还是有各种各样的不顺.
先说一下几个网上模棱两可的问题:
1. 客户端和服务端不用必须两个apk;
2. AndroidManifest 声明的 service 的 progress 不用必须写 :remote, 这里是写进程的名字, 可以写任意字符;
3. java.lang.SecurityException: Binder invocation to an incorrect interface 错误不一定是因为客户端和服务端的包名不一致导致的, 有可能是实例化AIDL接口的时候不是实现的 XXX.Stub
源码放在了github: https://github.com/YouCii/LearnApp
下面说下基本的实现流程
AIDL最简单实现流程
先写服务端
新建AIDL文件
新建完成后会在src/main下生成aidl目录, 修改生成的aidl文件, 写入自己的接口方法编译程序, AS 会在 build 目录中自动生成 aidl 对应的 java 实现
写好远程服务
别忘了在 AndroidManifest中声明
客户端
- 把所有 aidl 文件及其包名全部复制到客户端里, 要保证包名一致, 不过有人奇怪怎么能两个apk同一个包名呢? 可以这样做(这里的图片使用了后面加入ServiceData/ISocketStateListener.aidl的情况, 请忽略这几个文件)
- 实现客户端执行代码, 这里简化了无关代码, 只需要 bindService 时 传入创建的 connection, 获取到 aidl 对应的 java 对象即可
客户端和服务端在一个apk里
网上都没有提过这种情况, 其实是可以的, 根本不用拷贝aidl文件, 还要保证包名必须一致. 这种方式的唯一apk的结构树如下(这里的图片使用了后面加入ServiceData/ISocketStateListener.aidl的情况, 请忽略这几个文件)
更多的使用
AIDL默认只能传递基本类型, 如果想传递自己的对象, 需要利用 Parcelable
如果想监听服务端, 需要再创建一个 aidl 接口
然后在服务端实现接口, 客户端内调用 aidl 对应的 java 内的方法即可
服务端(请忽略代码里的错误, 这是为了演示修改出来的)
客户端
碰见的各种坑
报错 Error:Execution failed for task ‘:app:compileDebugAidl’.
原因是包名不匹配, 一定要注意aidl自己所在的包名, 以及引用的其他 aidl 所在的包名, 如果写错了as不会报错, 编译的时候才有问题, 一定要仔细检查.自动生成的AIDL找不到Parcelable自定义对象问题, 原因在于 aidl 文件和 Parcelable对象的包名不一致, 一定要保证两者所在的包名一模一样
\
-
报错 java.lang.SecurityException: Binder invocation to an incorrect interface. 这里有两种情况
- 客户端和服务端的包名不一致导致, 如果是客户端和服务端分开的实现形式, 建议直接复制服务端的 aidl 根目录. 请参考上面的目录树;
- onBind中返回aidl对象
return pitPatAidlStub;或者 调用binder的设置接口方法aidlBinder.setSocketStateListener时, 错误的实例化了new IPitPatAidlInterface()而不是new IPitPatAidlInterface.Stub(), 实例化了new ISocketStateListener()而不是new ISocketStateListener.Stub()
报错parcelable不能转换
原因是使用了 kotlin 的注解 parcelize, 在正常使用的话可以, 在 aidl 生成的文件中却报错, 删掉注解/实现parcelable的方法后错误消失.
其他说明
- 其中还好奇试了下, 使用 启动同一进程service的方式 启动 声明了progress的service, 结果报错: proxy can`t cast to…的错误.
- aidl接口传参时写的 in / out / inout 修饰符 也要知道, 否则会出现数据不同步的问题. in 代表客户端传入服务端, 如果在服务端修改 in 修饰的变量时, 客户端的变量不会更改, 修改为 out 修饰时服务端的变动会同步给客户端, 但是服务端拿到的对象内的参数会是空的, 可以使用inout来同时满足; 注意使用out或者inout修饰时, 自定义的pacelable对象不仅仅只实现writeToParcel, 还要手写
fun readFromParcel(parcel: Parcel)方法