com.dahuatech.hutool.core.codec.Base64Encoder Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.core.codec;

import com.dahuatech.hutool.core.util.CharsetUtil;
import com.dahuatech.hutool.core.util.StrUtil;

import java.nio.charset.Charset;

/**
 * Base64编码
 *
 * @author looly
 * @since 3.2.0
 */
public class Base64Encoder {

  private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8;
  /** 标准编码表 */
  private static final byte[] STANDARD_ENCODE_TABLE = { //
    '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', '+', '/' //
  };
  /** URL安全的编码表，将 + 和 / 替换为 - 和 _ */
  private static final byte[] URL_SAFE_ENCODE_TABLE = { //
    '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', '-', '_' //
  };

  // -------------------------------------------------------------------- encode
  /**
   * 编码为Base64，非URL安全的
   *
   * @param arr 被编码的数组
   * @param lineSep 在76个char之后是CRLF还是EOF
   * @return 编码后的bytes
   */
  public static byte[] encode(byte[] arr, boolean lineSep) {
    return encode(arr, lineSep, false);
  }

  /**
   * 编码为Base64，URL安全的
   *
   * @param arr 被编码的数组
   * @param lineSep 在76个char之后是CRLF还是EOF
   * @return 编码后的bytes
   * @since 3.0.6
   */
  public static byte[] encodeUrlSafe(byte[] arr, boolean lineSep) {
    return encode(arr, lineSep, true);
  }

  /**
   * base64编码
   *
   * @param source 被编码的base64字符串
   * @return 被加密后的字符串
   */
  public static String encode(CharSequence source) {
    return encode(source, DEFAULT_CHARSET);
  }

  /**
   * base64编码，URL安全
   *
   * @param source 被编码的base64字符串
   * @return 被加密后的字符串
   * @since 3.0.6
   */
  public static String encodeUrlSafe(CharSequence source) {
    return encodeUrlSafe(source, DEFAULT_CHARSET);
  }

  /**
   * base64编码
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   */
  public static String encode(CharSequence source, Charset charset) {
    return encode(StrUtil.bytes(source, charset));
  }

  /**
   * base64编码，URL安全的
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @since 3.0.6
   */
  public static String encodeUrlSafe(CharSequence source, Charset charset) {
    return encodeUrlSafe(StrUtil.bytes(source, charset));
  }

  /**
   * base64编码
   *
   * @param source 被编码的base64字符串
   * @return 被加密后的字符串
   */
  public static String encode(byte[] source) {
    return StrUtil.str(encode(source, false), DEFAULT_CHARSET);
  }

  /**
   * base64编码,URL安全的
   *
   * @param source 被编码的base64字符串
   * @return 被加密后的字符串
   * @since 3.0.6
   */
  public static String encodeUrlSafe(byte[] source) {
    return StrUtil.str(encodeUrlSafe(source, false), DEFAULT_CHARSET);
  }

  /**
   * 编码为Base64

   * 如果isMultiLine为true，则每76个字符一个换行符，否则在一行显示
   *
   * @param arr 被编码的数组
   * @param isMultiLine 在76个char之后是CRLF还是EOF
   * @param isUrlSafe 是否使用URL安全字符，一般为false
   * @return 编码后的bytes
   */
  public static byte[] encode(byte[] arr, boolean isMultiLine, boolean isUrlSafe) {
    if (null == arr) {
      return null;
    }

    int len = arr.length;
    if (len == 0) {
      return new byte[0];
    }

    int evenlen = (len / 3) * 3;
    int cnt = ((len - 1) / 3 + 1) << 2;
    int destlen = cnt + (isMultiLine ? (cnt - 1) / 76 << 1 : 0);
    byte[] dest = new byte[destlen];

    byte[] encodeTable = isUrlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE;

    for (int s = 0, d = 0, cc = 0; s < evenlen; ) {
      int i = (arr[s++] & 0xff) << 16 | (arr[s++] & 0xff) << 8 | (arr[s++] & 0xff);

      dest[d++] = encodeTable[(i >>> 18) & 0x3f];
      dest[d++] = encodeTable[(i >>> 12) & 0x3f];
      dest[d++] = encodeTable[(i >>> 6) & 0x3f];
      dest[d++] = encodeTable[i & 0x3f];

      if (isMultiLine && ++cc == 19 && d < destlen - 2) {
        dest[d++] = '\r';
        dest[d++] = '\n';
        cc = 0;
      }
    }

    int left = len - evenlen; // 剩余位数
    if (left > 0) {
      int i = ((arr[evenlen] & 0xff) << 10) | (left == 2 ? ((arr[len - 1] & 0xff) << 2) : 0);

      dest[destlen - 4] = encodeTable[i >> 12];
      dest[destlen - 3] = encodeTable[(i >>> 6) & 0x3f];

      if (isUrlSafe) {
        // 在URL Safe模式下，=为URL中的关键字符，不需要补充。空余的byte位要去掉。
        int urlSafeLen = destlen - 2;
        if (2 == left) {
          dest[destlen - 2] = encodeTable[i & 0x3f];
          urlSafeLen += 1;
        }
        byte[] urlSafeDest = new byte[urlSafeLen];
        System.arraycopy(dest, 0, urlSafeDest, 0, urlSafeLen);
        return urlSafeDest;
      } else {
        dest[destlen - 2] = (left == 2) ? encodeTable[i & 0x3f] : (byte) '=';
        dest[destlen - 1] = '=';
      }
    }
    return dest;
  }
}