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 {
// collector: Debug.Matcher.DebugLog
// filter: entity.hasDebugLog
public void Execute (List 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 {
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 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().To().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().FromInstance(Contexts.sharedInstance).AsSingle().NonLazy();
Container.Bind().WithId("SystemNamepsaces").FromInstance(SystemNamepsaces).AsSingle();
// Resolve all systems
for (var i = 0; i < SystemNamepsaces.Length; i++)
{
var nameSpace = SystemNamepsaces[i];
Container.Bind().WithId(nameSpace).To(x => x.AllTypes()
.DerivingFrom().InNamespaces(nameSpace)).AsSingle();
}
Container.Bind().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(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就能自动注入该命名空间的所有系统了。