README
¶
Compogo Dig
Адаптер Uber Dig для фреймворка Compogo.
Реализует интерфейс compogo.Container через Dig, позволяя использовать мощный DI-контейнер для управления зависимостями в приложениях на Compogo.
Установка
go get github.com/Compogo/compogo-dig
Использование
Подключение Dig-контейнера к приложению Compogo:
package main
import (
"github.com/Compogo/compogo"
"github.com/Compogo/dig"
)
func main() {
// Создание приложения с Dig
app := compogo.NewApp("myapp",
// Подключаем Dig как DI-контейнер
dig.WithDig(),
// Другие опции
compogo.WithConfigurator(configurator, configuratorCmp),
compogo.WithLogger(logger, loggerCmp),
compogo.WithOsSignalCloser(),
)
// Добавление компонентов
app.AddComponents(
HTTPServerComponent,
DatabaseComponent,
)
// Запуск
if err := app.Serve(); err != nil {
panic(err)
}
}
Что происходит под капотом
При вызове dig.WithDig() происходит следующее:
- Создаётся экземпляр dig.Container
- Создаётся обёртка Container, реализующая compogo.Container
- Регистрируется системный компонент container.Dig, который:
-
- Регистрирует оригинальный
*dig.Container
- Регистрирует оригинальный
-
- Регистрирует обёртку
*Container
- Регистрирует обёртку
-
- Регистрирует обёртку как
compogo.Container
- Регистрирует обёртку как
После этого все компоненты могут использовать container.Provide() и container.Invoke() через Dig.
Методы
Container
Реализует интерфейс compogo.Container:
type Container struct {
dig *dig.Container
}
// Provide регистрирует конструктор
func (c *Container) Provide(constructor interface{}) error
// Provides регистрирует несколько конструкторов
func (c *Container) Provides(constructors ...interface{}) error
// Invoke вызывает функцию с внедрёнными зависимостями
func (c *Container) Invoke(function interface{}) error
WithDig
func WithDig() compogo.Option
Возвращает опцию для подключения Dig к приложению Compogo.
Зависимости
Лицензия
MIT License
Copyright (c) 2026 Compogo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithDig ¶
WithDig возвращает опцию для подключения Dig-контейнера к приложению Compogo.
Опция выполняет:
- Создание нового экземпляра Dig-контейнера
- Создание обёртки Container, реализующей интерфейс compogo.Container
- Регистрацию системного компонента "container.Dig", который:
- Регистрирует Dig-контейнер в DI (чтобы его можно было получить)
- Регистрирует обёртку Container
- Регистрирует обёртку как интерфейс compogo.Container
Пример использования:
app := compogo.NewApp("myapp",
compogo.WithConfigurator(configurator, configuratorCmp),
compogo.WithLogger(logger, loggerCmp),
compogo.WithCloser(closer, closerCmp),
dig.WithDig(), // подключаем Dig
)
// Теперь все компоненты могут регистрировать зависимости через DI:
app.AddComponents(myComponent)
Types ¶
type Container ¶ added in v0.0.7
type Container struct {
// contains filtered or unexported fields
}
Container реализует интерфейс compogo.Container на основе Uber Dig. Предоставляет удобную обёртку над dig.Container с поддержкой массовой регистрации конструкторов через метод Provides.
Используется в Compogo как стандартная реализация DI-контейнера. Позволяет регистрировать зависимости и вызывать функции с внедрёнными аргументами.
Пример:
container := NewContainer(dig.New())
container.Provide(func() *Config { return &Config{Port: 8080} })
container.Provide(func(cfg *Config) *http.Server {
return &http.Server{Addr: fmt.Sprintf(":%d", cfg.Port)}
})
container.Invoke(func(srv *http.Server) {
srv.ListenAndServe()
})
func NewContainer ¶ added in v0.0.7
NewContainer создаёт новый Container на основе переданного Dig-контейнера. Обычно используется внутри WithDig() и не требует ручного вызова.
func (*Container) Invoke ¶ added in v0.0.7
Invoke выполняет переданную функцию, внедряя в неё все необходимые зависимости из контейнера. Реализует интерфейс compogo.Container.
Пример:
container.Invoke(func(db *Database) {
db.Connect()
})
func (*Container) Provide ¶ added in v0.0.7
Provide регистрирует конструктор в контейнере. Конструктор должен быть функцией, возвращающей один или несколько сервисов. Реализует интерфейс compogo.Container.
Пример:
container.Provide(func() *Database { return &Database{DSN: "..."} })
func (*Container) Provides ¶ added in v0.0.7
Provides регистрирует несколько конструкторов за один вызов. Если хотя бы один конструктор вызывает ошибку, она возвращается. Реализует интерфейс compogo.Container.
Пример:
container.Provides(
func() *Config { return &Config{} },
func(cfg *Config) *Database { return NewDatabase(cfg) },
)
Source Files