Brush类型的绑定属性在异步调用时抛出异常

Question

我正在将一个可观察的集合绑定到一个数据网格。通过异步调用从服务器获取的集合。集合模型包含一个名为“System.Windows.Media.Brush”类型的“BackgroundBrush”属性，该属性绑定到数据网格中模板列的背景颜色。 Brush 属性可以是 SolidColorBrush 或 LinearGradientBrush，具体取决于应用于该属性的业务逻辑。

在向数据网格呈现数据时，应用程序会抛出类似“必须在与 DependencyObject 相同的线程上创建 DependencySource”这样的异常。

调试问题时注意的事项

1. 问题在于“背景”属性。注释掉这个属性绑定并使异步调用工作正常。

2. 使服务调用同步可以正常工作，但我需要它作为异步调用。

3. 在 Application.Current.Dispatcher.Invoke 中进行服务调用没有任何区别

以下是示例应用程序代码

型号

public class Model
{
    public string Name { get; set; }

    public string Email { get; set; }

    public string Address { get; set; }

    public Brush BackgroundBrush { get; set; }
}

查看模型

private ObservableCollection<Model> _dataCollection;

public ObservableCollection<Model> DataCollection
{
    get { return _dataCollection; }
    set
    {
        _dataCollection = value;
        RaisePropertyChanged(() => DataCollection);
    }
}

public RelayCommand LoadCommand { get; private set; }

private async Task LoadData()
{
    var list = await Task.Run(() => GetData());
    DataCollection = new ObservableCollection<Model>(list);

}

private ObservableCollection<Model> GetData()
{
    return new ObservableCollection<Model>()
    {
        new Model()
        {
            Address = "a",
            Email = "2",
            Name = "3",
            BackgroundBrush = new SolidColorBrush(Colors.SaddleBrown)
        }
    };
}

查看

<Grid x:Name="LayoutGrid">
    <DataGrid ItemsSource="{Binding DataCollection}" AutoGenerateColumns="False">
        <DataGrid.Columns>
            <DataGridTemplateColumn>
                <DataGridTemplateColumn.CellTemplate>
                    <DataTemplate>
                    <Border Background="{Binding BackgroundBrush}">
                        <TextBlock Text="{Binding Name}"></TextBlock>
                        </Border>
                    </DataTemplate>
                </DataGridTemplateColumn.CellTemplate>
            </DataGridTemplateColumn>
        </DataGrid.Columns>
    </DataGrid>
</Grid>

Answer 1

这是因为 await Task.Run 内部的所有内容都在不同的线程上运行。因此您无法更改其中的绑定源DataCollection。由于ObservableCollection 触发事件以更新绑定目标，因此它不允许来自不同线程的更改。

所以你的GetData 函数应该返回一个正常的集合：

private IEnumerable<Model> GetData()
{
    return new List<Model>()
    {
         new Model(){...}
    };
}

另一个问题是Brush。你的模型（线程安全）应该使用Color，你的viewModel（可绑定）应该使用Brush。因此，您应该在模型中添加一个 Color 属性，该属性可以在 GetData 的异步调用中设置。像这样的：

private Color _color;
public Color Color 
{ 
    get{ return _color; } 
    set
    { 
        _color = value; 
        Dispatcher.Invoke(()=>Brush = new SolidColorBrush(Color)); 
    } 
}
public Brush Brush { get; set; }

或者您不绑定到模型并遵循标准 MVVM 模式。

对于涉及依赖属性或您需要从调度程序调用的任何绑定源的部分。例如

Dispatcher.Invoke(() => aThreadSafeFunction());

但是在这种情况下，您可以先阅读整个列表，然后将其转换为 ObservableCollection：

private async Task LoadData()
{
    //load thread-safe data asynchronously
    var list = await Task.Run(() => GetData());
    //set binding source in the same thread
    DataCollection = new ObservableCollection<Model>(list);
}

Answer 2

System.Media.Brush 是一个DependencyObject，因此需要在Dispatcher 线程上创建。

ObservableCollection 通过INotifyCollectionChanged 使用UI 通知来启用它的Observer 模式实现，这意味着它还需要在Dispatcher 线程上构建。如果不编写自定义实现以在正确的线程上引发通知，则无法从另一个线程（即异步）加载 ObservableCollection 的内容。

编辑：

为了解决您的问题 - 在构造函数中创建 ObservableCollection 并且永远不要覆盖来自其他线程的属性引用。

写LoadData()和GetData()如下：

    private async Task LoadData()
    {
        var list = await Task.Run(() => GetData());
        list.ForEach(item => Dispatcher.Invoke(() => 
        {
           DataCollection.Add(item);
        }));

    }

    private List<Model> GetData()
    {
        var modelObject =
            new Model()
            {
                Address = "a",
                Email = "2",
                Name = "3",
            };
        Dispatcher.Invoke(() => 
        { 
            modelObject.BackgroundBrush = new SolidColorBrush(Colors.SaddleBrown);
        });

       return new List<Model>(){ modelObject };
    }