C#中的ObservableCollection及其数据绑定中的作用（含示例下载）

ObservableCollection<T>是C#中的一个集合类，它表示一个动态数据集合，位于System.Collections.ObjectModel命名空间中。以下是关于ObservableCollection<T>的详细解释以及它在数据绑定中的作用：

ObservableCollection的定义与特性

• ObservableCollection<T>继承自INotifyCollectionChanged和INotifyPropertyChanged接口。
• 当集合中的项被添加、删除或更改时，ObservableCollection<T>会自动发出通知。
• 这种特性特别适用于数据绑定场景，能够确保UI元素能够及时反映集合中的变化。

在数据绑定中的作用

• 自动通知UI更新：

  • 在WPF（Windows Presentation Foundation）和其他基于XAML的框架中，ObservableCollection<T>是数据绑定的理想选择。
  • 当集合中的数据发生变化时，如添加、删除或替换项，ObservableCollection<T>会自动通知绑定的UI元素进行相应的更新。
  • 这意味着开发者不需要手动刷新UI，从而简化了数据绑定的实现。

• 支持双向数据绑定：

  • ObservableCollection<T>不仅支持从集合到UI的单向数据绑定，还支持双向数据绑定。
  • 这意味着UI中的变化也可以反映回集合中，实现了数据的双向同步。

• 提高代码的可读性和维护性：

  • 使用ObservableCollection<T>可以减少代码量，因为开发者不需要编写额外的代码来手动通知UI更新。
  • 这使得代码更加简洁、易读且易于维护。

使用示例

以下是一个在WPF中使用ObservableCollection的示例：
假设我们有一个简单的用户管理界面，其中包含一个DataGrid用于显示用户列表，以及几个按钮用于添加、编辑和删除用户。

步骤

1. 定义数据模型

首先，我们需要定义一个用户类，这个类将实现INotifyPropertyChanged接口，以便在用户属性更改时能够通知UI。

public class User : INotifyPropertyChanged
{
    private string _name;
    private int _age;

    public string Name
    {
        get { return _name; }
        set
        {
            _name = value;
            OnPropertyChanged(nameof(Name));
        }
    }

    public int Age
    {
        get { return _age; }
        set
        {
            _age = value;
            OnPropertyChanged(nameof(Age));
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

    protected void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

2. 定义ViewModel

接下来，我们定义一个ViewModel类，它包含一个ObservableCollection<User>类型的属性，用于存储用户数据。

  public class UserViewModel
  {
      public ObservableCollection<User> Users { get; set; }

      public UserViewModel()
      {
          Users = new ObservableCollection<User>
      {
          new User { Name = "Alice", Age = 30 },
          new User { Name = "Bob", Age = 25 }
      };
      }
      public void AddUser(string name, int age)
      {
          Users.Add(new User { Name = name, Age = age });
      }

      public void EditUser(int index, string newName, int newAge)
      {
          if (index >= 0 && index < Users.Count)
          {
              Users[index].Name = newName;
              Users[index].Age = newAge;
          }
      }

      public void DeleteUser(int index)
      {
          if (index >= 0 && index < Users.Count)
          {
              Users.RemoveAt(index);
          }
      }
  }

3. 设置XAML界面

在XAML文件中，我们定义一个DataGrid来显示用户数据，并将其ItemsSource属性绑定到ViewModel中的Users集合。

<Window x:Class="TestWpfApp1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="655" Width="751">
    <Grid Margin="0,0,0,27">
        <DataGrid Name="dgUsers" AutoGenerateColumns="False" ItemsSource="{Binding Users}" Margin="10,10,10,150">
            <DataGrid.Columns>
                <DataGridTextColumn Header="Name" Binding="{Binding Name}" />
                <DataGridTextColumn Header="Age" Binding="{Binding Age}" />
            </DataGrid.Columns>
        </DataGrid>

        <StackPanel Orientation="Vertical" HorizontalAlignment="Center" VerticalAlignment="Bottom">
            <TextBox Name="txtNewName" Width="200" Margin="0,0,0,10" Text="Name"/>
            <TextBox Name="txtNewAge" Width="200" Margin="0,0,0,10" Text="Age"/>
            <Button Content="Add User" Width="200" Margin="0,0,0,10" Click="AddUserButton_Click"/>
            <Button Content="Delete Selected User" Width="200" Click="DeleteUserButton_Click"/>
        </StackPanel>
    </Grid>
</Window>

4. 在代码中设置DataContext

最后，在MainWindow的代码隐藏文件（.xaml.cs）中，我们将ViewModel设置为DataContext。

    public partial class MainWindow : Window
    {
        private UserViewModel _viewModel;
        public MainWindow()
        {
            InitializeComponent();
            //this.DataContext = new UserViewModel();
            _viewModel = new UserViewModel();
            this.DataContext = _viewModel;
        }
        private void AddUserButton_Click(object sender, RoutedEventArgs e)
        {
            string newName = txtNewName.Text;
            int newAge;
            if (int.TryParse(txtNewAge.Text, out newAge))
            {
                _viewModel.AddUser(newName, newAge);
                txtNewName.Clear();
                txtNewAge.Clear();
            }
            else
            {
                MessageBox.Show("输入合理年龄");
            }
        }


        private void DeleteUserButton_Click(object sender, RoutedEventArgs e)
        {
            var selectedItem = dgUsers.SelectedItem as User;
            if (selectedItem != null)
            {
                int index = _viewModel.Users.IndexOf(selectedItem);
                _viewModel.DeleteUser(index);
            }
            else
            {
                MessageBox.Show("请选择……");
            }
        }
    }

运行结果

当运行这个WPF应用程序时，DataGrid将显示UserViewModel中Users集合的用户数据。如果我们在ViewModel中添加、删除或编辑用户，DataGrid将自动更新以反映这些更改。

注意事项

• 确保ObservableCollection<T>中的项（在本例中是User对象）也实现了INotifyPropertyChanged接口，以便在项的属性更改时能够通知UI。
• 在XAML中绑定集合时，确保ItemsSource属性正确指向了ViewModel中的集合属性。

示例下载