阅读740 返回首页    go 阿里云 go 技术社区[云栖]

Go 语言编译期断言

这篇文章是关于一个鲜为人知的让 Go 在编译期断言的方法。你可能不会使用它，但是了解一下也很有趣。

作为一个热身，来看一个在 Go 中熟知的编译期断言：接口满意度检查。

在这段代码（playground）中，var _ = 行确保类型 W 是一个 stringWriter，其由 io.WriteString检查。



    

  1. package main
    2. 

    3. 

  3. import "io"
    4. 

    5. 

  5. type W struct{}
    6. 

    7. 

  7. func (w W) Write(b []byte) (int, error) { return len(b), nil }
    8. 

  8. func (w W) WriteString(s string) (int, error) { return len(s), nil }
    9. 

    10. 

  10. type stringWriter interface {
    11. 

  11.  WriteString(string) (int, error)
    12. 

  12. }
    13. 

    14. 

  14. var _ stringWriter = W{}
    15. 

    16. 

  16. func main() {
    17. 

  17.  var w W
    18. 

  18.  io.WriteString(w, "very long string")
    19. 

  19. }
    20. 



如果你注释掉了 W 的 WriteString 方法，代码将无法编译：




    

  1. main.go:14: cannot use W literal (type W) as type stringWriter in assignment:
    2. 

  2.  W does not implement stringWriter (missing WriteString method)
    3. 



这是很有用的。对于大多数同时满足 io.Writer 和 stringWriter 的类型，如果你删除 WriteString 方法，一切都会像以前一样继续工作，但性能较差。


你可以使用编译期断言保护你的代码，而不是试图使用`testing.T.AllocsPerRun'为性能回归编写一个脆弱的测试。


这是一个实际的 io 包中的技术例子。




好的，让我们低调一点！


接口满意检查是很棒的。但是如果你想检查一个简单的布尔表达式，如 1 + 1 == 2 ？


考虑这个代码（playground）：




    

  1. package main
    2. 

    3. 

  3. import "crypto/md5"
    4. 

    5. 

  5. type Hash [16]byte
    6. 

    7. 

  7. func init() {
    8. 

  8.  if len(Hash{}) < md5.Size {
    9. 

  9.  panic("Hash is too small")
    10. 

  10.  }
    11. 

  11. }
    12. 

    13. 

  13. func main() {
    14. 

  14.  // ...
    15. 

  15. }
    16. 



Hash 可能是某种抽象的哈希结果。init 函数确保它将与 crypto/md5 一起工作。如果你改变 Hash 为（比如说）[8]byte，它会在进程启动时发生崩溃。但是，这是一个运行时检查。如果我们想要早点发现怎么办？


如下。（没有 playground 链接，因为这在 playground 上不起作用。）




    

  1. package main
    2. 

    3. 

  3. import "C"
    4. 

    5. 

  5. import "crypto/md5"
    6. 

    7. 

  7. type Hash [16]byte
    8. 

    9. 

  9. func hashIsTooSmall()
    10. 

    11. 

  11. func init() {
    12. 

  12.  if len(Hash{}) < md5.Size {
    13. 

  13.  hashIsTooSmall()
    14. 

  14.  }
    15. 

  15. }
    16. 

    17. 

  17. func main() {
    18. 

  18.  // ...
    19. 

  19. }
    20. 



现在如果你改变 Hash 为 [8]byte，它将在编译过程中失败。（实际上，它在链接过程中失败。足够接近我们的目标了。）




    

  1. $ go build .
    2. 

  2. # demo
    3. 

  3. main.hashIsTooSmall: call to external function
    4. 

  4. main.init.1: relocation target main.hashIsTooSmall not defined
    5. 

  5. main.init.1: undefined: "main.hashIsTooSmall"
    6. 



这里发生了什么？


hashIsTooSmall 是一个没有函数体的声明。编译器假定别人将提供一个实现，也许是一个汇编程序。


当编译器可以证明 len（Hash {}）< md5.Size 时，它消除了 if 语句中的代码。结果，没有人使用函数hashIsTooSmall，所以链接器会消除它。没有其他损害。一旦断言失败，if 语句中的代码将被保留。不会消除hashIsTooSmall。链接器然后注意到没有人提供了函数的实现然后链接失败，并出现错误，这是我们的目标。


最后一个奇怪的点：为什么是 import "C"？ go 工具知道在正常的 Go 代码中，所有函数都必须有主体，并指示编译器强制执行。通过切换到 cgo，我们删除该检查。（如果你在上面的代码中运行 go build -x，而没有添加 import "C" 这行，你会看到编译器是用 -complete 标志调用的。）另一种方法是添加 import "C"来向包中添加一个名为 foo.s 的空文件。


我仅见过一次这种技术的使用，是在编译器测试套件中。还有其他可以发挥想象力的使用，但我还没见到过。


原文发布时间为：2017-03-28


本文来自云栖社区合作伙伴“Linux中国”


最后更新：2017-05-23 15:36:12
  上一篇：go  如何在 Linux 桌面上使用 Gifine 录制 GIF 动画？ 
  下一篇：go  机器学习初学者入门实践：怎样轻松创造高精度分类网络