中继指令 RelayCommand

Warning

虽然原生的 ICommand 接口以及 WPF 框架本身并没有对于中继指令的传参有任何要求，但是工具包要求我们必须提供默认值（default）为 null 的参数，否则按钮将会强制处于禁用状态！

如果希望传参是一个整数，那么一定要写成 int?（等价于 Nullable<int>），表示一个可为空的整数。

工具包为我们提供了一个 RelayCommand 类，用于快捷地实现中继指令。它最朴素的用法是：

public class ViewModel : ObservableObject
{
    public IRelayCommand MyCommand1 { get; } // (1)!
    public IRelayCommand MyCommand2 { get; }

    public ViewModel()
    {
        MyCommand1 = new RelayCommand(Execute, CanExecute); // (2)!
        MyCommand2 = new (() => {
            DoJob();
            Debug.WriteLine();
        }); // (3)!
    }

    private void Execute()
    {
        DoJob();
    }

    private bool CanExecute()
    {
        return true;
    }

    private void DoJob() { }
}

通常我们会将类型声明为 IRelayCommand，而不是 RelayCommand，从而让使用者只关注接口暴露的方法，而不关心其实现；并且通常我们会在 VM 的构造函数中初始化这些属性，所以只提供 getter 即可
RelayCommand 的构造函数可以接受两个参数：Execute 和 CanExecute，分别表示执行和判断是否可执行的方法
RelayCommand 的构造函数也支持只传入一个参数，表示执行的回调方法，且不提供 CanExecute 的逻辑。而且这里除了直接传入符合委托类型的方法，还可以使用一个 Lambda 表达式简单地进行实现。

类似地，RelayCommand<T> 方法传入的是包含一个 T 类型入参的 Execute 与 CanExecute 方法。这里不再赘述。

借助源生成器来快速实现

但是在实际使用工具包进行开发时，我们基本不会采用上述朴素的方式进行实现，而是会借助源生成器。方式如下：

public partial class ViewModel : ObservableObject
{
    [ObservableProperty]
    [NotifyCanExecuteChangedFor(nameof(SubmitCommand))]
    private string name;

    private bool CanSubmit() => !string.IsNullOrEmpty(name);

    [RelayCommand(CanExecute = nameof(CanSubmit))]
    private void Submit()
    {
        Debug.WriteLine($"Name: {name}");
    }
}

Tip

如果 CanExecute 与一个 bool 类型的属性的值有关，那么特性中的 CanExecute 参数可以直接写为 CanExecute = nameof(IsActive)，而不需要另写一个方法去返回属性的值。

后台生成的代码形如

partial class MainViewModel
{
    private RelayCommand? submitCommand;
    public IRelayCommand SubmitCommand
        => submitCommand ??= new RelayCommand(new Action(Submit), CanSubmit);
}

的属性。不难看出，这个属性的名称就是方法名后面加上 Command。

Info

借助源生成器为方法后台生成的代码同样可以在项目的 依赖项|分析器|CommunityToolkit.Mvvm.SourceGenerators 中看到。可以参考相关章节的介绍。

CanExecute 的实现

关于一个 RelayCommand 的 CanExecute 相关的逻辑，一般有如下几种实现方式：

不使用 RelayCommand 的这一功能，而是额外写一个具有通知功能的 bool 类型的属性，并绑定到 IsEnabled 属性上
声明一个 bool 类型的属性，并在 RelayCommand 特性中添加 CanExecute = nameof(PropertyName)
声明一个返回值为 bool 的无参方法，然后用 CanExecute = nameof(MethodName) 来添加
声明一个参数与 RelayCommand 对应方法相同的返回 bool 的方法，然后用上述方式添加

但实际上，为了最大化 CanExecute 与控件状态的同步，通常只使用上述方法是不够的。我们可能还需要主动调用 RelayCommand 的 NotifyCanExecuteChanged 方法，或为用于生成通知属性的字段添加 NotifyCanExecuteChangedFor 特性。

下面这个例子展示了常见的几种实现方式：

partial class ViewModel : ObservableObject
{
    // 方法一：绑定 IsEnabled 属性

    [ObservableProperty]
    private bool _isEnabled = true;  // 绑定到控件的 IsEnabled 属性

    [RelayCommand]
    private void Foo1() { }

    // 方法二：绑定到属性

    [ObservableProperty]
    [NotifyCanExecuteChangedFor(nameof(Foo2Command))]
    private string? _userName;

    private bool CanFoo2 => !string.IsNullOrEmpty(UserName);
    // public bool CanFoo2 { get { return !string.IsNullOrEmpty(UserName); } }

    [RelayCommand(CanExecute = nameof(CanFoo2))]
    private void Foo2() { }

    // 方法三：绑定到无参方法

    private bool CanFoo3() => !string.IsNullOrEmpty(UserName);
    // public bool CanFoo3() { return !string.IsNullOrEmpty(UserName); }

    [RelayCommand(CanExecute = nameof(CanFoo3))]
    private void Foo3() { }

    // 方法四：绑定到有参方法

    // 将 Button 的 Command 绑定到 Foo4Command，CommandParameter 绑定到 UserName
    private bool CanFoo4(string? userName) => !string.IsNullOrEmpty(userName);

    [RelayCommand(CanExecute = nameof(CanFoo4))]
    private void Foo4(string? userName) { }
}

在上面的第四种方法中，如果是通过 CommandParameter 绑定具有通知功能的属性（包括 VM 中的属性，以及其他控件的依赖属性，如 TextBox.Text 等），那么当该值发生改变时，按钮的可用状态也将得到更新；否则，按钮的可用状态将无法得到更新，但是在执行 RelayCommand 前，仍旧会调用 CanExecute 方法来判断是否可用。

中继指令 RelayCommand

借助源生成器来快速实现

CanExecute 的实现

评论