AlicizaX/DragonECS-AutoInjections
1
0
Fork 0
mirror of https://github.com/DCFApixels/DragonECS-AutoInjections.git synced 2025-09-17 20:34:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mikhail 2023-05-31 04:20:54 +08:00 committed by GitHub
parent 43799f4e84
commit 40c8242c97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -9,61 +9,15 @@
</p> </p>
# Auto Injections for [DragonECS](https://github.com/DCFApixels/DragonECS) # Auto Injections for [DragonECS](https://github.com/DCFApixels/DragonECS)
Расширение призвано сократить объем кода, упростив инъекцию зависимостей, делая их автоматически.
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
# Оглавление
* [Установка](#Установка)
* [Зависимости](#Зависимости)
* [Unity-модуль](#Unity-модуль)
* [В виде исходников](#В-виде-иходников)
* [Интеграция](#Интеграция)
* [Инъекция зависимостей](#Инъекция-зависимостей)
* [Auto Builder субъектов](#Auto-Builder-субъектов)
* [Пример кода](#Пример-кода)
* [Не null инъекции](#Не-null-инъекции)
# Установка | Languages: | [Русский](https://github.com/DCFApixels/DragonECS-AutoInjections/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-AutoInjections) |
### Зависимости | :--- | :--- | :--- |
Убедитесь что в проекте установлен фреймворк [DragonECS](https://github.com/DCFApixels/DragonECS).
* ### Unity-модуль
Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json`:
```
https://github.com/DCFApixels/DragonECS-AutoInjections.git
```
* ### В виде исходников
Фреймворк так же может быть добавлен в проект в виде исходников.
# Интеграция The extension is designed to reduce the amount of code by simplifying dependency injection by doing injections automatically.
Добавьте вызов метода `AutoInject()` для Builder-а пайплайна. Пример: > **NOTICE:** The project is a work in progress, API may change.
```csharp > While the English version of the README is incomplete, you can view the [Russian version](https://github.com/DCFApixels/DragonECS/blob/main/README-RU.md).
_pipeline = EcsPipeline.New()
.Inject(world)
.Inject(_timeService)
.Add(new TestSystem())
.Add(new VelocitySystem())
.Add(new ViewSystem())
.AutoInject()
.BuildAndInit();
```
# Инъекция зависимостей # Code Example
Атрибут `[EcsInject]` убирает необходимость использования интерфейса `IEcsInject<T>`, поля помеченные таким атрибутом автоматически подхватят зависимости внедренные в Pipeline. Пример：
```csharp
[EcsInject] EcsDefaultWorld _world;
```
# Auto Builder субъектов
Так же AutoInjections упрощает построение субъектов. Для начала наследуйте субъект не от `EcsSubject`, а от `EcsSubjectDI`, а далее добавьте специальные атрибуты.
Атрибуты для инициализации полей с пулами:
* `[Inc]` - кеширует пул и добавит тип компонента в включающее ограничение субъекта, аналог метода `Include`;
* `[Exc]` - кеширует пул и добавит тип компонента в исключающее ограничение субъекта, аналог метода `Exclude`;
* `[Opt]` - только кеширует пул, аналог метода `Optional`;
Дополнительные атрибуты только для задания ограничений субъекта. Их можно применить к самому субъекту, либо к любому полю внутри. Используйте атрибуты:
* `[IncImplicit(type)]` - добавит в включающее ограничение указанный в конструкторе тип `type`, аналог метода `Include`;
* `[ExcImplicit(type)]` - добавит в исключающее ограничение указанный в конструкторе тип `type`, аналог метода `Exclude`;
# Пример кода
```csharp ```csharp
class VelocitySystemDI : IEcsRunProcess class VelocitySystemDI : IEcsRunProcess
{ {
@ -87,7 +41,7 @@ class VelocitySystemDI : IEcsRunProcess
} }
``` ```
<details> <details>
<summary>Тот же код но без AutoInjections</summary> <summary>Same code but without AutoInjections</summary>
```csharp ```csharp
class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<TimeService> class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<TimeService>
@ -121,13 +75,3 @@ class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<T
``` ```
</details> </details>
# Не null инъекции
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy : Foo` если инъекции небыло.
``` csharp
[EcsInject(typeof(FooDummy))] Foo foo;
```
> Для корректной работы переданный тип должен иметь конструктор без парамтров и быть либо того же типа что и поле, либо производного типа.
Расширение так же сообщит если по завершению предварительной инъекции, остались не проинициализированные поля с `[EcsInject]`.