Go语言圣经 - 第7章 接口 - 7.4 flag.Value接口

第7章 接口

接口类型是对其它类型行为的抽象和概括.接口类型不会和特定的实现细节绑定在一起，这种抽象的方式能让我们的函数更加的灵活和更具有适应能力

Go语言的接口比较特殊，因为它是满足隐式实现的。也就是说，我们无需给具体类型定义所有满足足的接口类型，只需要让类型拥有一些简单必要的方法。这样我们新建一个接口类型，满足具体类型，并且我们不需要更改这些类型的定义。当我们使用的类型来自于不受我们控制的包时，这种机制比较有用

7.4 flag.Value接口

我们来看一个标准的接口类型flag.Value，它能够帮助命令行标记定义新符号，看看下面这个会休眠特定时间的程序

var period = flag.Duration("period",1*time.Second,"sleep period")

func main() {
	flag.Parse()
	fmt.Printf("sleep for %v...",*period)
	time.Sleep(*period)
	fmt.Println()
}

运行上述代码,输出的是一个非常友好的结果

C:\Users\xxx\GolandProjects\awesomeProject\src\chapter7>go run sleep.go
sleep for 1s...

默认的休眠是1s，但是我们可以通过 -period这个命令行标记来控制flag.Duration函数创建一个time.Duration类型的标记变量并且允许用户通过多种用户友好的方式来设置这个变量的大小。这种方法还包括和string方法相同的符号排版形式，这种对称设计使得用户交互良好

C:\Users\xxx\GolandProjects\awesomeProject\src\chapter7>go run sleep.go -period 50ms
sleep for 50ms...
C:\Users\xxx\GolandProjects\awesomeProject\src\chapter7>go run sleep.go -period "1h"
sleep for 1h0m0s...

因为时间周期标记值非常有用， 所以这个特性被构建到了flag包中，但是我们为自己的自定义类型定义一个新的标记符号时非常容易的，我们只需要定义一个实现flag.Value接口的类型，如下：

package flag
// Value is the interface to the value stored in a flag
Type Vlaue interface {
	String() string
	Set(string) error
}

String方法格式化标记的值用在命令行帮助消息中；这样每一个flag.Value也是一个fmt.Stringer.Set方法解析它的字符串参数并且更新标记变量的值，实际上，Set方法和String是两个相反的操作，所以最好的办法就是对它们使用相同的注解方式

定义一个允许通过摄氏度或者华氏温度变换的形式指定温度的celsiusFlag类型，注意celsiusFlag内嵌了一个Celsius类型，因此不用实现本身就已经有String方法了，为了实现flag.Value,我们只需要定义Set方法：

//*celsiusFlag satisfies the flag.Value interface.
type celsiusFlag struct {Celsius}

func (f *celsiusFlag) Set(s string) error {
	var unit string
	var value float64
	fmt.Sscanf(s,"%f%s",&value,&unit)
	switch unit {
	case "C","℃":
		f.Celsius = Celsius(value)
		return nil
	case "F","℉":
		f.Celsius = FToC(Fahrenheit(value))
		return nil
	}
	return fmt.Errorf("invalid temperature %q",s)
}

调用fmt.Sscanf函数从输入s中解析一个浮点数（value）和一个字符串（unit）。虽然通常必须检查Sscanf的错误返回，但是在这个例子中，我们不需要，因为如果有错误发生，就没有switch case匹配到

下面的CelsiusFlag函数将所有逻辑都封装在一起，它返回一个内嵌在celsiusFlag变量f中的Celsius指针给调用者

Celsius字段是一个会通过Set方法在标记处理的过程中更新的变量。调用Var方法将标记加入应用的命令行标记集合中，有异常复杂的命令行接口的全局变量flag.CommandLine.Programs可能有几个这个类型的变量。调用Var方法将一个*celsiusFlag参数赋值给一个flag.Value参数，导致编译器去检查 *celsiusFlag是否有必须的方法

// CelsiusFlag defines a Celsius flag with the specified name,
// default value, and usage, and returns the address of the flag variable.
// The flag argument must have a quantity and a unit, e.g., "100C".
func CelsiusFlag(name string, value Celsius, usage string) *Celsius {
    f := celsiusFlag{value}
    flag.CommandLine.Var(&f, name, usage)
    return &f.Celsius
}

现在我们可以在程序中使用新的标记

var temp = tempconv.CelsiusFlag("temp", 20.0, "the temperature")

func main() {
    flag.Parse()
    fmt.Println(*temp)
}

我们再来使用命令行试一下

$ go build gopl.io/ch7/tempflag
$ ./tempflag
20°C
$ ./tempflag -temp -18C
-18°C
$ ./tempflag -temp 212°F
100°C