版本
jdk: 1.8.0_172
dom4j: 2.0.1
问题
带有回车换行符属性值示例：
select *
from
table
where
id = 0;
使用以下配置输出以上属性值时：
OutputFormat format = OutputFormat.createPrettyPrint();
属性值中的回车换行符会原封不动的保留，生成的xml示例如下：
这样也没什么错误，只是不符合xml的规范。问题在于，如果使用dom4j回读以上生成的xml，那么dom4j会将属性值中的回车换行符替换为空格，如果应用在UI中，会导致用户看到的和其实际输入的不一致，这就很尴尬了。
解决办法
三种解决办法：
- 方法一：自定义替换字符，生成的时候将回车换行符替换为自定义的字符，读取的时候再替换回来。实在没办法时的办法，比较笨，不推荐。
- 方法二：自定义XmlReader，修改读取属性值的逻辑，不替换为空格。
- 方法三：自定义XMLWriter，修改生成属性值的逻辑，将回车换行符转义为xml支持的字符。
推荐方法三，优势如下：
- 符合xml规范。
- 使用dom4j默认的Reader读取时也能正确读取。
- 如果使用该xml与其他程序通信时，如果其他程序采用的是非dom4j时也能正确读取。
方法一很简单，略过。因为推荐方法三，所以优先说明方法三的方案。
方法三
先看一下方法三生成的XML结果：
查看dom4j的org.dom4j.io.XMLWriter类，会发现其中有一个escapeAttributeEntities方法：
protected String escapeAttributeEntities(String text) {
char quote = format.getAttributeQuoteCharacter();
char[] block = null;
int i;
int last = 0;
int size = text.length();
for (i = 0; i < size; i++) {
String entity = null;
char c = text.charAt(i);
switch (c) {
case '<':
entity = "<";
break;
case '>':
entity = ">";
break;
case '\'':
if (quote == '\'') {
entity = "'";
}
break;
case '\"':
if (quote == '\"') {
entity = """;
}
break;
case '&':
entity = "&";
break;
case '\t':
case '\n':
case '\r':
// don't encode standard whitespace characters
break;
default:
if ((c < 32) || shouldEncodeChar(c)) {
entity = "&#" + (int) c + ";";
}
break;
}
if (entity != null) {
if (block == null) {
block = text.toCharArray();
}
buffer.append(block, last, i - last);
buffer.append(entity);
last = i + 1;
}
}
if (last == 0) {
return text;
}
if (last < size) {
if (block == null) {
block = text.toCharArray();
}
buffer.append(block, last, i - last);
}
String answer = buffer.toString();
buffer.setLength(0);
return answer;
}
通过以上代码可以看出，dom4j在处理'\t'、'\n'、'\r'时默认会不处理支持输出到属性文本中。
而该方法是protected的，修改方案就呼之欲出了，继承该类，复写该方法，在其中处理回车换行的case中，修改为如下：
case '\t':
case '\n':
case '\r':
//// ESCAPE HERE:
entity = "&#" + (int) c + ";";
break;
Tips：如果是转义Element标签文本值中的回车换行，可以考虑复写该类中的escapeElementEntities方法。
方法二
dom4j使用的是SAXReader，最终定位到读取时替换回车换行符的代码位于com.sun.org.apache.xerces.internal.impl.XMLScanner#scanAttributeValue，代码片段如下：
} else if (c == '\n' || c == '\r') {
fEntityScanner.scanChar(null);
stringBuffer.append(' ');
if (entityDepth == fEntityDepth && fNeedNonNormalizedValue) {
fStringBuffer2.append('\n');
}
}
替换后还有一些逻辑，感兴趣的可以继续研究。
修改方案就是创建一个新的同包名同类名的这个类，然后修改这一段逻辑，最后让JVM加载我们修改后的这个类。由于这个类是jdk内部的类，会优先被加载，所以采用自定义ClassLoader的方法在这里行不通，可以通过JVM的java.endorsed.dirs启动参数来让JVM加载我们自定义的类，感兴趣的可以参考：Dom4j解析XML丢失文本中换行符的问题解决 - (jianshu.com)
。