使用 tide、handlebars、rhai、graphql 开发 Rust web 前端(3)- rhai 脚本、静态/资源文件、环境变量等

前 2 篇文章《crate 选择及环境搭建》《获取并解析 GraphQL 数据》中,我们已经整合应用 tide、graphql-client、handlebars,以及 surf,从 GraphQL 服务后端 API 获取 GraphQL 数据并解析、渲染到 html 模板。这已经是一个完整的技术组合,其成熟度足以用于生产环境,构建自己的想法和应用了。

handlebars 模板支持 JavaScript 脚本及助手代码,应用方面非常灵活和强大。handlebars-rust 模板引擎是对 handlebars 模板语法规范的 Rust 实现,在前文中评测中(详见 crate 选择及环境搭建),笔者提及:此次实践选择 handlebars-rust 模板引擎,主要是因为其对 rhai(Rust 的嵌入式脚本引擎)的支持方面,笔者非常感兴趣,是故选择。

所以本文是一个补充:我们补充整合 Rust 的嵌入式脚本引擎—— rhai 脚本语言的应用实践。开发者可以在项目中,用性能出众、语法类同 Rust 语言的 RhaiScript 脚本,替代 JavaScript,为数据展示和页面渲染提供辅助。

rhai 嵌入式脚本语言

基于 Rust 语言丰富和创新的特性,以及超高性能的执行效率,目前在开源界,产生了众多 Rust 语言的嵌入式脚本引擎。rhai 是新兴的,但创新性较高的一个。其在 Rust 语言特性之上实现,具有 no-std 特性,以及动态类型。编译时开销非常低,但执行效率很可观:在单核 2.3 GHz 的 Linux 虚拟机上,0.3 秒内,达到了超百万次迭代。

rhai 脚本语言可以独立使用,也可以嵌入 Rust 代码中使用。作为 Rust 的内嵌代码使用时,可以和原生 Rust 代码一样,可以调用其它 crate。尤其是,rhai 支持模块/库的动态加载、解析,并且支持最小构建。

  • 类似于 Rust + JavaScript,且具有动态类型。
  • 与 Rust 函数和类型紧密集成。
  • 通过外部作用域,将 Rust 变量/常量无损传递到脚本中,无需实现任何特殊特性。
  • 从 Rust 代码内,轻松调用脚本定义的函数。
  • 很少的依赖项,实际必须具有的仅 2 个第三方 Rust crate。
  • 动态:函数重载、运算符过载、函数指针可动态调度。
  • 动态加载的模块,以组织代码库。
  • 可以捕获共享变量的闭包。
  • 支持面向对象编程(OOP)。
  • 支持大多数构建目标,包括 no-std、WebAssembly(WASM)等。
  • 可自行精确禁用关键字、运算符,以限制语言。
  • 可用作 DSL。
  • ……

总体来说,rhai 提供了一种安全、简单的方式,向任何应用程序添加以 Rust 语法编写的脚本,但保持了 Rust 语言“零开销”的执行效率。rhai 可以给 Rust 生态带来很多扩展。详细优势可参阅 rhai 文档,其开源仓库 rhaiscript/rhai/examples 提供了大量示例代码:包括 Rust 内嵌代码、独立脚本。

Rust web 项目中对 rhai 的使用,主要是在模板的渲染过程中。如作为模板内嵌助手脚本,对获取到的 API 数据进行计算。由此说来,即是在 handlebars-rust 模板引擎层面的使用。

Cargo.toml 中,启用 handlebars 依赖项的 script_helper 特性。

handlebars = { version = "4.0.0", features = ["script_helper"] }

rhai 脚本示例

在目录 frontend-handlebars 中,创建 scripts 目录,以及 scripts/length.rhai 文件。

scripts/length.rhai 文件的代码是一个最简单的可用于 handlebars 模板的 rhai 脚本示例:计算传入的数据的字符长度。


#![allow(unused)]
fn main() {
let username = params[0];

username.len()
}

这个代码没什么需要解说的,如果一定要说点什么,那就是 params[0] 表示的含义是:由模板传入脚本的第一个参数,多个参数类推。

向模板注册脚本

src/routes/users.rs 文件中,在模板声明语句之后,注册脚本名称和文件路径:


#![allow(unused)]
fn main() {
    let mut user_index: Tpl = Tpl::new("users/index").await;
    user_index
        .reg
        .register_script_helper_file(
            "length",
            format!("{}{}", "scripts/", "length.rhai"),
        )
        .unwrap();
}

:实际项目中,将字面量 "scripts/" 通过配置环境变量来读取,是较好的体验。

模板中使用脚本

脚本助手的使用语法为 {{<helper_name> helper.args}}。我们注册脚本助手时,指定的助手名称为 length,所以 {{length u.username}} 即可。如 templates/users/index.html 中的用法:

    <ul>
      {{#each allUsers as |u|}}
        <li><b>{{u.username}} - (length: {{length u.username}})</b></li>
        <ul>
          <li>{{ u.id }}</li>
          <li>{{ u.email }}</li>
        </ul>
      {{/each}}
    </ul>

现在,编译和运行后,你可以看到用户列表页面,用户名的括号内,显示了用户名称的字符长度。

静态/资源文件、环境变量等

  • 静态/资源文件(样式表、图像、js,以及其它)的使用,是规范的 html 标签和元素的语法。静态/资源文件的服务路径,属于 tide 的路由配置:一个 serve_dir 方法,指定为放置静态/资源文件(样式表、图像、js,以及其它)的路径即可。如:

#![allow(unused)]
fn main() {
  app.at("/static").serve_dir("./static").unwrap();

  app.at("/").get(index);
  app.at("users").get(user_index);
  ……
}

至此,《使用 tide、handlebars、rhai、graphql 开发 Rust web 前端》第一阶段就结束了;第二阶段,将专注于 cookie/session、rhai、jwt-auth,以及复杂的 GraphQL 查询等。

谢谢您的阅读!