0x01 Introduction
Rust语言突然很火,其运行速度堪比C++,有传言说可能会成为C/C++的替代品。但是这不是今天讨论的话题。还是来看下Rust强大的交叉编译吧,用Rust构建so库。网络上大都是在Linux系统下操作,包括官方文档也都是以Linux系统为例说明的。今天我们就来详细的讲一下如何在Windows下使用Rust构建so库,以及Rust构建的so文件与传统的C/C++有什么区别呢?
0x02 Tools
主要工具:
- Android Studio——编写Android Demo的工具
- IDEA(VS Code也可以)——编写Rust语言的工具
- Python——执行生成工具链的 python脚本
其它工具(非必须):
- IDA——反编译so文件
0x03 Environment
- 安装Rust语言环境
- 安装Python环境
- 安装Android SDK和Android NDK环境
0x04 Code
新建项目
IDEA安装Rust插件,新建项目。新建项目的项目名称如果存在多个单词建议使用下划线分隔,比如rust_jni_android,防止后面编译报warning。
添加依赖
在Cargo.toml
中添加JNI
依赖,并声明lib.rs
的crate_type
为cdylib
。告知编译器要编译成库。这样将会构建出动态库 (.so, .dylib 或 .dll 文件,取决你的操作系统类型)。
[dependencies]
# 添加 jni 依赖,并指定版本 0.17.0 截至目前是最新的版本
jni = { version = "0.17.0", default-features = false }
[lib]
crate_type = ["cdylib"]
编写代码
coding...
#![cfg(target_os = "android")]
#![allow(non_snake_case)]
use std::ffi::{CString, CStr};
use jni::JNIEnv;
use jni::objects::{JObject, JString};
use jni::sys::{jstring};
#[no_mangle]
pub unsafe extern fn Java_com_example_logproject_NativeMethodTest_hello(env: JNIEnv, _: JObject, j_recipient: JString) -> jstring {
let recipient = CString::from(
CStr::from_ptr(
env.get_string(j_recipient).unwrap().as_ptr()
)
);
let output = env.new_string("Hello ".to_owned() + recipient.to_str().unwrap()).unwrap();
output.into_inner()
}
#[no_mangle]
pub unsafe extern fn Java_com_example_logproject_NativeMethodTest_init(env: JNIEnv, jclass: JObject)
-> jstring {
// 将某个setEnable方法设置为true
let clazz = env.find_class("com/example/logproject/SDK").unwrap();
env.call_static_method(clazz, "setEnable", "(Z)V", &[JValue::from(true)]);
let str = "i'm a so by rust!";
let str = env.new_string(str.to_owned()).unwrap();
str.into_inner()
}
0x04 Building
准备工具链
用Python编译工具链。如果Android NDK安装的是默认路径,在任意位置新建一个文件夹(建议不要带有中文路径),然后使用CMD或者PowerShell执行下面的代码。如果NDK的位置不是默认安装位置,务必更换NDK_HOME的地址。
注:--api 29
中的29是Android SDK中下载的API版本。我这里项目中用的androidx,也下载过API 28的SDK,依然可以正常运行。
$NDK_HOME="$env:LOCALAPPDATA\Android\Sdk\ndk-bundle"
mkdir NDK
python "$NDK_HOME\build\tools\make_standalone_toolchain.py" --api 28 --arch arm64 --install-dir NDK/arm64
python "$NDK_HOME\build\tools\make_standalone_toolchain.py" --api 28 --arch arm --install-dir NDK/arm
python "$NDK_HOME\build\tools\make_standalone_toolchain.py" --api 28 --arch x86 --install-dir NDK/x86
生成过程大约需要2-3分钟,下面是生成结果。
创建Cargo配置文件
进入到Cargo的安装目录,查看目录下是否有config文件,没有就创建。默认应该是没有config文件的。
注:config文件不需要扩展名。
在config文件中添加以下内容,其中ar和linker中的路径请修改为上面创建工具链的路径
[target.aarch64-linux-android]
ar = "E:\\rust_jni\\NDK\\arm64\\bin\\aarch64-linux-android-ar.exe"
linker = "E:\\rust_jni\\NDK\\arm64\\bin\\aarch64-linux-android-clang.cmd"
[target.armv7-linux-androideabi]
ar = "E:\\rust_jni\\NDK\\arm\\bin\\arm-linux-androideabi-ar.exe"
linker = "E:\\rust_jni\\NDK\\arm\\bin\\arm-linux-androideabi-clang.cmd"
[target.i686-linux-android]
ar = "E:\\rust_jni\\NDK\\x86\\bin\\i686-linux-android-ar.exe"
linker = "E:\\rust_jni\\NDK\\x86\\bin\\i686-linux-android-clang.cmd"
安装交叉编译组件
在CMD或者PowerShell执行下面的代码,来支持各平台的编译,依然需要等待几分钟。
其中,各平台与Android NDK filter的映射关系如下:
aarch64-linux-android
对应 arm64-v8a
armv7-linux-androideabi
对应 armeabi-v7a
i686-linux-android
对应 x86
rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android
生成so库
三个平台需要以下三条命令分别生成,这里我仅测试过生成arm64-v8a
和armeabi-v7a
的so库。
cargo build --target aarch64-linux-android --release
cargo build --target armv7-linux-androideabi --release
cargo build --target i686-linux-android --release
以armeabi-v7a
为例,打开在IDEA中刚才编写的代码,在控制台中输入编译命令,回车。
so库在哪里呢?展开target
目录,我这里编译了两次,所以存在两个编译文件
然后在展开armv7-linux-androideabi-release-deps-librust_jni_android
,
然后拷到android的项目目录就行了。
0x05 Finally
所有的工作都已经完成了,生成的so也可以使用。
但是我发现几个问题:
- 生成的so文件在Android 5.1的系统可能会崩溃,Android 10正常。也有可能是我5.1手机的问题。我需要再进一步验证。
- 调试so文件比较复杂,我还没找到好的调试方法,如果有好的方法,大家可以分享下。
关于源码,我会在写完第二节放出。
参考资料:
rust-jni:https://docs.rs/jni/0.17.0/jni/
Building and Deploying aRust library on Android:https://mozilla.github.io/firefox-browser-architecture/experiments/2017-09-21-rust-on-android.html