【译】一个 NTP 客户端的 Go 实现

发表于 |
字数统计: 1.2k | 阅读时长 ≈ 5

在网络编程做了一些研究之后，我邂逅了一篇题目为《Let’s Make a NTP Client in C》，由 David Lettier（Lettier） 编写的文章。这篇文章鼓舞了我用 Go 去做相似的事。

1
这篇博文提到的代码都在这里 [https://github.com/vladimirvivien/go-ntp-client](https://github.com/vladimirvivien/go-ntp-client.)

这篇博文描述了一个（真正的） NTP 客户端的结构，使用 Go 语言编写。它通过　encoding/binary 库去封装，解封装，发送和接收来自远端 NTP 服务器基于 UDP 协议的 NTP 包。

你能通过这里学到更多关于 NTP 协议的内容，或者阅读 RFC5905 规范、研究一个实现了更多的功能，（可能）比 Go NTP 客户端更好的客户端 https://github.com/beevik/ntp。

NTP 包结构

时间同步的概念是非常复杂的，我还不能完全理解，也超过这篇博文的范围。但幸运的是，NTP 使用的数据包格式很简单，对于客户端来说也小而足够了。下面的图展示了 NTP v4 的包格式。关于这篇博文，我们只关注前 48 个字节，忽略掉 v4 版本的扩展部分。

NTP v4 data format (abbreviated) — https://tools.ietf.org/html/rfc5905
NTP v4 data format (abbreviated) — https://tools.ietf.org/html/rfc5905

NTP 包

客户端和对应的服务端都使用上面提到的相同的包格式。下面的结构体定义了 NTP 包和它的属性，跟上面提到的格式一一对应。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
type packet struct {
    Settings       uint8  // leap yr indicator, ver number, and mode
    Stratum        uint8  // stratum of local clock
    Poll           int8   // poll exponent
    Precision      int8   // precision exponent
    RootDelay      uint32 // root delay
    RootDispersion uint32 // root dispersion
    ReferenceID    uint32 // reference id
    RefTimeSec     uint32 // reference timestamp sec
    RefTimeFrac    uint32 // reference timestamp fractional
    OrigTimeSec    uint32 // origin time secs
    OrigTimeFrac   uint32 // origin time fractional
    RxTimeSec      uint32 // receive time secs
    RxTimeFrac     uint32 // receive time frac
    TxTimeSec      uint32 // transmit time secs
    TxTimeFrac     uint32 // transmit time frac
}

启动 UDP 连接

接下来，我们通过 UDP 协议，使用　net.Dial 函数去启动一个 socket，与 NTP 服务器联系，并设定 15 秒的超时时间。

1
2
3
4
5
6
7
8
9
conn, err := net.Dial("udp", host)
if err != nil {
    log.Fatal("failed to connect:", err)
}
defer conn.Close()
if err := conn.SetDeadline(
  time.Now().Add(15 * time.Second)); err != nil {
    log.Fatal("failed to set deadline: ", err)
}

从服务端获取时间

在发送请求包给服务端前，第一个字节是用来设置通信的配置，我们这里用 0x1B（或者二进制 00011011），代表客户端模式为 3，NTP版本为 3，润年为 0，如下所示：

1
2
3
4
5
6
// configure request settings by specifying the first byte as
// 00 011 011 (or 0x1B)
// |  |   +-- client mode (3)
// |  + ----- version (3)
// + -------- leap year indicator, 0 no warning
req := &packet{Settings: 0x1B}

接下来，我们使用 binary 库去自动地将 packet 结构体封装成字节流，并以大端格式发送出去。

1
2
3
if err := binary.Write(conn, binary.BigEndian, req); err != nil {
    log.Fatalf("failed to send request: %v", err)
}

从服务端读取时间

接下来，我们使用 binary 包再次将从服务端读取的字节流自动地解封装成对应的 packet 结构体。

1
2
3
4
rsp := &packet{}
if err := binary.Read(conn, binary.BigEndian, rsp); err != nil {
    log.Fatalf("failed to read server response: %v", err)
}

解析时间

在这个超普通的例子里面，我们只对　Transmit Time 字段 （rsp.TxTimeSec 和 rspTxTimeFrac） 感兴趣，它们是从服务端发出时的时间。但我们不能直接使用它们，必须先转成 Unix 时间。

Unix 时间是一个开始于 1970 年的纪元（或者说从 1970 年开始的秒数）。然而 NTP 使用的是另外一个纪元，从 1900 年开始的秒数。因此，从 NTP 服务端获取到的值要正确地转成 Unix 时间必须减掉这 70 年间的秒数 （1970-1900），或者说 2208988800 秒。

1
2
3
4
const ntpEpochOffset = 2208988800
...
secs := float64(rsp.TxTimeSec) - ntpEpochOffset
nanos := (int64(rsp.TxTimeFrac) * 1e9) >> 32

NTP 值的分数部分转成纳秒。在这个平凡的例子里，这里是可选的，展示只是为了完整性。

显示时间

最后，函数 time.Unix 被用来创建一个秒数部分使用 secs，分数部分使用 nanos 值的时间。然后这个时间会被打印到终端。

1
fmt.Printf("%v\n", time.Unix(int64(secs), nanos))

结论

这篇博文展示了一个关于 NTP 客户端的普通的例子。描述了如何利用 encoding/binary 库，非常容易地将一个结构体转成字节形式。相反，我们使用 binary 库将一个字节流转成对应的结构体值。

这个 NTP 客户端还不是一个可用于生产环境的产品，毕竟它缺少了 NTP 规范指定的很多功能。从服务端返回的大部分字段都被忽略了。你可以从这里获取到一个用 Go 写的更完整的 NTP 客户端。

via: https://medium.com/learning-the-go-programming-language/lets-make-an-ntp-client-in-go-287c4b9a969f

作者：Vladimir Vivien
译者：gogeof
校对：polaris1119

本文由 GCTT 原创编译，Go 中文网 荣誉推出