封装各种格式的编码解码工具类

曾经终败给现在 2022-05-14 08:17 216阅读 0赞

/**
     * Copyright (c) 2005-2012 springside.org.cn
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     */
    package com.mls.sopp.util.tool.codec;
    
    import com.mls.sopp.util.tool.lang.ExceptionUtils;
    import com.mls.sopp.util.tool.lang.StringUtils;
    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 org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    import java.io.UnsupportedEncodingException;
    import java.net.URLDecoder;
    import java.net.URLEncoder;
    import java.util.regex.Pattern;
    
    /**
     * 封装各种格式的编码解码工具类.
     * 1.Commons-Codec的 hex/base64 编码
     * 2.自制的base62 编码
     * 3.Commons-Lang的xml/html escape
     * 4.JDK提供的URLEncoder
     * @version 2013-01-15
     */
    public class EncodeUtils {
    	
    	private static final Logger logger = LoggerFactory.getLogger(EncodeUtils.class);
    	private static final String DEFAULT_URL_ENCODING = "UTF-8";
    	private static final char[] BASE62 = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".toCharArray();
    
    	/**
    	 * Hex编码.
    	 */
    	public static String encodeHex(byte[] input) {
    		return new String(Hex.encodeHex(input));
    	}
    
    	/**
    	 * Hex解码.
    	 */
    	public static byte[] decodeHex(String input) {
    		try {
    			return Hex.decodeHex(input.toCharArray());
    		} catch (DecoderException e) {
    			throw ExceptionUtils.unchecked(e);
    		}
    	}
    
    	/**
    	 * Base64编码.
    	 */
    	public static String encodeBase64(byte[] input) {
    		return new String(Base64.encodeBase64(input));
    	}
    	
    	/**
    	 * Base64编码.
    	 */
    	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解码.
    	 */
    	public static byte[] decodeBase64(String input) {
    		return Base64.decodeBase64(input.getBytes());
    	}
    	
    	/**
    	 * Base64解码.
    	 */
    	public static String decodeBase64String(String input) {
    		try {
    			return new String(Base64.decodeBase64(input.getBytes()), DEFAULT_URL_ENCODING);
    		} catch (UnsupportedEncodingException e) {
    			return "";
    		}
    	}
    
    	/**
    	 * Base62编码。
    	 */
    	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 转码.
    	 */
    	public static String encodeHtml(String html) {
    		return StringEscapeUtils.escapeHtml4(html);
    	}
    
    	/**
    	 * Html 解码.
    	 */
    	public static String decodeHtml(String htmlEscaped) {
    		return StringEscapeUtils.unescapeHtml4(htmlEscaped);
    	}
    
    	/**
    	 * Xml 转码.
    	 */
    	public static String encodeXml(String xml) {
    		return StringEscapeUtils.escapeXml(xml);
    	}
    
    	/**
    	 * Xml 解码.
    	 */
    	public static String decodeXml(String xmlEscaped) {
    		return StringEscapeUtils.unescapeXml(xmlEscaped);
    	}
    
    	/**
    	 * URL 编码, Encode默认为UTF-8. 
    	 */
    	public static String encodeUrl(String part) {
    		return encodeUrl(part, DEFAULT_URL_ENCODING);
    	}
    
    	/**
    	 * URL 编码, Encode默认为UTF-8. 
    	 */
    	public static String encodeUrl(String part, String encoding) {
    		if (part == null){
    			return null;
    		}
    		try {
    			return URLEncoder.encode(part, encoding);
    		} catch (UnsupportedEncodingException e) {
    			throw ExceptionUtils.unchecked(e);
    		}
    	}
    
    	/**
    	 * URL 解码, Encode默认为UTF-8. 
    	 */
    	public static String decodeUrl(String part) {
    		return decodeUrl(part, DEFAULT_URL_ENCODING);
    	}
    
    	/**
    	 * URL 解码, Encode默认为UTF-8. 
    	 */
    	public static String decodeUrl(String part, String encoding) {
    
    		try {
    			return URLDecoder.decode(part, encoding);
    		} catch (UnsupportedEncodingException e) {
    			throw ExceptionUtils.unchecked(e);
    		}
    	}
    	
    	/**
    	 * URL 解码（两次）, Encode默认为UTF-8. 
    	 */
    	public static String decodeUrl2(String part) {
    		return decodeUrl(decodeUrl(part));
    	}
    	
    	// 预编译XSS过滤正则表达式
    	private static Pattern p1 = Pattern.compile("<\\s*(script|link|style|iframe)(.|\\n)*<\\s*\\/\\s*\\1\\s*>\\s*", Pattern.CASE_INSENSITIVE);
    	private static Pattern p2 = Pattern.compile("\\s*on[a-z]+\\s*=\\s*(\"[^\"]+\"|'[^']+'|[^\\s]+)\\s*(?=>)", Pattern.CASE_INSENSITIVE);
    	private static Pattern p3 = Pattern.compile("\\s*(href|src)\\s*=\\s*(\"\\s*(javascript|vbscript):[^\"]+\"|'\\s*(javascript|vbscript):[^']+'|(javascript|vbscript):[^\\s]+)\\s*(?=>)", Pattern.CASE_INSENSITIVE);
    	private static Pattern p4 = Pattern.compile("epression\\((.|\\n)*\\);?", Pattern.CASE_INSENSITIVE);
    	
    	/**
    	 * XSS 非法字符过滤
    	 * 内容以开头的用以下规则（保留标签，去掉js脚本）：
    	 * 	1、<(script|link|style|iframe)(.|\n)*<\/\1>\s* 
    	 * 	2、\s*on[a-z]+\s*=\s*("[^"]+"|'[^']+'|[^\s]+)\s*(?=>) 
    	 * 	3、\s*(href|src)\s*=\s*("\s*(javascript|vbscript):[^"]+"|'\s*(javascript|vbscript):[^']+'|(javascript|vbscript):[^\s]+)\s*(?=>) 
    	 * 	4、epression\((.|\n)*\);? 
    	 * 其它情况下：进行HTML4编码
    	 * @author ThinkGem
    	 */
    	public static String xssFilter(String text) {
    		if (text != null){
    			String oriValue = StringUtils.trim(text), value = oriValue;
    			value = p1.matcher(value).replaceAll("");
    			value = p2.matcher(value).replaceAll("");
    			value = p3.matcher(value).replaceAll("");
    			value = p4.matcher(value).replaceAll("");
    			// 如果开始不是HTML，XML，JOSN格式，则再进行HTML的 "、<、> 转码。
    			if (!StringUtils.startsWithIgnoreCase(value, "") 	// HTML
    					&& !StringUtils.startsWithIgnoreCase(value, "<?xml ") 	// XML
    					&& !StringUtils.contains(value, "id=\"FormHtml\"") 		// JFlow
    					&& !(StringUtils.startsWith(value, "{") && StringUtils.endsWith(value, "}")) // JSON Object
    					&& !(StringUtils.startsWith(value, "[") && StringUtils.endsWith(value, "]")) // JSON Array
    				){
    				value = value.replaceAll("\"", """).replaceAll("<", "<").replaceAll(">", ">");
    			}
    			if (logger.isInfoEnabled() && !value.equals(oriValue)){
    				logger.info("xssFilter: {} to {}", text, value);
    			}
    			return value;
    		}
    		return null;
    	}
    	
    	// 预编译SQL过滤正则表达式
    	private static Pattern p5 = Pattern.compile("(?:')|(?:--)|(/\\*(?:.|[\\n\\r])*?\\*/)|(\\b(select|update|and|or|delete|insert|trancate|char|into|substr|ascii|declare|exec|count|master|into|drop|execute)\\b)", Pattern.CASE_INSENSITIVE);
    			
    	/**
    	 * SQL过滤，防止注入，传入参数输入有select相关代码，替换空。
    	 * @author ThinkGem
    	 */
    	public static String sqlFilter(String text){
    		if (text != null){
    			String value = p5.matcher(text).replaceAll("");
    			if (logger.isWarnEnabled() && !value.equals(text)){
    				logger.warn("sqlFilter: {} to {}", text, value);
    				return StringUtils.EMPTY;
    			}
    			return value;
    		}
    		return null;
    	}
    }