PureMVC （Unity游戏框架入门学习首选） 个人理解学习详细笔记


篇前杂言

最近找工作因为经验不足吃了很多闭门羹。不过最主要还是自己太菜的原因。所以决定静心修炼，翻年之后再尝试。

正文

PureMVC是我在看国内某Unity框架视频时无意间听到的。作为一个轻量级的 开源 MVC扩展框架，非常适合学习框架入门的人。
PureMVC官网传送门
Unity3D目前开源的框架资源不多，PureMVC是一个很好的选择。以下框架讲解也就使用Unity和C#作为基础。

在开始PureMVC学习之前你需要掌握的知识：

  • C#委托。
  • C#接口特点。
  • 基础MVC概念。
  • 单例，中介者，门面，观察者，命令，代理六种模式。
    软件程序员必须掌握的23种设计模式传送门

下面是PureMVC整体的设计思想图。如果你是刚刚接触这个框架思想，看到这个图会很难受。大概看看就好。


官方对PureMVC设计示意图

因为对这个框架的基本讲解的Blog很多如下列举一些当时我查阅的Blog：

  • PureMVC的总结 --作者：LinGeeHuy
  • PureMVC框架在Unity中的应用 --作者：Ken
  • PureMVC新手入门 --作者：笨鳥
    上面的Blog大概看看PureMVC的大体概念就行了。
    顺便附上最开始我找到的一个Unity万用框架的Blog，这位Bloger我也是很佩服的，在没有学习到这种思想之前就大概自己琢磨除了这种框架。其实这个思想基本上就是PureMVC的思想。
  • Unity3D开发之我认为的万能应用框架 --作者：JayW就是我吖

你肯定想吐槽，你什么介绍都不写，让我看别人的Blog你这还算是Blog吗？
我只是想给大家一个快速学习的通道，而不用像我一样到处查阅资料。一篇文章就能搞定这个知识才是我的目的。

学习一个框架最快捷的方式是先学会使用这个框架。所以我这里先做一个简单的案例来介绍PureMVC的使用。
1.创建一个新的Unity工程。
2.导入PureMVC框架
什么？不会导入？下载源码放入VS编译，拿到dll丢到工程目录下Assets/Plugins文件夹下。(编译的时候建议把注释导出到xml作者的注释非常好。把dll和xml同时拷贝到文件夹下，确保注释生效。)
3.创建基本的测试环境
4.看代码
如果不想看，直接跳过下面一大堆代码~
注释我已经写在代码中了。这里是源码下载 提取码：j34t（如果挂了请通知我谢谢~）

1
2
3
4
5
6
7
8
9
10
11
using PureMVC.Patterns.Facade;

public class AppFacade : Facade
{
    父类中初始化整个MVC数据结构。完成之后可以加上我们自己的一些初始化内容。这个函数执行完之后就初始化完了，数据结构。
    protected override void InitializeFacade()
    {
        base.InitializeFacade();
        RegisterCommand("StartGame", () => new StartCommand());
    }
}

PureMVC为使用者提供了一个Facade单例类，这个类就是使用门面模式来对View, Model, Controller三大数据进行了隐藏。让使用者不用关心内部数据结构。使用者只需要通过Facade类对自己实现的Mediator, Command, Proxy进行注册, 删除, 检索来对MVC数据进行操作。自己只需要在自己的工程中继承Facade类一次，并且重写父类中的一些方法就能实现自己的Facade类。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
数据类，只用来存储数据。这里我使用set属性来发送SetText消息。
public class DataMainPage
{
    private string _text;
    public string Text
    {
        get => _text;
        set
        {
            _text = value;
            GameManager.Instance.facade.SendNotification("SetText", this);
        }
    }
    public DataMainPage(string msg)
    {
        _text = msg;
    }
}

这里只需要添加数据即可，复杂的逻辑代码不应该在这里。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
using UnityEngine;
using PureMVC.Interfaces;

public class GameManager : MonoBehaviour
{
    public static GameManager Instance;
    public IFacade facade = null;

    当前GameManager脚本在Unity中的脚本执行于所有自定义脚本最早。
    private void Awake()
    {
        Instance = this;
        DontDestroyOnLoad(gameObject);

        创建AppFacade单例类且完成AppFacade类中的InitializeFacade()函数的初始化操作。
        facade = AppFacade.GetInstance(() => new AppFacade());

        注册StartGame命令。执行开始游戏操作。
        facade.RegisterCommand("StartGame", () => new StartCommand());
    }
}

设置当前GameManager脚本优先于所有自定义脚本执行非常重要。因为这里需要初始化所有的框架和数据。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
using PureMVC.Interfaces;
using PureMVC.Patterns.Mediator;
using System.Collections.Generic;

public class MediatorMainPage : Mediator
{
    public ViewMainPage MainPage = null;

    初始化并且添加按钮事件。
    public MediatorMainPage(string mediatorName, object viewComponent = null) : base(mediatorName, viewComponent)
    {
        MainPage = ViewComponent as ViewMainPage;
        MainPage.m_Btn.onClick.AddListener(ClickBtnStart);
    }

    这个函数用来添加当前类关心哪些消息。
    public override string[] ListNotificationInterests()
    {
        List<string> list = new List<string>();
        //Add Message here whatever you want.
        list.Add("SetText");

        return list.ToArray();
    }

    这个类用于处理到来的消息，如果是当前类关心的消息，则执行相应的函数。
    public override void HandleNotification(INotification notification)
    {
        DataMainPage page = notification.Body as DataMainPage;
        switch (notification.Name)
        {
            case "SetText":
                SetTextToView(page.Text);
                break;
        }
    }
    public void SetTextToView(string text)
    {
        这里对View中的Text进行赋值，更新游戏中Text的内容。
        MainPage.m_Text.text = text;
    }
    private void ClickBtnStart()
    {
        使用RetrieveProxy获取Model数据。

        DataMainPage data = GameManager.Instance.facade.RetrieveProxy("MainPage").Data as DataMainPage;

        这里对数据赋值，触发Text的Set属性，发送SetText消息。最后被上面的HandleNotification()函数处理。
        data.Text = "Hello PureMVC";
    }
}

Mediator类在实际的项目中可能会变得很大，所以设计时要衡量模块大小。

1
2
3
4
5
6
7
8
using PureMVC.Patterns.Proxy;

public class ProxyMainPage : Proxy
{
    public ProxyMainPage(string proxyName, object data = null) : base(proxyName, data)
    {
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
using PureMVC.Interfaces;
using PureMVC.Patterns.Command;
using UnityEngine;

public class StartCommand : SimpleCommand
{
    public override void Execute(INotification notification)
    {
        这里也可以用来执行对游戏的初始化，继承制Command类的子类都是用于游戏全局命令的逻辑。
        Debug.Log("Game Start Data Initialized.");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
using UnityEngine;
using UnityEngine.UI;

public class ViewMainPage : MonoBehaviour
{
    public Text m_Text;
    public Button m_Btn;

    public void Awake()
    {
        这里直接使用facade对前面所有自定义的Proxy, Mediator进行注册。
        使用字符串“MainPage”来统一所有的Proxy, Mediator在字典中的储存键值，方便后续访问。

        GameManager.Instance.facade.RegisterMediator(new MediatorMainPage("MainPage", this));
        DataMainPage data = new DataMainPage("I Wanna study PureMVC.");
        GameManager.Instance.facade.RegisterProxy(new ProxyMainPage("MainPage", data));

        注册完成且DataMainPage完成构造，发送“SetText”消息，首次对View进行更新。

        GameManager.Instance.facade.SendNotification("SetText", data);

        tips：其实最好不要在View结构里面进行绑定，如果你有更好的注册和初始化方式请一定不使用当前方式。
    }
}

下面开始是我对PureMVC的理解。

首先，从源码中知道了View, Controller, Model三个类中分别用ConcurrentDictionary储存了IMediator, ICommand, IProxy三种接口实现的类，分别实现了IView, IController, IModel。这三个接口也只为这三个类服务，分别都实现了注册，删除，访问/执行的方法。其中View中还多储存了一种IObserver接口实现的类的列表所以IView接口中也多添加了对IObserver的注册，删除，通知。Command中还储存了View的引用。

View类中储存的数据

Command类中储存的数据

Model类中储存的数据

这里都是用ConcurrentDictionary使用string类型作为键值储存。但是这里要注意，IObserver接口列表的对应键值string类型和前三种使用的string在这个框架设计思想中有所不同。在上面的例子里面也看得出来，对对象的索引和注册对象的时候使用的字符串如例子中的“MainPage”和发送消息时“SetText”是不同的。实际上“MainPage”这个键值在执行了注册之后会被作为上图中字典“mediatorMap”, 和“proxyMap”的键值，分别对应一个Mediator类和Proxy类。是一对一关系。而“SetText”在注册Mediator到View数据中的时候，会被作为observerMap的键值，这是一个一对多的关系。一个string对应多个Observer类。Observer类是Mediator注册到View数据中时自动生成的类。Observer实际上就是使用的时观察者模式

View类中对Mediator注册源码

PureMVC最重要的思想就是在原有的MVC框架基础之上，分别把MVC三者和储存的数据之间加了一层新的数据结构。用新的数据结构来操作Model, View, Controller。然后使用事件来通知View模块更新。Proxy负责对数据的代理， Mediator则是使用中介者模式实现对视图组件的操作。

另外每次在我们使用SendNotification使用字符串作和数据类型作为参数发送消息的时候，PureMVC实际上使用了命令模式动态地生成了一个Notification对象，这个对象就只包含了当前传入地参数作为成员字段。然后调用View中地方对各个观察者发送消息。

基本以上就是PureMVC最主要地内容了，另外实现了ICommand接口地两个类SimpleCommand和MacroCommand分别是单个消息和多个消息的类型。

如果这篇教程对你有所帮助，请务必点个赞，谢谢。