使用Golang修改YAML文件的实践指南

对于修改YAML文件同时保持格式和注释的需求，推荐使用yaml.v3库的yaml.Node结构。以下是具体实现示例：

package main

import (
    "fmt"
    "io/ioutil"
    "gopkg.in/yaml.v3"
)

func updateYAML(filePath string, targetPath []string, newValue interface{}) error {
    // 读取YAML文件
    data, err := ioutil.ReadFile(filePath)
    if err != nil {
        return err
    }

    // 解析为yaml.Node
    var root yaml.Node
    if err := yaml.Unmarshal(data, &root); err != nil {
        return err
    }

    // 递归查找并修改目标节点
    if err := findAndUpdateNode(&root, targetPath, newValue); err != nil {
        return err
    }

    // 重新编组回YAML
    output, err := yaml.Marshal(&root)
    if err != nil {
        return err
    }

    // 写回文件
    return ioutil.WriteFile(filePath, output, 0644)
}

func findAndUpdateNode(node *yaml.Node, path []string, newValue interface{}) error {
    if len(path) == 0 {
        // 找到目标节点，更新值
        node.Value = fmt.Sprintf("%v", newValue)
        return nil
    }

    currentKey := path[0]
    remainingPath := path[1:]

    // 遍历当前节点的内容
    for i := 0; i < len(node.Content); i += 2 {
        keyNode := node.Content[i]
        valueNode := node.Content[i+1]

        if keyNode.Value == currentKey {
            return findAndUpdateNode(valueNode, remainingPath, newValue)
        }
    }

    return fmt.Errorf("key not found: %s", currentKey)
}

func main() {
    // 示例：修改嵌套的键值
    targetPath := []string{"services", "app", "environment", "LOG_LEVEL"}
    newValue := "debug"
    
    err := updateYAML("docker-compose.yml", targetPath, newValue)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
    }
}

对于更复杂的Docker Compose文件修改，可以使用更通用的方法：

func updateDockerCompose(filePath string, serviceName string, envKey string, envValue string) error {
    data, err := ioutil.ReadFile(filePath)
    if err != nil {
        return err
    }

    var root yaml.Node
    if err := yaml.Unmarshal(data, &root); err != nil {
        return err
    }

    // 查找services节点
    servicesNode := findNode(&root, "services")
    if servicesNode == nil {
        return fmt.Errorf("services not found")
    }

    // 查找特定服务
    serviceNode := findNode(servicesNode, serviceName)
    if serviceNode == nil {
        return fmt.Errorf("service %s not found", serviceName)
    }

    // 查找或创建environment节点
    envNode := findNode(serviceNode, "environment")
    if envNode == nil {
        // 创建新的environment节点
        envNode = &yaml.Node{
            Kind:    yaml.MappingNode,
            Tag:     "!!map",
            Content: []*yaml.Node{},
        }
        addToNode(serviceNode, "environment", envNode)
    }

    // 更新环境变量
    updateEnvVar(envNode, envKey, envValue)

    output, err := yaml.Marshal(&root)
    if err != nil {
        return err
    }

    return ioutil.WriteFile(filePath, output, 0644)
}

func findNode(parent *yaml.Node, key string) *yaml.Node {
    if parent.Kind == yaml.DocumentNode && len(parent.Content) > 0 {
        return findNode(parent.Content[0], key)
    }
    
    if parent.Kind == yaml.MappingNode {
        for i := 0; i < len(parent.Content); i += 2 {
            if parent.Content[i].Value == key {
                return parent.Content[i+1]
            }
        }
    }
    return nil
}

这种方法可以保持YAML文件的原始格式、注释和结构，同时只修改指定的键值。yaml.Node提供了对YAML文档的完整控制，包括行注释、头部注释等元数据。