C# - MVVM vo WPF: od code-behind k ViewModelu

MVVM (Model – View – ViewModel) je návrhový vzor, ktorý vo WPF oddeľuje vzhľad okna od logiky aplikácie. Namiesto obslúh udalostí v súbore MainWindow.xaml.cs, ktoré priamo čítajú a nastavujú ovládacie prvky, sa okno cez väzby (binding) napojí na obyčajnú triedu – ViewModel. Tú možno testovať bez okna a vzhľad možno meniť bez zásahu do logiky.

V článku postavíme malú aplikáciu so zoznamom úloh: najprv ručne, aby bolo vidieť, čo sa deje, a na konci to isté s knižnicou CommunityToolkit.Mvvm.

Tri časti vzoru

  • Model – dáta a pravidlá aplikácie (trieda Uloha, prístup k databáze…). O používateľskom rozhraní nič nevie.
  • View – okno alebo ovládací prvok v XAML. Obsahuje iba vzhľad a väzby.
  • ViewModel – stav a operácie obrazovky: vlastnosti, na ktoré sa View viaže, a príkazy, ktoré spúšťa. Nepozná žiadne ovládacie prvky.

Závislosti idú jedným smerom: View pozná ViewModel, ViewModel pozná Model. Nikdy naopak.

1. INotifyPropertyChanged – oznámenie o zmene

Aby sa okno prekreslilo, keď ViewModel zmení hodnotu, musí o tom dať vedieť udalosťou PropertyChanged. Spoločný kód patrí do základnej triedy:

using System.ComponentModel;
using System.Runtime.CompilerServices;

public abstract class ViewModelBase : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler? PropertyChanged;

    protected void OnPropertyChanged([CallerMemberName] string? nazov = null)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nazov));
    }

    protected bool SetProperty<T>(ref T pole, T hodnota, [CallerMemberName] string? nazov = null)
    {
        if (EqualityComparer<T>.Default.Equals(pole, hodnota))
            return false;

        pole = hodnota;
        OnPropertyChanged(nazov);
        return true;
    }
}

Atribút [CallerMemberName] doplní názov vlastnosti automaticky, takže ho netreba písať ako text.

2. RelayCommand – príkaz namiesto udalosti Click

Tlačidlo sa vo WPF dá naviazať na objekt s rozhraním ICommand. Univerzálna implementácia, ktorej stačí odovzdať metódu:

using System.Windows.Input;

public class RelayCommand : ICommand
{
    private readonly Action<object?> _vykonaj;
    private readonly Predicate<object?>? _mozeVykonat;

    public RelayCommand(Action<object?> vykonaj, Predicate<object?>? mozeVykonat = null)
    {
        _vykonaj = vykonaj ?? throw new ArgumentNullException(nameof(vykonaj));
        _mozeVykonat = mozeVykonat;
    }

    public event EventHandler? CanExecuteChanged
    {
        add    => CommandManager.RequerySuggested += value;
        remove => CommandManager.RequerySuggested -= value;
    }

    public bool CanExecute(object? parameter) => _mozeVykonat?.Invoke(parameter) ?? true;

    public void Execute(object? parameter) => _vykonaj(parameter);
}

Keď CanExecute vráti false, WPF tlačidlo samo zneprístupní. Vďaka CommandManager.RequerySuggested sa podmienka znovu vyhodnotí po každej akcii používateľa.

3. Model

public class Uloha
{
    public string Nazov { get; set; } = "";
    public bool Hotova { get; set; }
}

4. ViewModel

using System.Collections.ObjectModel;
using System.Windows.Input;

public class MainViewModel : ViewModelBase
{
    private string _novaUloha = "";
    private Uloha? _vybranaUloha;

    public MainViewModel()
    {
        PridajCommand = new RelayCommand(_ => Pridaj(), _ => !string.IsNullOrWhiteSpace(NovaUloha));
        ZmazCommand   = new RelayCommand(_ => Zmaz(),   _ => VybranaUloha is not null);

        Ulohy.Add(new Uloha { Nazov = "Prečítať článok o MVVM", Hotova = true });
        Ulohy.Add(new Uloha { Nazov = "Prepísať starý projekt" });
    }

    public ObservableCollection<Uloha> Ulohy { get; } = new();

    public string NovaUloha
    {
        get => _novaUloha;
        set => SetProperty(ref _novaUloha, value);
    }

    public Uloha? VybranaUloha
    {
        get => _vybranaUloha;
        set => SetProperty(ref _vybranaUloha, value);
    }

    public ICommand PridajCommand { get; }
    public ICommand ZmazCommand { get; }

    private void Pridaj()
    {
        Ulohy.Add(new Uloha { Nazov = NovaUloha.Trim() });
        NovaUloha = "";
    }

    private void Zmaz()
    {
        if (VybranaUloha is not null)
            Ulohy.Remove(VybranaUloha);
    }
}

Dôležitý je typ ObservableCollection<T>: na rozdiel od List<T> oznamuje pridanie a odobratie položky, takže sa zoznam v okne aktualizuje sám. Všimnite si tiež, že vo ViewModeli nie je ani jeden TextBox či ListBox.

5. View – XAML s väzbami

<Window x:Class="ZoznamUloh.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:local="clr-namespace:ZoznamUloh"
        Title="Úlohy" Height="350" Width="400">

    <Window.DataContext>
        <local:MainViewModel />
    </Window.DataContext>

    <DockPanel Margin="10">
        <DockPanel DockPanel.Dock="Top">
            <Button DockPanel.Dock="Right" Content="Pridať" Margin="5,0,0,0" Padding="10,2"
                    IsDefault="True"
                    Command="{Binding PridajCommand}" />
            <TextBox Text="{Binding NovaUloha, UpdateSourceTrigger=PropertyChanged}" />
        </DockPanel>

        <Button DockPanel.Dock="Bottom" Content="Zmazať vybranú"
                Command="{Binding ZmazCommand}" />

        <ListBox Margin="0,10"
                 ItemsSource="{Binding Ulohy}"
                 SelectedItem="{Binding VybranaUloha}">
            <ListBox.ItemTemplate>
                <DataTemplate>
                    <CheckBox Content="{Binding Nazov}" IsChecked="{Binding Hotova}" />
                </DataTemplate>
            </ListBox.ItemTemplate>
        </ListBox>
    </DockPanel>
</Window>

Čo tu robia väzby:

  • DataContext – objekt, voči ktorému sa vyhodnocujú všetky {Binding …} v okne.
  • UpdateSourceTrigger=PropertyChanged – text sa do ViewModelu zapisuje pri každom stlačení klávesu, nie až pri opustení poľa. Tlačidlo Pridať sa tak povolí hneď, ako začnete písať.
  • SelectedItem – výber v zozname sa prenáša do vlastnosti VybranaUloha, od ktorej závisí príkaz na zmazanie.

Súbor MainWindow.xaml.cs ostáva prázdny – obsahuje iba konštruktor s InitializeComponent().

To isté s CommunityToolkit.Mvvm

Triedy ViewModelBase a RelayCommand netreba písať v každom projekte znova. Balík CommunityToolkit.Mvvm od Microsoftu ich obsahuje a vlastnosti aj príkazy navyše generuje z atribútov:

using System.Collections.ObjectModel;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;

public partial class MainViewModel : ObservableObject
{
    [ObservableProperty]
    [NotifyCanExecuteChangedFor(nameof(PridajCommand))]
    private string novaUloha = "";

    [ObservableProperty]
    [NotifyCanExecuteChangedFor(nameof(ZmazCommand))]
    private Uloha? vybranaUloha;

    public ObservableCollection<Uloha> Ulohy { get; } = new();

    [RelayCommand(CanExecute = nameof(MozemPridat))]
    private void Pridaj()
    {
        Ulohy.Add(new Uloha { Nazov = NovaUloha.Trim() });
        NovaUloha = "";
    }

    private bool MozemPridat() => !string.IsNullOrWhiteSpace(NovaUloha);

    [RelayCommand(CanExecute = nameof(MozemZmazat))]
    private void Zmaz() => Ulohy.Remove(VybranaUloha!);

    private bool MozemZmazat() => VybranaUloha is not null;
}

Z poľa novaUloha vznikne vlastnosť NovaUloha, z metódy Pridaj príkaz PridajCommand. Trieda musí byť partial, aby k nej generátor mohol doplniť druhú časť. XAML sa nemení.

Časté chyby

  • Väzba nič nezobrazuje – preklep v názve vlastnosti kompilátor neodhalí. Chyby väzieb vypisuje Visual Studio počas ladenia do okna Output a XAML Binding Failures.
  • Viazať sa dá len na vlastnosti, nie na verejné polia.
  • Zoznam sa neaktualizuje – použitý List<T> namiesto ObservableCollection<T>.
  • Hodnota sa mení v kóde, ale okno ostáva rovnaké – vlastnosť nevyvoláva PropertyChanged. Týka sa to aj modelu: ak by sa Uloha.Hotova menila z kódu, aj trieda Uloha potrebuje INotifyPropertyChanged.
  • ViewModel otvára okná alebo MessageBox – tým sa stráca testovateľnosť. Dialógy schovajte za rozhranie (napr. IDialogService), ktoré ViewModel dostane v konštruktore.
O autorovi

Ing.Jaroslav Vadel

Som zakladateľom www.projectik.eu. Hrám sa na programátora, ktorý ovláda: c#,cpp,java,unity3d,php,html,NI testand,NI Vision Builder,Cognex In-Sight,NI LabView "Naprogramovať program, ktorý funguje vie každy. Ale to, že program funguje ešte neznamena, že je napísany správne "

Súvisiace články