Entitas + Zenject 解决繁琐的手动注入

Service

Services: Outside sources and sinks for information e.g. Pathfinding, Leaderboards, Anti-Cheat, Social, Physics, even the game engine itself.

Service就是由外部提供的数据、信息以及操作来源,像是寻路、物理、日志等等。下面引用一下原文中的例子:一个简单打出日志的功能。

简单的实现

直接使用UnityEngine.Debug.Log()

直接调用目标功能函数虽然方便快捷,但是强耦合使代码的维护性大大降低。一旦需要更换Log的实现方式或是增添什么功能,手动替换所有的Log是非常痛苦的事情。

解耦合的实现

  • 使用Entiats的实现

制作LogComponent,用ReactiveSystem对LogSystem进行处理。

using UnityEngine;
using Entitias; 
using System.Collections.Generic;

// debug message component
[Debug] 
public sealed class DebugLogComponent : IComponent {
    public string message;
}

// reactive system to handle messages
public class HandleDebugLogMessageSystem : ReactiveSystem<DebugEntity> {

    // collector: Debug.Matcher.DebugLog
    // filter: entity.hasDebugLog

    public void Execute (List<DebugEntity> entities) {
        foreach (var e in entities) {
            Debug.Log(e.debugLog.message);
            e.isDestroyed = true;
        }
    }
}

虽然这样做解决了耦合度的问题(只有一行代码需要替换),但在功能的实现上却与Entitas紧紧挂在了一起,需要在这个System中引用其他第三方和引擎无关的类。

  • 使用Interface的实现

设定ILogService,并且通过实现ILogService处理Log方法。

// the interface 
public interface ILogService {
    void LogMessage(string message);
}

// a class that implements the interface
using UnityEngine;
public class UnityDebugLogService : ILogService {
    public void LogMessage(string message) {
        Debug.Log(message);
    }
}

// another class that does things differently but still implements the interface
using SomeJsonLib;
public class JsonLogService : ILogService {
    string filepath;
    string filename;
    bool prettyPrint;
    // etc...
    public void LogMessage(string message) {
        // open file
        // parse contents
        // write new contents
        // close file
    }
}

然后ILogService已经可以在外面正常使用,在Entitas中可以这样用:

// the previous reactive system becomes 
public class HandleDebugLogMessageSystem : ReactiveSystem<DebugEntity> {

    ILogService _logService;

    // contructor needs a new argument to get a reference to the log service
    public HandleDebugLogMessageSystem(Contexts contexts, ILogService logService) {
         // could be a UnityDebugLogService or a JsonLogService
        _logService = logService; 
    }

    // collector: Debug.Matcher.DebugLog
    // filter: entity.hasDebugLog

    public void Execute (List<DebugEntity> entities) {
        foreach (var e in entities) {
            _logService.LogMessage(e.DebugLog.message); // using the interface to call the method
            e.isDestroyed = true;
        }
    }
}

上面代码的ILogService是在Constructor中手动注入的,原文使用的方法是定义Services类,手动绑定并且在Entitas系统中注入所有的Services,这样做非常麻烦,新增新的类以及外部使用接口方法的很不方便。在这个时候,Zenject能很好地解决我们的问题。

Zenject

Zenject 是一款为Unity3D设计的依赖注入的开源框架。

Git上面有非常详尽的文档介绍,我这边简单的说一下使用。
还是用上面的例子,我们依然使用Interface的实现方法,额外需要处理一下以下的组件

Installer

我们需要新建一个类集成MonoInstaller,在Binding方法中绑定ILogService,并且注册成单例AsSingle()。

public interface IDebugService
{
    void Log(string str);
}

public class UnityDebugService : IDebugService
{
    public void Log(string str)
    {
        Debug.Log(obj);
    }
}

public class ServicesInstaller : MonoInstaller
    {
        public override void InstallBindings()
        {
            // Unity Debug
            Container.Bind<IDebugService>().To<UnityDebugService>().AsSingle();
        }
    }

Context

我们需要在场景中增加一个SceneContext(还有Project/Decorator的Context 官方文档中有注明),将刚才增加的Installer挂载到Scene Context的GameObject上,并且在SceneContext上加入该Installer。

完成以上的步骤后,只要从Zenject中Resolve出来,Zenject的自动注入就会生效了。Zenject支持多种注入方式,这里推荐使用构造器注入以及方法注入。

构造器注入

public clas Test
{
    private ILogService _logService;

    public Test(ILogService logService)
    {
        _logService = logService;
    }
}

那么在Entitas中怎么Resolve所有的系统呢?这里需要用到在Installer种用到反射获取所有的ISystem来进行绑定。

    public class SystemsInstaller : MonoInstaller
    {
        public string[] SystemNamepsaces;

        public override void InstallBindings()
        {
            // Resolve contexts
            Container.Bind<Contexts>().FromInstance(Contexts.sharedInstance).AsSingle().NonLazy();

            Container.Bind<string[]>().WithId("SystemNamepsaces").FromInstance(SystemNamepsaces).AsSingle();

            // Resolve all systems
            for (var i = 0; i < SystemNamepsaces.Length; i++)
            {
                var nameSpace = SystemNamepsaces[i];
                Container.Bind<ISystem>().WithId(nameSpace).To(x => x.AllTypes()
                    .DerivingFrom<ISystem>().InNamespaces(nameSpace)).AsSingle();
            }

            Container.Bind<GameController>().FromNewComponentOnNewGameObject()
                .AsSingle().NonLazy();
        }
    }

同时在GameController中用DiContainer Resolve所有的System(GameController是Entitas的启动入口)。

public class GameController : MonoBehaviour
    {
        private DiContainer _container;

        [Inject(Id = "SystemNamepsaces")]
        private string[] _systemNamespaces;

        [SerializeField]
        public Systems Systems = new Systems();
        ...

        private void SetupAllBindingSystems()
        {
            var autoBindingFeature = new Feature("Auto Binding Features");
            for (var i = 0; i < _systemNamespaces.Length; i++)
            {
                var nameSpace = _systemNamespaces[i];
                var allSystems = _container.ResolveIdAll<ISystem>(nameSpace);
                var featureName = nameSpace.Split('.').LastOrDefault() + " Systems";
                var feature = new Feature(featureName);

                allSystems.ForEach(x => feature.Add(x));
                autoBindingFeature.Add(feature);
            }

            Systems.Add(autoBindingFeature);
        }
        ...
}

这样我们就完成了所有System的自动注入,我们只需要在Inspector上加入系统的Namespace就能自动注入该命名空间的所有系统了。

image
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270