Skip to content

ViewModel

阿晴最好看! edited this page May 25, 2025 · 7 revisions

假设我们有一个UserInfoViewModel作为UserControl的DataContext

Ⅰ 轻松实现MVVM模式

  • INotifyPropertyChanged 自动实现
  • Property 自动实现
  • Property CallBack 自动实现
    // 1. 必须将ViewModel类标记为partial类
    public partial class UserInfoViewModel
    {
        // 2. 必须至少包含一个声明了[Observable]特性的字段,且字段应以下划线/小写字母开头

        [Observable]
        private string name = string.Empty;
        [Observable]
        private string id = string.Empty;
        [Observable]
        private string date = string.Empty;

        // 3. 请删除默认构造器,仅在需要时以下述方式定义 :

        [Constructor]
        private void InitializeData()
        {
            Name = "Axvser";
            Id = "10000678";
            Date = DateTime.Now.ToShortDateString();
        }

        // 4. 使用回调方法,打出partial关键字并Tab可以快速生成

        partial void OnDateChanging(string oldValue, string newValue)
        {
            throw new NotImplementedException();
        }
        partial void OnDateChanged(string oldValue, string newValue)
        {
            throw new NotImplementedException();
        }
    }

Ⅱ 轻松实现ViewModel全局通信

  • 现在,UserInfo包括了Name、Id、Date数据,而我们希望有一种全局的、统一的方式来通知UserInfo做出数据更新
    • 例如,更新当前所有UserInfo的Date属性为当前时间
    • 例如,更新指定Id值的UserInfo的Name属性
    • 例如,更新指定Id值的UserInfo的Date属性
    [SubscribeMessageFlows([MessageFlows.UpdateDate, MessageFlows.UpdateName])]
    // 此特性意味着在类实例化时,已订阅了指定名称的消息流,而不需要手动订阅
    public partial class UserInfoViewModel
    {
        public static class MessageFlows
        {
            /// <summary>
            /// 消息流 - 更新日期上下文
            /// </summary>
            public const string UpdateDate = nameof(UserInfoViewModel) + nameof(UpdateDate);

            /// <summary>
            /// 消息流 - 更新名称上下文
            /// </summary>
            public const string UpdateName = nameof(UserInfoViewModel) + nameof(UpdateName);
        }

        // 你可从全局任何地方通知UserInfoViewModel实例更新日期
        private partial void FlowUserInfoViewModelUpdateDate(object sender, MessageFlowArgs e)
        {
            if (e.Messages.Length > 1 && e.Messages[0]?.ToString() is "02801")
            // 验证消息流是否可执行,通常将令牌置于Messages首位,此处令牌是 "02801"
            {
                switch (e.Messages.Length)
                {
                    case 2:
                        // 无条件更新日期
                        Date = e.Messages[1] as string ?? Date;
                        break;
                    case 3:
                        if (e.Messages[1] is string id && id == Id)
                        // 仅更新指定ID的日期
                        {
                            Date = e.Messages[2] as string ?? Date;
                            e.Handled = true; // 处理完毕
                        }
                        break;
                }

            }
        }

        // 你可从全局任何地方通知UserInfoViewModel实例更新名称
        private partial void FlowUserInfoViewModelUpdateName(object sender, MessageFlowArgs e)
        {
            if (e.Messages.Length > 2 && e.Messages[0]?.ToString() is "05392")
            {
                if (e.Messages[1] is string id && id == Id)
                {
                    Name = e.Messages[2] as string ?? Name;
                    e.Handled = true;
                }
            }
        }
    }
  • 完成上述代码后,我们在其它地方可以像这样发送消息,SendMessage的参数含义如下
    • 参数1. 事件发送者,是一个对象,此处为 this
    • 参数2. 消息名, 是一个字符串,我们在上面的 UserInfoViewModel 内部已将其模块化成 MessageFlows ,便于在任何地方获取消息名 ,需要注意的是 ,消息名全局必须唯一
    • 参数3. 消息内容,是一个对象数组,可以自由传入参数,例如,我偏好于将Token验证作为首个元素
        public void GlobalUpdateDate(object token)
        {
            // 通知所有UserInfoViewModel将日期更新为当前日期
            MessageCentral.SendMessage(
                this,
                UserInfoViewModel.MessageFlows.UpdateDate,
                [token, DateTime.Now.ToShortDateString()]);
        }

        public void UpdateDate(object token, string id)
        {
            // 仅更新指定ID的UserInfoViewModel的日期
            MessageCentral.SendMessage(
                this,
                UserInfoViewModel.MessageFlows.UpdateDate,
                [token, id, DateTime.Now.ToShortDateString()]);
        }

        public void UpdateName(object token, string id, string name)
        {
            // 仅更新指定ID的UserInfoViewModel的名称
            MessageCentral.SendMessage(
                this,
                UserInfoViewModel.MessageFlows.UpdateName,
                [token, id, name]);
        }
  • 这种方式实现的全局ViewModel通信具备一些值得注意的特点
    • 源生成器为你实现了IMessageFlow,于是,发生消息流时,不需要进行类型转换,它们已经以接口形式存在于MessageCentral的缓存中
    • 即便缓存使用WeakReference,回收也仅发生在指定名称的消息流产生后、消息流开始传播前,所以,假设A类订阅了消息流B,而消息流B不会被触发,就会导致无效 WeakReference 占用内存,这是一种坏的实践,不要在永远不使用一个消息流的情况下订阅它

Clone this wiki locally