netty系列之:java中的base64編碼器

flydean發表於2022-04-08
NettyJava

簡介

什麼是Base64編碼呢？在回答這個問題之前，我們需要了解一下計算機中檔案的分類，對於計算機來說檔案可以分為兩類，一類是文字檔案，一類是二進位制檔案。

對於二進位制檔案來說，其內容是用二進位制來表示的，對於人類是不可立馬理解的。如果你嘗試用文字編輯器開啟二進位制檔案，可能會看到亂碼。這是因為二進位制檔案的編碼方式和文字檔案的編碼方式是不一樣的，所以當文字編輯器嘗試將二進位制檔案翻譯成為文字內容的時候，就會出現亂碼。

對於文字檔案來說，也有很多種編碼方式，比如最早的ASCII編碼和目前常用的UTF-8和UTF-16等編碼方式。即使是文字檔案，如果你使用不同的編碼方式開啟，也可能會看到亂碼。

所以不管是文字檔案還是二進位制檔案也好，都需要進行編碼格式的統一。也就是說寫入的編碼是什麼樣子的，那麼資料讀取的編碼也應該和其匹配。

Base64編碼實際上就是將二進位制資料編碼成為視覺化ASCII字元的一種編碼方式。

為什麼會有這樣的要求呢？

我們知道計算機世界的發展不是一蹴而就的，它是一個慢慢成長的過程，對於字元編碼來說，最早只支援ASCII編碼，後面才擴充套件到Unicode等。所以對於很多應用來說除了ASCII編碼之外的其他編碼格式是不支援的，那麼如何在這些系統中展示非ASCII code呢？

解決的方式就是進行編碼對映，將非ASCII的字元對映成為ASCII的字元。而base64就是這樣的一種編碼方式。

常見的使用Base64的地方就是在web網頁中，有時候我們需要在網頁中展示圖片，那麼可以將圖片進行base64編碼，然後填充到html中。

還有一種應用就是將檔案進行base64編碼，然後作為郵件的附件進行傳送。

JAVA對base64的支援

既然base64編碼這麼好用，接下來我們來看一下JAVA中的base64實現。

java中有一個對應的base64實現，叫做java.util.Base64。這個類是Base64的工具類，是JDK在1.8版本引入的。

Base64中提供了三個getEncoder和getDecoder方法，通過獲取對應的Encoder和Decoder，然後就可以呼叫Encoder的encode和decode方法對資料進行編碼和解碼，非常的方便。

我們先來看一下Base64的基本使用例子：

 // 使用encoder進行編碼
 String encodedString = Base64.getEncoder().encodeToString("what is your name baby?".getBytes("utf-8"));
 System.out.println("Base64編碼過後的字串 :" + encodedString);

 // 使用encoder進行解碼
 byte[] decodedBytes = Base64.getDecoder().decode(encodedString);

 System.out.println("解碼過後的字串: " + new String(decodedBytes, "utf-8"));

作為一個工具類，JDK中提供的Base64工具類還是很好用的。

這裡就不詳細講解它的使用，本篇文章主要分析JDK中Base64是怎麼實現的。

JDK中Base64的分類和實現

JDK中Base64類有提供了三個encoder方法，分別是getEncoder,getUrlEncoder和getMimeEncoder:

    public static Encoder getEncoder() {
         return Encoder.RFC4648;
    }

    public static Encoder getUrlEncoder() {
         return Encoder.RFC4648_URLSAFE;
    }

    public static Encoder getMimeEncoder() {
        return Encoder.RFC2045;
    }

同樣的，它也提供了三個對應的decoder，分別是getDecoder，getUrlDecoder，getMimeDecoder：

    public static Decoder getDecoder() {
         return Decoder.RFC4648;
    }

    public static Decoder getUrlDecoder() {
         return Decoder.RFC4648_URLSAFE;
    }

    public static Decoder getMimeDecoder() {
         return Decoder.RFC2045;
    }

從程式碼中可以看出，這三種編碼分別對應的是RFC4648，RFC4648_URLSAFE和RFC2045。

這三種都屬於base64編碼的變體，我們看下他們有什麼區別：

編碼名稱編碼字元編碼字元編碼字元
第62位第63位補全符
RFC 2045: Base64 transfer encoding for MIME+/= mandatory
RFC 4648: base64 (standard)+/= optional
RFC 4648: base64url (URL- and filename-safe standard)-_= optional

可以看到base64和Base64url的區別是第62位和第63位的編碼字元不一樣，而base64 for MIME跟base64的區別是補全符是否是強制的。

另外，對於Basic和base64url來說，不會新增line separator字元，而base64 for MIME在一行超出76字元之後，會新增'\r' 和 '\n'作為line separator。

最後，如果在解碼的過程中，發現有不存於Base64對映表中的字元的處理方式也不一樣，base64和Base64url會直接拒絕，而base64 for MIME則會忽略。

base64和Base64url的區別可以通過下面兩個方法來看出：

        private static final char[] toBase64 = {
            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
            'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
            'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
            'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
            '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
        };
        private static final char[] toBase64URL = {
            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
            'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
            'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
            'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
            '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_'
        };

而對MIME來說，定義了一個一行的最大字元個數,和換行符：

        private static final int MIMELINEMAX = 76;
        private static final byte[] CRLF = new byte[] {'\r', '\n'};

Base64的高階用法

一般情況下我們用Base64進行編碼的物件長度是固定的，我們只需要將輸入物件轉換成為byte陣列即可呼叫encode或者decode的方法。

但是在某些情況下我們需要對流資料進行轉換，這時候就可以用到Base64中提供的兩個對Stream進行wrap的方法：

        public OutputStream wrap(OutputStream os) {
            Objects.requireNonNull(os);
            return new EncOutputStream(os, isURL ? toBase64URL : toBase64,
                                       newline, linemax, doPadding);
        }
        public InputStream wrap(InputStream is) {
            Objects.requireNonNull(is);
            return new DecInputStream(is, isURL ? fromBase64URL : fromBase64, isMIME);
        }

這兩個方法分別對應於encoder和decoder。

總結

以上就是JDK中對Base64的實現和使用，雖然base64的變種有很多種，但是JDK中的Base64只實現了其中用處最為廣泛的3種。大家在使用的時候一定要區分具體是那種Base64的實現方式，以免出現問題。

本文已收錄於 http://www.flydean.com/14-1-1-java-base64/

最通俗的解讀，最深刻的乾貨，最簡潔的教程，眾多你不知道的小技巧等你來發現！

歡迎關注我的公眾號:「程式那些事」,懂技術，更懂你！

相關文章