mirror of
https://github.com/DCFApixels/DragonECS-AutoInjections.git
synced 2025-09-18 05:04:35 +08:00
Update README.md
This commit is contained in:
parent
c45958e9ce
commit
2fa89a5577
57
README.md
57
README.md
@ -3,10 +3,11 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
# [DragonECS](https://github.com/DCFApixels/DragonECS) - Auto Injections Extension
|
# [DragonECS](https://github.com/DCFApixels/DragonECS) - Auto Injections Extension
|
||||||
Данное ресширение призвано скоратить объем кода, упростив инбъекцию зависимостей, делая их автоматическими.
|
Расширение призвано сократить объем кода, упростив инбъекцию зависимостей, делая их автоматическими.
|
||||||
|
|
||||||
## Оглавление
|
# Оглавление
|
||||||
* [Установка](#Установка)
|
* [Установка](#Установка)
|
||||||
|
* [Зависимости](#Зависимости)
|
||||||
* [Unity-модуль](#Unity-модуль)
|
* [Unity-модуль](#Unity-модуль)
|
||||||
* [В виде иходников](#В-виде-иходников)
|
* [В виде иходников](#В-виде-иходников)
|
||||||
* [Инъекция зависимостей](#Инъекция-зависимостей)
|
* [Инъекция зависимостей](#Инъекция-зависимостей)
|
||||||
@ -15,33 +16,51 @@
|
|||||||
* [Не null инъекции](#Не-null-инъекции)
|
* [Не null инъекции](#Не-null-инъекции)
|
||||||
|
|
||||||
# Установка
|
# Установка
|
||||||
Сначала убдитесь что в проекте установлен [DragonECS](https://github.com/DCFApixels/DragonECS).
|
### Зависимости
|
||||||
|
Убдитесь что в проекте установлен фреймворк [DragonECS](https://github.com/DCFApixels/DragonECS).
|
||||||
* ### Unity-модуль
|
* ### Unity-модуль
|
||||||
Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json`:
|
Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json`:
|
||||||
```
|
```
|
||||||
https://github.com/DCFApixels/DragonECS.git
|
https://github.com/DCFApixels/DragonECS-AutoInjections.git
|
||||||
```
|
```
|
||||||
* ### В виде иходников
|
* ### В виде иходников
|
||||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||||
|
|
||||||
## Инъекция зависимостей
|
# Интеграция
|
||||||
Аттрибут `[EcsInject]` скрывает необходимость использования интерфейса `IEcsInject<T>`, поля помеченные таким атрибутом автоматически подхватят зависимости переданные в метод Inject.
|
Добавте вызов метода `AutoInject()` для фабрики Pipeline. Пример:
|
||||||
|
```csharp
|
||||||
|
_pipeline = EcsPipeline.New()
|
||||||
|
.Inject(world)
|
||||||
|
.Inject(_timeService)
|
||||||
|
.Add(new TestSystem())
|
||||||
|
.Add(new VelocitySystem())
|
||||||
|
.Add(new ViewSystem())
|
||||||
|
.AutoInject()
|
||||||
|
.BuildAndInit();
|
||||||
|
```
|
||||||
|
|
||||||
|
# Инъекция зависимостей
|
||||||
|
Аттрибут `[EcsInject]` убирает необходимость использования интерфейса `IEcsInject<T>`, поля помеченные таким атрибутом автоматически подхватят зависимости внедренные в Pipeline.
|
||||||
|
|
||||||
## Фабрикаа субъектов
|
# Фабрикаа субъектов
|
||||||
Так же данное расширение упрощает построение субъектов, добавляя 3 сппециальных аттрибута `[Inc]`, `[Exc]`, `[Opt]`. Данные атрибуты аналогичны вызовам мтодов `Include`, `Exclude`, `Optional` в фабрике субъекта. Так же еще существует 2 атрибута для неявного задания ограничения `[IncImplicit]`, `[ExcImplicit]`, эти атрибуты в обход кеширования пула, задают ограничения длясубъекта.
|
Так же AutoInjections упрощает построение субъектов. Для работы наследйте субъекты не от `EcsSubject`, а от `EcsSubjectDI`.
|
||||||
Атрибуты
|
|
||||||
* `[Inc]` -
|
|
||||||
* `[Exc]` -
|
|
||||||
* `[Opt]` -
|
|
||||||
|
|
||||||
|
Есть 3 атрибтуа для инициализации полей с пулами. В поле будет автоматически закеширован пул, а тип компонента добавится в ограничение субъекта. Используйте аттрибуты:
|
||||||
|
* `[Inc]` - добавит тип компонента в включающее ограничение, аналог метода `Include`;
|
||||||
|
* `[Exc]` - добавит тип компонента в исключающее ограничение, аналог метода `Exclude`;
|
||||||
|
* `[Opt]` - только кеширует пул, аналог метода `Optional`;
|
||||||
|
|
||||||
## Пример кода
|
Дополнительные аттрибуты только для задания ограничений субъекта. Их можно применить к самому субъекту, либо к любому полю внутри. Используйте аттрибуты:
|
||||||
|
* `[IncImplicit(type)]` - добавит в включающее ограничение тип указанный в конструкторе `type`, аналог метода `Include`;
|
||||||
|
* `[ExcImplicit(type)]` - добавит в исключающее ограничение тип указанный в конструкторе `type`, аналог метода `Exclude`;
|
||||||
|
|
||||||
|
# Пример кода
|
||||||
```csharp
|
```csharp
|
||||||
class VelocitySystemDI : IEcsRunProcess
|
class VelocitySystemDI : IEcsRunProcess
|
||||||
{
|
{
|
||||||
class Subject : EcsSubjectDI
|
class Subject : EcsSubjectDI
|
||||||
{
|
{
|
||||||
[IncImplicit(typeof(PlayerTag))]
|
[ExcImplicit(typeof(FreezedTag))]
|
||||||
[Inc] public EcsPool<Pose> poses;
|
[Inc] public EcsPool<Pose> poses;
|
||||||
[Inc] public EcsPool<Velocity> velocities;
|
[Inc] public EcsPool<Velocity> velocities;
|
||||||
}
|
}
|
||||||
@ -70,7 +89,7 @@ class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<T
|
|||||||
public EcsPool<Velocity> velocities;
|
public EcsPool<Velocity> velocities;
|
||||||
public Subject(Builder b)
|
public Subject(Builder b)
|
||||||
{
|
{
|
||||||
b.Include<PlayerTag>();
|
b.Exclude<FreezedTag>();
|
||||||
poses = b.Include<Pose>();
|
poses = b.Include<Pose>();
|
||||||
velocities = b.Include<Velocity>();
|
velocities = b.Include<Velocity>();
|
||||||
}
|
}
|
||||||
@ -94,10 +113,12 @@ class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<T
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## Не null инъекции
|
# Не null инъекции
|
||||||
|
|
||||||
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy` если инъекции небыло.
|
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy : Foo` если инъекции небыло.
|
||||||
``` csharp
|
``` csharp
|
||||||
[EcsInject(typeof(FooDummy))] Foo foo;
|
[EcsInject(typeof(FooDummy))] Foo foo;
|
||||||
```
|
```
|
||||||
|
> Для корректной работы переданный тип должен иметь конструктор без парамтров и быть либо того же типа что и поле, либо производного типа.
|
||||||
|
|
||||||
Расширение так же сообщит если по заврешению предварительной инъекции, остались непроинициализированные поля с `[EcsInject]`.
|
Расширение так же сообщит если по заврешению предварительной инъекции, остались непроинициализированные поля с `[EcsInject]`.
|
||||||
|
Loading…
Reference in New Issue
Block a user