JAVA

StringEscapeUtils的使用

apache工具包common-lang中有一个很有用的处理字符串的工具类,其中之一就是StringEscapeUtils,这个工具类是在2.3版本以上加上的去的,利用它能很方便的进行html,xml,Java等的转义与反转义,而且还能对关键字符串进行处理预防SQL注入。

  • 添加依赖
<dependency>
    <groupId>commons-lang</groupId>
    <artifactId>commons-lang</artifactId>
    <version>2.6</version>
</dependency>
  • html脚本
// escapeHtml转义html脚本
System.out.println(StringEscapeUtils.escapeHtml("<a>abc</a>"));
// unescapeHtml反转义html脚本
System.out.println(StringEscapeUtils.unescapeHtml("&lt;a&gt;abc&lt;/a&gt;"));

输出
&lt;a&gt;abc&lt;/a&gt;
<a>abc</a>
  • js脚本
// escapeJavaScript转义js脚本
System.out.println(StringEscapeUtils.escapeJavaScript("<script>alert('123')<script>"));
// unescapeJavaScript反转义js脚本
System.out.println(StringEscapeUtils.unescapeJavaScript("<script>alert(\'123\')<script>"));

输出
<script>alert(\'123\')<script>
<script>alert('123')<script>
  • 字符串Unicode 
// escapeJava转义成Unicode编码
System.out.println(StringEscapeUtils.escapeJava("你好"));
// unescapeJava反转义成Unicode编码
System.out.println(StringEscapeUtils.unescapeJava("\u4F60\u597D"));

输出
\u4F60\u597D
你好
  • xml
// escapeXML转义XML
System.out.println(StringEscapeUtils.escapeXml("<name>贝贝</name>"));
// unescapeXML反转义XML
System.out.println(StringEscapeUtils.unescapeXml("&lt;name&gt;&#36125;&#36125;&lt;/name&gt;"));

输出

&lt;name&gt;&#36125;&#36125;&lt;/name&gt;
<name>贝贝</name>
  • sql
// escapeSql sql转义,防止sql注入攻击
StringBuffer sql = new StringBuffer("select * from users where 1=1 ");
String keyWord="aaa' or '1=1";
if(!keyWord.isEmpty()){
      sql.append(" and username like '%" + StringEscapeUtils.escapeSql(keyWord) + "%'");
}
System.out.println(sql);

输出

select * from users where 1=1  and username like '%aaa'' or ''1=1%'

不进行转义的,会查出全部用户

select * from users where 1=1  and username like '%aaa' or '1=1%' 
  • json串反转义(消除反斜杠)
JSon串在被串行化后保存在文件中,读取字符串时,是不能直接拿来用JSON.parse()解析为JSON  对象的。因为它是一个字符串,不是一个合法的JSON对象格式。例如下面的JSON串保存在文件中,读出来不能直接解析:

“{\"resourceId\":\"dfead70e4ec5c11e43514000ced0cdcaf\",\"properties\":{\"process_id\":\"process4\",\"name\":\"\",\"documentation\":\"\",\"processformtemplate\":\"\"}}"

这个串如果出现在代码中是没有问题的,因为反斜杠就表示转义,但如果从文本文件中直接读出来就是这个样子,则不能直接用JSON.parse()进行解析,需要反串行化,消除掉反斜杠。有些programmer喜欢自己写一个工具类来做这样的事情,但已经有方便快捷的工具类可以来做这件事情,毋需我们重复发明车轮子。

可以直接使用Apache 的 common.lang工具包(使用工具类:org.apache.commons.lang.StringEscapeUtils)。例子如下:

public void test(){
		String str1 = "{\"resourceId\":\"dfead70e4ec5c11e43514000ced0cdcaf\",\"properties\":{\"process_id\":\"process4\",\"name\":\"\",\"documentation\":\"\",\"processformtemplate\":\"\"}}";
		String tmp = StringEscapeUtils.unescapeJavaScript(str1);
		System.out.println("tmp:" + tmp);
	}

输出:
tmp:{"resourceId":"51ad70e41c5c11e88514000c290cdcfa","properties":{"process_id":"process4","name":"","documentation":"","processformtemplate":""}}