dom4j 中文编码读写异常

在使用dom4j的时候发现有时会出现这样一个问题：无法以UTF-8编码格式成功保存xml文件，具体表现为保存后中文呈现乱码（如果没有乱码，说明保存前的编码没有设置成功，保存成了本地的gbk或者gb2312格式）再次读取的时候会报类似如下的错误：

1. Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.  
2. Invalid byte 1 of 1-byte UTF-8 sequence. Nested exception: Invalid byte 1 of 1-byte UTF-8 sequence.  
3. Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.  
4. Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.  
5. Invalid byte 1 of 1-byte UTF-8 sequence. Nested exception: Invalid byte 1 of 1-byte UTF-8 sequence.  

在dom4j的范例中新建一个xml文档的代码如下：

1. // 输出XML文档  
2. try  
3. {  
4.     XMLWriter output = new XMLWriter(new FileWriter(new File("data/catalog.xml")));  
5.     output.write(document);  
6.     output.close();  
7. }  
8. catch (IOException e)  
9. {  
10.     System.out.println(e.getMessage());  
11. }  

错误原因分析
    在上面的代码中输出使用的是FileWriter对象进行文件的输出。这就是不能正确进行文件编码的原因所在，Java中由Writer类继承下来的子类没有提供编码格式处理，所以dom4j也就无法对输出的文件进行正确的格式处理。这时候所保存的文件会以系统的默认编码对文件进行保存，在中文版的window下Java的默认的编码为GBK，也就是说虽然我们标识了要将xml保存为utf-8格式，但实际上文件是以GBK格式来保存的，所以这也就是为什么我们使用GBK、GB2312编码来生成xml文件能正确的被解析，而以UTF-8格式生成的文件不能被xml解析器所解析的原因。

如何解决问题？

首先我们看看dom4j是如何实现编码处理的，如下所示：

1. public XMLWriter(OutputStream out) throws UnsupportedEncodingException {  
2.     //System.out.println("In OutputStream");  
3.     this.format =DEFAULT_FORMAT;  
4.     this.writer = createWriter(out,format.getEncoding());  
5.     this.autoFlush =true;  
6.    namespaceStack.push(Namespace.NO_NAMESPACE);  
7. }  
8. public XMLWriter(OutputStream out, OutputFormat format)throws UnsupportedEncodingException {  
9.     //System.out.println("In OutputStream,OutputFormat");  
10.     this.format = format;  
11.     this.writer = createWriter(out, format.getEncoding());  
12.     this.autoFlush =true;  
13.    namespaceStack.push(Namespace.NO_NAMESPACE);  
14. }  
15. /** 
16. * Get an OutputStreamWriter, use preferred encoding. 
17. */  
18. protected Writer createWriter(OutputStream outStream, String  
19.     encoding) throws UnsupportedEncodingException {  
20.     return new BufferedWriter(  
21.         new OutputStreamWriter( outStream, encoding )  
22.     );  
23. }  

由上面的代码我们可以看出dom4j对编码并没有进行什么很复杂的处理，完全通过 Java本身的功能来完成。所以我们在使用dom4j生成xml文件时不应该直接在构建XMLWriter时，为其赋一个Writer对象，而应该通过一个OutputStream的子类对象来构建。也就是说在我们上面的代码中，不应该用FileWriter对象来构建xml文档，而应该使用FileOutputStream对象来构建，修改后的代码如下:

1. // 输出XML文档  
2. try  
3. {  
4.     OutputFormat outFmt = new OutputFormat("\t", true);  
5.     outFmt.setEncoding("UTF-8");  
6.     XMLWriter output = new XMLWriter(new FileOutputStream(filename), outFmt);    
7.     output.write(document);  
8.     output.close();  
9. }  
10. catch (IOException e)  
11. {  
12.     System.out.println(e.getMessage());  
13. }  

如何读取呢？

1. public List extractXMLText(File inputXml, String node)  
2. {  
3.     List texts = null;  
4.     try  
5.     {  
6.        // 使用SAXReader解析XML文档,SAXReader包含在org.dom4j.io包中。  
7.        // inputXml是由xml文件创建的java.io.File。  
8.        SAXReader saxReader = new SAXReader();  
9.        saxReader.setEncoding("UTF-8");  
10.        Document document = saxReader.read(inputXml);  
11.             
12.        texts = document.selectNodes(node); // 获取sentence列表  
13.     }  
14. catch (DocumentException e)  
15.   {  
16.        System.out.println(e.getMessage());  
17.   }  
18.   return texts;  
19. }