DllImport進階：引數配置與高階主題探究

龙骑科技發表於2024-06-27

深入討論DllImport屬性的作用和配置方法

在基礎篇中，我們已經簡單介紹了DllImport的一些屬性。現在我們將深入探討這些屬性的實際應用。

1. EntryPoint

EntryPoint屬性用於指定要呼叫的非託管函式的名稱。如果託管程式碼中的函式名與非託管程式碼中的函式名不同，可以使用這個屬性。例如：

[DllImport("user32.dll", EntryPoint = "MessageBoxW")]
public static extern int ShowMessage(IntPtr hWnd, String text, String caption, uint type);

在這個例子中，我們將非託管函式MessageBoxW對映到託管函式ShowMessage。

2. CallingConvention

CallingConvention屬性指定呼叫約定，它定義了函式如何接收引數和返回值。常見的呼叫約定包括：

CallingConvention.Cdecl：呼叫者清理堆疊，多用於C/C++庫。
CallingConvention.StdCall：被呼叫者清理堆疊，Windows API常用。
CallingConvention.ThisCall：用於C++類方法。
CallingConvention.FastCall：用於快速呼叫，較少使用。

示例：

[DllImport("kernel32.dll", CallingConvention = CallingConvention.StdCall)]
public static extern bool Beep(uint dwFreq, uint dwDuration);

3. CharSet

CharSet屬性用於指定字串的字符集，影響字串的處理和傳遞方式。主要選項有：

CharSet.Ansi：將字串作為ANSI編碼傳遞。
CharSet.Unicode：將字串作為Unicode編碼傳遞。
CharSet.Auto：根據平臺自動選擇ANSI或Unicode。

示例：

[DllImport("user32.dll", CharSet = CharSet.Unicode)]
public static extern int MessageBox(IntPtr hWnd, String text, String caption, uint type);

4. SetLastError

SetLastError屬性指定是否在呼叫非託管函式後呼叫GetLastError。設定為true時，可以使用Marshal.GetLastWin32Error獲取錯誤程式碼。

示例：

[DllImport("kernel32.dll", SetLastError = true)]
public static extern bool CloseHandle(IntPtr hObject);

public void CloseResource(IntPtr handle)
{
    if (!CloseHandle(handle))
    {
        int error = Marshal.GetLastWin32Error();
        // 處理錯誤
    }
}

5. ExactSpelling

ExactSpelling屬性指定是否精確匹配入口點名稱。預設情況下，CharSet影響名稱查詢，設定為true時，關閉字符集查詢。

示例：

[DllImport("kernel32.dll", ExactSpelling = true)]
public static extern IntPtr GlobalAlloc(uint uFlags, UIntPtr dwBytes);

6. PreserveSig

PreserveSig屬性指定是否保留方法簽名的HRESULT返回型別。預設值為true。當設定為false時，HRESULT會轉換為異常。

示例：

[DllImport("ole32.dll", PreserveSig = false)]
public static extern void CoCreateGuid(out Guid guid);

7. BestFitMapping 和 ThrowOnUnmappableChar

BestFitMapping屬性控制是否啟用ANSI到Unicode的最佳對映。ThrowOnUnmappableChar指定是否在遇到無法對映的字元時丟擲異常。

示例：

[DllImport("kernel32.dll", BestFitMapping = false, ThrowOnUnmappableChar = true)]
public static extern bool SetEnvironmentVariable(string lpName, string lpValue);

實踐示例

下面是一個綜合使用多個DllImport屬性的示例：

using System;
using System.Runtime.InteropServices;

class Program
{
    [DllImport("user32.dll", EntryPoint = "MessageBox", CharSet = CharSet.Auto, SetLastError = true, CallingConvention = CallingConvention.StdCall)]
    public static extern int ShowMessageBox(IntPtr hWnd, String text, String caption, uint type);

    static void Main()
    {
        int result = ShowMessageBox(IntPtr.Zero, "Hello, World!", "Hello Dialog", 0);
        if (result == 0)
        {
            int error = Marshal.GetLastWin32Error();
            Console.WriteLine($"Error: {error}");
        }
    }
}

在這個例子中，我們使用了EntryPoint、CharSet、SetLastError和CallingConvention屬性來精確配置MessageBox函式的呼叫。

深入理解和正確配置DllImport屬性可以幫助我們更高效地呼叫非託管程式碼，確保資料型別和呼叫約定的匹配，處理潛在的錯誤和異常，提升程式碼的穩定性和安全性。

探討資料型別匹配的重要性

在C#中透過DllImport呼叫非託管程式碼時，資料型別的匹配是確保程式碼正確執行的關鍵因素之一。正確的資料型別匹配能夠避免資料損壞、記憶體洩漏和程式崩潰等問題。

1. 資料型別匹配的重要性

避免資料損壞：非託管程式碼和託管程式碼的資料型別必須一致，否則傳遞的資料可能會損壞。例如，將一個32位的整數傳遞給一個預期為64位整數的非託管函式會導致資料截斷或損壞。
防止程式崩潰：不匹配的資料型別可能會導致非託管程式碼訪問非法記憶體地址，進而導致程式崩潰。
確保資料完整性：正確的資料型別匹配可以確保資料在託管程式碼和非託管程式碼之間正確傳遞，保持資料的完整性。
提高程式碼安全性：資料型別的不匹配可能會引入安全漏洞，導致潛在的緩衝區溢位等安全問題。

2. 基本資料型別的匹配

基本資料型別在託管程式碼和非託管程式碼之間的匹配非常重要。以下是常見資料型別的匹配示例：

整數型別

C#中的int通常對應C/C++中的int或LONG型別：

[DllImport("Example.dll")] 
public static extern int Add(int a, int b);

無符號整數型別

C#中的uint通常對應C/C++中的unsigned int或DWORD型別：

[DllImport("Example.dll")]
public static extern uint GetTickCount();

長整數型別

C#中的long對應C中的long long或__int64型別：

[DllImport("Example.dll")] 
public static extern long Multiply(long a, long b);

指標型別

C#中的IntPtr或UIntPtr對應C中的指標型別，如void*或HANDLE：

[DllImport("Example.dll")] 
public static extern IntPtr OpenHandle(uint access);

布林型別

C#中的bool對應C中的BOOL型別，需要注意的是，C/C++中的BOOL通常定義為int，而C#中的bool是1位元組。

[DllImport("Example.dll")] [return: MarshalAs(UnmanagedType.Bool)] 
public static extern bool CloseHandle(IntPtr handle);

3. 複雜資料型別的匹配

對於結構體、陣列和字串等複雜資料型別的匹配，需要特別注意。

結構體

結構體需要在託管程式碼和非託管程式碼中保持一致，並使用StructLayout屬性進行佈局控制：

[StructLayout(LayoutKind.Sequential)] 
public struct Point { public int X; public int Y; } 

[DllImport("Example.dll")] 
public static extern void GetPoint(out Point p);

陣列

陣列的匹配需要使用MarshalAs屬性指定陣列的型別和大小：

[DllImport("Example.dll")]
public static extern void FillArray([MarshalAs(UnmanagedType.LPArray, SizeConst = 10)] int[] array);

字串

字串的匹配需要注意字符集的選擇（如CharSet.Ansi或CharSet.Unicode）：

[DllImport("Example.dll", CharSet = CharSet.Unicode)] 
public static extern void PrintMessage(string message);

4. 資料型別匹配的常見問題及解決方法

字符集不匹配：在傳遞字串時，如果字符集不匹配，可能會導致字串被截斷或亂碼。解決方法是在DllImport特性中明確指定字符集：

[DllImport("Example.dll", CharSet = CharSet.Unicode)] 
public static extern void PrintMessage(string message);

指標型別不匹配：非託管程式碼中的指標型別應對應C#中的IntPtr或UIntPtr：

[DllImport("Example.dll")] 
public static extern IntPtr AllocateMemory(uint size);

結構體佈局不匹配：如果結構體在記憶體中的佈局不同，可能會導致資料損壞。解決方法是使用StructLayout屬性確保一致的記憶體佈局：

[StructLayout(LayoutKind.Sequential)] 
public struct Point { public int X; public int Y; }

陣列邊界問題：傳遞陣列時，應確保陣列的大小匹配，避免越界訪問：

[DllImport("Example.dll")] 
public static extern void ProcessArray([MarshalAs(UnmanagedType.LPArray, SizeConst = 10)] int[] array);

討論記憶體管理的重要性

在呼叫非託管程式碼時，記憶體管理是一個不可忽視的重要環節。非託管程式碼不受.NET垃圾回收器的管理，因此需要開發人員手動分配和釋放記憶體。這不僅涉及到如何正確使用記憶體，還包括如何避免記憶體洩漏和其他潛在問題。

1. 記憶體管理的重要性

防止記憶體洩漏：手動分配的記憶體如果不正確釋放，會導致記憶體洩漏，逐漸消耗系統資源。
確保資料安全：未正確管理的記憶體可能會被覆蓋或誤用，導致資料損壞和程式崩潰。
提高程式效能：高效的記憶體管理能夠減少記憶體使用，提升程式效能。

2. 記憶體分配和釋放

在非託管程式碼中，記憶體通常使用malloc、calloc等函式分配，並使用free函式釋放。在託管程式碼中，我們可以使用Marshal類提供的方法來分配和釋放非託管記憶體。

分配記憶體Marshal.AllocHGlobal：分配指定位元組數的非託管記憶體。Marshal.AllocCoTaskMem：分配任務記憶體，適用於COM互操作。

IntPtr ptr = Marshal.AllocHGlobal(100); // 分配100位元組的記憶體
// 使用ptr進行操作
Marshal.FreeHGlobal(ptr); // 釋放記憶體

釋放記憶體使用Marshal.FreeHGlobal或Marshal.FreeCoTaskMem釋放之前分配的記憶體。

IntPtr ptr = Marshal.AllocCoTaskMem(100);
// 使用ptr進行操作
Marshal.FreeCoTaskMem(ptr); // 釋放記憶體

3. 記憶體複製

在託管程式碼和非託管程式碼之間傳遞資料時，可能需要進行記憶體複製。Marshal類提供了一些方法用於記憶體複製：

Marshal.Copy：用於從託管陣列複製到非託管記憶體，或從非託管記憶體複製到託管陣列。
Marshal.StructureToPtr：將託管結構複製到非託管記憶體。
Marshal.PtrToStructure：將非託管記憶體的資料複製到託管結構。

int[] managedArray = new int[10];
IntPtr unmanagedArray = Marshal.AllocHGlobal(managedArray.Length * sizeof(int));

Marshal.Copy(managedArray, 0, unmanagedArray, managedArray.Length);
// 使用unmanagedArray進行操作
Marshal.Copy(unmanagedArray, managedArray, 0, managedArray.Length);

Marshal.FreeHGlobal(unmanagedArray);

4. 處理非託管資源

呼叫非託管程式碼時，可能會使用非託管資源（如檔案控制代碼、視窗控制代碼等），這些資源也需要正確管理以避免資源洩漏。

關閉控制代碼使用CloseHandle或類似的API來關閉非託管資源。

[DllImport("kernel32.dll", SetLastError = true)]
public static extern bool CloseHandle(IntPtr hObject);

public void CloseResource(IntPtr handle)
{
    if (!CloseHandle(handle))
    {
        int error = Marshal.GetLastWin32Error();
        // 處理錯誤
    }
}

5. 管理生命週期

對於需要頻繁分配和釋放記憶體的操作，可以考慮封裝記憶體管理邏輯，確保記憶體能夠正確釋放。

public class UnmanagedBuffer : IDisposable
{
    private IntPtr buffer;
    private bool disposed = false;

    public UnmanagedBuffer(int size)
    {
        buffer = Marshal.AllocHGlobal(size);
    }

    ~UnmanagedBuffer()
    {
        Dispose(false);
    }

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (!disposed)
        {
            if (buffer != IntPtr.Zero)
            {
                Marshal.FreeHGlobal(buffer);
                buffer = IntPtr.Zero;
            }
            disposed = true;
        }
    }

    public IntPtr Buffer => buffer;
}

6. 記憶體管理最佳實踐

始終釋放記憶體：確保所有分配的記憶體都在適當的時候釋放，防止記憶體洩漏。
使用智慧指標或封裝類：封裝記憶體管理邏輯，減少手動管理的複雜性。
定期檢查記憶體使用：使用工具和程式碼分析，確保沒有未釋放的記憶體。

實踐示例

以下是一個綜合示例，展示了記憶體分配、記憶體複製和資源管理的完整流程：

C++部分程式碼：PointManager.h和PointManager.cpp兩個檔案

#pragma once

#ifdef EXAMPLE_EXPORTS
#define EXAMPLE_API __declspec(dllexport)
#else
#define EXAMPLE_API __declspec(dllimport)
#endif

struct Point
{
    int X;
    int Y;
};

extern "C" EXAMPLE_API Point* CreatePoint(int x, int y);
extern "C" EXAMPLE_API void GetPoint(Point * point, Point * pOut);
extern "C" EXAMPLE_API void DeletePoint(Point * point);
#include "pch.h"
#include "PointManager.h"

// 建立一個新的 Point 物件並返回其指標
extern "C" __declspec(dllexport) Point* CreatePoint(int x, int y)
{
    Point* p = new Point();
    p->X = x;
    p->Y = y;
    return p;
}

// 獲取 Point 物件的值
extern "C" __declspec(dllexport) void GetPoint(Point * point, Point * pOut)
{
    if (point == nullptr || pOut == nullptr)
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        return;
    }
    pOut->X = point->X;
    pOut->Y = point->Y;
}

// 刪除 Point 物件
extern "C" __declspec(dllexport) void DeletePoint(Point * point)
{
    if (point != nullptr)
    {
        delete point;
    }
}

C#部分程式碼：

using System;
using System.Runtime.InteropServices;

class Program
{
    [StructLayout(LayoutKind.Sequential)]
    public struct Point
    {
        public int X;
        public int Y;
    }

    [DllImport("Example.dll", SetLastError = true)]
    public static extern IntPtr CreatePoint(int x, int y);

    [DllImport("Example.dll", SetLastError = true)]
    public static extern void GetPoint(IntPtr point, out Point p);

    [DllImport("Example.dll", SetLastError = true)]
    public static extern void DeletePoint(IntPtr point);

    static void Main()
    {
        IntPtr pointPtr = CreatePoint(10, 20);
        if (pointPtr == IntPtr.Zero)
        {
            int error = Marshal.GetLastWin32Error();
            Console.WriteLine($"Error: {error}");
            return;
        }

        Point p;
        GetPoint(pointPtr, out p);
        Console.WriteLine($"Point: {p.X}, {p.Y}");

        DeletePoint(pointPtr);
    }
}

這個示例展示瞭如何在非託管程式碼中建立和管理記憶體資源，並在託管程式碼中正確分配和釋放記憶體。

參考文件

使用非託管 DLL 函式 - .NET Framework | Microsoft Learn

標識 DLL 中的函式 - .NET Framework | Microsoft Learn

DllImportAttribute.EntryPoint 欄位 (System.Runtime.InteropServices) | Microsoft Learn

原文連結：https://www.toutiao.com/article/7383720159233573427/?app=news_article&timestamp=1719443240&use_new_style=1&req_id=2024062707072029288E0C168B30524880&group_id=7383720159233573427&share_token=27F51CAD-7939-4769-90A3-0F26B5F997C4&tt_from=weixin&utm_source=weixin&utm_medium=toutiao_ios&utm_campaign=client_share&wxshare_count=1&source=m_redirect&wid=1719451374672

Java進階專題(十一) 探究JMM
2020-08-20
Java
「譯」Web 安全高階主題
2019-05-07
Web
CSS高階進階
2018-02-12
CSS
pytest 引數化進階
2020-09-29
Flutter進階：深入探究 TextField
2019-01-26
Flutter
MySQL進階：主主複製+Keepalived高可用
2021-06-18
MySql
高階前端進階（五）
2022-05-09
前端
高階前端進階（七）
2022-12-17
前端
高階前端進階（三）
2021-11-22
前端
Hexo Next主題進階教程
2018-07-31
Hexo
Typescript 高階語法進階
2020-08-09
TypeScript
React 進階(三) 高階元件
2019-03-18
React元件
高階前端進階系列 - webview
2019-05-10
前端WebView
Python進階：切片的誤區與高階用法
2018-12-29
Python
Draft 文件翻譯 - 高階主題 - Decorators
2021-09-09
Raft
Python Django進階教程（一）（高階檢視和URL配置）
2017-05-03
PythonDjango
Pytest高階進階之Fixture
2017-03-18
Python高階 -- 09 MySQL高階之事務、檢視、索引、賬戶管理、主從配置
2018-03-15
PythonMySql索引
Flutter進階：深入探究 ListView 和 ScrollPhysics
1970-01-01
FlutterView
【進階之路】執行緒池配置與調優的一些高階選項（一）
2020-12-08
執行緒
高階前端的進階——CSS之flex
2019-03-11
前端CSSFlex
【狂神說】Docker（三） - 高階進階
2020-12-06
Docker
SCO UNIX--高階進階(一)(轉)
2007-08-10
WordPress主題製作進階#10自定義主頁
2018-09-30
【進階5-3期】深入探究 Function & Object 雞蛋問題
2019-04-16
FunctionObject
Draft 文件翻譯 - 高階主題 - 管理焦點
2021-09-09
Raft
Web Audio API 第6章高階主題
2024-04-30
WebAPI
OpenGL ES 高階進階：紋理陣列
2019-05-19
陣列
Python 函式進階-高階函式
2022-04-25
Python函式
Java初級~中級~高階進階之路
2020-10-24
Java
react進階系列：高階元件詳解（三）
2017-06-27
React元件
圖解Activity啟動流程，進階高階
2017-07-17
圖解
【JavaScript高階進階】JavaScript變數/函式提升的細節總結
2018-08-07
JavaScript變數函式
Sonatype Nexus高階配置
2013-08-01
dns配置高階篇(轉)
2007-08-11
DNS
[譯]React高階話題之高階元件
2018-11-27
React元件
介面測試--獲取動態引數進階
2021-01-06
CSS使用的一些小技巧/高階進階
2019-03-04
CSS

DllImport進階：引數配置與高階主題探究

深入討論DllImport屬性的作用和配置方法

1. EntryPoint

2. CallingConvention

3. CharSet

4. SetLastError

5. ExactSpelling

6. PreserveSig

7. BestFitMapping 和 ThrowOnUnmappableChar

實踐示例

探討資料型別匹配的重要性

1. 資料型別匹配的重要性

2. 基本資料型別的匹配

3. 複雜資料型別的匹配

4. 資料型別匹配的常見問題及解決方法

討論記憶體管理的重要性

1. 記憶體管理的重要性

2. 記憶體分配和釋放

3. 記憶體複製

4. 處理非託管資源

5. 管理生命週期

6. 記憶體管理最佳實踐

實踐示例

參考文件

相關文章