gcc编译DLL供.NET调用报BadImageFormatException如何兼容x86/x64

问题根源 #

你遇到的BadImageFormatException是因为当前gcc默认编译出的是64位原生DLL，当.NET程序运行在32位进程下（勾选「首选32位」的Any CPU程序默认跑32位）时，32位进程无法加载64位原生库，就会抛出该异常。Windows平台不存在单个原生DLL同时支持x86、x64双架构的方案，你可以通过多架构分发+自动适配的方案解决需求。

方案1：多架构编译+提前加载适配（兼容.NET Framework/.NET Core所有版本）

步骤1：编译不同架构的原生库

修改gcc编译命令，分别生成x86、x64两个版本的DLL，命名区分：

# 编译32位x86版本DLL
gcc -m32 -c test.c
gcc -m32 -shared -o test_x86.dll test.o

# 编译64位x64版本DLL
gcc -m64 -c test.c
gcc -m64 -shared -o test_x64.dll test.o

macOS平台同理，分别编译x86_64、arm64版本的dylib即可。

步骤2：.NET侧自动适配加载

在类库的原生方法包装类的静态构造函数中，提前判断当前进程架构，加载对应版本的原生库，后续DllImport会直接使用已加载的模块，不需要用户做任何配置：

using System;
using System.Runtime.InteropServices;

public static class NativeApi
{
    // 导入Windows系统的LoadLibrary方法，用于提前加载对应架构的原生库
    [DllImport("kernel32.dll", SetLastError = true)]
    private static extern IntPtr LoadLibrary(string lpFileName);

    static NativeApi()
    {
        // 根据进程指针长度判断架构：4字节为32位，8字节为64位
        string libName = IntPtr.Size == 4 ? "test_x86.dll" : "test_x64.dll";
        IntPtr libHandle = LoadLibrary(libName);
        if (libHandle == IntPtr.Zero)
        {
            throw new DllNotFoundException($"无法加载原生库：{libName}，请确认文件存在");
        }
    }

    // 此处DllImport参数仍写test即可，会自动匹配已经加载的对应架构库
    [DllImport("test")]
    public static extern int Foo();
}

部署时将test_x86.dll、test_x64.dll和你的.NET类库放在同一目录即可。如果要同时兼容macOS，可以增加操作系统判断逻辑，加载对应dylib即可。

方案2：标准NuGet原生库结构（推荐分发类库使用）

如果你的类库通过NuGet分发，可直接使用.NET官方约定的原生库目录结构，运行时会自动根据当前系统、架构加载对应原生库，不需要写额外的加载代码：

1. 按以下目录结构存放不同平台、架构的原生库：

   runtimes/
   ├─ win-x86/
   │  └─ native/
   │     └─ test.dll
   ├─ win-x64/
   │  └─ native/
   │     └─ test.dll
   ├─ osx-x64/
   │  └─ native/
   │     └─ test.dylib
   └─ osx-arm64/
      └─ native/
         └─ test.dylib
   

2. 在类库的csproj文件中配置将上述目录打包到NuGet包中，用户安装你的NuGet包后，不管项目配置为Any CPU、x86还是x64，都可以直接调用DllImport方法，无需任何额外配置。

内容的提问来源于stack exchange，提问作者Maxim