Uber Go 语言编程规范：验证接口的合规性

最新推荐文章于 2025-05-17 10:13:01 发布

原创最新推荐文章于 2025-05-17 10:13:01 发布 · 302 阅读

0 ·

CC 4.0 BY-SA版权

Uber技术研究专栏收录该内容

48 篇文章

订阅专栏

本文探讨了在编译时验证接口合规性的重要性，并通过示例对比了正确的代码风格与不良的代码风格。强调了如何确保类型正确实现了所需的接口。

在编译时适当的时候验证接口的合规性，这主要包括：

作为API契约的一部分，需要实现特定接口的导出类型。
导出和未导出类型都是作为实现同一接口类型集合的一部分。
其他违反接口的情况，将会阻止用户编译。

坏的的代码风格：

type Handler struct {
  // ...
}



func (h *Handler) ServeHTTP(
  w http.ResponseWriter,
  r *http.Request,
) {
  ...
}

好的代码风格：

type Handler struct {
  // ...
}

var _ http.Handler = (*Handler)(nil)

func (h *Handler) ServeHTTP(
  w http.ResponseWriter,
  r *http.Request,
) {
  // ...
}

语句 var _ http.Handler = (*Handler)(nil) 将会编译失败，如果*Handler不能匹配http.Handler接口的话。

赋值语句的右边应该为断言类型的零值，对于指针类型（例如*Handler）、 slices 和maps则为nil,对于结构体类型则为空的结构体。

例如：

type LogHandler struct {
  h   http.Handler
  log *zap.Logger
}

var _ http.Handler = LogHandler{}

func (h LogHandler) ServeHTTP(
  w http.ResponseWriter,
  r *http.Request,
) {
  // ...
}