结构命名约定

我在一个包中有一些结构,它们进行简单的金融 API 调用,一个实现对 API 的请求,一个存储响应。


我想知道分别将结构命名为“Request”和“Response”是否合适,或者我应该在它们前面加上主题/包——比如“FinanceRequest”和“FinanceResponse”?或者通过使用finance.FinanceRequest(财务词使用两次)会使外部调用变得多余吗?


寻找关于此事的想法(golang 约定/偏好)...


样品:


package finance


type Request struct {

//...

}


type Response struct {

//...


func DoSomething(r *Request) (*Response, error) {

//...

}

或者


package finance


type FinanceRequest struct {

//...

}


type FinanceResponse struct {

//...


func DoSomething(r *FinanceRequest) (*FinanceResponse, error) {

//...

}


天涯尽头无女友
浏览 198回答 1
1回答

慕运维8079593

约定是使用请求和响应。以下是Effective Go所说的:包的导入器将使用名称来引用其内容,因此包中的导出名称可以使用该事实来避免口吃。(不要使用 import . 表示法,它可以简化必须在他们测试的包之外运行的测试,否则应该避免。)例如,bufio 包中的缓冲读取器类型称为 Reader,而不是 BufReader,因为用户将其视为 bufio.Reader,这是一个清晰简洁的名称。此外,因为导入的实体总是以其包名寻址,所以 bufio.Reader 不会与 io.Reader 冲突。该golint工具会抱怨有关的名字FinanceRequest和FinanceResponse。
打开App,查看更多内容
随时随地看视频慕课网APP

相关分类

Go