go语言操作windows注册表

---

简介

注册表是windows中很重要的一个功能，通过它可以实现很多功能，在Go语言中操作注册表就目前而言有三种方式

1. 命令：通过exec.Command执行REGINI命令来操作注册表，效率较低
2. 系统调用：在syscall/zsyscall_windows.go文件中包含了所有的注册表操作的系统调用，用编程的方式进行操作
3. 库：go官方编写了注册表库registry，其原理就是封装了系统调用

很显然，使用官方编写的库效率是最高的，不过它并没有加入标准库，需要我们单独下载。

$ go get golang.org/x/sys@latest

示例

const (
	// Windows defines some predefined root keys that are always open.
	// An application can use these keys as entry points to the registry.
	// Normally these keys are used in OpenKey to open new keys,
	// but they can also be used anywhere a Key is required.
	CLASSES_ROOT     = Key(syscall.HKEY_CLASSES_ROOT)
	CURRENT_USER     = Key(syscall.HKEY_CURRENT_USER)
	LOCAL_MACHINE    = Key(syscall.HKEY_LOCAL_MACHINE)
	USERS            = Key(syscall.HKEY_USERS)
	CURRENT_CONFIG   = Key(syscall.HKEY_CURRENT_CONFIG)
	PERFORMANCE_DATA = Key(syscall.HKEY_PERFORMANCE_DATA)
)

大部分注册表操作都是基于这些windows预定义好的键，库中以常量的方式定义了这些键，可以直接使用。操作一个注册表项的API跟操作文件没什么太大的区别，使用完后一样要关闭。

新建

下面演示一个创建GoLand右键菜单项的例子。

func CreateKey(k Key, path string, access uint32) (newk Key, openedExisting bool, err error)

首先如果要修改右键菜单的话，就需要基于CLASSES_ROOT键，rootKey作为第一个参数，子路径作为第二个参数传递

// 在文件夹背景生效
Directory\Background\shell\goland

第三个参数是access，就类似于访问文件的perm一样，关于这个的详细释义可以看注册表项安全和访问权限 - Win32 apps | Microsoft Learn，那么代码如下

golandkey, exist, err := registry.CreateKey(registry.CLASSES_ROOT, 
                                            `Directory\Background\shell\goland`,registry.WRITE|registry.READ)

然后给它设置两个字符串值，类型为REG_EXPAND_SZ或REG_MULTI_SZ都行，键为空就表示默认值，内容会展示到菜单上，Icon即图标。

bin := "D:\\work\\tools\\toolbox\\GoLand\\bin\\goland64.exe"
golandkey.SetStringValue("", "Open Goland Here")
golandkey.SetExpandStringValue("Icon", bin)

然后再创建一个子项command，表示动作

golandCmdKey, exist, err := registry.CreateKey(registry.CLASSES_ROOT, 
                                               `Directory\Background\shell\goland\command`, registry.WRITE|registry.READ)

它的默认值就是goland程序的地址

golandCmdKey.SetExpandStringValue("",`"D:\work\tools\toolbox\GoLand\bin\goland64.exe" "%V"`)

完整代码如下

package main

import (
	"fmt"
	"golang.org/x/sys/windows/registry"
	"log"
)

func main() {

	golandkey, exist, err := registry.CreateKey(registry.CLASSES_ROOT, `Directory\Background\shell\goland`, registry.WRITE|registry.READ)
	if exist {
		log.Println("Key already exists")
		return
	}
	if err != nil {
		fmt.Println(err)
		return
	}
	bin := "D:\\work\\tools\\toolbox\\GoLand\\bin\\goland64.exe"
	golandkey.SetStringValue("", "Open Goland Here")
	golandkey.SetExpandStringValue("Icon", bin)

	golandCmdKey, exist, err := registry.CreateKey(registry.CLASSES_ROOT, `Directory\Background\shell\goland\command`, registry.WRITE|registry.READ)
	if exist {
		log.Println("Key already exists")
		return
	}
	if err != nil {
		fmt.Println(err)
		return
	}
	golandCmdKey.SetExpandStringValue("", fmt.Sprintf(`"%s" "%%V"`, bin))
}

需要注意的是在运行时必须要以管理员模式执行，否则会拒绝访问。

成功后效果如下

删除

如果要删除一个注册表项，那么它必须没有子项才能成功删除，否则会返回错误

Access is denied

所以必须要先递归删除它的所有子项才行，我们可以编写下面一个简单的函数

func deleteKey(key registry.Key, path string) error {
	// 访问当前项，查看是否存在，不存在直接返回
	parentKey, err := registry.OpenKey(key, path, registry.READ)
	if errors.Is(err, registry.ErrNotExist) {
		return nil
	} else if err != nil {
		return err
	}
	defer parentKey.Close()

	// 拼接路径
	if len(path) > 0 && path[len(path)-1] != '\\' {
		path = path + `\`
	}

	// 访问它的所有子项
	subKeyNames, err := parentKey.ReadSubKeyNames(-1)
	if err != nil {
		return err
	}

	// 继续递归
	for _, name := range subKeyNames {
		subKeyPath := path + name
		err := deleteKey(key, subKeyPath)
		if err != nil {
			return err
		}
	}

	// 最后才删除当前注册表项
	return registry.DeleteKey(key, path)
}

总结

总的来说使用官方的API是最简单的，库函数加起来也没几个，非常易于使用。