添加 Java 系统服务回调

8/3/2023

本文在Binder 程序示例之 Java 篇 (opens new window) 的基础上修改,来显示如何添加 Java 系统服务回调,为了保证重点突出和过程简洁清晰,不会演示如何集成 Java 系统服务到系统中。这部分内容请参考添加 Java 系统服务 (opens new window)Android Java 系统服务框架与第三方 App 使用自定义 Java 系统服务 (opens new window)

首先我们在Binder 程序示例之 Java 篇 (opens new window)完成的源码的基础上添加 ICallback.aidl 文件,添加完成后整体文件结构如下:

BinderJavaDemo/
└── com 
    └── yuandaima
        ├── Android.bp
        ├── Client.java
        ├── HelloService.java
        ├── ICallback.aidl
        ├── IHelloService.aidl
        └── Server.java
1
2
3
4
5
6
7
8
9

其中 ICallback.aidl 内容如下:

package com.yuandaima;

interface ICallback {
    void onMessage(String message);
}
1
2
3
4
5

接着修改 IHelloService.aidl 添加服务注册接口:

package com.yuandaima;
import com.yuandaima.ICallback;

interface IHelloService
{
	void sayhello();
	int sayhello_to(String name);
	void registerCallback(int pid, ICallback callback);
}
1
2
3
4
5
6
7
8
9

接下里我们编译 aidl 文件:

# 系统源码目录下
source build/envsetup.sh
# 选择合适的 product
lunch rice14-eng

# 进入到项目目录下
cd device/jelly/rice14/BinderJavaDemo/com/yuandaima
aidl ICallback.aidl
# -I 用于指定我们的在哪里查找 import
aidl -I .  IHelloService.aidl
1
2
3
4
5
6
7
8
9
10

编译完成后,项目整体目录如下:

BinderJavaDemo/
└── com
    └── yuandaima
        ├── Android.bp
        ├── Client.java
        ├── HelloService.java
        ├── ICallback.aidl
        ├── ICallback.java
        ├── IHelloService.aidl
        ├── IHelloService.java
        └── Server.java
1
2
3
4
5
6
7
8
9
10
11

接下来我们修改 Binder 服务端类,主要工作是添加注册回调函数:

//HelloService.java
package com.yuandaima;

import android.util.Log;

public class HelloService extends IHelloService.Stub {

    private ICallback mCallback;
    private static final String TAG = "HelloService";
    private int cnt1 = 0;
    private int cnt2 = 0;

    public void sayhello() throws android.os.RemoteException {
        cnt1++;
        Log.i(TAG, "sayhello : cnt = "+cnt1);
        //调用注册的回调接口
        if(mCallback != null) {
            mCallback.onMessage("message from server");
        }
    }
    
    public int sayhello_to(java.lang.String name) throws android.os.RemoteException {
        cnt2++;
        Log.i(TAG, "sayhello_to "+name+" : cnt = "+cnt2);
        return cnt2;
    }

    //添加注册回调函数
    public void registerCallback(int pid, ICallback callback) {
        Log.d(TAG, "register callback receive");
        mCallback = callback;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

接着修改客户端, 主要定义回调接口以及注册回调接口:

//Client.java
package com.yuandaima;

import android.util.Log;
import android.os.ServiceManager;

import android.os.RemoteException;

import android.os.IBinder;

public class Client {

    private static final String TAG = "BinderClient";

    public static void main(String args[])
    {
        
        /* 1. getService */
        IBinder binder = ServiceManager.getService("hello");
        
        if (binder == null)
        {
            Log.i(TAG, "can not get hello service");
            return;
        }

        IHelloService svr = IHelloService.Stub.asInterface(binder);
        
        ICallback callback = new ICallback.Stub() {

            @Override
            public void onMessage(String message) throws RemoteException {
                Log.d(TAG, "onMessage:" + message);
            }
        };
        try {
            svr.registerCallback(android.os.Process.myPid(), callback);
        } catch (RemoteException e) {
            Log.d(TAG, "register callback fail");
            e.printStackTrace();
        }
       

        try {
	        svr.sayhello();
	        Log.i(TAG, "call sayhello");
        } catch (Exception e) {

        }
           
        try {
	        int cnt = svr.sayhello_to("hello");
	    
	        Log.i(TAG, "call sayhello_to " + " : cnt = " + cnt);
        } catch (Exception e) {
            System.out.println("call sayhello_to , err :"+e);
            Log.i(TAG, "call sayhello_to , err : "+e);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

然后修改 Android.bp:

java_library {
    name: "BinderClient",
    installable: true,
    srcs: [ "Client.java", 
            "HelloService.java", 
            "IHelloService.java",
            "ICallback.java" ],
}

java_library {
    name: "BinderServer",
    installable: true,
    srcs: [ "Server.java", 
            "HelloService.java", 
            "IHelloService.java",
            "ICallback.java" ],
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

最后我们就可以运行我们的程序了:

# 在项目目录下执行
mm
# 在源码目录下执行
# 将 jar 包 push 到虚拟机上
cd out/target/product/generic_x86_64/system/framework
adb push BinderClient.jar /data/local/tmp
adb push BinderServer.jar /data/local/tmp

# 进入模拟器 shell 环境
adb shell

# 执行 java 程序
export CLASSPATH=/data/local/tmp/BinderClient.jar:/data/local/tmp/BinderServer.jar
# 启动服务端
app_process /data/local/tmp  com.yuandaima.Server
# 启动客户端
app_process /data/local/tmp com.yuandaima.Client 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

查看 log:

logcat | grep BinderClient
1

可以看出我们的 Client 端已经收到回调消息了,证明我们的回调执行成功了。

# 关于

我叫阿豪,2015 年本科毕业于国防科学技术大学指挥信息系统专业,毕业后从事信息化装备的研发工作,主要研究方向是 Android Framework 与 Linux Kernel。

如果你对 Android Framework 感兴趣或者正在学习 Android Framework,可以关注我的微信公众号和抖音,我会持续分享我的学习经验,帮助正在学习的你少走一些弯路。学习过程中如果你有疑问或者你的经验想要分享给大家可以添加我的微信,我拉你进技术交流群。