在进行软件开发的时候,可能会需要将用户输入的数据插入至网址(URL)中,但 URL 能够使用的字符是有限制的,错误格式的 URL 有机会使得 HTTP 客户端在访问 URL 资源时出现问题,也可能会导致透过 URL 来传递的参数有误。为了让 URL 可以传递任意字符的数据,对于不合法的字符,我们需要将其进行编码。例如在网址的查找(Query)部份(? 之后的部份),如果要在查找的参数值中使用 & 字符,就不能直接使用 & 字符,因为 & 字符在网址查找中是用来隔开不同的查找参数。参数值中的 & 字符,要用 %26 来取代,才可以正常地把 & 字符放进查找的参数值中。

这虽然是蛮基本的功能,但是在 crates.io 上却没有好用的套件,只好自己实作一个了。

URL Escape

「URL Escape」是笔者开发的套件,可以快速地编码(跳脱)或是解码(反跳脱)URL 的特殊字符。

Crates.io

Cargo.toml

url-escape = "*"

使用方法

编码

url_escape 这个 crate 提供了一些 encode_ 函数,可以针对不同的使用情境编码 URL 文字。

例如,要在 URL 的锚点(fragment),也就是 # 之后的部份加入文字的话,可以使用 encode_fragment 函数来跳脱文字中的 、"、<、> 和 ` 字符。

assert_eq!("a%20%3E%20b?", url_escape::encode_fragment("a > b?"));

以 _to_writer、_to_vec 或 _to_string 为名称后缀的函数可以方便用来产生 URL。

let mut url = String::from("https://");
assert_eq!("admin%40example.com", url_escape::encode_userinfo_to_string("admin@example.com", &mut url));
url.push_str("@127.0.0.1/");
assert_eq!("%E4%B8%AD%E6%96%87%E5%AD%97/eng/12%2034", url_escape::encode_path_to_string("中文字/eng/12 34", &mut url));
url.push('/');
assert_eq!(r"56%2F78", url_escape::encode_component_to_string("56/78", &mut url));
url.push('?');
assert_eq!(r"a=1&b=a%20b%20c", url_escape::encode_query_to_string("a=1&b=a b c", &mut url));

assert_eq!("https://admin%40example.com@127.0.0.1/%E4%B8%AD%E6%96%87%E5%AD%97/eng/12%2034/56%2F78?a=1&b=a%20b%20c", url);
解码
assert_eq!("中文字/eng/12 34", url_escape::decode("%E4%B8%AD%E6%96%87%E5%AD%97/eng/12%2034"));