Golang D-Bus 原生绑定插件库 dbus 使用指南

D-Bus 是 Linux 系统上广泛使用的进程间通信(IPC)机制，Go 语言可以通过 github.com/godbus/dbus 库实现原生 D-Bus 绑定。下面我将详细介绍如何使用这个库。

安装

首先安装 dbus 库：

go get github.com/godbus/dbus/v5

基本概念

D-Bus 中有几个核心概念：

• 总线(Bus)：系统总线(system bus)和会话总线(session bus)
• 对象路径(Object Path)：类似于文件路径的标识符，如 /org/freedesktop/DBus
• 接口(Interface)：定义了一组方法和信号
• 服务名(Service Name)：如 org.freedesktop.DBus

连接到 D-Bus

package main

import (
	"github.com/godbus/dbus/v5"
	"log"
)

func main() {
	// 连接到会话总线
	conn, err := dbus.SessionBus()
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	// 连接到系统总线
	// conn, err := dbus.SystemBus()
}

调用 D-Bus 方法

func callMethod(conn *dbus.Conn) {
	// 创建一个 D-Bus 对象
	obj := conn.Object("org.freedesktop.DBus", "/org/freedesktop/DBus")

	// 调用 ListNames 方法
	var result []string
	err := obj.Call("org.freedesktop.DBus.ListNames", 0).Store(&result)
	if err != nil {
		log.Fatal(err)
	}

	log.Println("D-Bus 服务列表:")
	for _, name := range result {
		log.Println(name)
	}
}

导出 D-Bus 服务

package main

import (
	"github.com/godbus/dbus/v5"
	"log"
)

const (
	objectPath = "/com/example/Hello"
	interfaceName = "com.example.Hello"
	serviceName = "com.example.HelloService"
)

// Hello 结构体实现 D-Bus 接口
type Hello struct{}

// SayHello 是要导出的方法
func (h *Hello) SayHello(name string) (string, *dbus.Error) {
	return "Hello " + name, nil
}

func exportService(conn *dbus.Conn) {
	// 请求服务名
	reply, err := conn.RequestName(serviceName, dbus.NameFlagDoNotQueue)
	if err != nil {
		log.Fatal(err)
	}
	if reply != dbus.RequestNameReplyPrimaryOwner {
		log.Fatal("名称已被占用")
	}

	// 导出接口
	err = conn.Export(&Hello{}, objectPath, interfaceName)
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("已导出服务 %s 在路径 %s", serviceName, objectPath)
}

func main() {
	conn, err := dbus.SessionBus()
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	exportService(conn)
	
	// 保持程序运行
	select {}
}

监听信号

func watchSignals(conn *dbus.Conn) {
	// 添加匹配规则来监听 NameOwnerChanged 信号
	err := conn.AddMatchSignal(
		dbus.WithMatchInterface("org.freedesktop.DBus"),
		dbus.WithMatchMember("NameOwnerChanged"),
	)
	if err != nil {
		log.Fatal(err)
	}

	c := make(chan *dbus.Signal, 10)
	conn.Signal(c)

	for signal := range c {
		if signal.Name == "org.freedesktop.DBus.NameOwnerChanged" {
			name := signal.Body[0].(string)
			oldOwner := signal.Body[1].(string)
			newOwner := signal.Body[2].(string)
			log.Printf("NameOwnerChanged: %s (old: %s, new: %s)", name, oldOwner, newOwner)
		}
	}
}

属性访问

type Properties struct {
	Value int `dbus:"value"`
}

func propertyExample(conn *dbus.Conn) {
	props := &Properties{Value: 42}
	
	// 导出属性接口
	err := conn.Export(props, "/com/example/Props", "org.freedesktop.DBus.Properties")
	if err != nil {
		log.Fatal(err)
	}

	// 客户端获取属性
	obj := conn.Object("com.example.PropsService", "/com/example/Props")
	var value int
	err = obj.Call("org.freedesktop.DBus.Properties.Get", 0, "com.example.Props", "value").Store(&value)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("属性值: %d", value)
}

注意事项

1. D-Bus 方法调用是同步的，如果需要异步调用，可以使用 goroutine
2. 导出的方法必须返回 *dbus.Error 作为最后一个返回值
3. 方法参数和返回值必须是可以被 D-Bus 类型系统表示的类型
4. 在导出服务前应该先检查服务名是否可用

完整示例

下面是一个完整的服务端和客户端示例：

服务端:

package main

import (
	"github.com/godbus/dbus/v5"
	"log"
)

const (
	objectPath    = "/com/example/Calculator"
	interfaceName = "com.example.Calculator"
	serviceName   = "com.example.CalculatorService"
)

type Calculator struct{}

func (c *Calculator) Add(a, b int32) (int32, *dbus.Error) {
	return a + b, nil
}

func (c *Calculator) Subtract(a, b int32) (int32, *dbus.Error) {
	return a - b, nil
}

func main() {
	conn, err := dbus.SessionBus()
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	reply, err := conn.RequestName(serviceName, dbus.NameFlagDoNotQueue)
	if err != nil {
		log.Fatal(err)
	}
	if reply != dbus.RequestNameReplyPrimaryOwner {
		log.Fatal("名称已被占用")
	}

	err = conn.Export(&Calculator{}, objectPath, interfaceName)
	if err != nil {
		log.Fatal(err)
	}

	log.Println("计算器服务已启动...")
	select {}
}

客户端:

package main

import (
	"github.com/godbus/dbus/v5"
	"log"
)

func main() {
	conn, err := dbus.SessionBus()
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	obj := conn.Object("com.example.CalculatorService", "/com/example/Calculator")

	var result int32
	err = obj.Call("com.example.Calculator.Add", 0, int32(10), int32(5)).Store(&result)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("10 + 5 = %d", result)

	err = obj.Call("com.example.Calculator.Subtract", 0, int32(10), int32(5)).Store(&result)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("10 - 5 = %d", result)
}

通过以上示例，你可以实现基本的 D-Bus 通信功能。godbus/dbus 库还支持更高级的功能如属性访问、信号监听等，可以根据需要进一步探索。