当前位置: article > 正文

Qt——xml文件生成DBus接口

作者：你好赵伟 | 2024-04-25 01:34:23

踩

Qt——xml文件生成DBus接口

1. 如何根据xml文件生成Dbus接口

要使用 XML 文件生成 D-Bus 接口，你可以按照以下步骤操作：

步骤 1: 准备 XML 文件

确保你的 XML 文件遵循 D-Bus 的接口描述规范。这通常包括定义接口、方法、信号和属性。一个基本的例子如下：


<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
  <interface name="com.example.SampleInterface">
    <method name="TestMethod">
      <arg direction="in" type="s" name="input"/>
      <arg direction="out" type="s" name="output"/>
    </method>
    <signal name="TestSignal">
      <arg type="s" name="signalData"/>
    </signal>
  </interface>
</node>

步骤 2: 使用工具生成代码

在 Linux 系统上，你可以使用 `gdbus-codegen` 工具来根据 XML 文件生成代码。这个工具是 Glib 库的一部分，能够生成服务端和客户端代码。


1. 安装工具（如果尚未安装）：
   sudo apt-get install libglib2.0-dev
 
2. 生成代码：
   gdbus-codegen --generate-c-code my_interface_gen --c-namespace My --interface-prefix com.example. my_interface.xml
这里，`my_interface_gen` 是生成的源文件的前缀，`com.example.` 是接口名称的前缀，`my_interface.xml` 是你的 XML 文件。
 
生成的文件通常包括：
- `my_interface_gen.h`：头文件，包含接口定义。
- `my_interface_gen.c`：源文件，包含接口实现的框架。

当你使用工具如 `qdbusxml2cpp`（这是 Qt 提供的一个工具，用来从 D-Bus XML 描述文件生成 D-Bus 适配器代码），你会得到两个主要的文件：

1. Header (.h) 文件 - 包含了从 XML 文件定义的 D-Bus 接口生成的 C++ 类的声明。这个类通常继承自 `QDBusAbstractAdaptor`。
2. Source (.cpp) 文件 - 包含了实现文件，实现了 XML 文件中定义的接口。

使用 `qdbusxml2cpp` 生成的适配器代码可能会看起来像这样：


// Generated Adaptor Code (SampleAdaptor.h)
#include <QDBusAbstractAdaptor>
#include <QDBusConnection>
#include <QObject>
 
class SampleAdaptor : public QDBusAbstractAdaptor {
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "com.example.SampleInterface")
public:
    SampleAdaptor(QObject *parent) : QDBusAbstractAdaptor(parent) {
        // Constructor code here
    }
 
public slots:
    QString TestMethod(const QString &input) {
        // Implementation here
        return "Received: " + input;
    }
signals:
    void TestSignal(const QString &signalData);
};

2. QDBusAbstractAdaptor QDBusAbstractInter区别是什么?

在 Qt 的 D-Bus 模块中，`QDBusAbstractAdaptor` 和 `QDBusAbstractInterface` 是两个核心类，它们在 D-Bus 系统中扮演不同的角色，分别用于实现服务端适配器和客户端接口。下面是这两个类的主要区别和用途：

QDBusAbstractAdaptor

1. 定义与用途：
- `QDBusAbstractAdaptor` 类用于创建 D-Bus 适配器。这个适配器充当了 Qt 对象和 D-Bus 之间的桥梁。
- 它通常用于将现有的 Qt 对象的功能公开为 D-Bus 服务，允许其他应用程序通过 D-Bus 调用这些功能。

2. 工作方式：
- 适配器类从 `QDBusAbstractAdaptor` 派生，并将其关联到一个 QObject。这个适配器为 QObject 定义的公开方法、信号和属性提供 D-Bus 访问。

3. 特点：
- 适配器通过注册到 D-Bus 系统来使得其他应用可以通过 D-Bus 通信机制调用其方法、接收信号或访问属性。

QDBusAbstractInterface

1. 定义与用途：
- `QDBusAbstractInterface` 类用于创建能与 D-Bus 服务进行交互的客户端接口。
- 它通常用于编写客户端应用程序，这些应用程序需要与 D-Bus 服务通信，调用服务提供的方法或访问服务的属性。

2. 工作方式：
- 从 `QDBusAbstractInterface` 派生的类可以用来表示 D-Bus 上的远程接口。这个类处理所有的低级 D-Bus 通信细节，如方法调用、信号订阅和属性访问。

3. 特点：
- 客户端接口对象提供了一个高级的抽象，使得开发者可以像调用本地对象一样调用远程 D-Bus 服务的方法。

`QDBusAbstractAdaptor` 适用于需要将应用的一部分功能通过 D-Bus 公开给其他应用调用的场景（服务端），`QDBusAbstractAdaptor` 是为了将本地对象的功能“导出”到 D-Bus 上。

`QDBusAbstractInterface` 适用于需要从应用中访问其他应用公开的 D-Bus 服务的场景（客户端），`QDBusAbstractInterface` 是为了从 D-Bus 上“导入”远程服务的接口。

2.1 举例

接下来通过一个简单的例子来展示如何使用 `QDBusAbstractAdaptor` 和 `QDBusAbstractInterface` 来在 Qt 应用程序中实现 D-Bus 服务端和客户端。

假设我们有一个简单的系统服务，它提供了一个方法来获取系统的当前时间。我们将首先创建一个服务端应用程序，它使用 `QDBusAbstractAdaptor` 将这个功能公开为一个 D-Bus 服务。然后，我们将创建一个客户端应用程序，使用 `QDBusAbstractInterface` 来访问这个服务。

服务端：使用 QDBusAbstractAdaptor


1. 定义服务接口 (`TimeService.h`):
 
   #include <QObject>
   #include <QDBusAbstractAdaptor>
   #include <QDateTime>
 
   class TimeService : public QObject
   {
       Q_OBJECT
       Q_CLASSINFO("D-Bus Interface", "com.example.timeservice")
   public:
       explicit TimeService(QObject *parent = nullptr) : QObject(parent) {}
 
   public slots:
       QString getCurrentTime() {
           return QDateTime::currentDateTime().toString();
       }
   };
 
   class TimeServiceAdaptor : public QDBusAbstractAdaptor
   {
       Q_OBJECT
       Q_CLASSINFO("D-Bus Interface", "com.example.timeservice")
   public:
       explicit TimeServiceAdaptor(TimeService *service)
           : QDBusAbstractAdaptor(service), m_service(service) {
           setAutoRelaySignals(true);
       }
 
   public slots:
       QString getCurrentTime() {
           return m_service->getCurrentTime();
       }
 
   private:
       TimeService *m_service;
   };
 
 
2. 实现主函数 (`main.cpp`):
 
   #include <QCoreApplication>
   #include <QDBusConnection>
   #include "TimeService.h"
 
   int main(int argc, char *argv[])
   {
       QCoreApplication app(argc, argv);
 
       TimeService service;
       TimeServiceAdaptor adaptor(&service);
 
       QDBusConnection connection = QDBusConnection::sessionBus();
       connection.registerObject("/timeservice", &service);
       connection.registerService("com.example.timeservice");
 
       return app.exec();
   }

仔细看代码会发现 `TimeServiceAdaptor`构造函数中，有一个方法`setAutoRelaySignals(true)`，这个函数的作用可参见setAutoRelaySignals(true)-CSDN博客

客户端：使用 QDBusAbstractInterface


1. 定义客户端接口 (`TimeClient.h`):
 
   #include <QDBusAbstractInterface>
   #include <QDBusConnection>
 
   class TimeClient : public QDBusAbstractInterface
   {
       Q_OBJECT
 
   public:
       explicit TimeClient(QObject *parent = nullptr)
           : QDBusAbstractInterface("com.example.timeservice",
                                    "/timeservice",
                                    "com.example.timeservice",
                                    QDBusConnection::sessionBus(),
                                    parent) {}
 
       QDBusPendingCall asyncGetCurrentTime() {
           return asyncCall("getCurrentTime");
       }
   };
 
 
2. 实现客户端主函数 (`main.cpp`):
 
   #include <QCoreApplication>
   #include <QDebug>
   #include "TimeClient.h"
 
   int main(int argc, char *argv[])
   {
       QCoreApplication app(argc, argv);
 
       TimeClient client;
       QDBusPendingReply<QString> reply = client.asyncGetCurrentTime();
       reply.waitForFinished();
       if (reply.isValid()) {
           qDebug() << "Current Time:" << reply.value();
       } else {
           qDebug() << "Error:" << reply.error().message();
       }
 
       return app.exec();
   }

        在这个示例中：
        - 服务端应用程序创建了一个 `TimeService` 对象和一个 `TimeServiceAdaptor` 适配器，通过 D-Bus 在 `com.example.timeservice` 服务下公开了一个方法 `getCurrentTime`。
        - 客户端应用程序使用 `TimeClient`（派生自 `QDBusAbstractInterface`）来异步调用这个方法，并在接收到结果后打印当前时间或错误信息。

3. xml生成的QDBusAbstractAdaptor函数直接就生成dbus服务了吗？

使用 XML 文件生成 `QDBusAbstractAdaptor` 类的代码并不会直接创建一个运行的 D-Bus 服务。这个过程只是自动化了在 Qt 中为 D-Bus 服务编写适配器代码的部分工作，生成的适配器代码需要在一个 Qt 应用程序中被编译和运行，才能实际形成一个可用的 D-Bus 服务。

看过刚刚服务端的例子，可以了解到尽管 XML 到 `QDBusAbstractAdaptor` 的代码生成是自动的，但是要让这个适配器成为一个活跃的 D-Bus 服务，还需要手动编写一些胶水代码来实例化和注册到 D-Bus 系统。这包括设置 Qt 应用程序基础设施、实例化适配器类、并且确保它被注册为一个 D-Bus 服务。

4. QDBusAbstractAdaptor如何绑定的接口

在 Qt 的 D-Bus 系统中，`QDBusAbstractAdaptor` 类用于将一个 QObject 或其子类的方法、属性和信号绑定到 D-Bus 接口。这个绑定过程是通过几个关键步骤实现的，使得当远程 D-Bus 调用发生时，相应的本地 QObject 的方法能够被触发。下面详细介绍这个过程。

创建 QObject 子类

首先，你需要有一个 QObject 子类，这个类实现了你想要通过 D-Bus 公开的功能。例如：


class MyService : public QObject {
    Q_OBJECT
public:
    explicit MyService(QObject *parent = nullptr) : QObject(parent) {}
 
public slots:
    QString performAction(const QString &param) {
        // 实现具体的功能
        return "Action performed with: " + param;
    }
};

创建和配置 QDBusAbstractAdaptor 子类

接着，你创建一个从 `QDBusAbstractAdaptor` 派生的类，这个类将作为中间人，把 D-Bus 调用转发到你的 QObject 子类。你需要在这个适配器类中声明你想通过 D-Bus 公开的所有方法、信号和属性。


class MyServiceAdaptor : public QDBusAbstractAdaptor {
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "com.example.MyService")
public:
    explicit MyServiceAdaptor(MyService *service)
        : QDBusAbstractAdaptor(service), myService(service) {
        // 自动将所有信号关联到 D-Bus
        setAutoRelaySignals(true);
    }
 
public slots:
    QString performAction(const QString &param) {
        return myService->performAction(param);
    }
 
private:
    MyService *myService;
};

注册 QObject 和适配器到 D-Bus 系统

在你的应用程序的主函数中或在适当的初始化代码中，你需要创建你的服务和适配器的实例，并将它们注册到 D-Bus 系统中。


int main(int argc, char *argv[]) {
    QCoreApplication app(argc, argv);
 
    MyService service;
    MyServiceAdaptor adaptor(&service);
 
    QDBusConnection dbus = QDBusConnection::sessionBus();
    bool success = dbus.registerObject("/MyService", &service);
    success &= dbus.registerService("com.example.MyService");
 
    return success ? app.exec() : -1;
}

绑定和调用流程

1. D-Bus 请求到达：当其他应用通过 D-Bus 发送请求调用 `performAction` 方法时，请求首先到达 D-Bus 守护进程。
2. 适配器接收请求：D-Bus 守护进程将调用转发到注册的对象（在本例中是 `/MyService`）和其适配器。
3. 适配器调用 QObject 方法：`MyServiceAdaptor` 的 `performAction` 方法被触发，该方法内部再调用 `MyService` 实例的 `performAction` 方法。
4. 结果返回给调用者：方法执行完成后的返回值被发送回调用者。

这种方式通过 `QDBusAbstractAdaptor` 类来封装 QObject 的实现细节，使得 D-Bus 服务的创建和管理更加模块化和清晰。这样，你就能够在 Qt 应用程序中方便地实现和使用基于 D-Bus 的 IPC (进程间通信) 功能。

5. 为了调用能联通 MyServiceAdaptor 和MyService的方法名需一致吗？

        在使用 `QDBusAbstractAdaptor` 时，确保 D-Bus 接口能够正确地调用到后端 `MyService` 的方法，并不严格要求适配器和服务中的方法名完全一致。但是，使它们一致通常会使代码更易于理解和维护。关键在于适配器方法中如何调用服务方法，以及如何映射 D-Bus 接口到具体的实现。
        `QDBusAbstractAdaptor` 的工作是为一个或多个 QObject 方法提供 D-Bus 访问。当你创建适配器类的时候，你定义了哪些方法应该通过 D-Bus 被暴露出去。这包括在适配器中定义方法，这些方法将会在 D-Bus 调用时被触发。在这些方法内部，你可以调用实际的服务对象（例如 `MyService` 类）的任何方法。
        以下示例展示了即使方法名不一致，适配器如何将调用正确地转发给服务对象：

服务器的类如上，就不举例了，下面是修改后的适配器类


 class MyServiceAdaptor : public QDBusAbstractAdaptor {
       Q_OBJECT
       Q_CLASSINFO("D-Bus Interface", "com.example.MyService")
   public:
       explicit MyServiceAdaptor(MyService *service)
           : QDBusAbstractAdaptor(service), myService(service) {
           setAutoRelaySignals(true);
       }
 
   public slots:
       QString performAction(const QString &param) {
           return myService->serviceAction(param);
            //注意这里函数名不一致，主要还是看绑定的对象
       }
 
   private:
       MyService *myService;
   };

在这个例子中，适配器的 `performAction` 方法调用了服务对象 `MyService` 的 `serviceAction` 方法。这样的设计允许你在 D-Bus 接口中公开一个逻辑上的接口，而无需关心服务实现的内部方法名，增加了灵活性。

6. xml 生成的`QDBusAbstractInterface`，客户端是怎么使用的？

在 Qt 中使用 `QDBusAbstractInterface` 创建 D-Bus 客户端是与 D-Bus 服务进行交互的一种方式。`QDBusAbstractInterface` 提供了一个便捷的方法来调用 D-Bus 服务上的方法、订阅信号和访问属性，而无需手写大量的 D-Bus 通信代码。下面详细介绍如何使用 `QDBusAbstractInterface` 创建和使用一个 D-Bus 客户端。

### 步骤 1: 创建客户端接口

假设你已经有一个 D-Bus 服务在运行，比如前面服务端的例子，你可以手动定义接口或使用 `qdbusxml2cpp` 工具生成接口类。这里我们手动定义一个：


   #include <QDBusAbstractInterface>
   #include <QDBusReply>
 
   class TestClient : public QDBusAbstractInterface {
   public:
       TestClient (QObject *parent = nullptr)
           : QDBusAbstractInterface("com.test",
                                    "/test,
                                    "com.test",
                                    QDBusConnection::sessionBus(),
                                    parent) {}
       QDBusReply<void> test(const QString &name, const QString &testname) {
           return call("test", name, testname);
       }
   };

这个类定义了如何连接到 D-Bus 服务 (`com.test`) 和调用 `test` 方法。

使用客户端接口，在你的 Qt 应用程序中，你可以创建 `TestClient` 的实例并使用它来调用 D-Bus 服务。


#include <QCoreApplication>
#include <QDebug>
 
 
int main(int argc, char *argv[]) {
    QCoreApplication app(argc, argv);
 
    TestClient client;
    QDBusReply<void> reply = client.test("test", "test");
 
    if (reply.isValid()) {
        qDebug() << "Call succeeded";
    } else {
        qDebug() << "Call failed:" << reply.error().message();
    }
 
    return app.exec();
}

7. QDBusAbstractAdaptor 和QDBusAbstractInterface之间是怎么绑定的呢?

在 Qt 的 D-Bus 系统中，`QDBusAbstractInterface` 和对应的 `QDBusAbstractAdaptor` 之间的“绑定”是通过 D-Bus 服务的接口定义实现的。具体来说，这种绑定不是在代码层面上直接操作的，而是通过 D-Bus 的服务注册和接口调用机制来实现相互操作的。下面详细解释这个过程。

这种“绑定”实际上是通过 D-Bus 的消息传递系统在服务端和客户端之间进行的。下面是绑定过程的简化描述：

1. 服务注册:
- 在服务端，`QDBusAbstractAdaptor` 将 QObject 的某些功能注册为 D-Bus 服务。
- 服务通过在 D-Bus 系统中注册一个唯一的服务名称和对象路径来完成。
- 这些信息（服务名称、对象路径、接口名）都需要在客户端知晓，以便能正确地定位和调用服务。

2. 服务发现:
- 客户端使用 `QDBusAbstractInterface` 来创建一个代表远程服务的对象。
- 客户端在创建这个接口对象时，需要指定服务名称、对象路径和接口名称。
- 一旦指定，`QDBusAbstractInterface` 就可以使用这些信息通过 D-Bus 发送调用请求。

3. 方法调用和响应
- 当客户端通过 `QDBusAbstractInterface` 调用一个方法时，D-Bus 守护进程将这个调用转发到服务端。
- 服务端的 `QDBusAbstractAdaptor` 接收到调用后，会将其转化为本地的 QObject 方法调用。
- 执行结果（如果方法调用有返回值）或状态（成功或失败）将通过 D-Bus 返回给客户端。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/你好赵伟/article/detail/482605

Qt——xml文件生成DBus接口

1. 如何根据xml文件生成Dbus接口

步骤 1: 准备 XML 文件

步骤 2: 使用工具生成代码

2. QDBusAbstractAdaptor QDBusAbstractInter区别是什么?

2.1 举例

3. xml生成的QDBusAbstractAdaptor函数 直接就生成dbus服务了吗？

4. QDBusAbstractAdaptor如何绑定的接口

5. 为了调用能联通 MyServiceAdaptor 和MyService的方法名需一致吗？

6. xml 生成的`QDBusAbstractInterface`，客户端是怎么使用的？

7. QDBusAbstractAdaptor 和QDBusAbstractInterface之间是怎么绑定的呢?

3. xml生成的QDBusAbstractAdaptor函数直接就生成dbus服务了吗？