База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C#

BindingFlags: филтриране на методи чрез отражение

Комбинирайте флагове за търсене, за да изберете методи според видимостта им, според това дали са за екземпляр или са статични и според мястото на декларацията им.

Версия: C# 12 and .NET 8; later runtimes may add compatible features

Синтаксис

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 е изброим тип в .NET, означен с атрибута [Flags]. Импортирайте именното пространство System.Reflection с using, за да използвате краткото име BindingFlags. Комбинирайте флаговете с побитовото ИЛИ (|), а не с ||, и предайте резултата на Type.GetMethods(BindingFlags).

Видимостта и видът на метода са независими филтри. Public включва публичните методи, а NonPublic — непубличните. Instance избира методи на екземпляр, а Static — статични методи. Посочете поне един флаг от всяка двойка. Можете да посочите и двата: Public | Instance | Static допуска публични методи и от двата вида.

DeclaredOnly ограничава търсенето до методите, декларирани пряко в разглеждания тип. Без този флаг в резултатите могат да се появят наследени методи на екземпляр, които отговарят на критериите. При търсене на статични методи FlattenHierarchy позволява да се включат публични и защитени статични методи от базовите класове според филтъра за видимост, но не и техните частни статични методи.

Претовареният вариант с флагове връща MethodInfo[]: той описва методите, без да ги извиква. Връща празен масив, ако липсва някоя от двете задължителни категории флагове или ако няма съвпадение. Затова GetMethods(BindingFlags.Default) не е равностойно на GetMethods() без параметри, което търси публични методи.

Примери

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

Резултат

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

В примера за C# 12 и .NET 8 `Public` изключва `Debug`. Без `DeclaredOnly` търсенето на методи на екземпляр намира и `Reset`, и публичните методи на екземпляр от `object`. С `FlattenHierarchy` търсенето на статични методи намира и `Help`. То намира и статичните методи `Equals` и `ReferenceEquals`, декларирани в `object`, но кодът ги отстранява, преди да изведе резултатите. Кодът изрично сортира имената, вместо да разчита на реда в метаданните.

Свързани уроци

  • C# · Урок 23 · Напреднало · Версия: 3

Източници