WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

BindingFlags: Methoden mit Reflexion filtern

Kombiniere Suchflags, um Methoden nach Sichtbarkeit, nach Methodenart und nach dem deklarierenden Typ auszuwählen.

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

Syntax

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 ist ein .NET-Enumerationstyp mit dem Attribut [Flags]. Importiere System.Reflection mit using, um den Kurznamen BindingFlags zu verwenden. Verknüpfe die Flags mit dem bitweisen ODER (|), nicht mit ||, und übergib das Ergebnis an Type.GetMethods(BindingFlags).

Sichtbarkeit und Methodenart sind unabhängige Filter. Public berücksichtigt öffentliche Methoden, NonPublic nicht öffentliche Methoden. Instance wählt Instanzmethoden aus, Static statische Methoden. Gib mindestens ein Flag aus jedem Paar an. Du kannst auch beide angeben: Public | Instance | Static lässt öffentliche Methoden beider Arten zu.

DeclaredOnly beschränkt die Suche auf Methoden, die direkt im untersuchten Typ deklariert sind. Ohne dieses Flag können passende geerbte Instanzmethoden im Ergebnis stehen. Bei der Suche nach statischen Methoden können mit FlattenHierarchy je nach Sichtbarkeitsfilter öffentliche und geschützte statische Methoden aus Basisklassen hinzukommen, nicht aber deren private statische Methoden.

Die Überladung mit Flags gibt ein MethodInfo[] zurück: Sie beschreibt Methoden, ohne sie aufzurufen. Fehlt eine der beiden erforderlichen Flag-Kategorien oder gibt es keinen Treffer, ist das Array leer. GetMethods(BindingFlags.Default) ist daher nicht mit dem parameterlosen GetMethods() gleichzusetzen, das nach öffentlichen Methoden sucht.

Beispiele

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() { }
}

Ergebnis

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

Im Beispiel für C# 12 und .NET 8 filtert `Public` die Methode `Debug` aus. Ohne `DeclaredOnly` findet die Suche nach Instanzmethoden auch `Reset` und öffentliche Instanzmethoden von `object`. Mit `FlattenHierarchy` findet die Suche nach statischen Methoden auch `Help`. Diese Suche findet außerdem die in `object` deklarierten statischen Methoden `Equals` und `ReferenceEquals`, die der Code vor der Ausgabe herausfiltert. Der Code sortiert die Namen explizit, statt sich auf die Metadatenreihenfolge zu verlassen.

Zugehörige Lektionen

  • C# · Lektion 23 · Fortgeschritten · Version: 3

Quellen