Ошибка "Import cycle not allowed" в Go: как исправить циклический импорт пакетов

Понимание проблемы циклического импорта

Циклический импорт в Go — это ситуация, когда пакет A импортирует пакет B, а пакет B прямо или косвенно импортирует пакет A. Компилятор Go запрещает такие циклы, потому что это нарушает принцип направленного графа зависимостей. В вашем случае auth → user → auth — классический цикл.

Способы решения

Есть несколько проверенных подходов, которые используют опытные Go-разработчики. Рассмотрим каждый с примерами.

1. Выделение общего интерфейса (рекомендуемый способ)

Создайте третий пакет, который будет содержать интерфейсы, или разместите интерфейсы в одном из существующих пакетов, но без конкретных реализаций.

// contract/contract.go (новый пакет)
package contract

type UserProvider interface {
    GetUserByID(id int) *User
}

type PermissionChecker interface {
    CheckPermission(role string) bool
}

type User struct {
    ID   int
    Name string
}

Теперь оба пакета зависят только от contract:

// auth/auth.go
package auth
import "project/contract"

type AuthService struct {
    userProvider contract.UserProvider
}

func NewAuthService(up contract.UserProvider) *AuthService {
    return &AuthService{userProvider: up}
}

func (a *AuthService) Login(userID int) bool {
    user := a.userProvider.GetUserByID(userID)
    return user != nil
}

// user/user.go
package user
import "project/contract"

type UserService struct {
    permChecker contract.PermissionChecker
}

func NewUserService(pc contract.PermissionChecker) *UserService {
    return &UserService{permChecker: pc}
}

func (u *UserService) CreateUser(name string) *contract.User {
    if !u.permChecker.CheckPermission("admin") {
        return nil
    }
    return &contract.User{ID: 1, Name: name}
}

// main.go
package main
import (
    "project/auth"
    "project/user"
    "project/contract"
)

func main() {
    // Создаём реализации и внедряем зависимости
    userSvc := user.NewUserService(auth.NewAuthService(nil)) // упрощённо
    authSvc := auth.NewAuthService(userSvc)
    // ...
}

2. Инверсия зависимостей через интерфейсы в том же пакете

Если не хотите создавать новый пакет, определите интерфейс в одном из пакетов и передавайте реализацию через параметры функции или поля структуры.

// auth/auth.go
package auth

type UserGetter interface {
    GetUserByID(id int) *User
}

type User struct {
    ID   int
    Name string
}

func Login(ug UserGetter, userID int) bool {
    user := ug.GetUserByID(userID)
    return user != nil
}

// user/user.go
package user
import "project/auth"

type UserService struct{}

func (u *UserService) GetUserByID(id int) *auth.User {
    // реализация
    return &auth.User{ID: id}
}

func CreateUser(name string) *auth.User {
    // теперь не нужно импортировать auth для проверки прав
    // проверка переносится на уровень выше
    return &auth.User{ID: 1, Name: name}
}

3. Объединение пакетов

Если пакеты тесно связаны и представляют одну предметную область, объедините их в один пакет. Это не всегда возможно, но для небольших проектов — простое решение.

Рекомендации по проектированию

• Стремитесь к ацикличному графу зависимостей — пакеты нижнего уровня не должны импортировать пакеты верхнего уровня.
• Используйте интерфейсы для разрыва циклических зависимостей — это стандартная практика в Go.
• Внедряйте зависимости (Dependency Injection) через конструкторы или параметры функций, а не через глобальные переменные.
• Правильно выбирайте уровень абстракции — общие типы и интерфейсы выносите в отдельные пакеты (например, types, contract, interfaces).

В вашем случае лучшим решением будет выделить общий пакет с интерфейсами (способ 1) — это наиболее гибкий и масштабируемый подход, который также облегчит тестирование.

// auth/auth.go
package auth

type User struct {
    ID   int
    Name string
}

var getUserByID func(id int) *User

func SetUserProvider(fn func(id int) *User) {
    getUserByID = fn
}

func Login(userID int) bool {
    if getUserByID == nil {
        return false
    }
    user := getUserByID(userID)
    return user != nil
}

// user/user.go
package user
import "project/auth"

type User struct {
    ID   int
    Name string
}

func Init() {
    auth.SetUserProvider(GetUserByID)
}

func GetUserByID(id int) *auth.User {
    // реализация
    return &auth.User{ID: id, Name: "Test"}
}

func CreateUser(name string) *auth.User {
    // проверка прав теперь не требует импорта auth
    return &auth.User{ID: 1, Name: name}
}

// main.go
package main
import (
    "project/auth"
    "project/user"
)

func main() {
    user.Init() // регистрируем провайдер
    auth.Login(1)
}