Vorgehensweise: Bestimmen, ob eine Datei eine Assembly ist

  • Artikel

Eine Datei ist nur dann eine Assembly, wenn sie verwaltet wird und einen Assemblyeintrag in ihren Metadaten enthält. Weitere Informationen zu Assemblys und Metadaten finden Sie unter Assemblymanifest.

So bestimmen Sie manuell, ob eine Datei eine Assembly ist

  1. Starten Sie das Ildasm.exe (IL Disassembler) Tool.

  2. Laden Sie die Datei, die Sie testen möchten.

  3. Wenn ILDASM meldet, dass die Datei keine portierbare ausführbare Datei (PE, portable executable) ist, ist es keine Assembly. Weitere Informationen finden Sie im Thema How to: Anzeigen des Assemblyinhalts.

So bestimmen Sie programmgesteuert, ob eine Datei eine Assembly ist

Verwenden der AssemblyName-Klasse

  1. Rufen Sie die AssemblyName.GetAssemblyName-Methode auf, und übergeben Sie den vollständigen Dateipfad der Datei, die Sie überprüfen möchten.

  2. Wenn eine BadImageFormatException-Ausnahme ausgelöst wird, ist die Datei keine Assembly.

In diesem Beispiel wird eine DLL getestet, um festzustellen, ob es sich um eine Assembly handelt.

using System;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;

static class ExampleAssemblyName
{
    public static void CheckAssembly()
    {
        try
        {
            string path = Path.Combine(
                RuntimeEnvironment.GetRuntimeDirectory(),
                "System.Net.dll");

            AssemblyName testAssembly = AssemblyName.GetAssemblyName(path);
            Console.WriteLine("Yes, the file is an assembly.");
        }
        catch (FileNotFoundException)
        {
            Console.WriteLine("The file cannot be found.");
        }
        catch (BadImageFormatException)
        {
            Console.WriteLine("The file is not an assembly.");
        }
        catch (FileLoadException)
        {
            Console.WriteLine("The assembly has already been loaded.");
        }
    }

    /* Output: 
    Yes, the file is an assembly.  
    */
}

Imports System
Imports System.IO
Imports System.Reflection
Imports System.Runtime.InteropServices

Module ExampleAssemblyName
    Sub CheckAssembly()
        Try
            Dim filePath As String = Path.Combine(
                RuntimeEnvironment.GetRuntimeDirectory(),
                "System.Net.dll")

            Dim testAssembly As AssemblyName =
                                AssemblyName.GetAssemblyName(filePath)
            Console.WriteLine("Yes, the file is an Assembly.")
        Catch ex As FileNotFoundException
            Console.WriteLine("The file cannot be found.")
        Catch ex As BadImageFormatException
            Console.WriteLine("The file is not an Assembly.")
        Catch ex As FileLoadException
            Console.WriteLine("The Assembly has already been loaded.")
        End Try
    End Sub
End Module
' Output:  
' Yes, the file is an Assembly.

Die GetAssemblyName-Methode lädt die Testdatei und gibt sie wieder frei, sobald die Informationen gelesen wurden.

Verwenden der PEReader-Klasse

  1. Wenn Sie .NET Standard oder .NET Framework verwenden möchten, installieren Sie das NuGet-Paket System.Reflection.Metadata. (Bei Verwendung von .NET Core oder .NET 5+ ist dieser Schritt nicht erforderlich, da diese Bibliothek im freigegebenen Framework enthalten ist.)

  2. Erstellen Sie eine System.IO.FileStream-Instanz, um Daten aus der Testdatei zu lesen.

  3. Erstellen Sie eine System.Reflection.PortableExecutable.PEReader-Instanz, und übergeben Sie Ihren Dateidatenstrom an den Konstruktor.

  4. Überprüfen Sie den Wert der HasMetadata-Eigenschaft. Wenn der Wert false lautet, ist die Datei keine Assembly.

  5. Rufen Sie die GetMetadataReader-Methode für die PE-Reader-Instanz auf, um einen Metadatenleser zu erstellen.

  6. Überprüfen Sie den Wert der IsAssembly-Eigenschaft. Wenn der Wert true lautet, ist die Datei eine Assembly.

Im Gegensatz zur GetAssemblyName-Methode löst die PEReader-Klasse keine Ausnahme für native PE-Dateien (portierbare ausführbare Dateien) aus. Dadurch können Sie den Zusatzaufwand vermeiden, der durch Ausnahmen verursacht wird, wenn solche Dateien überprüft werden müssen. Sie müssen allerdings weiterhin Ausnahmen für den Fall behandeln, dass die Datei nicht vorhanden oder keine PE-Datei ist.

Im folgenden Beispiel wird gezeigt, wie mithilfe der PEReader-Klasse ermittelt wird, ob es sich bei einer Datei um eine Assembly handelt:

using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;
using System.Runtime.InteropServices;

static class ExamplePeReader
{
    static bool IsAssembly(string path)
    {
        using var fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);

        // Try to read CLI metadata from the PE file.
        using var peReader = new PEReader(fs);

        if (!peReader.HasMetadata)
        {
            return false; // File does not have CLI metadata.
        }

        // Check that file has an assembly manifest.
        MetadataReader reader = peReader.GetMetadataReader();
        return reader.IsAssembly;
    }

    public static void CheckAssembly()
    {
        string path = Path.Combine(
                RuntimeEnvironment.GetRuntimeDirectory(),
                "System.Net.dll");

        try
        {
            if (IsAssembly(path))
            {
                Console.WriteLine("Yes, the file is an assembly.");
            }
            else
            {
                Console.WriteLine("The file is not an assembly.");
            }
        }
        catch (BadImageFormatException)
        {
            Console.WriteLine("The file is not an executable.");
        }
        catch (FileNotFoundException)
        {
            Console.WriteLine("The file cannot be found.");
        }
    }

    /* Output: 
    Yes, the file is an assembly.  
    */
}

Imports System
Imports System.Collections.Generic
Imports System.IO
Imports System.Reflection.Metadata
Imports System.Reflection.PortableExecutable
Imports System.Runtime.InteropServices

Module ExamplePeReader
    Function IsAssembly(path As String) As Boolean

        Dim fs As FileStream = New FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)

        ' Try to read CLI metadata from the PE file.
        Dim peReader As PEReader = New PEReader(fs)
        Using (peReader)
            If Not peReader.HasMetadata Then
                Return False ' File does Not have CLI metadata.
            End If

            ' Check that file has an assembly manifest.
            Dim reader As MetadataReader = peReader.GetMetadataReader()
            Return reader.IsAssembly
        End Using
    End Function

    Sub CheckAssembly()
        Dim filePath As String = Path.Combine(
                RuntimeEnvironment.GetRuntimeDirectory(),
                "System.Net.dll")

        Try
            If IsAssembly(filePath) Then
                Console.WriteLine("Yes, the file is an assembly.")
            Else
                Console.WriteLine("The file is not an assembly.")
            End If
        Catch ex As BadImageFormatException
            Console.WriteLine("The file is not an executable.")
        Catch ex As FileNotFoundException
            Console.WriteLine("The file cannot be found.")
        End Try
    End Sub
End Module
' Output:  
' Yes, the file is an Assembly.

Siehe auch