猿学－unity游戏开发之entitas框架

框架介绍

entitas是一个超快、超轻量的c# Entity-Component-System (ECS)框架，专门为Unity引擎设计。提供内部缓存和高速的组件访问，经过精心设计，可以在垃圾收集环境中最优地工作。

框架解析

要理解框架，就需要知道这四种概念，分别是：Entiy实体、Context环境、Group组、Collector收集器。如图，在一个Context中，会有很多Entity，每个Entity都拥有若干Component，Component中只有数据，而Group是拥有相同Component的Entity集合，用于快速查找拥有特定属性的Entity。

Entity

Entity实体是保存数据的容器，用于表示应用程序中的某些对象。可以以IComponent的形式从实体中添加、替换或删除数据。实体有相应的事件来让你知道组件是否被添加、替换或删除。

Context

Context环境是用来创建和销毁entity的工厂，用它来过滤感兴趣的entity。

Group

Group支持对Context中的实体进行超级快速过滤。当实体发生变化时，它们会不断更新，并且可以立即返回实体组。假设有数千个实体，而你只想要那些具有PositionComponent的实体——只需为这个Group询问Context，就可以很方便的获得结果。

Collector

Collector收集器提供了一种随时间变化对组中的更改作出反应的简单方法。它能很方便的汇总处理特定的Entity。

基本使用

Group

Group总是最新的，并且包含与指定匹配程序匹配的所有实体。每个环境都有一个特定的匹配器类型——如果在你的游戏环境中寻找实体(比如游戏实体)，你需要使用GameMatcher

var context = contexts.game;

var movables = context.GetGroup(GameMatcher.Movable);

var count = movables.count; // count is 0, the group is empty

var entity1 = context.CreateEntity();

entity1.isMovable = true;

var entity2 = context.CreateEntity();

entity2.IsMovable = true;

count = movables.count; // count is 2, the group contains the entity1 and entity2

// GetEntities() always provides an up to date list

var movableEntities = movables.GetEntities();

foreach (var e in movableEntities) {

    // Do sth

}

entity1.Destroy();

entity2.Destroy();

count = movables.count; // count is 0, the group is empty

Matcher

Matcher匹配器由代码生成器生成，可以组合。匹配器通常用于从感兴趣的上下文中获取实体组。需要在匹配器前加上你感兴趣的上下文名称(例如GameMatcher, InputMatcher等)。

var matcher = GameMatcher.Movable;

GameMatcher.AllOf(GameMatcher.Movable, GameMatcher.Position);

GameMatcher.AnyOf(GameMatcher.Move, GameMatcher.Position);

GameMatcher

    .AllOf(GameMatcher.Position)

    .AnyOf(GameMatcher.Health, GameMatcher.Interactive)

    .NoneOf(GameMatcher.Animating);

Systems

entitas中有四种Systems：

IInitializeSystem:只执行一次 (system.Initialize())

IExecuteSystem:每帧执行 (system.Execute())

ICleanupSystem:在其他系统完成后每一帧执行(system.Cleanup())

ReactiveSystem:当观察的group改变时执行(system.Execute(Entity[]))

用法实例如下：

public class MoveSystem : IExecuteSystem {

    public void Execute() {

        // Do sth

    }

}

public class CreateLevelSystem : IInitializeSystem {

    public void Initialize() {

        // Do sth

    }

}

public class RenderPositionSystem: ReactiveSystem {

    public RenderPositionSystem(Contexts contexts) : base(contexts.Game) {

    }

    protected override Collector GetTrigger(IContext context) {

        return context.CreateCollector(GameMatcher.Position);

    }

    protected override bool Filter(GameEntity entity) {

        // check for required components (here it is position and view)

        return entity.hasPosition && entity.hasView;

    }

    protected override void Execute(List entities) {

        foreach (var e in entities) {

            // do stuff to the matched entities

            e.view.gameObject.transform.position = e.position.position;

        }

    }

}

最后需要注意的是，需要创建一个管理System的System，因为一个游戏开发过程中，不可能只有一个System的，为了方便管理，便有了【Feature】System的概念。这个类要继承Feature，在构造器里Add所有System进去。Feature就像一个管理System的SystemManager。

var systems = new Systems(contexts)

    .Add(new CreateLevelSystem(contexts))

    .Add(new UpdateBoardSystem(contexts))

    .Add(new MoveSystem(contexts))

    .Add(new RenderPositionSystem(contexts));

// Call once on start

systems.Initialize();

// Call every frame

systems.Execute();

System详解

总共有上述四种Systems，在实际开发中，需要为应用程序中的每个任务或行为创建systems，并按照定义的顺序执行它们。

InitializeSystem

InitializeSystem在程序开始时运行一次。它实现接口IInitializeSystem，后者定义了Initialize()方法。这是您设置初始游戏状态的地方，类似于Unity的Start()方法。

using Entitas;publicclass MyInitSystem : IInitializeSystem {

    publicvoid Initialize() {

        // Initialization code here    }

}

ExecuteSystem

ExecuteSystem每帧执行一次。它实现接口IExecuteSystem，接口定义了Execute()方法。这是放置需要每帧执行的代码的地方，类似于Unity的Update()方法。

using Entitas;publicclass MyExecSystem : IExecuteSystem {

    publicvoid Execute() {

        // per-frame code goes here    }

}

CleanupSystem

在所有其他systems完成它们的工作之后，CleanupSystem在每个帧的末尾运行。它实现了接口ICleanupSystem，接口定义了方法Cleanup()。如果想要创建只存在于一帧的实体，那么这个工具非常有用。

publicclass MyCleanupSystem : ICleanupSystem {

    publicvoid Cleanup() {

        // cleanup code here

        // runs after every execute and reactive system has completed    }

}

ReactiveSystem

ReactiveSystem在底层是使用了group观察者。通过它，你可以轻而易举的拥有发生改变的你感兴趣的实体。假设你在战场上有100个战斗单位，但是只有10个单位改变了他们的位置。不使用普通的IExecuteSystem，根据位置更新所有100个视图，您可以使用IReactiveSystem，它只更新10个更改单元的视图。所以效率很高。与其他system不同，ReactiveSystem继承自基类ReactiveSystem，而不是实现接口。entitas为游戏中的每个context生成一个实体类型。如果您的context是Game, GameState and Input，那么将生成三种类型:GameEntity、GameStateEntity和InputEntity。ReactiveSystem要求提供它们响应的特定context和关联实体类型。基类定义了一些必须实现的抽象方法。首先，须创建一个构造函数，该构造函数调用基构造函数并为其提供适当的context。必须重写3个方法:GetTrigger()返回一个Collector收集器，它告诉system要响应什么事件。Filter()对collector收集器返回的实体执行最后检查，确保它们在对每个实体调用Execute()之前都附加了所需的组件。Execute()是游戏逻辑的主要位置。需要注意的是:不应该尝试将ReactiveSystem和ExecuteSystem相结合，只需将ReactiveSystem看作是ExecuteSystem的一种特殊情况。所有其他接口都可以混合使用。

using System.Collections.Generic;using Entitas;publicclassMyReactiveSystem : ReactiveSystem {

    publicMyReactiveSystem (Contexts contexts) :base(contexts.MyContext) {

        // pass the context of interest to the base constructor    }

    protectedoverrideICollector GetTrigger(IContext context) {

        // specify which component you are reacting to

        // return context.CreateCollector(MyContextMatcher.MyComponent);

        // you can also specify which type of event you need to react to

        // return context.CreateCollector(MyContextMatcher.MyComponent.Added()); // the default

        // return context.CreateCollector(MyContextMatcher.MyComponent.Removed());

        // return context.CreateCollector(MyContextMatcher.MyComponent.AddedOrRemoved());

        // combine matchers with AnyOf and AllOf

        // return context.CreateCollector(LevelMatcher.AnyOf(MyContextMatcher.Component1, MyContextMatcher.Component2));

        // use multiple matchers

        // return context.CreateCollector(LevelMatcher.MyContextMatcher, MyContextMatcher.Component2.Removed());

        // or any combination of all the above

        // return context.CreateCollector(LevelMatcher.AnyOf(MyContextMatcher.Component1, MyContextMatcher.Component2),

        //                                LevelMatcher.Component3.Removed(),

        //                                LevelMatcher.AllOf(MyContextMatcher.C4, MyContextMatcher.C5).Added());    }

    protectedoverridebool Filter(MyContextEntity entity) {

        // check for required components    }

    protectedoverridevoidExecute(List entities) {

        foreach(varein entities) {

            // do stuff to the matched entities        }

    }

}

要响应来自多个context的实体的更改，需要使用multi-reactive system（多响应系统）。首先，需要声明一个接口，该接口将组合来自具有相同组件的多个context的实体，并且需要通过部分类为实体类实现该接口。然后创建从MultiReactiveSystem继承的系统，并传递新接口。

publicinterface PositionViewEntity : IEntity, IPosition, IView {}publicpartialclass EnemyEntity : PositionViewEntity {}publicpartialclass ProjectileEntity : PositionViewEntity {}publicclassViewSystem : MultiReactiveSystem {

    publicViewSystem(Contexts contexts) :base(contexts) {}

    protectedoverride ICollector[] GetTrigger(Contexts contexts) {

        returnnew ICollector[] {

            contexts.Enemy.CreateCollector(EnemyMatcher.Position),

            contexts.Projectile.CreateCollector(ProjectileMatcher.Position)

        };

    }

    protectedoverridebool Filter(PositionViewEntityentity) {

        returnentity.hasView && entity.hasPosition;

    }

    protectedoverridevoidExecute(List entities) {

        foreach(varein entities) {

            e.View.transform.position = e.Position.value;

        }

    }

}

Features

entitas为提供了Features来组织你的system。使用Features将相关system组合在一起。这有一个额外的好处，就是可以在Unity层次结构中为你的system分离可视化调试对象。现在可以在逻辑组中检查它们，而不是一次检查所有。

Feature还可以帮助你在项目中执行更广泛的范例规则。功能的执行顺序由添加它们的顺序决定，把你的系统分成InputSystems: Feature, GameLogicSystems: Feature和RenderingSystems: Feature，然后按照这个顺序初始化它们，确保游戏逻辑不会被干扰。

Feature要求实现构造函数。使用Add()方法向Feature添加system。这里添加它们的顺序定义了它们在运行时的执行顺序。可以在GameController中使用Feature将systems组实例化。

using Entitas;publicclass InputSystems : Feature

{

    publicInputSystems(Contexts contexts) :base("Input Systems")

    {

        // order is respected Add(new EmitInputSystem(contexts));

        Add(new ProcessInputSystem(contexts));

    }

}

在你的GameController中：

Systems createSystems(Contexts contexts) {

    // order is respectedreturnnewFeature("Systems")

        // Input executes first.Add(new InputSystems(contexts))

        // Update .Add(new GameBoardSystems(contexts))

        .Add(new GameStateSystems(contexts))

        // Render executes after game logic .Add(new ViewSystems(contexts))

        // Destroy executes last.Add(new DestroySystem(contexts));

}

entitas中的Attributes

Code Generator（代码生成器）目前支持与类、接口和结构一起使用的以下特性：

[Context]:可以使用此特性使组件仅在指定的context中可用;例如[MyContextName],[Enemies],[UI]....提高内存占用。它还可以创建组件。

[Unique]:代码生成器将提供额外的方法，以确保最多存在一个具有该组件的实体。

[FlagPrefix]:仅可用于支持标记组件的自定义前缀。

[PrimaryEntityIndex]:可用于将实体限制为唯一的组件值。

[EntityIndex]:可用于搜索具有组件值的实体。

[CustomComponentName]:为一个类或接口生成具有不同名称的多个组件。

[DontGenerate]:代码生成器不会使用此属性处理组件。

[Cleanup]:代码生成器将生成删除组件或销毁实体的系统。

这些特性的具体使用可以参考https://github.com/sschmid/Entitas-CSharp/wiki/Attributes

Code Generator代码生成

code generator是entitas框架的一大特色，可以让我们在开发时少写一些代码，在unity编辑器project面板中，Generated目录下都是自动生成的文件，不要去修改它们。

官方文档中介绍说可以自定义以及扩展code generator，让codegenerator更好的为我们服务，这一点我暂时没有去尝试。

个人看法

以下是个人愚见，如有错误欢迎指正。

优点：

遵循这个框架的规则去写代码，代码结构清晰。

ECS这种模式，耦合度就很低，所有的游戏物体都是组件的组合而已，可扩展性强，通过合理组合component就能配置出一个新的游戏物体。

很方便的管理所有实体状态，entitas提供了类似状态机的功能，当感兴趣的某个属性发生变化时，能在System中很方便的做出响应，不管什么状态，都能很方便的做出对应处理。

unity本身的开发模式就类似ECS，unity2018更是推出了最新的ECS框架，entitas很符合这种开发模式

entitas自开源以来，一直在更新维护，并受到了unity官方的认可，在unite大会上都有提到。所以，这个框架还是很靠谱的。

缺点：

国内资料少，上手难度高。国内用这个框架开发的特别少，遇到问题需要自己爬坑。

不适合小项目。小项目用entitas反而麻烦

entitas更新太快，官方wiki文档更新没有跟上，比如，我在看官方Demo-MatchOne的时候，有个Event的Attribute， wiki上暂时还没有这个的

代码热更方面是个问题， entitas基本对unity开发定了一套完整的规则，特别是有Code Generate，如果项目发布后想要更新加入新的代码会很麻烦，官方对此也没有说明，目前好像也没有人分享在entitas中加入lua热更的功能

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,324评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,303评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,192评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,555评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,569评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,566评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,927评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,583评论 0赞 257
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,827评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,365评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,941评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2赞 342

推荐阅读更多精彩内容

  • 爱情故事
    和以前一样和一群小伙伴像假小子一样在一起玩，不过今天有些特别。 这一天，有一个男孩加入了我们，我和闺密一起和他们玩...
    常小黎阅读 687评论 1赞 1
  • 菇凉，你命犯桃花一朵朵。
    男问:“你喜欢什么花? ” 女羞答答道：“我喜欢3种花。 ” 男急切地问：“哪3种? ” 女子低头小声说：“有钱花...
    足记阅读 681评论 0赞 2
  • 为什么不回爸妈电话
    你和她有没有联系？她在哪里？ 面对一个母亲迫切想知道的问题，我只有无尽的叹息。 有联系，不知道在哪里。 她有个习惯...
    沉溪阅读 310评论 0赞 0