com.github.ibole.infrastructure.web.servlet.utils.Encodes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infrastructure-all Show documentation
The all in one project of ibole infrastructure
The newest version!
package com.github.ibole.infrastructure.web.servlet.utils;

import com.github.ibole.infrastructure.web.exception.Exceptions;

import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang3.StringEscapeUtils;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

/**
 * 封装各种格式的编码解码工具类. 1.Commons-Codec的 hex/base64 编码 2.自制的base62 编码 3.Commons-Lang的xml/html escape
 * 4.JDK提供的URLEncoder
 */
public class Encodes {

  private static final String DEFAULT_URL_ENCODING = "UTF-8";
  private static final char[] BASE62 =
      "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".toCharArray();

  /**
   * Hex编码.
   * @param input byte[]
   * @return encoded Hex String
   */
  public static String encodeHex(byte[] input) {
    return new String(Hex.encodeHex(input));
  }

  /**
   * Hex解码.
   * @param input String
   * @return decoded Hex String
   */
  public static byte[] decodeHex(String input) {
    try {
      return Hex.decodeHex(input.toCharArray());
    } catch (DecoderException e) {
      throw Exceptions.unchecked(e);
    }
  }

  /**
   * Base64编码.
   * @param input byte[]
   * @return encoded Base64 String
   */
  public static String encodeBase64(byte[] input) {
    return new String(Base64.encodeBase64(input));
  }

  /**
   * Base64编码.
   * @param input String
   * @return encoded Base64 String
   */
  public static String encodeBase64(String input) {
    try {
      return new String(Base64.encodeBase64(input.getBytes(DEFAULT_URL_ENCODING)));
    } catch (UnsupportedEncodingException e) {
      return "";
    }
  }

  // /**
  // * Base64编码, URL安全(将Base64中的URL非法字符'+'和'/'转为'-'和'_', 见RFC3548).
  // */
  // public static String encodeUrlSafeBase64(byte[] input) {
  // return Base64.encodeBase64URLSafe(input);
  // }

  /**
   * Base64解码.
   * @param input String
   * @return decoded Base64 String
   */
  public static byte[] decodeBase64(String input) {
    return Base64.decodeBase64(input.getBytes());
  }

  /**
   * Base64解码.
   * @param input String
   * @return decoded String
   */
  public static String decodeBase64String(String input) {
    try {
      return new String(Base64.decodeBase64(input.getBytes()), DEFAULT_URL_ENCODING);
    } catch (UnsupportedEncodingException e) {
      return "";
    }
  }

  /**
   * Base62编码。
   * @param input byte[]
   * @return encoded String
   */
  public static String encodeBase62(byte[] input) {
    char[] chars = new char[input.length];
    for (int i = 0; i < input.length; i++) {
      chars[i] = BASE62[((input[i] & 0xFF) % BASE62.length)];
    }
    return new String(chars);
  }

  /**
   * Html 转码.
   * @param html String
   * @return escaped html String
   */
  public static String escapeHtml(String html) {
    return StringEscapeUtils.escapeHtml4(html);
  }

  /**
   * Html 解码.
   * @param htmlEscaped String
   * @return unescaped html String
   */
  public static String unescapeHtml(String htmlEscaped) {
    return StringEscapeUtils.unescapeHtml4(htmlEscaped);
  }

  /**
   * Xml 转码.
   * @param xml String
   * @return escaped xml String
   */
  public static String escapeXml(String xml) {
    return StringEscapeUtils.escapeXml10(xml);
  }

  /**
   * Xml 解码.
   * @param xmlEscaped String
   * @return unescaped xml String
   */
  public static String unescapeXml(String xmlEscaped) {
    return StringEscapeUtils.unescapeXml(xmlEscaped);
  }

  /**
   * URL 编码, Encode默认为UTF-8.
    *@param part String
   * @return encoded url String
   */
  public static String urlEncode(String part) {
    try {
      return URLEncoder.encode(part, DEFAULT_URL_ENCODING);
    } catch (UnsupportedEncodingException e) {
      throw Exceptions.unchecked(e);
    }
  }

  /**
   * URL 解码, Encode默认为UTF-8.
   * @param part String
   * @return decoded url String
   */
  public static String urlDecode(String part) {

    try {
      return URLDecoder.decode(part, DEFAULT_URL_ENCODING);
    } catch (UnsupportedEncodingException e) {
      throw Exceptions.unchecked(e);
    }
  }
}