JDom或Dom4j输出UTF-8的XML完美解决

JDom输出UTF-8的XML完美解决
http://dev.yesky.com/82/8205582.shtml

 

2008-07-08 07:00作者：王琦出处：天极网责任编辑：nancy

 

　　现象描述：JDom输出Xml文件，当使用字符编码GBK时正常，而输出UTF-8时乱码。

　　完美的解决方法从辟谣开始：

　　1)JDOM是否生成UTF-8的文件与Format是否设置无关，只有输出其他字符编码才需要设置，见下面的注释。

　　2)JDOM输出UTF-8文件乱码的根本原因并非在JDOMAPI，而是在JDK。

　　具体描述：

　　JDOM的输出类XMLOutputter有两个output接口，除了都具有一个Document参数外，分别接受Writer和OutputStream参数。

　　这给我们一个错觉，两个接口可以任意使用。

　　首先我们用output(doc,System.out)来做测试，此时得到乱码，

　　然后我们改为output(doc,new PrintWriter(System.out))来测试，输出不是乱码，

　　也就是说在控制台的时候一定要用一个Writer接口包装一下。

　　然后我们用output(doc,new FileWriter(path))来做测试，结果却得到乱码，

　　然后我们改为output(doc,new FileOutputStream(path))来测试，输出不是乱码，

　　也就是说在输出文件的时候一定要用一个OutputStream接口包装一下。

　　疯了吧?呵呵，很搞笑是吧。经过到JDOM的源码中调试，发现没有任何问题，问题出在了JDK里面。

　　JDK内的对应接口处理：

　　1)PrintWriter类有参数为OutputStream的构造方法，因此可以从System.out包装到PrintWriter

　　2)FileWriter类没有参数为OutputStream的构造方法，因此不能从FileOutputStream包装到FileWriter

　　3)如果PrintWriter类用了参数为Writer的构造方法(Writer实现为FileWriter)，最后输出也是乱码

　　4)如果用一个FileOutputStream来包装一个控制台输出，也是乱码

　　因此，对于JDK内的各种输出体系，各种InputStream、OutputStream、reader和writer要充分认识，否则极容易出现一些意想不到的问题。

　　测试的JDOM版本：1.0、1.1

　　测试代码：

import java.io.File; 　　import java.io.FileOutputStream; 　　import java.io.FileWriter; 　　import java.io.PrintWriter; 　　import java.util.HashMap; 　　import org.jdom.Document; 　　import org.jdom.Element; 　　import org.jdom.output.Format; 　　import org.jdom.output.XMLOutputter; 　　public class BuildXML { 　　public static void main(String[] args) throws Exception{ 　　File xmlfile=new File("C:\\EditTemp\\xml\\abc.xml"); 　　//中文问题 //GBK 是没有问题的，但UTF-8就是有问题的 　　//原因： 　　//1)对于磁盘文件，必须使用输出流 FileOutputStream 　　// FileWriter out=new FileWriter(xmlfile);会导致乱码 　　//2)对于控制台输出，则必须使用PrintWriter，如果直接使用System.out也会出现乱码 　　// PrintWriter out=new PrintWriter(System.out); 　　FileOutputStream out=new FileOutputStream(xmlfile); 　　Element eroot=new Element("root"); 　　eroot.addContent((new Element("code")).addContent("代码")); 　　eroot.addContent((new Element("ds")).addContent("数据源")); 　　eroot.addContent((new Element("sql")).addContent("检索sql")); 　　eroot.addContent((new Element("order")).addContent("排序")); 　　Document doc=new Document(eroot); 　　XMLOutputter outputter = new XMLOutputter(); 　　//如果不设置format，仅仅是没有缩进，xml还是utf-8的，因此format不是必要的 　　Format f = Format.getPrettyFormat(); 　　//f.setEncoding("UTF-8");//default=UTF-8 　　outputter.setFormat(f); 　　outputter.output(doc, out); 　　out.close(); 　　} 　　}

 

---

Dom4j 编码问题彻底解决

http://www./resource/article/2004-10-31/1090.html

 

lonsen 发表于 2004-10-31 01:39:00

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

        }

    }
  
   至此DOM4J的问题编码问题算是告一段落，希望对此文章对其他朋友有用。

（#）