gdbus 编程优化

原创已于 2025-07-07 16:14:42 修改 · 525 阅读

CC 4.0 BY-SA版权

文章标签：

于 2025-07-07 16:13:57 首次发布

将参数打包为 JSON 这种处理方法在 GDBus 中的应用，主要是为了简化复杂数据结构的传递和解析。通过这种方式，你可以轻松地将多个不同类型的参数打包成一个字符串（JSON 格式），并在客户端和服务端之间进行传输。这种方法不仅提高了接口的通用性和灵活性，还使得跨语言、跨平台的数据交换变得更加容易。

为什么选择 JSON？

通用性：几乎所有现代编程语言都支持 JSON 的序列化和反序列化。
易读性：JSON 格式的字符串易于阅读和理解，便于调试。
灵活性：可以轻松表示复杂的数据结构，如数组、对象等。
轻量级：相比于 XML 等其他格式，JSON 更加简洁，减少了网络传输的开销。

具体实现步骤

以下是一个详细的例子，展示了如何使用 JSON 来打包和解包参数，并通过 GDBus 在客户端和服务端之间传递这些参数。

示例场景

假设我们有一个服务端提供了一个 SetValue 方法，该方法接收两个整数作为输入参数，并返回一个结果。我们将这两个整数打包成一个 JSON 对象，然后以字符串的形式传递给服务端。

服务端代码

首先，我们需要定义 D-Bus 接口并实现相应的逻辑。

#include <gio/gio.h>
#include <json-glib/json-glib.h>

// 处理 SetValue 方法的回调函数
static void handle_set_value(ComExampleCalculator *object, GDBusMethodInvocation *invocation, const gchar *type, const gchar *input_array) {
    // 解析 JSON 字符串
    JsonParser *parser = json_parser_new();
    json_parser_load_from_data(parser, input_array, -1, NULL);
    JsonObject *root = json_node_get_object(json_parser_get_root(parser));

    // 提取参数
    gint param1 = json_object_get_int_member(root, "param1");
    const gchar *param2 = json_object_get_string_member(root, "param2");

    // 模拟一些业务逻辑
    gint result = param1 + strlen(param2); // 假设这是一个简单的计算

    // 完成方法调用并返回结果
    com_example_calculator_complete_set_value(object, invocation, result);

    g_object_unref(parser);
}

int main() {
    GMainLoop *loop = g_main_loop_new(NULL, FALSE);
    GError *error = NULL;

    // 创建服务对象实例
    ComExampleCalculator *service = com_example_calculator_skeleton_new();
    
    // 连接 handle_set_value 函数到 SetValue 方法
    g_signal_connect(service, "handle-set-value", G_CALLBACK(handle_set_value), NULL);

    // 获取会话总线连接
    GDBusConnection *connection = g_bus_get_sync(G_BUS_TYPE_SESSION, NULL, &error);
    if (connection == NULL) {
        g_printerr("Failed to connect to the bus: %s\n", error->message);
        return 1;
    }

    // 将服务对象导出到 D-Bus 上
    g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(service), connection, "/com/example/calculator", &error);
    if (error != NULL) {
        g_printerr("Failed to export object: %s\n", error->message);
        return 1;
    }

    g_print("Service is running...\n");
    
    // 启动主事件循环
    g_main_loop_run(loop);
    return 0;
}

客户端代码

接下来是客户端代码，它负责将参数打包成 JSON 字符串，并调用服务端的方法。

#include <gio/gio.h>
#include <json-glib/json-glib.h>

int main() {
    GError *error = NULL;
    
    // 获取会话总线连接
    GDBusConnection *connection = g_bus_get_sync(G_BUS_TYPE_SESSION, NULL, &error);
    if (connection == NULL) {
        g_printerr("Failed to connect to the bus: %s\n", error->message);
        return 1;
    }

    // 创建代理对象
    ComExampleCalculator *proxy = com_example_calculator_proxy_new_sync(connection, G_DBUS_PROXY_FLAGS_NONE, "com.example.Calculator", "/com/example/calculator", NULL, &error);
    if (proxy == NULL) {
        g_printerr("Failed to create proxy: %s\n", error->message);
        return 1;
    }

    // 创建 JSON 对象并添加参数
    JsonObject *root = json_object_new();
    json_object_set_int_member(root, "param1", 10);
    json_object_set_string_member(root, "param2", "Hello World!");

    // 将 JSON 对象转换为字符串
    JsonGenerator *generator = json_generator_new();
    json_generator_set_root(generator, json_node_init_object(json_node_alloc(), root));
    gchar *json_str = json_generator_to_data(generator, NULL);

    // 调用远程方法
    gint result;
    gboolean success = com_example_calculator_call_set_value_sync(proxy, 1, json_str, &result, NULL, &error);
    if (!success) {
        g_printerr("Failed to call SetValue: %s\n", error->message);
        return 1;
    }
    g_print("Result of SetValue: %d\n", result);

    // 清理资源
    g_free(json_str);
    g_object_unref(generator);
    g_object_unref(proxy);
    g_object_unref(connection);

    return 0;
}

json_generator_new(): 创建一个新的 JSON 生成器对象。
json_generator_set_root(): 设置生成器的根节点为之前创建的 JSON 对象。这里我们使用
json_node_init_object() 和 json_node_alloc() 来初始化一个 JSON 节点，并将其设置为根节点。
json_generator_to_data(): 将 JSON 对象转换为字符串格式。结果存储在 json_str 中，其内容将是类似于 {“param1”:10,“param2”:“Hello World!”} 的字符串。

关键点解释

创建 JSON 对象：

在客户端，我们使用 JsonObject 来创建一个 JSON 对象，并通过 json_object_set_*_member() 函数设置其成员。

JsonObject *root = json_object_new();
json_object_set_int_member(root, "param1", 10);
json_object_set_string_member(root, "param2", "Hello World!");

转换为 JSON 字符串：

使用 JsonGenerator 将 JSON 对象转换为字符串，以便可以通过 D-Bus 传递。

JsonGenerator *generator = json_generator_new();
json_generator_set_root(generator, json_node_init_object(json_node_alloc(), root));
gchar *json_str = json_generator_to_data(generator, NULL);

服务端解析 JSON 字符串：

在服务端，接收到 JSON 字符串后，使用 JsonParser 解析该字符串，并提取其中的参数。

JsonParser *parser = json_parser_new();
json_parser_load_from_data(parser, input_array, -1, NULL);
JsonObject *root = json_node_get_object(json_parser_get_root(parser));

gint param1 = json_object_get_int_member(root, "param1");
const gchar *param2 = json_object_get_string_member(root, "param2");