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。
我们直接点开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文件的位置。
0x03 编写C#项目(Codding C#)
创建项目
简单创建一个C#控制台项目RustDLLTest
,如下图所示。
导入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调用约定。
运行程序
直接运行程序,控制台出现hello Rust DLL!
。大功告成。可能有部分小伙伴无法运行成功,会碰到BadImageFormatException。第四节将给出解决办法。
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?
这是由于架构不同的原因。这是一个坑。现在大部分电脑都是64位的架构,而Rust默认生成与电脑架构相同的类库。但是由于C#创建的程序默认是32位架构,导致运行时报错。有以下两种解决办法:
1、Rust生成x86架构的dll库
编译时指定架构,下面的代码是生成x86结构的dll库。
cargo build --release --target i686-pc-windows-msvc
2、指定C# 程序为64位架构
修改项目Properties
中的目标平台为x64。
两种办法都可以,选择其一即可。