参考:https://studygolang.com/pkgdoc
导入方式:
import "encoding/base64"
base64实现了RFC 4648规定的base64编码。Base64是网络上最常见的用于传输8Bit字节码的编码方式之一,Base64就是一种基于64个可打印字符(即6Bits)来表示二进制数据(即8Bits)的方法。Base64编码是从二进制到字符的过程,可用于在HTTP环境下传递较长的标识信息,这样更适合放在URL中进行传递。此时,采用Base64编码具有不可读性,需要解码后才能阅读。
该编码的规则就是:
- 把3个字符变成4个字符:方法就是先将3个8Bits(3*8=24Bits)的值分成4个6Bits的值(4*6=24Bits),然后在这四个6Bits值前添加两个0将其变为8Bits的值,这样就能够保证生成的4个值表示的值大小为(0~63),即可以将其转成对应的ASCII码(64个可打印字符)举例:
转换前:
拆分成4份:
高位补0:
对应的值为:
转成对应的ASCII码: c z E z
- 每76个字符加一个换行符
- 最后的结束符也要处理
type Encoding
type Encoding struct {
// 内含隐藏或非导出字段
}
双向的编码/解码协议,根据一个64字符的字符集定义,RFC 4648标准化了两种字符集。默认字符集用于MIME(RFC 2045)和PEM(RFC 1421)编码;另一种用于URL和文件名,用'-'和'_'替换了'+'和'/'。
func NewEncoding
func NewEncoding(encoder string) *Encoding
使用给出的字符集生成一个*Encoding,字符集必须是64字节的字符串。
Variables
var StdEncoding = NewEncoding(encodeStd)
RFC 4648定义的标准base64编码字符集。
var URLEncoding = NewEncoding(encodeURL)
RFC 4648定义的另一base64编码字符集,用于URL和文件名。
下面的两个函数分别就是编码和解码的过程:
func (*Encoding) EncodeToString
func (enc *Encoding) EncodeToString(src []byte) string
返回将src编码后的字符串。
func (*Encoding) DecodeString
func (enc *Encoding) DecodeString(s string) ([]byte, error)
返回base64编码的字符串s代表的数据。
举例:
package main
import(
"fmt"
"encoding/base64"
) func main() {
msg := "Hello,world" //11个字符应该装成15个base64编码的字符
encoded := base64.StdEncoding.EncodeToString([]byte(msg))
fmt.Println(encoded) //SGVsbG8sd29ybGQ=,后面的=是作填充用的
decoded, err := base64.StdEncoding.DecodeString(encoded)
if err != nil {
fmt.Println("decode error:", err)
return
}
fmt.Println(string(decoded))//Hello,world
}
下面的方法不是将他们编码成字符串:
解码字符:
func (*Encoding) DecodedLen
func (enc *Encoding) DecodedLen(n int) int
返回n字节base64编码的数据解码后的最大长度。
func (*Encoding) Decode
func (enc *Encoding) Decode(dst, src []byte) (n int, err error)
将src的数据解码后存入dst,最多写DecodedLen(len(src))字节数据到dst,并返回写入的字节数。 如果src包含非法字符,将返回成功写入的字符数和CorruptInputError。换行符(\r、\n)会被忽略。
举例:
package main
import(
"encoding/base64"
"log"
"fmt"
"io"
) func main() {
encoded := "Zm9vLGJhcg=="
n := base64.StdEncoding.DecodedLen(len(encoded))//DecodedLen返回len(encoded)字节base64编码的数据解码后的最大长度
fmt.Println(n) //
dbuf := make([]byte, n)
_, err :=base64.StdEncoding.Decode(dbuf, []byte(encoded)) if err != nil && err != io.EOF {
log.Fatal("Read failed", err)
}
fmt.Printf("decoded result : %s\n", dbuf) //decoded result : foo,bar
}
下面两个代码组合进行编码:
func (*Encoding) EncodedLen
func (enc *Encoding) EncodedLen(n int) int
返回n字节数据进行base64编码后的最大长度。
func (*Encoding) Encode
func (enc *Encoding) Encode(dst, src []byte)
将src的数据编码后存入dst,最多写EncodedLen(len(src))字节数据到dst,并返回写入的字节数。
函数会把输出设置为4的倍数,因此不建议对大数据流的独立数据块执行此方法,使用NewEncoder()代替。
举例:
package main
import(
"encoding/base64"
"fmt"
) func main() {
decoded := "foo,bar"
n := base64.StdEncoding.EncodedLen(len(decoded))//DecodedLen返回len(encoded)字节base64编码的数据解码后的最大长度
fmt.Println(n) //
dbuf := make([]byte, n)
base64.StdEncoding.Encode(dbuf, []byte(decoded)) fmt.Printf("encode result : %s\n", dbuf) //encode result : Zm9vLGJhcg==
}
下面就是生成编码器和解码器的方法,其实和上面的Encode和Decode实现的效果一样,在编码的是大数据流时使用下面的方法:
func NewEncoder(可写Write)
func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
创建一个新的base64流编码器。写入的数据会在编码后再写入w,base32编码每3字节执行一次编码操作;写入完毕后,使用者必须调用Close方法以便将未写入的数据从缓存中刷新到w中。
举例:
package main
import(
"encoding/base64"
"os"
) func main() {
input := []byte("foo,bar")
encoder := base64.NewEncoder(base64.StdEncoding, os.Stdout) //生成一个编码器,会将调用Write()写入的值编码后写到os.Stdout中
encoder.Write(input) encoder.Close()
//返回Zm9vLGJhcg==
}
func NewDecoder(可读-Read)
func NewDecoder(enc *Encoding, r io.Reader) io.Reader
创建一个新的base64流解码器。
举例:
package main
import(
"encoding/base64"
"strings"
"log"
"fmt"
"io"
) func main() {
encoded := "Zm9vLGJhcg=="
decoder := base64.NewDecoder(base64.StdEncoding, strings.NewReader(encoded))
n := base64.StdEncoding.DecodedLen(len(encoded))//DecodedLen返回len(encoded)字节base64编码的数据解码后的最大长度
fmt.Println(n) //
dbuf := make([]byte, n)
_, err := decoder.Read(dbuf)//将读取的解码后的值写到dbuf中
if err != nil && err != io.EOF {
log.Fatal("Read failed", err)
}
fmt.Printf("decoded result : %s\n", dbuf) //decoded result : foo,bar
}