Golang 结构体字段的命名规范是什么？

在 Go 中，结构体字段的命名约定通常遵循驼峰式大小写，即首字母大写，之后字母小写。但是，对于首字母缩略词，应使用全大写形式。当变量或函数以大写开头时，可以导出它们。包始终为小写，而接口应以“-er”结尾。这些命名规范有助于确保代码的可读性和一致性。

我正在尝试使用 visual studio code 来学习 go，我猜它使用的是 go linter。我创建了这个结构来将 json 对象映射到其中。

type someAPI struct {
    ApiEndpoint string   `json:"apiEndpoint"`
    ApiVersion  string   `json:"apiVersion"`
    ...
}

我收到这些警告...

结构体字段 api​​endpoint 应该是 apiendpoint 结构体字段 api​​version 应该是 apiversion

我做了一些谷歌搜索，但找不到与此相关的结构字段名称的任何要求。我发现最多的是，如果您想公开某个字段，则必须将其大写。

那么为什么这个 linter 会警告我有关这些名称的信息？

我通过将 api 更改为 abc 进行了一些测试，并且 linter 没有警告我将其更改为“abc”。所以我必须假设它正在检查以“api”开头的名称。

go 的字段名称约定是什么？或者换句话说，还有其他我应该了解的约定吗？

解决方案

对于大多数情况，Go 中的命名约定只是使用驼峰式大小写，如果它是公共字段则以大写字母开头，如果不是公共字段则以小写字母开头。但在诸如 API 或 URL 之类的首字母缩略词中，它们是用全大写写的，例如。 func ProxyURL(fixedURL *url.URL) 在 http package 上。

编辑：我搜索了更多内容，并在 Go Code Review Comments 上找到了缩写词指南。它在 Initialisms 部分中讨论了缩写词：

名称中包含首字母缩写词或首字母缩略词（例如“URL”或“NATO”） 有一致的案例。例如，“URL”应显示为“URL”或 “url”（如“urlPony”或“URLPony”），切勿作为“Url”。举个例子： ServeHTTP 不是 ServeHttp。对于具有多个初始化的标识符 “words”，例如使用“xmlHTTPRequest”或“XMLHTTPRequest”。

当“ID”是“identifier”的缩写时，此规则也适用于“ID”，因此 写“appID”而不是“appId”。

因此，首字母缩略词的规则是它们应该具有恒定的大小写。在您的情况下，因为它们必须以大写“A”开头，您应该将它们写为“API”。

此外，这只是我个人的意见，我知道示例中的代码可能不是您正在使用的确切代码，但如果是，我认为在字段名称中包含结构名称是一个不好的做法。您正在执行 api.APIField 但 api.Field 更容易阅读，如果您知道该对象是一个 API，那么毫无疑问该字段属于一个 API。

就像您的问题中提到的那样，在@topo的回答中，变量和函数命名的约定是驼峰式命名法（混合大写）。如果名称以大写字母开头，则可以导出变量/函数。

包始终为小写。

接口应以 -er 结尾

您可以在effective go naming session阅读更多内容

另一方面，Golint 超越了 Go 的命名约定。词语有一些规则，在你的情况下，你就满足了其中一条规则。您可以在此处查看完整列表：https://github.com/golang/lint/blob/master/lint.go#L751

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Golang 结构体字段的命名规范是什么？》文章吧，也可关注golang学习网公众号了解相关技术文章。