Соглашения об именах интерфейсов в Go

При создании интерфейсов в Go важно следовать установленным соглашениям об именах, чтобы улучшить читаемость и обеспечить единообразие внутри вашего интерфейса. codebase.

Одним из распространенных соглашений является использование суффикса «er» для интерфейсов, определяющих один метод. Например, этому правилу соответствуют такие интерфейсы, как Reader, Writer и Formatter.

Для интерфейсов с несколькими методами рекомендуется выбирать имя, которое точно описывает их назначение. Примеры включают net.Conn (для сетевых подключений), http.ResponseWriter (для ответов HTTP) и io.ReadWriter (как для чтения, так и для записи).

При именовании объектов-получателей рекомендуется избегать общих терминов, таких как это или себя. Вместо этого используйте сокращения, отражающие тип получателя, например c для Client или sh для serverHandler.

Рассмотрите следующий пример:

type Role string

type RolesHierarchy []Role

// IsRole verifies if a role is within the hierarchy.
func (r Role) IsRole(role Role, hierarchy RolesHierarchy) bool {
    // ... Implementation ...
}

// AssumeRole sets the role in the session.
func (r *Role) AssumeRole(session ServerSession, role Role) {
    // ... Implementation ...
}

В соответствии с предложенными соглашениями подходящие имена интерфейсов и получателей для приведенного выше кода могут быть следующими:

• Интерфейс: RoleChecker или RoleVerifier
• Receiver: r или роль

В качестве альтернативы, если предпочтительнее объединить обе функции в один интерфейс, подходящим именем может быть RoleManager.

Помните, что последовательность является ключевым моментом в именовании интерфейсов и получателей. Выбирайте имена, которые ясны, описательны и соответствуют правилам, изложенным выше. Это улучшит читаемость и удобство сопровождения вашего кода Go.