在实作多国语言网页的时候,除了网页后端程序需要拥有多国语言支持之外,前端程序也要跟着支持才行。怎么说呢?假设有个支持中文、英文的网页,我们在程序后端必须要想办法判断访客所使用的语言来决定前端网页到底要显示中文还是英文。而在网页上出现的文字可能会有两种情形:第一种,文字是直接显示在网页上的,后端程序所得到的中文或是英文文字可以透过 HTML 模板引擎,直接将文字填入 HTML 中,显示在网页上。第二种,文字一开始不会显示在网页,而是要透过网页跟用户交互之后才显示出来的消息,这种文字消息通常会需要经过 JavaScript 程序来判断要输出哪个文字,或是要组合出什么文字,后端程序就必须要有一个方式将中文或是英文文字预先喂给前端的 JavaScript 程序来使用。

第一种情况的实作方式很简单,只要参考这篇文章,让 Rust 程序拥有多国语言的语库之后,再根据访客所使用的语言来搜索要填空到 HTML 模板引擎的文字即可。这篇文章会着重介绍第二种情况的实作方式。

Map to JavaScript in HTML

「Map to JavaScript in HTML」是笔者开发的套件,可以将任意 key-value 形式的字符串所组成的 Map 结构实体,转成 JavaScript 的对象,并填写至 HTML 语法中。

Crates.io

Cargo.toml

map-to-javascript-html = "*"

使用方法

为了要将 JavaScript 程序插入至 HTML 语法中,建议使用 HTML 模板引擎来进行。假设 HTML 模板引擎是 Handlebars,我们可以在要处理文字的 JavaScript 程序之前,插入以下这段语法:

<script>
var _text = {};
{{{text}}}
</script>

语法中的 _text 这个变量名称,可以设置成其它的名称,但不要跟已存在的名称重复。

map_to_javascript_html 这个 crate 提供的 MapToJavaScriptHTML 特性,可以让 Map 相关的结构实体拥有以 to_javascript_html 为名称前缀的方法,能将自身转成类似以下的 JavaScript 程序语法:

_text['key1'] = 'value1';
_text['key2'] = 'value2';
_text['key3'] = 'value3';

举例来说:

use std::collections::BTreeMap;

use map_to_javascript_html::MapToJavaScriptHTML;

let mut map = BTreeMap::new();

map.insert("hello", "Hello world!");
map.insert("welcome", "Welcome to my website.");
map.insert("other keys", "Hello world!");

let text = map.to_javascript_html("_text");

以上程序运行完后,text 变量所保存的值是一个字符串,这个字符串就是将 map 这个 BTreeMap 结构实体,转成 HTML 语法中的 JavaScript 程序语法的结果。

「HTML 语法中的 JavaScript 程序语法」是什么意思?跟一般的「JavaScript 代码」有什么不同吗?

这样说好了,如果我们直接把一般的「JavaScript 代码」贴到 HTML 语法中的 <script> 标签内,如果这段「JavaScript 代码」内出现 </script> 这段子字符串,那么这整个 HTML 语法会出现严重的问题。而「Map to JavaScript in HTML」套件,会帮忙进行字符跳脱处理,可以确保任意字符串都可以转成能直接嵌入在 HTML 语法中的 JavaScript 程序语法。

透过 Handlebars,用 text 变量所保存的字符串取代模板中的 {{{text}}},可以得到以下的 HTML 语法:

<script>
var _text = {};
_text["hello"]="Hello world!";_text["other keys"]="Hello world!";_text["welcome"]="Welcome to my website.";
</script>

如此一来,在 JavaScript 程序中,我们就可以借由读取 _text 变量的方式,来动态取得需要用到的文字了!

以 _to_string、_to_vec、_to_writer 为名称后缀的方法,可以用来产生 HTML。

另外还有以 to_javascript_html_with_keys 为名称前缀的方法,可以用来过滤要输出的 key-value 组合。

use std::collections::BTreeMap;

use map_to_javascript_html::MapToJavaScriptHTML;

let mut map = BTreeMap::new();

map.insert("hello", "Hello world!");
map.insert("welcome", "Welcome to my website.");
map.insert("other keys", "Hello world!");

let text = map.to_javascript_html_with_keys("_text", &["hello", "welcome"]);

assert_eq!(r#"_text["hello"]="Hello world!";_text["welcome"]="Welcome to my website.";"#, text);

Serde 框架支持

激活 serde 特色即可让这个套件也支持 Serde 框架提供的一些 Map 结构体。

[dependencies.map-to-javascript-html]
version = "*"
features = ["serde"]