[CallerMemberName] w C
Co to jest - atrybut wstrzykiwany przez kompilator
[CallerMemberName] to atrybut z przestrzeni System.Runtime.CompilerServices, który automatycznie wypełnia parametr metody nazwą członu (property, metody), z którego ta metoda została wywołana - kompilator robi to w czasie kompilacji, nie w runtime, więc nie ma żadnego narzutu wydajnościowego (to nie jest refleksja).
Widziałeś go już wielokrotnie, w ViewModelBase:
protected void SetProperty<T>(ref T field, T value, [CallerMemberName] string propertyName = null)
{
if (EqualityComparer<T>.Default.Equals(field, value)) return;
field = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}
Problem, który rozwiązuje
Implementacja INotifyPropertyChanged wymaga podania nazwy właściwości jako string przy każdej zmianie - to jest podatne na błędy i nieporęczne:
// BEZ CallerMemberName - musisz ręcznie wpisywać nazwę jako string
private string _customerName;
public string CustomerName
{
get => _customerName;
set
{
_customerName = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs("CustomerName")); // ⚠️ magic string!
}
}
Problem z magic stringiem "CustomerName": jeśli ktoś zmieni nazwę property przez refaktoryzację (Rename w IDE), string się NIE zmieni automatycznie - kompilator tego nie sprawdzi, bo to zwykły tekst, nie odwołanie do symbolu. Skutek: binding w WPF przestaje działać, a błąd wychodzi dopiero w runtime (UI po prostu się nie aktualizuje), bez żadnego ostrzeżenia kompilatora.
Rozwiązanie z [CallerMemberName]
private string _customerName;
public string CustomerName
{
get => _customerName;
set => SetProperty(ref _customerName, value); // BEZ podawania nazwy jawnie!
}
protected void SetProperty<T>(ref T field, T value, [CallerMemberName] string propertyName = null)
{
field = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}
Gdy set właściwości CustomerName wywołuje SetProperty(ref _customerName, value), kompilator automatycznie wstawia "CustomerName" jako wartość parametru propertyName - dokładnie tak, jakbyś napisał:
set => SetProperty(ref _customerName, value, "CustomerName"); // to dzieje się NIEJAWNIE
Kluczowa korzyść: jeśli zmienisz nazwę property przez Rename w IDE (np. CustomerName → ClientName), wywołanie SetProperty nie musi być w ogóle dotykane - kompilator przy następnej kompilacji sam wstawi nową, poprawną nazwę. Błąd typu "zapomniałem zaktualizować string po refaktoryzacji" nie może się zdarzyć, bo nie ma już żadnego ręcznie wpisywanego stringa.
Jak dokładnie działa - "nazwa członu WYWOŁUJĄCEGO"
public class OrderViewModel : ViewModelBase
{
private decimal _totalAmount;
public decimal TotalAmount
{
get => _totalAmount;
set => SetProperty(ref _totalAmount, value); // wywołane WEWNĄTRZ setter'a TotalAmount
}
public void RecalculateTotal()
{
TotalAmount = 100; // to WYWOŁA setter, który wywoła SetProperty z "TotalAmount"
}
public void LogSomething([CallerMemberName] string caller = null)
{
Console.WriteLine($"Wywołane z: {caller}");
}
}
vm.RecalculateTotal();
// Wewnątrz RecalculateTotal(), jeśli TAM wywołasz LogSomething() bezpośrednio:
vm.LogSomething(); // wypisze "RecalculateTotal" - bo STAMTĄD zostało wywołane
[CallerMemberName] zawsze odnosi się do bezpośredniego wywołującego (metody/property, w którym fizycznie znajduje się wywołanie) - nie do "pierwotnego" wywołania gdzieś wyżej w stosie.
Wymagania składniowe
// ✅ Poprawnie - parametr musi mieć wartość domyślną
public void Method([CallerMemberName] string caller = null) { }
public void Method([CallerMemberName] string caller = "") { }
// ❌ Błąd kompilacji - CallerMemberName wymaga wartości domyślnej
public void Method([CallerMemberName] string caller) { }
Musi to być ostatni parametr (albo przynajmniej mieć wartość domyślną, żeby dało się wywołać metodę bez podawania go jawnie) - dokładnie ta sama zasada co przy zwykłych parametrach opcjonalnych w C#.
Można nadal podać wartość jawnie - [CallerMemberName] to tylko wartość DOMYŚLNA
protected void SetProperty<T>(ref T field, T value, [CallerMemberName] string propertyName = null) { }
// Normalne użycie - kompilator wstawia automatycznie
SetProperty(ref _customerName, value); // propertyName = "CustomerName" (automatycznie)
// Można NADAL podać jawnie, gdy potrzeba
SetProperty(ref _customerName, value, "InnaWlasciwosc"); // propertyName = "InnaWlasciwosc" (jawnie)
To bywa przydatne, gdy jedna właściwość musi powiadomić o zmianie innej, powiązanej właściwości - np. gdy TotalAmount zmienia się, a chcesz też odświeżyć FormattedTotalAmount w UI:
private decimal _totalAmount;
public decimal TotalAmount
{
get => _totalAmount;
set
{
SetProperty(ref _totalAmount, value); // propertyName = "TotalAmount" (automatycznie)
OnPropertyChanged(nameof(FormattedTotalAmount)); // jawnie - inna właściwość się zmieniła
}
}
public string FormattedTotalAmount => $"{TotalAmount:C}"; // właściwość obliczana, bez backing field
Powiązane atrybuty z tej samej rodziny (System.Runtime.CompilerServices)
Warto wspomnieć, bo czasem pytają o "resztę rodziny":
public void LogError(
string message,
[CallerMemberName] string memberName = "",
[CallerFilePath] string filePath = "",
[CallerLineNumber] int lineNumber = 0)
{
Console.WriteLine($"[{filePath}:{lineNumber}] {memberName}: {message}");
}
[CallerFilePath]- pełna ścieżka pliku źródłowego, z którego nastąpiło wywołanie[CallerLineNumber]- numer linii, w której nastąpiło wywołanie
To jest bardzo przydatne do logowania diagnostycznego - bez ręcznego wpisywania "OrderService.cs" czy numeru linijki, kompilator wstawia to automatycznie, i zawsze aktualne, nawet po przesunięciu kodu.
Alternatywa - nameof() (dla porównania, inny mechanizm, podobny cel)
Warto odróżnić [CallerMemberName] od nameof() - oba rozwiązują podobny problem (unikanie magic stringów), ale działają inaczej:
// nameof() - jawne, w miejscu WYWOŁANIA, dowolna nazwa symbolu
OnPropertyChanged(nameof(TotalAmount)); // "TotalAmount" - sprawdzane przez kompilator, ale trzeba napisać jawnie
// CallerMemberName - niejawne, AUTOMATYCZNE, zawsze nazwa WYWOŁUJĄCEGO
SetProperty(ref _totalAmount, value); // "TotalAmount" wstawione samo, bo STĄD wywołane
Kiedy nameof(): gdy chcesz odwołać się do konkretnej, dowolnej nazwy symbolu (może być innej niż ta, w której się aktualnie znajdujesz) - jak w przykładzie z FormattedTotalAmount wyżej.
Kiedy [CallerMemberName]: gdy chcesz automatycznie wiedzieć, "skąd mnie wywołano", bez zmuszania wywołującego kodu do jawnego podawania tej informacji za każdym razem.
Podsumowanie - dlaczego to ważne dla WPF/MVVM
[CallerMemberName]eliminuje magic stringi w implementacjiINotifyPropertyChanged- zamiast ręcznie wpisywać nazwę właściwości jako tekst przy każdymSetProperty/OnPropertyChanged(co jest kruche przy refaktoryzacji, bo string nie jest sprawdzany przez kompilator ani aktualizowany przez Rename), kompilator automatycznie wstawia nazwę właściwości/metody, z której nastąpiło wywołanie. To jeden z tych detali, które sprawiają, żeViewModelBasejest bezpieczny na refaktoryzację - zmiana nazwy property przez IDE nigdy nie "cichnie zepsuje" bindingu w WPF.