Android開源：AndLinker－Android 上的 IPC 庫
簡介
AndLinker是一款Android上的IPC (進程間通信) 庫，結合了 AIDL 和 Retrofit 的諸多特性，且可以與 RxJava 和 RxJava2 的Call Adapters無縫結合使用。項目的設計與部分代碼參考了偉大的 Retrofit 項目。
配置
在項目根目錄的 build.gradle 中添加 jcenter() 倉庫
allprojects {
repositories {
jcenter()
}
}
在App的 build.gradle 中添加如下依賴
dependencies {
implementation 'com.codezjx.library:andlinker:0.7.0'
}
功能特性
- 以普通Java接口代替AIDL接口
- 像 Retrofit 一樣生成遠程服務接口的IPC實現
- 支持的Call Adapters： Call ， RxJava Observable ， RxJava2 Observable & Flowable
- 支持遠程服務回調機制
- 支持AIDL的所有數據類型
- 支持AIDL的所有數據定向tag： in ， out ， inout
- 支持AIDL的 oneway 關鍵字
快速開始
使用注解 @ClassName 和 @MethodName 修飾遠程服務接口 IRemoteService ，并實現它
@ClassName("com.example.andlinker.IRemoteService")
public interface IRemoteService {
@MethodName("getPid")
int getPid();
@MethodName("basicTypes")
void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
double aDouble, String aString);
}
private final IRemoteService mRemoteService = new IRemoteService() {
@Override
public int getPid() {
return android.os.Process.myPid();
}
@Override
public void basicTypes(int anInt, long aLong, boolean aBoolean,
float aFloat, double aDouble, String aString) {
// Does something
}
};</code></pre>
在服務端App中，創建 AndLinkerBinder 對象，并注冊上面的接口實現。然后在 onBind() 方法中返回，暴露給客戶端
private AndLinkerBinder mLinkerBinder;
public class RemoteService extends Service {
@Override
public void onCreate() {
super.onCreate();
mLinkerBinder = AndLinkerBinder.Factory.newBinder();
mLinkerBinder.registerObject(mRemoteService);
}
@Override
public IBinder onBind(Intent intent) {
return mLinkerBinder;
}
}</code></pre>
在客戶端App中，通過 Builder 創建 AndLinker 對象，并通過 create() 方法生成一個 IRemoteService 遠程接口的IPC實現
public class BindingActivity extends Activity {
private AndLinker mLinker;
private IRemoteService mRemoteService;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mLinker = new AndLinker.Builder(this)
.packageName("com.example.andlinker")
.action("com.example.andlinker.REMOTE_SERVICE_ACTION")
.build();
mLinker.bind();
mRemoteService = mLinker.create(IRemoteService.class);
}
@Override
protected void onDestroy() {
super.onDestroy();
mLinker.unbind();
}
}</code></pre>
一切就緒，現在 mRemoteService 對象中的所有方法都是IPC方法，直接調用即可
int pid = mRemoteService.getPid();
mRemoteService.basicTypes(1, 2L, true, 3.0f, 4.0d, "str");
支持數據類型
AndLinker支持AIDL所有數據類型：
- Java語言中的所有原始類型 (如： int ， long ， char ， boolean ，等等)
- String
- CharSequence
- Parcelable
- List (List中的所有元素必須是此列表中支持的數據類型)
- Map (Map中的所有元素必須是此列表中支持的數據類型)
進階使用
Call Adapters
在客戶端App中，你可以copy并修改遠程服務接口，包裝方法的返回值
@ClassName("com.example.andlinker.IRemoteService")
public interface IRemoteService {
@MethodName("getPid")
Observable<Integer> getPid();
@MethodName("basicTypes")
Call<Void> basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
double aDouble, String aString);
}</code></pre>
在 AndLinker.Builder 中注冊對應的Call Adapter Factory，剩下的步驟基本和 Retrofit 一致，不再贅述
new AndLinker.Builder(this)
...
.addCallAdapterFactory(OriginalCallAdapterFactory.create()) // Basic
.addCallAdapterFactory(RxJava2CallAdapterFactory.create()) // RxJava2
.build();
處理遠程服務接口回調
使用 @ClassName 和 @MethodName 注解修飾遠程服務回調接口 IRemoteCallback
@ClassName("com.example.andlinker.IRemoteCallback")
public interface IRemoteCallback {
@MethodName("onValueChange")
void onValueChange(int value);
}</code></pre>
在遠程方法中使用 @Callback 注解修飾callback參數
@MethodName("registerCallback")
void registerCallback(@Callback IRemoteCallback callback);
在客戶端App中，實現上面定義的遠程服務回調接口 IRemoteCallback ，并且注冊到 AndLinker 中，就是這么簡單
private final IRemoteCallback mRemoteCallback = new IRemoteCallback() {
@Override
public void onValueChange(int value) {
// Invoke when server side callback
}
};
mLinker.registerObject(mRemoteCallback);
指定數據定向tag
你可以為遠程方法的參數指定 @In ， @Out ，或者 @Inout 注解，它標記了數據在底層Binder中的流向，跟AIDL中的用法一致
@MethodName("directionalParamMethod")
void directionalParamMethod(@In KeyEvent event, @Out int[] arr, @Inout Rect rect);
注意:
- 所有非原始類型必須指定數據定向tag： @In ， @Out ，或者 @Inout ，用來標記數據的流向。原始類型默認是 @In 類型，并且不能指定其他值。
- 使用 @Out 或者 @Inout 修飾的Parcelable參數必須實現 SuperParcelable 接口，否則你必須手動添加此方法 public void readFromParcel(Parcel in) 。
使用 @OneWay 注解
你可以在遠程方法上使用 @OneWay 注解，這會修改遠程方法調用的行為。當使用它時，遠程方法調用不會堵塞，它只是簡單的發送數據并立即返回，跟AIDL中的用法一致
@MethodName("onewayMethod")
@OneWay
void onewayMethod(String msg);
反饋
歡迎各位提issues和PRs！
License
Copyright 2018 codezjx <code.zjx@gmail.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</code></pre>