格式化输出

fmt.Printf(格式字符串,arg列表)使用格式字符串格式化arg列表 fmt.Println(arg列表)使用动词 v 格式化 arg 列表,所有元素之间添加空格,结尾添加换行符 fmt.Print(arg列表)使用动词 v 格式化 arg 列表,非字符串元素之间添加空格

格式字符串由普通字符和占位符组成

占位符以%开始(除转义的字符),以动词结尾,格式如下:

%[旗标][宽度][.精度][arg索引]动词 方括号内的动词可以省略

###旗标 旗标有以下几种:

    • :对于数值类型总是输出正负号(其它用法在动词部分说明)。
    • :在右边进行宽度填充,而不是默认的左边。
  • 空格:对于数值类型的正数,保留一个空白的符号位(其它用法在动词部分说明)。

  • 0 :用 0 进行宽度填充而不用空格,对于数值类型,符号将被移到所有 0 的前面。

  • #` :相关用法在动词部分说明。

  其中 “0” 和 “-” 不能同时使用,优先使用 “-” 而忽略 “0”。


宽度和精度

  “宽度”和“精度”都可以写成以下三种形式:

数值 | * | arg索引*

  其中“数值”表示使用指定的数值作为宽度值或精度值,” * “表示使用当前正在处理的 arg 的值作为宽度值或精度值,如果这样的话,要格式化的 arg 将自动跳转到下一个。“arg索引*”表示使用指定 arg 的值作为宽度值或精度值,如果这样的话,要格式化的 arg 将自动跳转到指定 arg 的下一个。

  宽度值:用于设置最小宽度。

  精度值:对于浮点型,用于控制小数位数,对于字符串或字节数组,用于控制字符数量(不是字节数量)。

  对于浮点型而言,动词 g/G 的精度值比较特殊,在适当的情况下,g/G 会设置总有效数字,而不是小数位数。


arg 索引

  “arg索引”由中括号和 arg 序号组成(就像上面示例中的 [3]),用于指定当前要处理的 arg 的序号,序号从 1 开始:

‘[’ + arg序号 + ‘]’


动词

  “动词”不能省略,不同的数据类型支持的动词不一样。

通用动词

v:默认格式,不同类型的默认格式如下:

  • 布尔型:t
  • 整型:d
  • 浮点型:g
  • 复数型:g
  • 字符串:s
  • 通道:p
  • =指针:p

PS: - T:输出 arg 的类型而不是值(使用 Go 语法格式)。

布尔型

t:输出 true 或 false 字符串。

整型

  • b/o/d:输出 2/8/10 进制格式
  • x/X :输出 16 进制格式(小写/大写)
  • c :输出数值所表示的 Unicode 字符
  • q :输出数值所表示的 Unicode 字符(带单引号)。对于无法显示的字符,将输出其转义字符。
  • U :输出 Unicode 码点(例如 U+1234,等同于字符串 “U+%04X” 的显示结果)

对于 o/x/X: 如果使用 “#” 旗标,则会添加前导 0 或 0x。

对于 U: 如果使用 “#” 旗标,则会在 Unicode 码点后面添加相应的 ‘字符’(前提是该字符必须可显示)


浮点型和复数型

  • b :科学计数法(以 2 为底)
  • e/E:科学计数法(以 10 为底,小写 e/大写 E)
  • f/F:普通小数格式(两者无区别)
  • g/G:大指数(指数 >= 6)使用 %e/%E,其它情况使用 %f/%F

字符串或字节切片

  • s :普通字符串
  • q :双引号引起来的 Go 语法字符串
  • x/X:十六进制编码(小写/大写,以字节为元素进行编码,而不是字符)

对于 q: 如果使用了 “+” 旗标,则将所有非 ASCII 字符都进行转义处理。 如果使用了 “#” 旗标,则输出反引号引起来的字符串(前提是 字符串中不包含任何制表符以外的控制字符,否则忽略 # 旗标)

对于 x/X: 如果使用了 “ ” 旗标,则在每个元素之间添加空格。 如果使用了 “#” 旗标,则在十六进制格式之前添加 0x 前缀。

指针类型

p :带 0x 前缀的十六进制地址值。 `#p:不带 0x 前缀的十六进制地址值。

符合类型

复合类型将使用不同的格式输出,格式如下:

  • 结构体:{字段1 字段2 …}
  • 数组或切片:[元素0 元素1 …]
  • 映射:map[键1:值1 键2:值2 …]

指向符合元素的指针:&{}, &[], &map[]

复合类型本身没有动词,动词将应用到复合类型的元素上。

结构体可以使用 “+v” 同时输出字段名。

例子

package main

import "fmt"

func main() {
	// 旗标、宽度、精度、索引
	fmt.Printf("|%0+- #[1]*.[2]*[3]d|%0+- #[1]*.[2]*[4]d|\n", 8, 4, 32, 64)

	// 浮点型精度
	fmt.Printf("|%f|%8.4f|%8.f|%.4f|%.f|\n", 3.2, 3.2, 3.2, 3.2, 3.2)
	fmt.Printf("|%.3f|%.3g|\n", 12.345678, 12.345678)
	fmt.Printf("|%.2f|\n", 12.345678+12.345678i)

	// 字符串精度
	s := "你好世界!"
	fmt.Printf("|%s|%8.2s|%8.s|%.2s|%.s|\n", s, s, s, s, s)
	fmt.Printf("|%x|%8.2x|%8.x|%.2x|%.x|\n", s, s, s, s, s)

	// 带引号字符串
	s1 := "Hello 世界!"       // CanBackquote
	s2 := "Hello\n世界!"      // !CanBackquote
	fmt.Printf("%q\n", s1)  // 双引号
	fmt.Printf("%#q\n", s1) // 反引号成功
	fmt.Printf("%#q\n", s2) // 反引号失败
	fmt.Printf("%+q\n", s2) // 仅包含 ASCII 字符

	// Unicode 码点
	fmt.Printf("%U, %#U\n", '好', '好')
	fmt.Printf("%U, %#U\n", '\n', '\n')

	// 接口类型将输出其内部包含的值
	var i interface{} = struct {
		name string
		age  int
	}{"AAA", 20}
	fmt.Printf("%v\n", i)  // 只输出字段值
	fmt.Printf("%+v\n", i) // 同时输出字段名
	fmt.Printf("%#v\n", i) // Go 语法格式

	// 输出类型
	fmt.Printf("%T\n", i)
}

一些Tips和坑

  1. 如果 arg 是一个反射值,则该 arg 将被它所持有的具体值所取代。

  2. 如果 arg 实现了 Formatter 接口,将调用它的 Format 方法完成格式化。

  3. 如果 v 动词使用了 # 旗标(%#v),并且 arg 实现了 GoStringer 接口,将调用它的 GoString 方法完成格式化。 如果格式化操作指定了字符串相关的动词(比如 %s、%q、%v、%x、%X),接下来的两条规则将适用:

  4. 如果 arg 实现了 error 接口,将调用它的 Error 方法完成格式化。

  5. 如果 arg 实现了 string 接口,将调用它的 String 方法完成格式化。

  6. 在实现格式化相关接口的时候,要避免无限递归的情况,比如:

    type X string
    
    func (x X) String() string {
        return Sprintf("<%s>", x)
    }
    

    在格式化之前,要先转换数据类型,这样就可以避免无限递归:

    func (x X) String() string {
        return Sprintf("<%s>", string(x))
    }
    

    无限递归也可能发生在自引用数据类型上面,比如一个切片的元素引用了切片自身。这种情况比较罕见,比如:

    a := make([]interface{}, 1)
    a[0] = a
    fmt.Println(a)