Архитектура игры на Unity без Zenject. Часть 127.03.2023 18:47

Всем привет!

Меня зовут Игорь Гулькин, и я Unity разработчик. За свои 5 лет накопилось много опыта, поэтому в этой статье хотел бы поделиться принципами и подходами, с помощью которых можно реализовать архитектуру игры просто и гибко без фреймворка. Цель доклада, дать не просто готовое решение, а показать ход мыслей, как она выстраивается.  Ну что ж поехали :)

Пример

Давайте предположим, что мы делаем игру, где управляем кубиком с помощью клавиатуры. На сцене есть GameObject«ы:  

1. Player — кубик, которым игрок управляет.

2. KeyboardInput — пользовательский ввод с клавиатуры.

3. MoveController — соединяет пользовательский ввод и вызывает у кубика Player.Move().

Вот начальные скрипты этих классов:

Скрипт кубика:

public sealed class Player : MonoBehaviour
    {
        [SerializeField]
        private float speed = 2.0f;
    
        public void Move(Vector3 direction)
        {
            this.transform.position += direction * this.speed * Time.deltaTime;
        }
    }

Скрипт пользовательского ввода:

public sealed class KeyboardInput : MonoBehaviour
    {
        public event Action OnMove;

        private void Update()
        {
            this.HandleKeyboard();
        }

        private void HandleKeyboard()
        {
            if (Input.GetKey(KeyCode.UpArrow))
            {
                this.Move(Vector3.forward);
            }
            else if (Input.GetKey(KeyCode.DownArrow))
            {
                this.Move(Vector3.back);
            }
            else if (Input.GetKey(KeyCode.LeftArrow))
            {
                this.Move(Vector3.left);
            }
            else if (Input.GetKey(KeyCode.RightArrow))
            {
                this.Move(Vector3.right);
            }
        }

        private void Move(Vector3 direction)
        {
            this.OnMove?.Invoke(direction);
        }
    }

Скрипт контроллера перемещения:

public sealed class MoveController : MonoBehaviour
    {
        [SerializeField]
        private KeyboardInput input;

        [SerializeField]
        private Player player;

        private void OnEnable()
        {
            this.input.OnMove += this.OnMove;
        }

        private void OnDisable()
        {
            this.input.OnMove -= this.OnMove;
        }

        private void OnMove(Vector3 direction)
        {
            this.player.Move(direction);
        }
    }

Игра работает, но есть несколько архитектурных недостатков:

1. Нет точки входа в игру и соответственно завершения.

2. Все зависимости на классы проставляются вручную через инспектор.

3. Вся игровая логика привязана к монобехам (MonoBehaviour).

4. Нет порядка инициализации игры.

Давайте улучшать нашу архитектуру по порядку.

Состояние игры

Все мы знаем, что игра — это процесс у которого есть состояния. Есть состояние загрузки игры, старта, паузы и завершения. Практически во всех играх необходимо сделать так, чтобы этим состоянием можно было управлять. Поэтому будет здорово, если KeyboardInput и MoveController будут включаться по событию старта игры, а не при запуске PlayMode в Unity.

Тогда дизайн класса KeyboardInput будет выглядит так:

public sealed class KeyboardInput : MonoBehaviour, 
        IStartGameListener,
        IFinishGameListener
    {
        public event Action OnMove;

        private bool isActive;

        void IStartGameListener.OnStartGame()
        {
            this.isActive = true;
        }

        void IFinishGameListener.OnFinishGame()
        {
            this.isActive = false;
        }
        
        private void Update()
        {
            if (this.isActive)
            {
                this.HandleKeyboard();
            }
        }

        //TODO: Rest code…
    }

А класс MoveController будет выглядеть так:

public sealed class MoveController : MonoBehaviour, 
        IStartGameListener,
        IFinishGameListener
    {
        [SerializeField]
        private KeyboardInput input;

        [SerializeField]
        private Player player;

        void IStartGameListener.OnStartGame()
        {
            this.input.OnMove += this.OnMove;
        }

        void IFinishGameListener.OnFinishGame()
        {
            this.input.OnMove -= this.OnMove;
        }

        private void OnMove(Vector3 direction)
        {
            this.player.Move(direction);
        }
    }

Здесь мы видим, что KeyboardInput и MoveController реализуют интерфейсы IStartGameListener и IFinishGameListener. Через эти интерфейсы, компоненты системы получают сигналы об изменении состояния игры. Сюда сразу же можно прикрутить еще два интерфейса: IPauseGameListener, IResumeGameListener. Они указывают, когда игра переходит в состояние паузы и наоборот. Ниже приложил код всех 4-х интерфейсов:

public interface IStartGameListener
    {
        void OnStartGame();
    }

    public interface IPauseGameListener
    {
        void OnPauseGame();
    }

    public interface IResumeGameListener
    {
        void OnResumeGame();
    }

    public interface IFinishGameListener
    {
        void OnFinishGame();
    }

Таким образом, используя принцип Interface Segregation компоненты будут обрабатывать только те состояния игры, которые они реализуют

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

public sealed class GameObservable : MonoBehaviour
    {
        private readonly List