Rust与C#交互——生成DLL库

0x00 开篇(Intro)

Rust的强大之处只有你想不到,没有它做不到。既然是打折取代C++语言的旗号,那么肯定只要C++能做到的,他也可以做到。这篇教程来说一下如何使用Rust来创建一个DLL库,并且从C#来调用它。

0x01 所需软件(Software)

  • CLion
  • Visual Studio 2013

注:CLion可以使用VSCode,甚至是记事本来代替,本教程以CLion为例。Visual Studio 2013以上的版本即可。

0x02 编写Rust库(Coding Rust)

创建项目

首先使用CLion创建一个rust lib

image

我们直接点开Cargo.toml,按照如下配置添加。

[lib]
name = "TestDLL" #生成dll的文件名
crate-type = ["cdylib"]

这里是配置这个项目生成一个lib库。其中,name是最终生成的DLL库的名称,可以随便起名,我这里按照C#的命名规则来命名为TestDLL。crate-type设置为cdylib。关于为什么这里是cdylib,第四节会解释原因。

简单函数编写

创建完成后,CLion会自动生成单元测试代码,我们可以先直接注释掉。我们先从简单的写起。题目:编写一个函数,输出hello Rust dLL!。代码如下:

#[no_mangle]
pub extern fn hello() {
    println!("hello Rust DLL!");
}

其中,#[no_mangle]为了编译时函数方法名不会被混淆。extern表示该函数是一个外部函数接口。

编译DLL库

控制台直接输入cargo build --release编译。如下图,可以找到DLL文件的位置。

image-20220108132949115

0x03 编写C#项目(Codding C#)

创建项目

简单创建一个C#控制台项目RustDLLTest,如下图所示。

image
导入DLL库

C#导入DLL库的方式有很多种,但是使用Rust生成的DLL库,只能使用DllImoport来导入。具体原因,第四节给出解释。

class Program
    {
        [DllImport("TestDLL.dll", EntryPoint = "hello", CallingConvention = CallingConvention.Cdecl)]
        public static extern void hello();

        static void Main(string[] args)
        {
            hello();
            Console.ReadLine();
        }
    }

DllImport有三个参数,第一个是dll的路径,由于我将dll放到了和生成exe的目录同目录下(如下图),这里就使用了相对路径。第二个参数是ll的入口点,也就是Rust中的方法名。第三个CallingConvention = CallingConvention.Cdecl表示C调用约定。

image
运行程序

直接运行程序,控制台出现hello Rust DLL!。大功告成。可能有部分小伙伴无法运行成功,会碰到BadImageFormatException。第四节将给出解决办法。

image

0x04 答疑解惑(QA)

什么是cdylib

cdylib,是C Dynamic Library的简写,名为C规范动态库。可以生成被其它语言调用的库,也就是跨语言 FFI 使用。因为几乎所有语言都有遵循 C 规范的 FFI 实现,它会按照平台生成.so.dylib.dll等库。当然crate-type还有其它类型,这里暂不介绍了。

为什么只能使用DllImport导入?

DllImport的是标准的dll,可以是DELPHI、C++等各种语言写的标准dll。如果调用C语言等语言编写的普通dll,那么就要用DllImport,典型的像Windows API函数都是C语言编写的dll所以都要DllImport。项目引入的dll,是.NET的dll,它属于非标准dll,只是一个类库。

为什么会报BadImageFormatException?
image

这是由于架构不同的原因。这是一个坑。现在大部分电脑都是64位的加固,而Rust默认生成与电脑架构相同的类库。但是由于C#创建的程序默认是32位架构,导致运行时报错。有以下两种解决办法:

1、Rust生成x86架构的dll库

编译时指定架构,下面的代码是生成x86结构的dll库。

cargo build --release --target i686-pc-windows-msvc

2、指定C# 程序为64位架构

修改项目Properties中的目标平台为x64。

image

两种办法都可以,选择其一即可。

0x05 源码(Source Code)

关注公众号《Rust学习日记》,回复【dll】获取完整源码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350