Base64 是一种能将任意 Binary 数据用 64 种字符组合成字符串的方法,而这个 Binary 数据和字符串数据彼此之间是可以互相转换的,十分方便。在实际应用上,Base64 除了能将 Binary 数据可视化之外,也常用来表示数据加密过后的内容。然而,标准版本的 Base64 对于 URL 或是文件路径来说可能不是那么的友善,因为编码后的 Base64 数据可能有 + 或是 / 这两种字符。为了解决这个问题,Base64 有个变体称作「Base64-URL」,会将字符 + 对应到字符 -(减号),字符 / 对应到字符 _(底线),且用来 padding 的 = 字符通常为了节省长度而会被省略。

举例来说,

qL8R4QIcQ/ZsRqOAbeRfcZhilN+MksRtDaErMA==

以上的这个标准版本的 Base64 字符串,可以转成如下的「Base64-URL」字符串:

qL8R4QIcQ_ZsRqOAbeRfcZhilN-MksRtDaErMA

转换之后的字符串可以无痛被使用在 URL/URI 或是文件路径中。

有关 Base16、Base32、Base64 的定义,可以查阅 RFC4648。

Base64 URL

「Base64 URL」是笔者开发的套件,可以用来将任意数据编码成 Base64-URL 字符串,或是将 Base64-URL 字符串解码回原始数据。也可以将现有的 Base64 字符串转成 Base64-URL 字符串,或是将现有的 Base64-URL 字符串转成 Base64 字符串。

Crates.io

Cargo.toml

base64-url = "*"

使用方法

若要将任意数据编码成 Base64-URL 字符串,可以使用 encode 函数。

assert_eq!("SGVsbG8sIHdvcmxkIQ", base64_url::encode("Hello, world!"));

若要将 Base64-URL 字符串解码回原始数据,可以使用 decode 函数。

assert_eq!(b"Hello, world!", base64_url::decode("SGVsbG8sIHdvcmxkIQ").unwrap().as_slice());

若要将现有的 Base64 字符串转成 Base64-URL 字符串,可以使用 escape 函数。这个函数并不会花费运算资源去检查 Base64 字符串的正确性。

assert_eq!("SGVsbG8sIHdvcmxkIQ", base64_url::escape("SGVsbG8sIHdvcmxkIQ=="));

若要将现有的 Base64-URL 字符串转成 Base64 字符串,可以使用 unescape 函数。这个函数并不会花费运算资源去检查 Base64-URL 字符串的正确性。

assert_eq!("SGVsbG8sIHdvcmxkIQ==", base64_url::unescape("SGVsbG8sIHdvcmxkIQ"));

另外还有其它的 encode_*、decode_*、escape_*、unescape_* 函数,可以用在特定的场合。例如:

let hash = &[1, 2, 3, 4, 5, 6, 7, 8, 9];
let mut url = String::from("https://example.com/?hash=");

assert_eq!("AQIDBAUGBwgJ", base64_url::encode_to_string(hash, &mut url));
assert_eq!("https://example.com/?hash=AQIDBAUGBwgJ", url);