#архитектура

Приветствую, друзья 👋

Сегодня затронем вторую тему из списка и поговорим о количестве точек входа в код проекта.
Точка входа может быть как одна, так и несколько.

Начнём с единой точки входа.
Единая точка входа - это главный скрипт, который инициализирует и контролирует все другие элементы проекта.
Представляет собой MonoBehaviour класс, который может быть легко просмотрен и понят.

В Unity единая точка входа может быть реализована с помощью скриптов и объектов, таких как менеджер сцен или стартовый класс.
Единая точка входа может включать в себя загрузку ресурсов, инициализацию компонентов, конфигурацию параметров и другие важные действия, необходимые для запуска и функционирования приложения.

Основные преимущества единой точки входа:
- возможность контролировать порядок инициализации элементов проекта. Особенно актуально, когда вы работаете с большим количеством ассетов и скриптов, и необходимо гарантировать, что все элементы будут инициализированы в нужном порядке
- улучшение производительности приложения. Достигается за счет того, что единая точка входа позволяет контролировать загрузку и инициализацию только тех элементов, которые необходимы для данного уровня или экрана, что уменьшает нагрузку на устройство
- повышение читаемости и поддерживаемости кода.

Применение единой точки входа является best practice и позволяет создать качественный и надежный продукт, существенно улучшает общую организацию и структуру кода, уменьшает риск возникновения ошибок и проблем с поддержкой, а также упрощает процесс разработки и тестирования.

Что касается нескольких точек входа в код проекта.
При таком подходе каждая точка входа представляет собой отдельный вход в код и может быть реализована с помощью GameObject на сцене.
На каждом GameObject расположены MonoBehaviour скрипты, в методах Awake или Start которых выполняется определенный код.
Использование нескольких точек входа проще в реализации, подходит для прототипов но неэффективно для крупных проектов.

Плюсы использования нескольких точек входа в код:
- простота использования (если речь о прототипах)
- отпадает необходимость задумываться о жизненном цикле объектов.

Минусы использования нескольких точек входа:
- усложнение отладки и увеличение времени на ее проведение
- снижение читаемости кода и усложнение его понимания.

Что касается меня, я являюсь сторонником единой точки входа.

Рассмотрим на примере:
В иерархии объектов на сцене я создаю GameObject с названием Root, на котором размещаю компонент EntryPoint. В Awake создаю первую Entity - RootEntity, далее код развивается древовидно.
В каждую из веток кода можно попасть через навигатор кода.
Каждая Entity, Pm, View включается в себя структуру Ctx, которая описывает все зависимости текущего класса.
В итоге код можно представить в виде дерева.
Кроме того, наличие Ctx в каждой Entity, Pm и View позволяет вам легко отслеживать все зависимости, что улучшает читаемость и поддерживаемость кода.

#разбортестового
Приветствую, друзья 👋
Сегодня публикуем разбор одного из присланных тестовых заданий.

Разбор представлен в 2-х форматах:
- Видео. Постарался сделать сжато, выделив суть.
- Текстовый. Для тех, кто не планирует смотреть видео.
Но я рекомендую выделить время как на прочтение, так и просмотр)

Итак, приступим, начнем с замечаний
1. Отсутствует единая точка входа.
Вход в код осуществляется в 2 классах:
- SceaneLoader, Awake
- Player, Start.

2. Разделение на слои абстракции.
Выполнено, но не до конца.
Есть классы отвечающие за несколько зон.

Так, например, класс UpgradableBuilding содержит в себе следующие ответственности:
- контент
- бизнес-логика смены зданий
- слой представления.

Класс Player содержит избыточную ответственность:
- бизнес-логику (управление и передвижение камеры)
- слой представления.

3. Слой State.
В текущей реализации будет невозможно создать BuildingController из State в случае сохранения игрового состояния мира на диск и его последующего восстановления.

4. Загрузка ресурсов.
Процесс загрузки ресурсов требует особого внимания. Независимо от сложности проекта, следует описать в комментариях способы загрузки и обработки большого количества ресурсов. В противном случае возможно переполнение оперативной памяти устройства, что может привести к негативным последствиям.

5. Организация префабов с UpgradableBuilding.
Префабы изначально содержат все возможные уровни апгрейда зданий, по умолчанию все кроме первого уровня находятся в неактивном состоянии.
В идеале UpgradableBuilding не должен знать свою цепочку апгрейда.
Возможность задавать цепочку апгрейда должна быть доступна через контент. Это необходимо для того, чтобы гейм-дизайнер или контент-менеджер могли управлять апгрейдом самостоятельно при настройке баланса игры без участия разработки.
Для этого необходим отдельный контентный класс, в котором прописывается:
- уровень,
- id здания, которое апгрейдим,
- id здания, на какое апгрейдим.

6. Использование большого количества MonoBehaviour.

7. Утилитарные классы можно не инстанцировать, вместо этого использовать статические классы и методы. Например, сделать статическим класс GridGenerator, метод GetGrid.

8. Использования постфикса Controller в классах.
Уйти от использования постфикса Controller в классах, это может вызвать диссонанс у проверяющего.
Controller из MVC - это слой, который отвечает за пользовательский ввод и уведомляет модель, далее слой представления рендерит изменения.

8. Использовать namespace.

---
Что понравилось в тестовом:
1. Простота кода
2. Единообразие с методом Init.

Тестовое выполнено довольно неплохо
Спасибо автору за проделанную работу и предоставленный для разбора материал 💪
Всем хорошего дня и прекрасных выходных!

#библиотека_программиста #геймдев #слои_абстракции

Привествую! По просьбам читателей и в дополнение к предыдущим постам, сегодняшняя публицация будет посвящена литературе по слоям абстракции.

К сожалению, хорошей литературы по слоям абстракции в геймдеве я не встречал.
Но для понимания на концептуальном уровне могу посоветовать следующие варианты:
📚
1. Предметно-ориентированное проектирование (DDD). Структуризация сложных программных систем, Эванс Эрик, стр. 79.
2. Архитектура корпоративных программных приложений, Мартин Фаулер, стр. 43.
3. Программист-прагматик. Путь от подмастерья к мастеру, Эндрю Хант, Дэвид Томас, стр. 32.

Приятного прочтения 🙂

Привествую, друзья.
Одна из тем, которой я касаюсь при отборе в команду - использование интерфеса IDisposable.

Перед очередной нашей публикацией предлагаю вам принять участие в опросе 👇

#idisposable #управление_ресурсами

Приветствую, друзья!

Подведем итоги опроса про интерфейс IDisposable 👇
На момент подведения итогов получены следующие результаты:
✅ 44% - разработчик решает, что произойдет
16% - освободится память
26% - освободятся неуправляемые ресурсы
14% - затрудняются ответить.

Как показал опрос использование интерфейса IDisposable в C# часто некорректно связывают только с освобождением памяти или освобождением неуправляемых ресурсов.
‼️ На самом деле сам разработчик может задать сценарий происходящего.

Понимание работы IDisposable понадобится нам для дальнейших публикаций и разбора кода, поэтому приступим.

Один из вариантов использования интерфейса IDisposable в C# - реализация паттерна "ресурсов", суть которого состоит в управлении использованием ресурсов, таких как: файлы, сетевые подключения, базы данных и других неуправляемых ресурсов.

Управляемые ресурсы - это ресурсы, которыми управляет сборщик мусора, такие как объекты ref типа, созданные с использованием оператора new.
Сборщик мусора автоматически освобождает память, выделенную под управляемые ресурсы, когда они больше не используются.

Неуправляемые ресурсы - это ресурсы, которые не попадают под управление сборщика мусора, например: открытые файлы, сетевые подключения, базы данных, оборудование и т.д.
Освобождение неуправляемых ресурсов требует явного вызова методов для их освобождения, что и реализуется через использование интерфейса IDisposable.

Таким образом использование интерфейса IDisposable для реализации паттерна "ресурсов" помогает управлять ресурсами и предотвращать утечки памяти.

Рассмотрим другие сценарии.

Реализация паттерна "заимствования" (borrowing).
Паттерн будет полезен при работе с потоками данных или потоковыми операциями, где необходимо убедиться, что определенные ресурсы используются только одним потоком в определенный момент времени, и избежать ошибок при многопоточной обработке данных.
При данном подходе интерфейс IDisposable используют для создания блоков кода, в которых происходит заимствование (borrowing) ресурса и автоматическое освобождение этого ресурса после завершения блока.

Рассмотрим пример реализации паттерна "заимствования", где использование интерфейса IDisposable позволит гарантировать правильную обработку ресурса и избежать ошибок при работе с потоками данных.

class StreamResource : IDisposable
{
    private Stream _stream;

    public StreamResource(Stream stream)
    {
        _stream = stream;
    }

    public Stream GetStream()
    {
        return _stream;
    }

    public void Dispose()
    {
        _stream = null;
    }
}

// Использование ресурса в блоке using
using (var resource = new StreamResource(new FileStream("file.txt", FileMode.Open)))
{
    var stream = resource.GetStream();
    // обработка потока данных
}

В примере класс StreamResource представляет собой ресурс (поток данных), который может быть заимствован в блоке using, после чего происходит автоматическое освобождение ресурса.
Внутри блока using происходит обработка потока данных.

Таким образом, использование интерфейса IDisposable в рассмотренном примере позволяет гарантировать правильную обработку ресурса и избежать ошибок при работе с потоками данных.

Продолжение 👇

#idisposable #управление_ресурсами

IDisposable продолжение 👇

Другим примером использования интерфейса IDisposable является реализация механизма отмены операции или транзакции.

Например, у вас есть сложная операция, которую нужно выполнить в несколько этапов, и необходима возможность отмены операции в любой момент времени.

Рассмотрим реализацию механизма отмены операции на примере:

class Operation : IDisposable
{
    private bool _isCompleted = false;

    public void Execute()
    {
        // выполнение операции
        _isCompleted = true;
    }

    public void Cancel()
    {
        if (!_isCompleted)
        {
            // отмена операции
            _isCompleted = true;
        }
    }

    public void Dispose()
    {
        if (!_isCompleted)
        {
            Cancel();
        }
    }
}

// Использование операции с возможностью отмены
using (var operation = new Operation())
{
    try
    {
        operation.Execute();
        // выполнение операции
    }
    catch (Exception ex)
    {
        // обработка ошибки
        operation.Cancel();
    }
}

В примере класс Operation представляет собой операцию, которая может быть выполнена и отменена.
В блоке using используется операция с возможностью отмены.
Если операция завершается успешно, то она просто выполняется, и интерфейс IDisposable не используется.
Если же происходит ошибка, то операция отменяется с помощью метода Cancel, который также вызывается при автоматическом освобождении ресурса благодаря интерфейсу IDisposable.

Использование интерфейс IDisposable в рассмотренном выше примере позволяет реализовать механизм отмены и гарантировать, что операция будет правильно завершена или отменена в любом случае.

✅ Итак, мы рассмотрели варианты использования интерфейса IDisposable для реализации:
- паттерна "ресурсы" для управления ресурсам и предотвращения утечек памяти
- паттерна "заимствования" (borrowing) для работы с потоками данных
- реализация механизма отмены операции или транзакции.

Всем хорошего дня 👋

Для тех, кто планирует более глубокое погружение, в следующем посте подборка тематической литературы 👇

#библиотека_программиста #геймдев #idisposable

Подборка литературы по использованию IDisposable.

📚
1. Де Смет, Барт. C# 5.0 Unleashed, глава 20, "Диспозиция и финализация".

2. Скит, Джон. C# in Depth, глава 6, "Размещение объектов и сборка мусора".

3. MSDN. "Использование using в C#", (https://docs.microsoft.com/ru-ru/dotnet/csharp/language-reference/keywords/using-statement).

4. CodeProject. "Implementing IDisposable and the Dispose Pattern Properly", (https://www.codeproject.com/Articles/15360/Implementing-IDisposable-and-the-Dispose-Pattern-P).

5. Albahari, Joseph and Albahari, Ben. C# 9.0 in a Nutshell: The Definitive Reference, глава 9, "Memory Management, Pointers, and Unsafe Code".

6. Nagel, Christian. Professional C# 7 and .NET Core 2.0, глава 21, "Unsafe Code and Pointers".

7. Скит, Джон. C# in Depth, глава 15, "Unsafe code and pointers".

8.Agafonov, Eugene. Mastering C# Concurrency: Write Flawless C# Code for Concurrent and Parallel Programming, глава 7, "Low-level Threading in C#".

9. Miles, Rob. C# Programming Yellow Book, глава 25, "Unsafe Code".

10. Официальная документация Microsoft по C#, раздел "Unsafe Code and Pointers".

11. C# Language Specification, раздел "28.1 Pointer types".

Приятного прочтения 🙂

#monobehaviour #архитектура

Приветствую, друзья 👋

Сегодняшняя публикация посвящена роли MonoBehaviour в проекте.

MonoBehaviour - это базовый класс в Unity, который используется для написания скриптов, управляющих поведением игровых объектов.
Он предоставляет множество методов жизненного цикла, которые могут быть переопределены для реализации логики игровых объектов.

Некоторые из основных методов, используемые в жизненном цикле объекта, включают в себя:
- Awake(): вызывается при создании объекта после инициализации всех его компонентов, но до того, как он станет активным в иерархии сцены.

- Start(): вызывается после Awake() и до первого обновления фрейма.
✅ В методе можно инициализировать переменные и компоненты, которые зависят от других объектов в сцене.

- Update(): вызывается каждый кадр и используется для обновления поведения объекта.
✅ В методе можно изменять свойства объекта, перемещать его, обрабатывать ввод и т.д.

- FixedUpdate(): вызывается с фиксированной частотой и используется для обновления физики объекта.
✅ Метод должен использоваться всякий раз, когда вам нужно изменять физические свойства объекта, такие как скорость, позиция, силы и т.д.

- LateUpdate(): вызывается после того, как все объекты обновили свои позиции в текущем кадре.
✅ Метод полезен, когда необходимо обновить объект, исходя из его новой позиции после обновления других объектов.

- OnEnable(): вызывается, когда объект становится активным в иерархии сцены.
- OnDisable(): вызывается, когда объект становится неактивным в иерархии сцены.
- OnDestroy(): вызывается перед уничтожением объекта.

В дополнение к методам, MonoBehaviour имеет свойства, ниже некоторые из них:
- transform - для доступа к компоненту Transform объекта,
- gameObject - для доступа к объекту, на котором находится компонент
- и многие другие, которые позволяют получить доступ к различным свойствам и компонентам объекта.

С помощью MonoBehaviour можно реализовать множество функций, например:
- управление движением объектов,
- обработка столкновений,
- взаимодействие с пользователем и многое другое.

⛔На практике разработчики часто смешивают слои бизнес-логики, представления и контента в наследнике MonoBehaviour.
Такое смешение является плохой практикой по нескольким причинам:

1. Нарушение принципа единственной ответственности (SRP).
Каждый класс должен быть ответственным только за одну вещь, и смешение различных слоев функциональности в одном классе приводит к необходимости поддерживать несколько ответственностей одновременно.
Это усложняет код и его тестирование, увеличивает количество ошибок.

2. Сложность переноса и интеграции кода.
Когда вся функциональность приложения сосредоточена в наследнике MonoBehaviour, усложняется перенос в другую среду или интеграции с другими проектами.
Разделение функциональности на различные классы и слои позволяет легче переносить код и переиспользовать его.

3. Сложность тестирования.
Когда код приложения находится в одном монолитном классе, усложняется тестирование. Возникает необходимость создания сложных тестовых сценариев для проверки функциональности, что ведет к росту времени и увеличивает вероятность возниконовения ошибок.

4. Нарушение принципа разделения интерфейса и реализации (ISP).
Классы должны предоставлять только те методы и свойства, которые необходимы для работы с ними, а не всю функциональность приложения.
Смешение различных слоев функциональности в одном классе нарушает ISP и делает код менее гибким и модульным.

5. Усложнение поддержки кода.
Смешение различных слоев функциональности в одном классе делает код менее читабельным и понятным для других разработчиков.
Это усложняет поддержку и дальнейшее развитие приложения.

6. Трудности в отслеживании состояния объектов и их взаимодействия друг с другом.
Часто компоненты MonoBehaviour создаются и удаляются динамически в зависимости от событий в игре, подобное использование MonoBehaviour может сделать код менее гибким и менее управляемым.

Продолжение 👇

#monobehaviour #архитектура

Продолжение Роль MonoBehaviour в проекте 👇

✅Что же является хорошей практикой?
Хорошей практикой является использование MonoBehaviour в качестве слоя View в Unity проекте.

Несколько правил, которые сделают использование данного класса эффективным:
1. Разделяйте логику и представление:
MonoBehaviour должен использоваться только для отображения объектов на сцене

2. Разделяйте игровые логики в отдельные классы:
Все игровые логики должны быть разделены в отдельных классах. Это обеспечит легкость понимания кода и возможность повторного использования
ℹ️ исключение может составлять логика, которая используется для работы самого представления.

Вопросы в комментариях приветствуются!

Лёгкой и продуктивной недели 💪

Приветствую, друзья 👋

По плану публикаций следующая тема должна быть посвящена организации префабов и роли слоя view в ней.
Но нам поступило несколько запросов на пост про CI/CD.

Поэтому предлагаем вам принять участие в опросе и выбрать тему следующей публикации 🙂

Поехали 👇

#архитектура #prefab #view
Приветствую, друзья! 👋

По результатам голосования за выбор темы публикации между "Организацией префабов и роли слоя view в ней" и "CI/CD в игровой разработке" с результатом 57% победу одержали префабы.
Поэтому сегодня говорим про организацию префабов и роль слоя view в ней.

Начнем с организации.
Организация префабов в Unity - важный аспект процесса разработки игры.

Префаб - заранее созданный объект, который можно использовать в разных сценах игры.
Правильная организация позволит упростить процесс разработки, и организовать префабы таким образом, чтобы они были легко доступны и понятны для всей команды.

✅ Советы по организации префабов:

- Создание папок
Распределяйте префабы по папкам в соответствии с их функциональным назначением. Это упростит поиски нужного префаба. Например, разные папки для префабов игровых персонажей, окружения, звуков и т.д.

- Именование префабов
Имя префаба должно отражать его суть.
Ясные и понятные имена для каждого префаба позволяют легче его идентифицировать и искать.

- Использование тегов
Unity позволяет назначать теги для объектов, включая префабы.
Это упрощает поиск в больших проектах.
Назначение одного и того же тега нескольким префабам, позволит сгруппировать их вместе.

- Использование переменных
Используйте переменные для определения свойств префабов.
Например, переменная для определения здоровья игрового персонажа или скорости движения.

- Обновление префабов
При обновлении префаба, задействованного в сцене, убедитесь, что изменения не нарушит логику игры.
Например, если вы обновляете префаб игрового персонажа, убедитесь, что изменения не приведут к проблемам с анимацией или поведением персонажа.

- Переиспользование префабов
Будет полезно, если вы хотите создать множество однотипных объектов.
Например, при создании уровня, который включает множество блоков, можно создать префаб блока и использовать его для всех блоков в уровне.

Переиспользование префабов может значительно упростить процесс разработки игры в Unity, поскольку это позволяет использовать один раз созданный объект в разных частях игры.

✅ Советы по правильному переиспользованию префабов:

- Универсальность
Если планируется использование префаба в разных сценах игры, сделайте его универсальным для всех этих сцен.
Например, если вы создаете префаб здания, которое будет использоваться в разных уровнях игры, убедитесь, что он подходит для любого уровня, не только для текущего.

- Настраиваемость
Префабы могут быть настроены для изменения свойств в режиме редактирования Unity.
Например, вы можете создать префаб игрового персонажа и настроить его для разных типов персонажей, таких как главный герой, противники и т.д.
Это может упростить процесс создания игровых объектов в будущем.

- Версионнирование
Если вы обновляете префаб, который уже используется в игре, убедитесь, что новая версия не повлияет на уже созданные объекты.
Хорошей практикой является создание новых версий префаба с новым именем и обновление ссылок на них в игре.

- Документирование
Хорошей практикой является документирование использования префабов, чтобы другие члены команды знали как и могли легко использовать их в своей работе.

- Тестирование
Перед тем, как использовать префаб в игре, убедитесь, что он работает правильно.
Протестируйте его в разных условиях и убедитесь, что он работает корректно.

Продолжение 👇

#архитектура #prefab #view
Продолжение Роль слоя view в префабах 👇

View - наследник MonoBehaviour.
Его роль в организации префабов заключается в разделения ответственности между слоями представления и бизнес-логики.
Такой подход упрощает поддержку кода и делает его более гибким и масштабируемым.
View отвечает за отображение данных в игровом мире и может сообщать о них, также реагирует на изменение данных в pm.
Возможность реагировать на изменение данных в pm, отслеживать их и вызывать команды из слоя представления достигается через использование реактивных объектов, таких как ReactiveProperty или ReactiveCommand, помогает обеспечить правильное взаимодействие между слоями, упростить тестирование и отладку кода.

ReactiveProperty - это реактивный объект, который автоматически оповещает все подписанные на него объекты об изменении своего значения.
Он может использоваться для отслеживания изменений свойств.
Например, текущего здоровья игрока или его координат на карте.

ReactiveCommand - это реактивный объект, который представляет собой команду, которую можно вызвать.
Он позволяет разделять ответственность между слоем представления и pm, так как view не знает, что происходит за его пределами.
Например, при нажатии на кнопку "атаковать" в интерфейсе игрока, ReactiveCommand вызывает метод pm, который обрабатывает эту команду.

Кроме того, использование view позволяет легко настраивать префабы и создавать новые визуальные элементы, не затрагивая при этом pm.
Например, можно добавить новый элемент интерфейса, который будет отображать текущую скорость игрока, и при этом не вносить изменений в pm.

✅ Правила организации префабов с помощью View:
1. Каждый префаб должен иметь свой рутовый GameObject, на который необходимо повесить класс view.

2. В классе view необходимо явно прописать набор зависимостей
Набор зависимостей заполняем перетаскиванием. Они будут представлять собой другие GameObject'ы из иерархии префаба, необходимые для корректного отображения данных.
Например, у игрока может быть HpBar, который является дочерним объектом рутового GameObject'а, на котором также висит свой view класс.
Пример из Unity

3. В каждом классе view должен быть публичный метод SetCtx.
SetCtx вызывается при инициализации view через код в классе entity, после инстанцирования префаба.
Данный метод принимает контекст (обычно это структура) в виде зависимости.
Пример кода
Контекст должен содержать все необходимые зависимости для работы view.
Например, текущее здоровье игрока или его координаты на карте, реактивные объекты, контент.
Пример кода

‼️ Контекст view не должен содержать: context, entity, pm, view, content, state, так как в таком случае вы усилите зацепление.

Таким образом, использование view в организации префабов является важным элементом архитектуры Unity-проектов, который позволяет разделять ответственность между view и pm, упрощает поддержку и расширение кода и делает проект более гибким и масштабируемым.

Контекст View - иллюстрация к статье

Prefab View - иллюстрация к статье

Entity Prefab View - иллюстрация к статье

#архитектура #разбор_кода

Приветствую, друзья 👋

Сегодняшняя публикация посвящена видеоразбору кода в рамках предлагаемого мной подхода к проектированию архитектуры.
Код написан мной на базе задания, которое давали ранее.

Т.к. на текущий момент по плану публикаций мы разобрали 4 темы, акцент при разборе сделан именно на них:
- Деление игры на слои абстракции.
- С чего должен начинаться Unity проект. Точка входа в код.
- MonoBehaviour.
- Организация префабов.

Видео получилось продолжительное и увесистое, доступно по ссылке

Приятного просмотра 📺

ПС: Приносим извинения за качество звука, проработаем данный вопрос к следующим записям!