在 iOS 上构建和部署 Rust 库

首先,我们必须安装 Xcode,然后设置 Xcode 构建工具。如果您已经安装了构建工具并且它们是最新的,则可以跳过此步骤。

xcode-select --install
xcode-select --install

接下来,我们需要确保安装了 Rust,并且我们可以交叉编译到 iOS 架构。为此,我们将使用rustup。如果你已经安装了 rustup,你可以跳过这一步。Rustup 从官方发布渠道安装 Rust,使您能够轻松地在不同的发布版本之间切换。它对你未来所有的 Rust 开发都有用,而不仅仅是在这里。

curl https://sh.rustup.rs -sSf | sh

将 iOS 架构添加到 rustup,以便我们可以在交叉编译期间使用它们。
这里列出了所有支持的架构: Rust Cross-compilation Platform Support

rustup target add aarch64-apple-ios armv7-apple-ios armv7s-apple-ios x86_64-apple-ios i386-apple-ios

当你安装 Rust 时,它也安装了 cargo,这是一个类似于 pip、gems 等的包管理器。现在我们将使用 cargo 来安装cargo-lipo。这是一个 cargo 子命令,它自动创建一个用于 iOS 的通用库。没有这个箱子,交叉编译 Rust 以在 iOS 上工作将变得非常困难。

cargo install cargo-lipo

现在我们都准备好了,可以开始了。让我们创建项目目录。

mkdir greetings
cd greetings
cargo new cargo
mkdir iOS

cargo new cargo建立一个全新的 Rust 项目,其默认文件和目录位于名为cargo. 在这个目录中有一个名为 的文件Cargo.toml,它是包管理器描述符文件,还有一个子目录,src其中包含一个名为lib.rs. 这将包含我们将要执行的 Rust 代码。

我们这里的 Rust 项目是一个超级简单的 Hello World 库。它包含一个函数rust_greeting,该函数接受一个字符串参数并返回一个字符串问候该参数。因此,如果参数是“world”,则返回的字符串是“Hello world”。

打开cargo/src/lib.rs并输入以下代码。

use std::os::raw::{c_char};
use std::ffi::{CString, CStr};

#[no_mangle]
pub extern fn rust_greeting(to: *const c_char) -> *mut c_char {
    let c_str = unsafe { CStr::from_ptr(to) };
    let recipient = match c_str.to_str() {
        Err(_) => "there",
        Ok(string) => string,
    };

    CString::new("Hello ".to_owned() + recipient).unwrap().into_raw()
}

#[no_mangle]
pub extern fn rust_greeting_free(s: *mut c_char) {
    unsafe {
        if s.is_null() { return }
        CString::from_raw(s)
    };
}

让我们来看看这里发生了什么。

由于我们将从非 Rust 代码调用这个库,我们实际上将通过 C 桥调用它。#[no_mangle]告诉编译器不要像默认情况下那样破坏函数名,确保我们的函数名被导出,就像它是用 C 语言编写的一样。

extern告诉 Rust 编译器这个函数将从 Rust 外部调用,因此确保它是使用 C 调用约定编译的。

接受的字符串rust_greeting是指向 C 字符数组的指针。然后我们必须将字符串从 C 字符串转换为 Rust 字符串str。CStr首先我们从指针创建一个对象。然后我们将其转换为 astr并检查结果。如果发生错误,则没有提供 arg 并且我们替换there,否则我们使用提供的字符串的值。然后我们将提供的字符串附加到我们的问候字符串的末尾以创建我们的返回字符串。然后将返回字符串转换为 aCString并传递回 C 代码。

使用CString并返回原始表示将字符串保留在内存中并防止它在函数结束时被释放。如果要释放内存,返回给调用者的指针现在将指向空内存——或者可能完全指向其他东西。但是,通过确保字符串在函数执行完成后仍然存在,我们已经分配了内存并且不再有任何句柄。这是内存泄漏的一个秘诀,因此我们必须提供第二个函数rust_greeting_free,它接受一个指向 C 字符串的指针并释放该内存。我们必须记住rust_greeting_free从我们的 iOS 代码调用以确保我们不会遇到问题。

我们还需要创建我们的 C 桥。cargo/src在名为greetings.h. 在该文件中,让我们定义 C 接口的外观。我们需要确保我们想要从 iOS 调用的每个 Rust 函数都在这里定义。

#include <stdint.h>

const char* rust_greeting(const char* to);
void rust_greeting_free(char *);

让我们构建我们的代码以确保它有效。为此,我们必须完成我们的Cargo.toml文件。这将告诉 cargo 为我们的代码创建静态库和 C 动态库。

[package]
name = "greetings"
version = "0.1.1"
authors = ["fluffyemily <fluffyemily@mozilla.com>"]
description = "Example static library project built for iOS"
publish = false

[lib]
name = "greetings"
crate-type = ["staticlib", "cdylib"]

我们需要使用cargo-lipo. 的构建工件将放置在cargo/target/. 我们感兴趣的通用 iOS 库可以在cargo/target/universal/release/libgreetings.a.

cd cargo
cargo lipo --release

这就是我们的 Rust 库。让我们把它与一个 iOS 项目联系起来。

打开 Xcode 并创建一个新项目。转到File\New\Project…并选择iOS\Application\Single View Application模板。此模板尽可能接近默认的 iOS 应用程序。点击Next。

image.png

调用该项目Greetings,使其成为 Swift 项目。单击Next以选择位置。我们正在使用之前创建的 ios 目录。如果您选择另一个位置,您将不得不修改我们稍后设置的一些路径。点击Create。

image.png

从项目导航器中选择 Greetings 项目,然后确保选择了 Greetings 目标。打开General选项卡。向下滚动到该Linked Frameworks and Libraries部分。

image.png

通过从 finder 中拖入您的libgreetings.a库,或单击列表底部的 +,单击“添加其他...”并导航至 来导入您的库cargo/target/universal/release/。选择libgreetings.a然后单击Open。

链接libresolv.tbd。单击 Linked Frameworks 列表底部的 +,然后在搜索框中键入 libresolv。选择libresolv.tbd然后“添加”。

image.png

iOS 将需要一个桥接标头来访问我们创建的 C 标头。首先,让我们导入greetings.h到我们的 Xcode 项目中,以便我们可以链接到它。转到File\Add files to "Greetings"...导航到greetings.h并选择Add。

要创建我们的桥接头,请转到File\New\File...。iOS\Source\Header File从提供的选项中选择并选择Next。命名文件Greetings-Bridging-Header.h并选择Create.

image.png

打开桥接头并将其修改为如下所示:

#ifndef Greetings_Bridging_Header_h
#define Greetings_Bridging_Header_h

#import "greetings.h"

#endif

我们需要将桥接标头告知 Xcode。从项目导航器中选择 Greetings 项目,然后确保选择了 Greetings 目标并打开 Build Settings 选项卡。将Objective-C Bridging Header选项值设置为$(PROJECT_DIR)/Greetings/Greetings-Bridging-Header.h

image.png

我们还需要告诉 Xcode 在哪里寻找我们的链接库。在同一个 Build Settings 窗格中,将Library Search Paths选项值修改为$(PROJECT_DIR)/../../cargo/target/universal/release

image.png

构建你的 xcode 项目,一切都应该编译。

所以,现在我们已经将 Rust 库导入到我们的 iOS 项目中并成功链接到它。但是我们仍然需要调用它。去File\New\File...。iOS\Source\Swift File从提供的选项中选择并选择Next。命名命名它RustGreetings。

image.png

添加以下代码:

class RustGreetings {
    func sayHello(to: String) -> String {
        let result = rust_greeting(to)
        let swift_result = String(cString: result!)
        rust_greeting_free(UnsafeMutablePointer(mutating: result))
        return swift_result
    }
}

这将创建一个新类,我们将使用它作为调用我们的 Rust 库的接口。这将使我们能够从应用程序的主要代码中抽象出细微差别,包括从 C 字符串到 Swift 字符串的转换,并确保我们不会忘记调用我们的自由函数并无意中引入内存泄漏!

打开ViewController.swift。在函数内部viewDidLoad添加以下代码:

let rustGreetings = RustGreetings()
print("\(rustGreetings.sayHello(to: "world"))")

现在构建您的项目并运行。模拟器将打开并开始运行您的应用程序。当视图加载时,“Hello world”将在 Xcode 的控制台窗口中输出。

你可以在Github上找到这个代码

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容