DOM4J编码问题 Invalid byte 1 of 1-byte UTF-8 sequence

http://hlwlemon.blog.sohu.com/81841115.html      本文出处

在用dom4j的时候发现有时会出现这个问题：无法以UTF-8保存xml文件，保存后再次读出的时候会报“Invalid byte 2 of 2-byte UTF-8 sequence.”这样一个错误，检查发现由dom4j生成的这个文件，在使用可正确处理XML编码的任何的编辑器中中文成乱码，从记事本查看并不会出 现乱码会正确显示中文。让我很是头痛。。。。
    试着使用GBK、gb2312编码来生成的xml文件却可以正常的被解析。因此怀疑的dom4j没有对utf-8编码进行处理。便开始查看dom4j的原代码。终于发现的问题所在，是自己程序的问题。

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

public void createXML(String fileName) {
       Document doc = org.dom4j.DocumentHelper.createDocument();
        Element root = doc.addElement("book");
        root.addAttribute("name", "我的图书");
        Element childTmp;
       childTmp = root.addElement("price");
       childTmp.setText("21.22");
       Element writer = root.addElement("author");
       writer.setText("李四");
       writer.addAttribute("ID", "001");
       try {
             org.dom4j.io.XMLWriter xmlWriter = new org.dom4j.io.XMLWriter(
            new FileWriter(fileName));
            xmlWriter.write(doc);
            xmlWriter.close();
        }
        catch (Exception e) {
            System.out.println(e);
        }
}

   在上面的代码中输出使用的是FileWriter对象进行文件的输出。这就是不能

正确进行文件编码的原因所在，java中由Writer类继承下来的子类没有提供编码

格式处理，所以dom4j也就无法对输出的文件进行正确的格式处理。这时候所保

存的文件会以系统的默认编码对文件进行保存，在中文版的window下java的默认

的编码为GBK，也就是所虽然我们标识了要将xml保存为utf-8格式但实际上文件

是以GBK格式来保存的，所以这也就是为什么能够我们使用GBK、GB2312编码来生

成xml文件能正确的被解析，而以UTF-8格式生成的文件不能被xml解析器所解析

的原因。
   好了现在我们找到了原因所在了，我们来找解决办法吧。首先我们看看dom4j

是如何实现编码处理的
    public XMLWriter(OutputStream out) throws UnsupportedEncodingException {
        //System.out.println("In OutputStream");
        this.format = DEFAULT_FORMAT;
        this.writer = createWriter(out, format.getEncoding());
        this.autoFlush = true;
       namespaceStack.push(Namespace.NO_NAMESPACE);
    }
    public XMLWriter(OutputStream out, OutputFormat format) throws UnsupportedEncodingException {
        //System.out.println("In OutputStream,OutputFormat");
        this.format = format;
        this.writer = createWriter(out, format.getEncoding());
        this.autoFlush = true;
       namespaceStack.push(Namespace.NO_NAMESPACE);

    }
    /**

     * Get an OutputStreamWriter, use preferred encoding.

     */

    protected Writer createWriter(OutputStream outStream, String

        encoding) throws UnsupportedEncodingException {
        return new BufferedWriter(
            new OutputStreamWriter( outStream, encoding )
        );
    }

   由上面的代码我们可以看出dom4j对编码并没有进行什么很复杂的处理，完全通过java本身的功能来完成。所以我们在使用dom4j的来生成我们的 XML文件时不应该直接为在构建XMLWriter时，不应该直接为其赋一个Writer对象，而应该通过一个OutputStream的子类对象来构 建。也就是说在我们上面的代码中，不应该用FileWriter对象来构建xml文档，而应该使用FileOutputStream对象来构建，所以将代 码修改入下：
    public void createXML(String fileName) {
        Document doc = org.dom4j.DocumentHelper.createDocument();
        Element root = doc.addElement("book");
        root.addAttribute("name", "我的图书");
        Element childTmp;
        childTmp = root.addElement("price");
        childTmp.setText("21.22");
        Element writer = root.addElement("author");
        writer.setText("李四");
        writer.addAttribute("ID", "001");
        try {
            //注意这里的修改

            org.dom4j.io.XMLWriter xmlWriter = new org.dom4j.io.XMLWriter(
                    new FileOutputStream(fileName));
            xmlWriter.write(doc);
            xmlWriter.close();
        }
        catch (Exception e) {
            System.out.println(e);

        }

    }

这样生成的代码就是中文的了
异常：Invalid byte 1 of 1-byte UTF-8 sequence.

 

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

 

 

本人在利用程序生成xml的时候并不是用到的dom4j，而是使用最原始的javax.xml.parsers，标准的jdk api，程序类似与以下代码：（只是将设置编码那部分给注释起来了，应该是按系统默认的GBK给编上码了。）

/*来自：http://blog.csdn.net/BusAudio/archive/2008/03/08/2157876.aspx*/ //dom生成xml文件 package test; import javax.xml.parsers.DocumentBuilder; public class DOMTest2 { private String infile = "c://people.xml"; public static void main(String args[]) { new DOMTest2(); } public DOMTest2() { try { DocumentBuilder Builder = javax.xml.parsers.DocumentBuilderFactory .newInstance().newDocumentBuilder(); org.w3c.dom.Document doc=Builder.newDocument(); org.w3c.dom.Element root=doc.createElement("root"); org.w3c.dom.Element left=doc.createElement("left"); org.w3c.dom.Element right=doc.createElement("right"); left.appendChild(doc.createTextNode("wo shi left")); root.appendChild(left); root.appendChild(right); doc.appendChild(root); javax.xml.transform.Transformer transform = javax.xml.transform.TransformerFactory .newInstance().newTransformer(); transform.setOutputProperty(javax.xml.transform.OutputKeys.ENCODING,"gb2312"); transform.setOutputProperty(javax.xml.transform.OutputKeys.INDENT,"yes"); transform .transform( new javax.xml.transform.dom.DOMSource( doc), new javax.xml.transform.stream.StreamResult( infile)); } catch (Exception e) { System.out.print(e); } } } //================================================================================== //修改xml package test; import javax.xml.parsers.DocumentBuilder; import org.w3c.dom.Node; import org.w3c.dom.NodeList; public class DOMTest { private String outfile = "c://people.xml"; int i = 0; public static void main(String args[]) { new DOMTest(); } public DOMTest() { try { DocumentBuilder Builder = javax.xml.parsers.DocumentBuilderFactory .newInstance().newDocumentBuilder(); org.w3c.dom.Document doc = Builder.parse(outfile); Node child; Node next = doc.getFirstChild(); NodeList nodelist; org.w3c.dom.Element last = doc.createElement("last"); while ((child = next) != null) { System.out.println(next.getNodeName()); if ((nodelist = next.getChildNodes()) != null) { while (i < nodelist.getLength() && (child = nodelist.item(i++)) != null) { if (child.getNodeName().equals("left")) { org.w3c.dom.Element newleft = doc .createElement("newleft"); System.out.println(child.getTextContent()); newleft.appendChild(doc.createTextNode(child .getTextContent())); doc.getDocumentElement().replaceChild(newleft, child); } } next = next.getPreviousSibling(); } } //从内存中的dom保存到指定路径的文件中 javax.xml.transform.Transformer transform = javax.xml.transform.TransformerFactory .newInstance().newTransformer(); transform.transform(new javax.xml.transform.dom.DOMSource(doc), new javax.xml.transform.stream.StreamResult(outfile)); } catch (Exception e) { System.out.print(e.getMessage()); } } } 

而在解析的时候用的是dom4j，经常报出来这种错误：Invalid byte 1 of 1-byte UTF-8 sequence，原因应该是“中文版的window下java的默认的编码为GBK，也就是所虽然我们标识了要将xml保存为utf-8格式但实际上文件是以GBK格式来保存的”。因此，利用Ultra Edit将生成的xml文件，先转码（转至utf-8），就可以正常读取了。

如果最初需要用dom4j生成xml的话，代码应该类似以下内容：

OutputFormat format = OutputFormat.createPrettyPrint(); format.setEncoding("utf-8"); format.setNewlines(false); format.setTrimText(false); FileOutputStream fos = new FileOutputStream(rootPath + goodsNameList[k] + "//utf-8_data.xml"); BufferedWriter bw1 = new BufferedWriter(new OutputStreamWriter(fos,"utf-8")); XMLWriter output = new XMLWriter(bw1, format); output.write(document); bw1.close();