请提供一个WPF调用.net AOT dll的正确示例

Question

请提供一个WPF调用.net AOT dll的正确示例

William Liu 556

一个.net8/9的library, 暴露出一个函数功能为:接受一个指定长度,返回这个长度的字符'a'拼接的字符串. 将这个library通过aot编译成dll供WPF调用.

一个wpf的空模板项目,主页面上有一个按钮,点击后通过pinvoke调用上述的AOT dll获得长度为1万的字符串,并输出获得字符串的长度.

谢谢!

Answer accepted by question author

0 个其他答案

你的答案

Answer 1

匿名

你好，@William Liu。欢迎来到 Microsoft 问答。

这种使用方式似乎并不主流。你可以尝试下面的方式来使用。

创建Class Library

创建一个名为ClassLibrary1的Class Library，在其下面创建一个名为StringGenerator的类，添加下面的代码。

public class StringGenerator
{
    [UnmanagedCallersOnly(EntryPoint = "GenerateString")]
    public static IntPtr GenerateString(int length)
    {
        string result = new string('a', length);
        return Marshal.StringToHGlobalAnsi(result);
    }
}

点击ClassLibrary1 ，在<PropertyGroup>中添加<PublishAot>true</PublishAot>。打开Terminal(View->Terminal),通过cd ClassLibrary1定位到ClassLibrary1项目中,运行下面的命令生成dll：

dotnet publish -r win-x64 -c Release

更详细的生成dll的方法你可以参考文档。

创建WPF Application

在MainWindow.xaml中按如下调整代码

    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="7*"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>
        <TextBox x:Name="MyTextBox" Grid.Row="0" Width="400" Height="300" VerticalScrollBarVisibility="Visible" TextWrapping="Wrap" ></TextBox>
        <Button Content="Click Me!" Width="200" Height="50"  Click="Button_Click" Grid.Row="1"></Button>
    </Grid>

在MainWindow.xaml.cs中按如下调整代码

public partial class MainWindow : Window
{
    [DllImport("ClassLibrary1.dll", EntryPoint = "GenerateString", CallingConvention = CallingConvention.StdCall)]
    public static extern IntPtr GenerateString(int length);

    public MainWindow()
    {
        InitializeComponent();
    }

    private void Button_Click(object sender, RoutedEventArgs e)
    {
        try
        {
            int length = 10000;
            IntPtr resultPtr = GenerateString(length);
            string result = Marshal.PtrToStringAnsi(resultPtr);
            MyTextBox.Text = "string length: " + result.Length + "\n" + "string: " + result;
            // 记得释放非托管内存
            Marshal.FreeHGlobal(resultPtr);
        }
        catch (Exception exception)
        {
            MessageBox.Show(exception.Message.ToString());
        }
    }
}

WPF项目引用dll

对WPF项目进行右键->Rebuild。

将...ClassLibrary1\bin\Release\net8.0\win-x64\publish处的ClassLibrary1.dll复制到...WpfApp1\bin\Debug\net8.0-windows。

配置启动方式为不构建直接运行。

以调试方式运行WPF项目

运行结果

如果答案是正确的，请点击“接受答案”并点赞。如果您对此答案还有其他疑问，请点击“评论”。

注意：如果您想接收相关电子邮件，请按照我们的文档中的步骤启用电子邮件通知此线程的通知。

William Liu 556 信誉分

2024-11-15T02:44:40.4633333+00:00

@Anonymous 谢谢你的答复. 这个测试的目的是如何正确地用Native Aot dll接受参数并产生字符串供调用.

我用你的方法写了代码并上传在github上repo.

测试结果是可以从Native Aot dll生成字符串资源, 但是在这个过程中好像产生了无法释放的内存, 即使手动调用GC也无法将其释放. 我在两台电脑上都观察到了这个内存问题. 请问这里是否还有其它释放内存的动作没用被执行?
William Liu 556 信誉分

2024-11-15T03:37:31.7233333+00:00

@Anonymous 我在上述repo中还有一个webapi的项目分支, 使用同样的pinvoke方法从Native Aot dll获取字符串并输出它的长度后, 也出现了较大的无法被释放的内存增长.
匿名

2024-11-15T07:26:12.0666667+00:00

你好，@William Liu。

通过Marshal.FreeHGlobal(resultPtr);你的确已经成功地释放了非托管字符串的内存。当你再次使用resultPtr获取非托管字符串时，就出现违规访问的异常。

更多有关Marshal.FreeHGlobal();的回收内存，你可以参考文档。

而你的内存无法被释放的原因是new string('a', length).这即使编写在Wpf中，再通过GC.Collect();也无法很好地释放内存。
William Liu 556 信誉分

2024-11-15T07:35:12.3533333+00:00
@Anonymous 我不是很理解你的答复, 你的意思是说在ClassLibrary1中提供string的方法GenerateString存在内存泄露吗?

public class StringGenerator { [UnmanagedCallersOnly(EntryPoint = "GenerateString")] public static IntPtr GenerateString(int length) { string result = new string('a', length); return Marshal.StringToHGlobalAnsi(result); } }

一个比较奇怪的点是, 如果这里产生了内存泄露, 那么我在wpf端反复pinvoke这个函数的时候应该会看到持续增长的内存分配. 但实际上观察到内存只是增长到某个值后就没有明显的增长了.
William Liu 556 信誉分

2024-11-15T07:39:32.47+00:00

你能帮我找到适当的逻辑, 完成在Wpf上调用native dll取得目标字符串并不要产生内存泄露吗?

我希望把工作中开发的真实程序的一部分逻辑用native Aot library的方式引入, 但是在做string交互的时候遇到了这个奇怪的内存泄露问题.

匿名

你好，@William Liu。

你可以像非托管代码那样亲自管理内存的分配与释放以防止内存泄漏。对ClassLibrary1的定义可以参考如下(使用unsafe时，需要Allow unsafe code in this project)。

    [UnmanagedCallersOnly(EntryPoint = "GenerateString")]
    unsafe public static IntPtr GenerateString(int length)
    {
        try
        {
			//开辟指定大小的内存，并返回IntPtr
            IntPtr ptr = Marshal.AllocHGlobal((length + 1) * sizeof(char));
			//获取指针，向内存写数据
            char* pChar = (char*)ptr.ToPointer();
            for (int i = 0; i < length; i++)
            {
                pChar[i] = 'A';
            }
            pChar[length] = '\0';
            return ptr;
        }
        catch (Exception e)
        {
            Console.Write(e.Message.ToString());
        }
        return IntPtr.Zero;
    }

在WPF项目中，通过Marshal.PtrToStringUni从内存中获取字符串，然后通过Marshal.FreeHGlobal释放这部分内存。

        try
        {
            int length = 10_000_000;
            resultPtr = GenerateString(length);
            string result = Marshal.PtrToStringUni(resultPtr);

            //MyTextBox.Text = "string length: " + result.Length + "\n" + "string: " + result;
            MyTextBox.Text += "string length: " + result.Length + "\n";
            // 记得释放非托管内存
            Marshal.FreeHGlobal(resultPtr);
        }
        catch (Exception exception)
        {
            MessageBox.Show(exception.Message.ToString());
        }

释放后再次访问该片内存时就是报AccessViolationException。从而防止内存泄漏。你可以发现，Marshal.FreeHGlobal释放内存后，内存的占用量任然没有降低多少，这应该是WPF程序特有的内存占用情况了。

William Liu 556 信誉分

2024-11-15T10:35:13.03+00:00

@Anonymous 非常感谢,这种方式的确解决了我的问题, 现在GC后看不到显著的内存增加了.