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-28 20:29:42 +08:00 committed by GitHub
parent d199bcfce2
commit 11a19780f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -7,11 +7,16 @@
Данное ресширение призвано скоратить объем кода, упростив инбъекцию зависимостей, делая их автоматическими.
## Инжекция зависимостей
Аттрибут `[EcsInject]` скрывает необходимость использования интерфейса `IEcsInject<T>`, поля помеченные таким атрибутом автоматически подхватят зависимости переданные в метод Inject. У атрибута есть не обязательный аргумент notNullDummyType, если он указан, то во время предварительной инъекции, если поле небыло проинициализировано, ему будет присвоен экземпляр этого типа.
Аттрибут `[EcsInject]` скрывает необходимость использования интерфейса `IEcsInject<T>`, поля помеченные таким атрибутом автоматически подхватят зависимости переданные в метод Inject.
## Фабрикаа субъектов
Так же данное расширение упрощает построение субъектов, добавляя 3 сппециальных аттрибута `[Inc]`, `[Exc]`, `[Opt]`. Данные атрибуты аналогичны вызовам мтодов `Include`, `Exclude`, `Optional` в фабрике субъекта. Так же еще существует 2 атрибута для неявного задания ограничения `[IncImplicit]`, `[ExcImplicit]`, эти атрибуты в обход кеширования пула, задают ограничения длясубъекта.
Атрибуты
* `[Inc]` -
* `[Exc]` -
* `[Opt]` -
## Пример кода
* ### С использованием AutoInjections
```csharp
@ -67,4 +72,10 @@ class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<T
}
}
```
## Не null инъекции
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy` если инъекции небыло.
``` csharp
[EcsInject(typeof(FooDummy))] Foo foo;
```
Расширение так же сообщит если по заврешению предварительной инъекции, остались непроинициализированные поля с `[EcsInject]`.