编辑YAML文件时如何保留单引号？

原因分析 #

默认YAML序列化器（如gopkg.in/yaml.v2或v3）会根据字符串内容自动判断是否添加引号：仅当字符串包含特殊字符（如$、<>、空格）时才自动加引号，普通字符串直接输出。但你需要强制保留所有字符串的单引号，因此需要显式配置序列化规则。

解决方案一：使用gopkg.in/yaml.v3标签选项（推荐） #

若使用yaml.v3版本，可直接在结构体的yaml标签中添加singlequote选项，强制字符串用单引号包裹：

修改后的结构体 #

import "gopkg.in/yaml.v3"

type PipelineConfig struct {
    Trigger   string `yaml:"trigger, singlequote"`
    Variables []struct {
        Name  string `yaml:"name, singlequote"`
        Value string `yaml:"value, singlequote"`
    } `yaml:"variables"`
    
    Stages []struct {
        Template   string `yaml:"template, singlequote"`
        Parameters struct {
            AppName       string `yaml:"app_name, singlequote"`
            AppRepoBranch string `yaml:"app_repo_branch, singlequote"`
            LocationEnv   string `yaml:"location_env, singlequote"`
            ComponentName string `yaml:"component_name, singlequote"`
            ClusterName   string `yaml:"cluster_name, singlequote"`
        } `yaml:"parameters"`
    } `yaml:"stages"`
}

注意事项 #

• 确保项目依赖yaml.v3，若之前用v2需升级：

  go get gopkg.in/yaml.v3
  

• 该选项会强制所有对应字段的字符串输出时用单引号包裹，完全匹配需求。

解决方案二：自定义字符串类型（兼容yaml.v2） #

若无法升级到yaml.v3，可自定义带单引号的字符串类型，实现yaml.Marshaler和yaml.Unmarshaler接口：

自定义类型实现 #

import "gopkg.in/yaml.v2"

type QuotedString string

func (s QuotedString) MarshalYAML() (interface{}, error) {
    // 手动添加单引号
    return "'" + string(s) + "'", nil
}

func (s *QuotedString) UnmarshalYAML(unmarshal func(interface{}) error) error {
    var str string
    if err := unmarshal(&str); err != nil {
        return err
    }
    // 解析时去除原始字符串的单引号（若存在）
    if len(str) >= 2 && str[0] == '\'' && str[len(str)-1] == '\'' {
        str = str[1 : len(str)-1]
    }
    *s = QuotedString(str)
    return nil
}

修改结构体使用自定义类型 #

type PipelineConfig struct {
    Trigger   QuotedString `yaml:"trigger"`
    Variables []struct {
        Name  QuotedString `yaml:"name"`
        Value QuotedString `yaml:"value"`
    } `yaml:"variables"`
    
    Stages []struct {
        Template   QuotedString `yaml:"template"`
        Parameters struct {
            AppName       QuotedString `yaml:"app_name"`
            AppRepoBranch QuotedString `yaml:"app_repo_branch"`
            LocationEnv   QuotedString `yaml:"location_env"`
            ComponentName QuotedString `yaml:"component_name"`
            ClusterName   QuotedString `yaml:"cluster_name"`
        } `yaml:"parameters"`
    } `yaml:"stages"`
}

使用注意点 #

• 赋值时需将普通字符串转换为QuotedString类型：

  config.Variables[i].Value = QuotedString(nameValue)
  

• 该方案兼容yaml.v2，可精准控制单引号的添加与解析。

验证效果 #

修改后重新运行代码，生成的YAML文件会保留所有字段的单引号，示例如下：

trigger: 'none'
variables:
    - name: 'app_name'
      value: 'test'
    - name: 'cluster_name'
      value: 'test'
    - name: 'component_name'
      value: '<component>'
    - name: 'location_env'
      value: 'dev'

stages:
    - template: 'tem'
      parameters:
        app_name: '${{ variables.app_name }}'
        app_repo_branch: 'develop'
        location_env: '${{ variables.location_env }}'
        component_name: '${{ variables.component_name }}'
        cluster_name: '${{ variables.cluster_name }}'

内容的提问来源于stack exchange，提问作者younes