Base64 模块

Base64 模块提供用于

• 编码二进制字符串（包含非 ASCII 字符）为可打印 ASCII 字符串的方法。

• 解码此类编码字符串。

Base64 通常用于二进制数据不允许或不受支持的上下文中

• HTML 或 CSS 文件中的图像，或 URL 中的图像。

• 电子邮件附件。

Base64 编码字符串比其源大约三分之一。有关更多信息，请参阅 维基百科文章。

此模块提供三对编码/解码方法。在这些方法中进行选择应取决于

• 用于编码和解码的字符集。

• 是否使用“填充”。

• 编码字符串是否包含换行符。

注意：此页面上的示例假定包含的程序已执行

require 'base64'

编码字符集¶ ↑

Base64 编码字符串仅包含来自 64 个字符集的字符

• ('A'..'Z').

• ('a'..'z').

• ('0'..'9').

• =，'填充' 字符。

• 任一

  • %w[+ /]: RFC-2045 兼容；不适用于 URL。

  • %w[- _]: RFC-4648 兼容；适用于 URL。

如果您使用来自或放入 URL 的 Base64 编码字符串，则应选择 RFC-4648 兼容方法的此编码器-解码器对

• Base64.urlsafe_encode64 和 Base64.urlsafe_decode64。

否则，您可以在此模块中选择任意一对，包括上述一对或 RFC-2045 兼容对

• Base64.encode64 和 Base64.decode64。

• Base64.strict_encode64 和 Base64.strict_decode64。

填充¶ ↑

Base64 编码将三个输入字节更改为四个输出字符。

编码方法中的填充

填充 - 使用零、一个或两个尾部 = 字符扩展编码后的字符串 - 由方法 Base64.encode64、Base64.strict_encode64 和默认情况下 Base64.urlsafe_encode64 执行

Base64.encode64('s')                         # => "cw==\n"
Base64.strict_encode64('s')                  # => "cw=="
Base64.urlsafe_encode64('s')                 # => "cw=="
Base64.urlsafe_encode64('s', padding: false) # => "cw"

执行填充时，编码后的字符串始终为长度为 4n，其中 n 是非负整数

• 长度为 3n 的输入字节生成长度为 4n 的未填充输出字符

  # n = 1:  3 bytes => 4 characters.
  Base64.strict_encode64('123')      # => "MDEy"
  # n = 2:  6 bytes => 8 characters.
  Base64.strict_encode64('123456')   # => "MDEyMzQ1"
  

• 长度为 3n+1 的输入字节生成长度为 4(n+1) 的填充输出字符，末尾有两个填充字符

  # n = 1:  4 bytes => 8 characters.
  Base64.strict_encode64('1234')     # => "MDEyMw=="
  # n = 2:  7 bytes => 12 characters.
  Base64.strict_encode64('1234567')  # => "MDEyMzQ1Ng=="
  

• 长度为 3n+2 的输入字节生成长度为 4(n+1) 的填充输出字符，末尾有一个填充字符

  # n = 1:  5 bytes => 8 characters.
  Base64.strict_encode64('12345')    # => "MDEyMzQ="
  # n = 2:  8 bytes => 12 characters.
  Base64.strict_encode64('12345678') # => "MDEyMzQ1Njc="
  

当对正整数 n 抑制填充时

• 长度为 3n 的输入字节生成长度为 4n 的未填充输出字符

  # n = 1:  3 bytes => 4 characters.
  Base64.urlsafe_encode64('123', padding: false)      # => "MDEy"
  # n = 2:  6 bytes => 8 characters.
  Base64.urlsafe_encode64('123456', padding: false)   # => "MDEyMzQ1"
  

• 长度为 3n+1 的输入字节生成长度为 4n+2 的未填充输出字符，末尾有两个填充字符

  # n = 1:  4 bytes => 6 characters.
  Base64.urlsafe_encode64('1234', padding: false)     # => "MDEyMw"
  # n = 2:  7 bytes => 10 characters.
  Base64.urlsafe_encode64('1234567', padding: false)  # => "MDEyMzQ1Ng"
  

• 长度为 3n+2 的输入字节生成长度为 4n+3 的未填充输出字符，末尾有一个填充字符

  # n = 1:  5 bytes => 7 characters.
  Base64.urlsafe_encode64('12345', padding: false)    # => "MDEyMzQ"
  # m = 2:  8 bytes => 11 characters.
  Base64.urlsafe_encode64('12345678', padding: false) # => "MDEyMzQ1Njc"
  

解码方法中的填充

所有 Base64 解码方法都支持（但不要求）填充。

方法 Base64.decode64 不检查填充的大小

Base64.decode64("MDEyMzQ1Njc") # => "01234567"
Base64.decode64("MDEyMzQ1Njc=") # => "01234567"
Base64.decode64("MDEyMzQ1Njc==") # => "01234567"

方法 Base64.strict_decode64 严格执行填充大小

Base64.strict_decode64("MDEyMzQ1Njc")   # Raises ArgumentError
Base64.strict_decode64("MDEyMzQ1Njc=")  # => "01234567"
Base64.strict_decode64("MDEyMzQ1Njc==") # Raises ArgumentError

方法 Base64.urlsafe_decode64 允许在 str 中填充，如果存在，则必须正确：请参阅上面的 填充

Base64.urlsafe_decode64("MDEyMzQ1Njc") # => "01234567"
Base64.urlsafe_decode64("MDEyMzQ1Njc=") # => "01234567"
Base64.urlsafe_decode64("MDEyMzQ1Njc==") # Raises ArgumentError.

换行符¶ ↑

由 Base64.encode64 或 Base64.urlsafe_encode64 返回的编码字符串在每个 60 个字符序列后都有一个嵌入式换行符，并且如果非空，则在末尾

# No newline if empty.
encoded = Base64.encode64("\x00" *  0)
encoded.index("\n") # => nil

# Newline at end of short output.
encoded = Base64.encode64("\x00" *  1)
encoded.size        # => 4
encoded.index("\n") # => 4

# Newline at end of longer output.
encoded = Base64.encode64("\x00" * 45)
encoded.size        # => 60
encoded.index("\n") # => 60

# Newlines embedded and at end of still longer output.
encoded = Base64.encode64("\x00" * 46)
encoded.size                          # => 65
encoded.rindex("\n")                  # => 65
encoded.split("\n").map {|s| s.size } # => [60, 4]

要编码的字符串本身可能包含换行符，这些换行符编码为 Base64

  #   Base64.encode64("\n\n\n") # => "CgoK\n"
s = "This is line 1\nThis is line 2\n"
Base64.encode64(s) # => "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK\n"