起因:今天在学习MVVMLigth的时候碰到一个自己不懂的知识点就是这个这个代码

1
2
3
4
5
6
7
8
9
10
11
12
   public class PreparationViewModel : ViewModelBase
{
private string _environmentStatus = "等待检查";

public string EnvironmentStatus
{
get { return _environmentStatus; }
private set {
Set(ref _environmentStatus, value, nameof(EnvironmentStatus));
}
}
}

中的 set为什么要这样子写

1
2
3
private set {
Set(ref _environmentStatus, value, nameof(EnvironmentStatus));
}

我还挺疑惑的

还有这个如图 ,这个是属性变化通知的 ,因为这个是ObservableObject类型的

image


通过查阅发现 ,这段代码的核心目的只有一句话:

把“真正存值的字段”藏起来,只允许 ViewModel 自己修改;一旦修改,就通过 Set(...) 通知界面刷新。

先记住这个分工:

代码 作用
_environmentStatus 真正存字符串的字段
EnvironmentStatus 给界面绑定的公开属性
get 界面读取属性时执行
private set 只允许PreparationViewModel内部修改
Set(...) 比较新旧值、赋值、发出属性变化通知
ref 让Set能直接修改_environmentStatus字段
nameof(EnvironmentStatus) 告诉界面“变化的是 EnvironmentStatus 这个属性”

1. 为什么不直接写自动属性

你可能会想,为什么不写成这样:

1
public string EnvironmentStatus { get; set; }

这样写确实简单,但是有一个致命问题:

界面不知道这个属性变了。

WPF 的数据绑定不是一直盯着属性看。它第一次读取 EnvironmentStatus 后,就会等属性发出“我变了”的通知。没有通知,界面就继续显示旧值。

所以这里不能使用普通自动属性,必须自己写 setter,在 setter 里发出通知。

2. private set 是什么意思

1
2
3
4
5
6
7
8
public string EnvironmentStatus
{
get { return _environmentStatus; }
private set
{
Set(ref _environmentStatus, value, nameof(EnvironmentStatus));
}
}

这里的 public 修饰的是整个属性,所以外部可以读:

1
var text = viewModel.EnvironmentStatus;

但是 set 前面加了 private,意思是:只能通过内部去进行一个修改了

1
viewModel.EnvironmentStatus = "新值";  // 外部不能这样写

只有 PreparationViewModel 自己内部可以写:

1
2
3
4
private void CheckEnvironment()
{
EnvironmentStatus = "环境检查完成";
}

这样设计的原因是:

  • 界面只负责显示状态。
  • 状态应该由 ViewModel 根据业务逻辑修改。
  • 不让 View 随随便便改 ViewModel 的数据。

这不是语法上的“必须”,而是一种责任划分。你这个属性目前只用于显示,所以 private set 很合适。

3. Set(...) 到底做了什么

Set 是 ViewModelBase 提供的辅助方法。你可以把它理解成下面这段代码的简写:

1
2
3
4
5
6
7
8
9
10
11
12
13
private set
{
if (_environmentStatus == value) // 旧的值和新的值是否相同 ,不相同就更新
{
return;
}

_environmentStatus = value;

PropertyChanged?.Invoke(
this,
new PropertyChangedEventArgs(nameof(EnvironmentStatus)));
}

它做了三件事:

  1. 比较旧值和新值是否相同。
  2. 如果不同,把新值保存到 _environmentStatus。
  3. 发出 PropertyChanged 通知,告诉界面重新读取属性。

所以:

1
Set(ref _environmentStatus, value, nameof(EnvironmentStatus));

可以理解成:这样子理解的话就会感到非常透彻了

1
2
3
请把 value 存进 _environmentStatus,
如果值真的变了,
就通知界面 EnvironmentStatus 这个属性变了。

4. 为什么参数里要写 ref

Set 要修改的是字段本身,所以必须把字段“按引用”传进去:

1
Set(ref _environmentStatus, value, nameof(EnvironmentStatus));

如果没有 ref,Set 拿到的只是字段值的一个副本。它改了副本,外面的 _environmentStatus 还是旧值。因为是修改自身所以需要使用ref

可以把它想成:

  • 不加 ref:把一张写着值的纸交给别人,别人改纸,你的原字段没变。
  • 加 ref:把存放字段的抽屉钥匙交给别人,别人可以直接改抽屉里的值。

5. 为什么写 nameof(EnvironmentStatus)

界面需要知道“到底是哪一个属性变了”。这里传的是属性名:

1
nameof(EnvironmentStatus)

它等价于字符串:

1
"EnvironmentStatus"

但是 nameof 更好,因为:

  • 属性改名时,编译器会帮你一起改。
  • 不会因为手写字符串拼错,导致界面不刷新。
  • 比直接写 "EnvironmentStatus" 更安全。

如果这里写成:

1
Set(ref _environmentStatus, value, "EnvironmentStauts");  // 拼错了

字段其实已经改了,但界面收到的通知是另一个不存在的属性名,所以界面可能还是不刷新。

6. 运行时完整流程

假设界面绑定了:

1
<TextBlock Text="{Binding EnvironmentStatus}" />

点击按钮后,ViewModel 执行:

1
EnvironmentStatus = "环境检查完成";

整个过程是:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
界面第一次读取 get
↓
显示“等待检查”
↓
命令调用 CheckEnvironment
↓
EnvironmentStatus = "环境检查完成"
↓
进入 private set
↓
Set 比较新旧值
↓
更新 _environmentStatus
↓
发出 PropertyChanged 通知
↓
WPF 重新读取 get
↓
界面显示“环境检查完成”

7. 你可以这样记

以后写这种 “会变化并且要显示到界面” 的属性,可以套这个固定思路:

1
2
3
4
5
6
7
8
9
10
private string _字段;

public string 属性名
{
get { return _字段; }
private set
{
Set(ref _字段, value, nameof(属性名));
}
}

先问自己三个问题:

  1. 这个值会不会变化?
  2. 变化后界面要不要刷新?
  3. 这个值应该由谁修改?

如果“会变化、要刷新、只由 ViewModel 修改”,那这个写法就是合适的。

所以这段代码不是故意写得复杂,而是在同时解决三件事:保存值、限制修改权限、通知界面刷新。