接口命名约定 Golang

Question

我将发布我的代码：

/*
*  Role will ALWAYS reserve the session key "role".
 */
package goserver

const (
    ROLE_KEY string = "role"
)

type Role string

//if index is higher or equal than role, will pass
type RolesHierarchy []Role

func (r Role) String() string {
    return string(r)
}

func NewRole(session ServerSession) Role {
    return session.GetValue(ROLE_KEY).(Role)
}

func (this Role) IsRole(role Role, hierarchy RolesHierarchy) bool {
    if role == this {
        return true
    }
    if len(hierarchy) == 0 {
        return false
    }
    var thisI int = 0
    var roleI int = 0
    //Duped roles in hierarchy are verified in verifyConfig during parse
    for i, r := range hierarchy {
        if this == r {
            thisI = i
        }
        if role == r {
            roleI = i
        }
    }
    //TODO I can probably condense what follows into one if
    if thisI == 0 && roleI == 0 {
        return false
    }
    return thisI >= roleI
}

func (this *Role) AssumeRole(session ServerSession, role Role) {
    session.SetValue(ROLE_KEY, role)
    *this = role
}

需要注意的是，ServerSession也是一个接口，调用“ServerSessioner”对我来说感觉很奇怪。

我正在玩弄用 IsRole() 和 AssumeRole() 创建接口的想法，但是“Roler”似乎很不稳定。我突然意识到，除了标准的“er”后缀之外，我真的不知道或曾经遇到过接口的命名约定。我似乎确实记得 VS C++ 的约定是在所有内容前面加上一个“I”。这是“惯用语”吗？

有什么建议吗？

Answer 1

在 golang 中，按照惯例，一个方法的接口名称是 表示行为者的名词。例如，

the `Read` method implements the `Reader` interface, and
the `Generate` method implements the `Generator` interface.

最好明确约定的细节，不管它们是什么。当接口只需要一个函数或一组非常特定的函数时，这很好

有一种做法是使用I前缀作为函数的最小公分母，在这种情况下IRole将是一个更好的接口名称，因为接口定义了两个必须由所有代表@的类型满足的函数987654325@

Answer 2

我明白了，原来我可以使用“er”约定。

/*
*  Role will ALWAYS reserve the session key "role".
 */
package goserver

const (
    ROLE_KEY string = "role"
)

type Role string

//if index is higher or equal than role, will pass
type RolesHierarchy []Role

type RoleChecker interface {
    IsRole(Role, RolesHierarchy) bool
}

type RoleAssumer interface {
    AssumeRole(ServerSession, Role)
}

type RoleCheckerAssumer interface {
    RoleChecker
    RoleAssumer
}

func (r Role) String() string {
    return string(r)
}

func NewRole(session ServerSession) Role {
    return session.GetValue(ROLE_KEY).(Role)
}

func (this Role) IsRole(role Role, hierarchy RolesHierarchy) bool {
    if role == this {
        return true
    }
    if len(hierarchy) == 0 {
        return false
    }
    var thisI int = 0
    var roleI int = 0
    //Duped roles in hierarchy are verified in verifyConfig during parse
    for i, r := range hierarchy {
        if this == r {
            thisI = i
        }
        if role == r {
            roleI = i
        }
    }
    //TODO I can probably condense what follows into one if
    if thisI == 0 && roleI == 0 {
        return false
    }
    return thisI >= roleI
}

func (this *Role) AssumeRole(session ServerSession, role Role) {
   session.SetValue(ROLE_KEY, role)
   *this = role
}

感谢 Sarathsp 让我正确地思考这个问题。

Answer 3

在您的情况下，我只想将它们命名为 RoleChecker 和 RoleAssumer，即“合并”的 RoleCheckerAssumer。或者，如果您使用单一界面，则可能是 RoleHelper 或 RoleChecker。

ServerSession 也可以，甚至只是Session（尤其是在没有“客户端”会话的情况下）。另一方面，ServerSessioner 不好，Session 不是动词，也不是接口的方法。

---

关于约定的帖子很多。

Effective Go: Interface names:

按照惯例，单方法接口由方法名称加上 -er 后缀或类似修饰来命名以构造代理名词：Reader、Writer、Formatter、CloseNotifier 等。

这样的名称有很多，尊重它们以及它们捕获的函数名称是有成效的。 Read、Write、Close、Flush、String 等具有规范的签名和含义。为避免混淆，除非它具有相同的签名和含义，否则不要为您的方法提供这些名称之一。相反，如果您的类型实现了与知名类型上的方法具有相同含义的方法，请为其赋予相同的名称和签名；调用你的字符串转换器方法String 而不是ToString。

Interface Types @ What's in a name? - Talks at golang.org

只指定一种方法的接口通常只是那个附加了“er”的函数名。

type Reader interface {
    Read(p []byte) (n int, err error)
}

有时结果不是正确的英语，但我们还是这样做了：

type Execer interface {
    Exec(query string, args []Value) (Result, error)
}

有时我们会使用英语来使它更好听：

type ByteReader interface {
    ReadByte() (c byte, err error)
}

当一个接口包含多个方法时，选择一个准确描述其用途的名称（例如：net.Conn、http.ResponseWriter、io.ReadWriter）。

对于接收者名称，请勿使用 this 或 self 或类似名称。而是：

Receivers @ What's in a name? - Talks at golang.org

接收者是一种特殊的论点。

按照惯例，它们是反映接收者类型的一两个字符， 因为它们通常出现在几乎每一行：

func (b *Buffer) Read(p []byte) (n int, err error)

func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request)

func (r Rectangle) Size() Point

接收者名称应该在一个类型的方法中保持一致。 （不要在一种方法中使用 r，而在另一种方法中使用 rdr。）

Go Code Review Comments: Receiver Names:

方法接收者的名字应该反映它的身份；通常，其类型的一两个字母缩写就足够了（例如“客户端”的“c”或“cl”）。不要使用诸如“me”、“this”或“self”之类的通用名称，这些是面向对象语言的典型标识符，它们更强调方法而不是函数。该名称不需要像方法参数那样具有描述性，因为它的作用是显而易见的并且没有任何记录目的。它可以很短，因为它几乎出现在该类型的每个方法的每一行；熟悉承认简洁。也要保持一致：如果您在一种方法中将接收器称为“c”，请不要在另一种方法中将其称为“cl”。