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

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

import com.dahuatech.hutool.core.io.FileUtil;
import com.dahuatech.hutool.core.io.IoUtil;
import com.dahuatech.hutool.core.util.CharsetUtil;

import java.io.File;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.Charset;

/**
 * Base64工具类，提供Base64的编码和解码方案

 * base64编码是用64（2的6次方）个ASCII字符来表示256（2的8次方）个ASCII字符，

 * 也就是三位二进制数组经过编码后变为四位的ASCII字符显示，长度比原来增加1/3。
 *
 * @author Looly
 */
public class Base64 {

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

  /**
   * 编码为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 Base64Encoder.encodeUrlSafe(arr, lineSep);
  }

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

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

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

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

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

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

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

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

  /**
   * base64编码
   *
   * @param in 被编码base64的流（一般为图片流或者文件流）
   * @return 被加密后的字符串
   * @since 4.0.9
   */
  public static String encode(InputStream in) {
    return Base64Encoder.encode(IoUtil.readBytes(in));
  }

  /**
   * base64编码,URL安全的
   *
   * @param in 被编码base64的流（一般为图片流或者文件流）
   * @return 被加密后的字符串
   * @since 4.0.9
   */
  public static String encodeUrlSafe(InputStream in) {
    return Base64Encoder.encodeUrlSafe(IoUtil.readBytes(in));
  }

  /**
   * base64编码
   *
   * @param file 被编码base64的文件
   * @return 被加密后的字符串
   * @since 4.0.9
   */
  public static String encode(File file) {
    return Base64Encoder.encode(FileUtil.readBytes(file));
  }

  /**
   * base64编码,URL安全的
   *
   * @param file 被编码base64的文件
   * @return 被加密后的字符串
   * @since 4.0.9
   */
  public static String encodeUrlSafe(File file) {
    return Base64Encoder.encodeUrlSafe(FileUtil.readBytes(file));
  }

  /**
   * base64编码
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static String encode(byte[] source, String charset) {
    return Base64Encoder.encode(source);
  }

  /**
   * base64编码，URL安全的
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @since 3.0.6
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static String encodeUrlSafe(byte[] source, String charset) {
    return Base64Encoder.encodeUrlSafe(source);
  }

  /**
   * base64编码
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static String encode(byte[] source, Charset charset) {
    return Base64Encoder.encode(source);
  }

  /**
   * base64编码，URL安全的
   *
   * @param source 被编码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @since 3.0.6
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static String encodeUrlSafe(byte[] source, Charset charset) {
    return Base64Encoder.encodeUrlSafe(source);
  }

  /**
   * 编码为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) {
    return Base64Encoder.encode(arr, isMultiLine, isUrlSafe);
  }

  // -------------------------------------------------------------------- decode
  /**
   * base64解码
   *
   * @param source 被解码的base64字符串
   * @return 被加密后的字符串
   * @since 4.3.2
   */
  public static String decodeStrGbk(CharSequence source) {
    return Base64Decoder.decodeStr(source, CharsetUtil.CHARSET_GBK);
  }

  /**
   * base64解码
   *
   * @param source 被解码的base64字符串
   * @return 被加密后的字符串
   */
  public static String decodeStr(CharSequence source) {
    return Base64Decoder.decodeStr(source);
  }

  /**
   * base64解码
   *
   * @param source 被解码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   */
  public static String decodeStr(CharSequence source, String charset) {
    return Base64Decoder.decodeStr(source, CharsetUtil.charset(charset));
  }

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

  /**
   * base64解码
   *
   * @param base64 被解码的base64字符串
   * @param destFile 目标文件
   * @return 目标文件
   * @since 4.0.9
   */
  public static File decodeToFile(CharSequence base64, File destFile) {
    return FileUtil.writeBytes(Base64Decoder.decode(base64), destFile);
  }

  /**
   * base64解码
   *
   * @param base64 被解码的base64字符串
   * @param out 写出到的流
   * @param isCloseOut 是否关闭输出流
   * @since 4.0.9
   */
  public static void decodeToStream(CharSequence base64, OutputStream out, boolean isCloseOut) {
    IoUtil.write(out, isCloseOut, Base64Decoder.decode(base64));
  }

  /**
   * base64解码
   *
   * @param base64 被解码的base64字符串
   * @return 被加密后的字符串
   */
  public static byte[] decode(CharSequence base64) {
    return Base64Decoder.decode(base64);
  }

  /**
   * base64解码
   *
   * @param source 被解码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static byte[] decode(CharSequence source, String charset) {
    return Base64Decoder.decode(source);
  }

  /**
   * base64解码
   *
   * @param source 被解码的base64字符串
   * @param charset 字符集
   * @return 被加密后的字符串
   * @deprecated 编码参数无意义，作废
   */
  @Deprecated
  public static byte[] decode(CharSequence source, Charset charset) {
    return Base64Decoder.decode(source);
  }

  /**
   * 解码Base64
   *
   * @param in 输入
   * @return 解码后的bytes
   */
  public static byte[] decode(byte[] in) {
    return Base64Decoder.decode(in);
  }
}