Интерфейс именования 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++ - это просто бросить «я» перед всем. Является ли это «идиоматическим»?

Любые предложения?

Answer 1

У меня есть, тур ns out Я могу использовать соглашение «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 2

В golang По соглашению имена интерфейсов одного метода: существительные, обозначающие исполнителя действия. Например,

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

Было бы лучше, чтобы специфика конвенции ясно, независимо от того, что они are.This идет хорошо, когда есть только одна функция или очень специфический набор функций требует интерфейс

Существует практика использования I префикса к наименьшему общему знаменателю функций, в этом случае IRole будет лучше имя интерфейса в качестве интерфейса определяет две функции, которые должны быть satiisfied всеми типами представляющих Role

Answer 3

В вашем случае я бы назвал их RoleChecker и , «слитый» один 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

Интерфейсы, которые определяют только один метод, как правило, только что имя функции с «эр», приложенном к нему.

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 

имена приемника должны быть согласованы по методам типа. (Не следует использовать г в одном методе и РДР в другой.)

Go Code Review Comments: Receiver Names:

Имя приемнику метода должна быть отражением ее идентичности; часто бывает достаточно одной или двух буквенных сокращений его типа (например, «c» или «cl» для «Клиент»). Не используйте общие имена, такие как «я», «это» или «я», идентификаторы, типичные для объектно-ориентированных языков, которые уделяют больше внимания методам, а не функциям. Имя не должно быть таким же описательным, как имя аргумента метода, поскольку его роль очевидна и не служит никакой документальной цели. Он может быть очень коротким, поскольку он появится почти на каждой линии каждого метода типа; знакомство допускает краткость. Будьте также последовательны: если вы вызываете приемник «c» одним способом, не называйте его «cl» в другом.