百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

ObservableObject 基类详解

liuian 2025-03-05 17:59 10 浏览

引言

在现代应用程序开发中,MVVM(Model-View-ViewModel) 模式已成为构建可维护、可扩展和可测试应用程序的主流架构。微软的 CommunityToolkit.Mvvm(原名 Microsoft.Toolkit.Mvvm) 是一个轻量级且强大的库,旨在简化 MVVM 模式的实现。

在 MVVM 模式中,ObservableObject 基类是核心组件之一。它实现了 INotifyPropertyChanged 接口,用于通知视图属性的更改,从而更新 UI。本文将详细介绍 ObservableObject 基类的功能、用法,并通过 CMD(控制台应用程序)和 WinForms 下的示例,加深对其理解。


什么是 ObservableObject

ObservableObject 是一个抽象基类,位于
CommunityToolkit.Mvvm.ComponentModel 命名空间中。它实现了 INotifyPropertyChanged 接口,提供了属性更改通知的基础设施。

主要特性

  • 简化属性通知:通过内置的方法,减少手动编写重复的通知代码。
  • Source Generator 支持:利用 C# 的 Source Generator 特性,进一步减少样板代码。
  • 与 MVVM 模式完美结合:在 ViewModel 中继承 ObservableObject,即可轻松实现数据绑定。

如何使用 ObservableObject

安装 CommunityToolkit.Mvvm

在开始之前,确保已在项目中安装了 CommunityToolkit.Mvvm 包:

Install-Package CommunityToolkit.Mvvm

基本用法

继承 ObservableObject,并使用 SetProperty 方法设置属性值:

using CommunityToolkit.Mvvm.ComponentModel;

public class MyViewModel : ObservableObject
{
    private string _name;

    public string Name
    {
        get => _name;
        set => SetProperty(ref _name, value);
    }
}

当 Name 属性被更改时,SetProperty 方法将触发 PropertyChanged 事件,通知 UI 更新。

使用 [ObservableProperty] 属性

为简化代码,可以使用 CommunityToolkit.Mvvm 提供的 [ObservableProperty] 属性:

using CommunityToolkit.Mvvm.ComponentModel;

public partial class MyViewModel : ObservableObject
{
    [ObservableProperty]
    private string name;
}

编译时,Source Generator 会自动生成对应的属性和通知代码。


在 CMD 应用程序中的示例

即使在控制台应用程序中,ObservableObject 也能用于演示属性变化的通知机制。

示例:监控属性变化

using System;
using CommunityToolkit.Mvvm.ComponentModel;

public partial class Person : ObservableObject
{
    [ObservableProperty]
    private string name;
}

public class Program
{
    public static void Main()
    {
        var person = new Person();

        person.PropertyChanged += (sender, e) =>
        {
            Console.WriteLine($"属性 {e.PropertyName} 已更改");
        };

        Console.WriteLine("请输入姓名:");
        person.Name = Console.ReadLine();
    }
}

运行结果

当用户输入姓名时,设置 Name 属性并触发 PropertyChanged 事件。


在 WinForms 应用程序中的示例

在 WinForms 中,ObservableObject 可用于构建 ViewModel,实现数据与 UI 的双向绑定。

示例:数据绑定实现

  1. 创建 ViewModel
using CommunityToolkit.Mvvm.ComponentModel;

public partial class PersonViewModel : ObservableObject
{
    [ObservableProperty]
    private string name;
}
  1. 设计 WinForms 界面
  • 添加一个 TextBox 控件,命名为 txtName。
  • 添加一个 Label 控件,命名为 lblName。
  1. 绑定数据
public partial class MainForm : Form
{
    private PersonViewModel viewModel = new PersonViewModel();

    public MainForm()
    {
        InitializeComponent();

        // 绑定 TextBox 的 Text 属性到 ViewModel 的 Name 属性
        textBoxName.DataBindings.Add("Text", viewModel, "Name", false, DataSourceUpdateMode.OnPropertyChanged);

        // 绑定 Label 的 Text 属性到 ViewModel 的 Name 属性
        labelName.DataBindings.Add("Text", viewModel, "Name");
    }
}

效果

当用户在 textBoxName 中输入内容时,labelName 会实时显示当前输入的姓名。


深入了解 ObservableObject

SetProperty 方法

SetProperty 方法用于设置属性值并触发 PropertyChanged 事件。其签名为:

protected bool SetProperty(ref T field, T value, [CallerMemberName] string propertyName = null);
  • field:属性对应的私有字段。
  • value:要设置的值。
  • propertyName:属性名称,通常由编译器自动提供。

属性更改前后的操作

可以重载 OnPropertyChanging 和 OnPropertyChanged 方法,处理属性更改前后的逻辑:

protected override void OnPropertyChanging(PropertyChangingEventArgs e)
{
    // 属性更改前的逻辑
    base.OnPropertyChanging(e);
}

protected override void OnPropertyChanged(PropertyChangedEventArgs e)
{
    // 属性更改后的逻辑
    base.OnPropertyChanged(e);
}

使用属性通知的注意事项

  • 线程安全:默认情况下,ObservableObject 的属性通知不是线程安全的。如果需要跨线程更新 UI,需要使用 Dispatcher 或 SynchronizationContext。
  • 性能考虑:过度使用属性通知可能影响性能,尤其是在大量数据绑定的情况下。

结论

ObservableObject 基类是 CommunityToolkit.Mvvm 提供的强大工具,简化了属性通知的实现,减少了样板代码。在 CMD 和 WinForms 应用程序中,都可以利用其特性,提高开发效率和代码可维护性。

通过本文的介绍,相信你已经对 ObservableObject 有了深入的了解,能够在实际项目中灵活运用。

相关推荐

使用Assembly打包和部署Spring Boot工程

SpringBoot项目的2种部署方式目前来说,SpringBoot项目有如下2种常见的部署方式一种是使用docker容器去部署。将SpringBoot的应用构建成一个docke...

java高级用法之:调用本地方法的利器JNA

简介JAVA是可以调用本地方法的,官方提供的调用方式叫做JNI,全称叫做javanativeinterface。要想使用JNI,我们需要在JAVA代码中定义native方法,然后通过javah命令...

Linux中如何通过Shell脚本来控制Spring Boot的Jar包启停服务?

SpringBoot项目在为开发者带来方便的同时,也带来了一个新的问题就是Jar包如何启动?在一般情况下我们都是采用了最为经典的java-jar命令来进行启动。然后通过ps命令找到对应的应用线程通...

牛逼!自己手写一个热加载(人民币手写符号一个横还是两个横)

热加载:在不停止程序运行的情况下,对类(对象)的动态替换JavaClassLoader简述Java中的类从被加载到内存中到卸载出内存为止,一共经历了七个阶段:加载、验证、准备、解析、初始化、使用、...

java 错误: 找不到或无法加载主类?看看怎么解决吧!

问题扫述:项目名称调整,由原来的com.mp.qms.report.biz调整为com.mp.busicen.mec.qms.report.biz后。项目在IDEA直接运行,但打包部署到服务器...

如何将 Spring Boot 工程打包成独立的可执行 JAR 包

导语:通过将SpringBoot项目打包成独立的可执行JAR包,可以方便地在任何支持Java环境的机器上运行项目。本文将详细介绍如何通过Maven构建插件将SpringBoot...

class 增量发包改造为 jar 包方式发布

大纲class增量发包介绍项目目录结构介绍jar包方式发布落地方案class增量发包介绍当前项目的迭代修复都是通过class增量包来发版本的将改动的代码class增量打包,如下图cla...

Jar启动和IDE里启动Sprintboot的区别

想聊明白这个问题,需要补充一些前提条件,比如Fatjar、类加载机制等1、Fatjar我们在开发业务程序的时候,经常需要引用第三方的jar包,最终程序开发完成之后,通过打包程序,会把自己的代码和三...

Java 20年,以后将往哪儿走?(java还能流行多久)

在今年的Java20周年的庆祝大会中,JavaOne2015的中心议题是“Java的20年”。甲骨文公司Java平台软件开发部的副总裁GeorgesSaab的主题演讲就将关注点放在了java...

Spring Boot Jar 包秒变 Docker 镜像实现多环境部署

你是否在互联网大厂后端开发工作中,遇到过这样的困扰?当完成一个SpringBoot项目开发,准备将Jar包部署到不同环境时,却发现各个环境依赖不同、配置复杂,部署过程繁琐又容易出错,不仅耗费...

从0开始,让你的Spring Boot项目跑在Linux服务器

1搭建Linux服务器1.1购买阿里云服务器或安装虚拟机这里建议是CentOS7.X或CentOS8.X,当然其他的Linux如deepin、Ubuntu也可以,只是软件环境的安装包和安装方式...

【技术】Maven 上传第三方jar包到私服

通过nexus后台上传私服以NexusRepositoryManagerOSS2.14.5-02为例。登录nexus后台。定义Maven坐标Maven坐标有两种方式:1.自定义参数;2....

JVM参数、main方法的args参数使用

一、前言我们知道JVM参数分为自定义参数、JVM系统参数,Javamain方法的参数。今天就谈谈怎么使用吧。二、查看jvm参数定义自定义参数我们打开cmd窗口,输入java,就能看到自定义参数的格式...

Maven项目如何发布jar包到Nexus私服

Maven项目发布jar包到Nexus私服在编码过程中,有些通用的代码模块,有时候我们不想通过复制粘贴来粗暴地复用。因为这样不仅体现不了变化,也不利于统一管理。这里我们使用mavendeploy的方...

干货丨Hadoop安装步骤!详解各目录内容及作用

Hadoop是Apache基金会面向全球开源的产品之一,任何用户都可以从ApacheHadoop官网下载使用。今天,播妞将以编写时较为稳定的Hadoop2.7.4版本为例,详细讲解Hadoop的安...