P/Invoke各种总结（八、在C#中使用Union联合体)

Union联合体（共用体）

这里稍微简单介绍一下union这种类型。

有时候需要使几种不同类型的变量存放到同一段内存单元中，例如：可把一个整型变量、一个字符串变量放在同一个地址开始的内存单元中。以上两个变量在内存中占用的字节数不同，但都从同一个地址开始存放，也就是使用覆盖技术，几个变量互相覆盖。这种使用几个不同的变量共同占用同一段内存的结构，称为union。

union
    {        
        int a;
        char b;
    };

 

union的特点是：

1、同一个内存段可以用来存放几种不同类型的成员，但在同一时刻只能存放其中一种。

2、union起作用的成员是最后一次存放的变量，在存入一个新的成员后原有的成员就失去作用。

 

union和struct的区别

struct：所占内存长度是各成员占的内存之和，每个成员分别占用某个自己的内存单元

 

union：所占内存长度等于最长的成员的长度

 

在C#中使用union

在C#中与union交互，需要用到StructLayoutAttribute特性和FieldOffsetAttribute特性，关于这两个特性的介绍，可以参考https://www.cnblogs.com/zhaotianff/p/12510286.html

 

其实在知道union的原理后，在C#中进行映射也是非常简单。

 

如前面示例代码中的union，在C#中的表示形式如下：

   [StructLayout(LayoutKind.Explicit)]
    struct MyStruct
    {
        [FieldOffset(0)]int a;
        [FieldOffset(0)]char b;
   };

 

在上一篇文章中，介绍了  StructLayoutAttribute类的Pack字段，这里再介绍一下另外一个字段，StructLayoutAttribute.Size字段，Size字段用于指示类或结构的绝对大小。

在使用union时，如果不是C#中的值类型，就需要指定大小。

 

测试程序：

最简单的情况：

C++

union MYUNION
{
    int b;
    double d;
};

extern "C" __declspec(dllexport) MYUNION GetMyUnion();

extern "C" __declspec(dllexport) MYUNION GetMyUnion()
{
    MYUNION  myunion;    
    myunion.b = 10;
    return myunion;
}

 

 C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Runtime.InteropServices;

namespace UnionTest
{
    class Program
    {
        [DllImport("UnionLib.dll")]
        public static extern MyUnion GetMyUnion();

        static void Main(string[] args)
        {
            
            //只有值类型的情况
            var myunion = GetMyUnion();
            Console.WriteLine(myunion.b);        
        }
    }
}

运行结果：

 

带引用类型的情况：

需要注意的是：值类型和引用类型不允许重叠。所以在单独使用带引用类型的union时，需要分开处理。

这里定义了两个导出函数，TestUnion2函数可以传入MYUNION2，并进行输出。GetMyUnion2函数直接返回MYUNION2

C++

union MYUNION2
{
    int i;
    char str[128];
};

extern "C" __declspec(dllexport) void TestUnion2(MYUNION2 u, int type);

extern "C" __declspec(dllexport) void TestUnion2(MYUNION2 u, int type)
{
    if (type == 1)
    {
        std::cout << u.i << std::endl;
    }
    else
    {
        std::cout << u.str << std::endl;
    }
}

extern "C" __declspec(dllexport) MYUNION2 GetMyUnion2();

extern "C" __declspec(dllexport) MYUNION2 GetMyUnion2()
{
    MYUNION2  myunion2;
    strcpy_s(myunion2.str, 11, "HelloWorld");
    return myunion2;
}

 

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Runtime.InteropServices;

namespace UnionTest
{
    class Program
    {
        [DllImport("UnionLib.dll")]
        public static extern IntPtr GetMyUnion2();


        [DllImport("UnionLib.dll")]
        public static extern void TestUnion2(MyUnion2_INT mm, int i);

        [DllImport("UnionLib.dll")]
        public static extern void TestUnion2(MyUnion2_STR mm,int i);

        static void Main(string[] args)
        {          
            //使用了引用类型无法直接通过签名返回，需要进行转换
            //如果这里是使用了MYUNION2中的i字段，可以直接使用MyUnion2_INT作为返回值
            var myunion2Ptr = GetMyUnion2();
            MyUnion2_STR unionStr = new MyUnion2_STR();
            unionStr = (MyUnion2_STR)Marshal.PtrToStructure(myunion2Ptr, typeof(MyUnion2_STR));
            Console.WriteLine(unionStr.str);

            //注意：值类型和引用类型不允许重叠
            //在使用引用类型的情况下，无法直接返回union
            MyUnion2_INT mu1 = new MyUnion2_INT();
            mu1.i = 30;
            TestUnion2(mu1, 1);

            MyUnion2_STR mu2 = new MyUnion2_STR();
            mu2.str = "abc";
            TestUnion2(mu2, 2);
        }
    }



    /// <summary>
    /// 如果使用了union中的int字段，就使用这个结构体
    /// </summary>
    [StructLayout(LayoutKind.Explicit, Size = 128)]
    public struct MyUnion2_INT
    {
        [FieldOffset(0)]
        public int i;
    }

    /// <summary>
    /// 如果使用了union中的char[]字段，就使用这个结构体
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    public struct MyUnion2_STR
    {
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
        public string str;
    }

}

运行结果：

 

最看再看一下在struct中使用union的情况：

这段示例代码中使用了Windows Data Types(LPWSTR)，在不同的平台中，指针的大小不一样，所以在C#中调用时，需要根据平台，定义对应的结构体。

C++

struct MYSTRUCTUNION
{
    UINT uType;
    union
    {
        LPWSTR pStr;
        char cStr[260];
    };
};

extern "C" __declspec(dllexport) MYSTRUCTUNION GetMyUnion3();

extern "C" __declspec(dllexport) MYSTRUCTUNION GetMyUnion3()
{
    MYSTRUCTUNION myunion;
    myunion.uType = 0;
    myunion.pStr = L"HelloWorld";
    return myunion;
}

 

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Runtime.InteropServices;

namespace UnionTest
{
    class Program
    {
        [DllImport("UnionLib.dll")]
        public static extern MyStructUnion GetMyUnion3();

        static void Main(string[] args)
        {          
            //结构体和联合体一起使用的情况
            //引用类型部分使用指针再进行转换，直接用字符串将会封送失败
            var myStructUnion = GetMyUnion3();
            var str = Marshal.PtrToStringUni(myStructUnion.pStr);
            Console.WriteLine(str);
        }
    }

#if x86
    /// <summary>
    /// 32位
    /// </summary>
    [StructLayout(LayoutKind.Explicit, Size = 264)]
    public struct MyStructUnion
    {
        [FieldOffset(0)]
        public uint uType;

        [FieldOffset(4)]
        public IntPtr pStr;

        [FieldOffset(4)]
        public IntPtr cStr;
    }

#endif


#if x64
    /// <summary>
    /// 64位
    /// </summary>
    [StructLayout(LayoutKind.Explicit, Size = 272)]
    public struct MyStructUnion
    {
        [FieldOffset(0)]
        public uint uType;

        [FieldOffset(8)]
        public IntPtr pStr;

        [FieldOffset(8)]
        public IntPtr cStr;
    }
#endif

}

运行结果：

 

示例代码