mirror of
https://github.com/DCFApixels/DragonECS-AutoInjections.git
synced 2025-09-17 20:34:34 +08:00
Merge branch 'main' into dev
This commit is contained in:
Mikhail
commit
6166e2a426
140
README-RU.md
Normal file
140
README-RU.md
Normal file
@ -0,0 +1,140 @@
|
||||
<p align="center">
|
||||
<img width="400" src="https://github.com/DCFApixels/DragonECS-AutoInjections/assets/99481254/11868b2e-21f7-4f47-8970-03ad6329cf0e.png">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-AutoInjections?color=%23ff4e85&style=for-the-badge">
|
||||
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/DragonECS-AutoInjections?color=ff4e85&style=for-the-badge">
|
||||
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
|
||||
</p>
|
||||
|
||||
# Auto Injections for [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||
|
||||
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-AutoInjections/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-AutoInjections) |
|
||||
| :--- | :--- | :--- |
|
||||
|
||||
Расширение призвано сократить объем кода, упростив инъекцию зависимостей, делая их автоматически.
|
||||
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
|
||||
# Оглавление
|
||||
* [Установка](#Установка)
|
||||
* [Зависимости](#Зависимости)
|
||||
* [Unity-модуль](#Unity-модуль)
|
||||
* [В виде исходников](#В-виде-иходников)
|
||||
* [Интеграция](#Интеграция)
|
||||
* [Инъекция зависимостей](#Инъекция-зависимостей)
|
||||
* [Auto Builder субъектов](#Auto-Builder-субъектов)
|
||||
* [Пример кода](#Пример-кода)
|
||||
* [Не null инъекции](#Не-null-инъекции)
|
||||
|
||||
# Установка
|
||||
### Зависимости
|
||||
Убедитесь что в проекте установлен фреймворк [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
|
||||
```
|
||||
* ### В виде исходников
|
||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||
|
||||
### Версионирование
|
||||
В DragonECS применяется следующая семантика версионирования: [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)
|
||||
|
||||
# Интеграция
|
||||
Добавьте вызов метода `AutoInject()` для Builder-а пайплайна. Пример:
|
||||
```csharp
|
||||
_pipeline = EcsPipeline.New()
|
||||
.Inject(world)
|
||||
.Inject(_timeService)
|
||||
.Add(new TestSystem())
|
||||
.Add(new VelocitySystem())
|
||||
.Add(new ViewSystem())
|
||||
.AutoInject()
|
||||
.BuildAndInit();
|
||||
```
|
||||
|
||||
# Инъекция зависимостей
|
||||
Атрибут `[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
|
||||
class VelocitySystemDI : IEcsRunProcess
|
||||
{
|
||||
class Subject : EcsSubjectDI
|
||||
{
|
||||
[ExcImplicit(typeof(FreezedTag))]
|
||||
[Inc] public EcsPool<Pose> poses;
|
||||
[Inc] public EcsPool<Velocity> velocities;
|
||||
}
|
||||
|
||||
[EcsInject] EcsDefaultWorld _world;
|
||||
[EcsInject] TimeService _time;
|
||||
|
||||
public void Run(EcsPipeline pipeline)
|
||||
{
|
||||
foreach (var e in _world.Where(out Subject s))
|
||||
{
|
||||
s.poses.Write(e).position += s.velocities.Read(e).value * _time.DeltaTime;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
<details>
|
||||
<summary>Тот же код но без AutoInjections</summary>
|
||||
|
||||
```csharp
|
||||
class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<TimeService>
|
||||
{
|
||||
class Subject : EcsSubject
|
||||
{
|
||||
public EcsPool<Pose> poses;
|
||||
public EcsPool<Velocity> velocities;
|
||||
public Subject(Builder b)
|
||||
{
|
||||
b.Exclude<FreezedTag>();
|
||||
poses = b.Include<Pose>();
|
||||
velocities = b.Include<Velocity>();
|
||||
}
|
||||
}
|
||||
|
||||
EcsDefaultWorld _world;
|
||||
TimeService _time;
|
||||
|
||||
public void Inject(EcsDefaultWorld obj) => _world = obj;
|
||||
public void Inject(TimeService obj) => _time = obj;
|
||||
|
||||
public void Run(EcsPipeline pipeline)
|
||||
{
|
||||
foreach (var e in _world.Where(out Subject s))
|
||||
{
|
||||
s.poses.Write(e).position += s.velocities.Read(e).value * _time.DeltaTime;
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
# Не null инъекции
|
||||
|
||||
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy : Foo` если инъекции небыло.
|
||||
``` csharp
|
||||
[EcsInject(typeof(FooDummy))] Foo foo;
|
||||
```
|
||||
> Для корректной работы переданный тип должен иметь конструктор без парамтров и быть либо того же типа что и поле, либо производного типа.
|
||||
|
||||
Расширение так же сообщит если по завершению предварительной инъекции, остались не проинициализированные поля с `[EcsInject]`.
|
||||
74
README.md
74
README.md
@ -1,68 +1,26 @@
|
||||
<p align="center">
|
||||
<img width="400" src="https://github.com/DCFApixels/DragonECS-AutoInjections/assets/99481254/f120bb2b-5117-4546-aa13-4734b2608712.png">
|
||||
<img width="400" src="https://github.com/DCFApixels/DragonECS-AutoInjections/assets/99481254/11868b2e-21f7-4f47-8970-03ad6329cf0e.png">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-AutoInjections?color=%23ff4e85&style=for-the-badge">
|
||||
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/DragonECS-AutoInjections?color=ff4e85&style=for-the-badge">
|
||||
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
|
||||
</p>
|
||||
|
||||
# Auto Injections for [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||
Расширение призвано сократить объем кода, упростив инъекцию зависимостей, делая их автоматически.
|
||||
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
|
||||
# Оглавление
|
||||
* [Установка](#Установка)
|
||||
* [Зависимости](#Зависимости)
|
||||
* [Unity-модуль](#Unity-модуль)
|
||||
* [В виде исходников](#В-виде-иходников)
|
||||
* [Интеграция](#Интеграция)
|
||||
* [Инъекция зависимостей](#Инъекция-зависимостей)
|
||||
* [Auto Builder субъектов](#Auto-Builder-субъектов)
|
||||
* [Пример кода](#Пример-кода)
|
||||
* [Не null инъекции](#Не-null-инъекции)
|
||||
|
||||
# Установка
|
||||
### Зависимости
|
||||
Убедитесь что в проекте установлен фреймворк [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
|
||||
```
|
||||
* ### В виде исходников
|
||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-AutoInjections/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-AutoInjections) |
|
||||
| :--- | :--- | :--- |
|
||||
|
||||
# Интеграция
|
||||
Добавьте вызов метода `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. Пример：
|
||||
```csharp
|
||||
[EcsInject] EcsDefaultWorld _world;
|
||||
```
|
||||
# Auto Builder субъектов
|
||||
Так же AutoInjections упрощает построение субъектов. Для начала наследуйте субъект не от `EcsSubject`, а от `EcsSubjectDI`, а далее добавьте специальные атрибуты.
|
||||
The extension is designed to reduce the amount of code by simplifying dependency injection by doing injections automatically.
|
||||
> **NOTICE:** The project is a work in progress, API may change.
|
||||
> 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).
|
||||
|
||||
Атрибуты для инициализации полей с пулами:
|
||||
* `[Inc]` - кеширует пул и добавит тип компонента в включающее ограничение субъекта, аналог метода `Include`;
|
||||
* `[Exc]` - кеширует пул и добавит тип компонента в исключающее ограничение субъекта, аналог метода `Exclude`;
|
||||
* `[Opt]` - только кеширует пул, аналог метода `Optional`;
|
||||
# Versioning
|
||||
DragonECS uses this versioning semantics: [Open](https://gist.github.com/DCFApixels/c3b178a308b411f530361d1d56f1f929#versioning)
|
||||
|
||||
Дополнительные атрибуты только для задания ограничений субъекта. Их можно применить к самому субъекту, либо к любому полю внутри. Используйте атрибуты:
|
||||
* `[IncImplicit(type)]` - добавит в включающее ограничение указанный в конструкторе тип `type`, аналог метода `Include`;
|
||||
* `[ExcImplicit(type)]` - добавит в исключающее ограничение указанный в конструкторе тип `type`, аналог метода `Exclude`;
|
||||
|
||||
# Пример кода
|
||||
# Code Example
|
||||
```csharp
|
||||
class VelocitySystemDI : IEcsRunProcess
|
||||
{
|
||||
@ -86,7 +44,7 @@ class VelocitySystemDI : IEcsRunProcess
|
||||
}
|
||||
```
|
||||
<details>
|
||||
<summary>Тот же код но без AutoInjections</summary>
|
||||
<summary>Same code but without AutoInjections</summary>
|
||||
|
||||
```csharp
|
||||
class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<TimeService>
|
||||
@ -120,13 +78,3 @@ class VelocitySystem : IEcsRunProcess, IEcsInject<EcsDefaultWorld>, IEcsInject<T
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
# Не null инъекции
|
||||
|
||||
Чтобы поле помеченное `[EcsInject]` было проинициализированно даже в случае отстувия инъекции, в конструктор атрибута можно передать тип болванку. В примере ниже поле `foo` получит экземпляр класса `Foo` из инъекции или экземпляр `FooDummy : Foo` если инъекции небыло.
|
||||
``` csharp
|
||||
[EcsInject(typeof(FooDummy))] Foo foo;
|
||||
```
|
||||
> Для корректной работы переданный тип должен иметь конструктор без парамтров и быть либо того же типа что и поле, либо производного типа.
|
||||
|
||||
Расширение так же сообщит если по завершению предварительной инъекции, остались не проинициализированные поля с `[EcsInject]`.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user