Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

BindingFlags: filtrowanie metod w refleksji

Łącz flagi wyszukiwania, aby wybrać metody według widoczności, rodzaju i miejsca deklaracji.

Wersja: C# 12 and .NET 8; later runtimes may add compatible features

Składnia

using System.Reflection;

BindingFlags flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly;
MethodInfo[] methods = typeof(T).GetMethods(flags); // T is the type to inspect.
// Use BindingFlags.Static instead of Instance for static methods,
// or combine Instance | Static to include both.

System.Reflection.BindingFlags to typ wyliczeniowy .NET oznaczony atrybutem [Flags]. Po zaimportowaniu System.Reflection przez using możesz używać krótkiej nazwy BindingFlags. Połącz flagi bitowym operatorem LUB |, a nie operatorem ||, i przekaż wynik do Type.GetMethods(BindingFlags).

Widoczność i rodzaj metody to dwa niezależne kryteria. Public uwzględnia metody publiczne, a NonPublic — niepubliczne. Instance wybiera metody instancji, a Static — metody statyczne. Podaj co najmniej jedną flagę z każdej pary; możesz też podać obie. Public | Instance | Static dopuszcza zarówno publiczne metody instancji, jak i publiczne metody statyczne.

DeclaredOnly ogranicza wyszukiwanie do metod zadeklarowanych bezpośrednio w badanym typie. Bez tej flagi kwalifikujące się odziedziczone metody instancji mogą pojawić się w wynikach. Przy wyszukiwaniu statycznym FlattenHierarchy pozwala uwzględnić publiczne i chronione metody statyczne klas bazowych, zależnie od wybranej widoczności, ale nie prywatne metody statyczne klas bazowych.

Przeciążenie z flagami zwraca MethodInfo[]: opisuje metody, ale ich nie wywołuje. Gdy brakuje którejkolwiek z dwóch wymaganych kategorii flag lub nie ma dopasowań, zwraca pustą tablicę. Dlatego GetMethods(BindingFlags.Default) nie działa tak jak bezparametrowe GetMethods(), które wyszukuje metody publiczne.

Przykłady

using System;
using System.Linq;
using System.Reflection;

Type type = typeof(Player);
const BindingFlags publicInstance = BindingFlags.Public | BindingFlags.Instance;
const BindingFlags publicStatic = BindingFlags.Public | BindingFlags.Static;

Print("Instance here", type, publicInstance | BindingFlags.DeclaredOnly);
Print("Static here", type, publicStatic | BindingFlags.DeclaredOnly);
Print("Instance including inherited", type, publicInstance);
Print("Static including inherited", type, publicStatic | BindingFlags.FlattenHierarchy);

static void Print(string label, Type type, BindingFlags flags)
{
    var names = type.GetMethods(flags)
        // Keep object instance methods, but omit static methods declared on object.
        .Where(method => !method.IsStatic || method.DeclaringType != typeof(object))
        .Select(method => method.Name)
        .OrderBy(name => name, StringComparer.Ordinal);

    Console.WriteLine($"{label}: {string.Join(", ", names)}");
}

class BasePlayer
{
    public void Reset() { }
    public static void Help() { }
}

class Player : BasePlayer
{
    public void Play() { }
    public static void Create() { }
    private void Debug() { }
}

Wynik

Instance here: Play
Static here: Create
Instance including inherited: Equals, GetHashCode, GetType, Play, Reset, ToString
Static including inherited: Create, Help

W przykładzie dla C# 12 i .NET 8 `Debug` odpada przez filtr `Public`. Bez `DeclaredOnly` wyszukiwanie metod instancji znajduje też `Reset` i publiczne metody instancji z `object`. Dzięki `FlattenHierarchy` w wynikach wyszukiwania statycznego pojawia się `Help`. Wyszukiwanie znajduje też statyczne metody `Equals` i `ReferenceEquals` zadeklarowane w `object`, ale kod odfiltrowuje je przed wypisaniem wyników. Nazwy są sortowane jawnie, niezależnie od kolejności metadanych.

Powiązane lekcje

  • C# · Lekcja 23 · Zaawansowany · Wersja: 3

Źródła