ReactiveUI.SourceGenerators 1.0.3

ReactiveUI.SourceGenerators

使用源生成器生成ReactiveUI对象。

目前不接受公开贡献

这些源生成器被设计为与ReactiveUI V19.5.31及其更高版本完全兼容，当前支持所有功能：

• [Reactive]
• [ObservableAsProperty]
• [ReactiveCommand]

V19.5.31之前的版本

• [Reactive] 完全支持，
• [ObservableAsProperty] 完全支持，
• [ReactiveCommand] 除Cancellation Token异步方法外所有支持。

历史方法

读写属性

通常属性声明如下

private string _name;
public string Name 
{
    get => _name;
    set => this.RaiseAndSetIfChanged(ref _name, value);
}

在这些源生成器可用之前，我们使用了ReactiveUI.Fody。对于ReactiveUI.Fody，[Reactive] 属性被放置在具有自动 get/set 属性的公共属性上，源生成器生成的代码和Fody注入的代码在属性之外非常相似。

[Reactive]
public string Name { get; set; }

ObservableAsPropertyHelper属性

同样，为了声明输出属性，代码看起来如下

public partial class MyReactiveClass : ReactiveObject
{
    ObservableAsPropertyHelper<string> _firstName;

    public MyReactiveClass()
    {
        _firstName = firstNameObservable
            .ToProperty(this, x => x.FirstName);
    }

    public string FirstName => _firstName.Value;

    private IObservable<string> firstNameObservable() => Observable.Return("Test");
}

使用ReactiveUI.Fody，你只需使用[ObservableAsProperty]属性简单地声明只读属性，下面展示了两种选项之一。

[ObservableAsProperty]
public string FirstName { get; }

欢迎使用新的方式 - 源生成器

使用响应式属性 [Reactive]

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass : ReactiveObject
{
    [Reactive]
    private string _myProperty;
}

使用 ObservableAsPropertyHelper [ObservableAsProperty]

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass : ReactiveObject
{
    [ObservableAsProperty]
    private string _myProperty;
}

使用 ReactiveCommand [ReactiveCommand]

使用不带参数的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private void Execute() { }
}

使用带参数的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private void Execute(string parameter) { }
}

使用带参数和返回值的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private string Execute(string parameter) => parameter;
}

使用带参数和异步返回值的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private async Task<string> Execute(string parameter) => await Task.FromResult(parameter);
}

使用 IObservable 返回值的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private IObservable<string> Execute(string parameter) => Observable.Return(parameter);
}

使用 CancellationToken 的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private async Task Execute(CancellationToken token) => await Task.Delay(1000, token);
}

使用 CancellationToken 和参数的 ReactiveCommand

using ReactiveUI.SourceGenerators;

public partial class MyReactiveClass
{
    public MyReactiveClass()
    {
        InitializeCommands();
    }

    [ReactiveCommand]
    private async Task<string> Execute(string parameter, CancellationToken token)
    {
        await Task.Delay(1000, token);
        return parameter;
    }
}