JavaからXMLをきれいに印刷する方法は?


442

改行やインデントのないXMLを含むJava文字列があります。うまくフォーマットされたXMLで文字列に変換したいと思います。どうすればよいですか?

String unformattedXml = "<tag><nested>hello</nested></tag>";
String formattedXml = new [UnknownClass]().format(unformattedXml);

注:私の入力はStringです。私の出力はStringです。

(基本)模擬結果:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <tag>
    <nested>hello</nested>
  </tag>
</root>

この質問を確認してください。stackoverflow.com/questions/1264849/...
DFA

10
好奇心旺盛ですが、この出力をXMLファイルまたはインデントが本当に重要な他の何かに送信していますか?しばらく前に、XMLを適切に表示するためにフォーマットすることについて非常に心配していました...しかし、これに多くの時間を費やした後、出力をWebブラウザーや比較的最近のWebブラウザーに送信する必要があることに気付きましたXMLは実際には見事なツリー構造で表示されるので、この問題を忘れて先に進むことができます。これは、あなた(または同じ問題を持つ他のユーザー)が同じ詳細を見落とした可能性がある場合に備えて言及しています。
アベルモレロス

3
@Abel、テキストファイルへの保存、HTMLテキストエリアへの挿入、およびデバッグ目的でのコンソールへのダンプ。
スティーブマクロード

2
「広すぎるとして保留する」-現在の質問より正確にするのは難しいです!
スティーブマクロード

回答:


265
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
//initialize StreamResult with File object to save to file
StreamResult result = new StreamResult(new StringWriter());
DOMSource source = new DOMSource(doc);
transformer.transform(source, result);
String xmlString = result.getWriter().toString();
System.out.println(xmlString);

注:Javaのバージョンによって結果が異なる場合があります。プラットフォームに固有の回避策を検索します。


1
出力に含まれないようにするにはどうすればよい<?xml version="1.0" encoding="UTF-8"?>ですか?
タンファン

19
<?xml ...>宣言を省略するには、追加transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes")
rustyx

4
カジュアルな読者は、ここで説明されているソリューションの改良バージョンが役立つと思うかもしれません(stackoverflow.com/a/33541820/363573)。
ステファン

5
どこにdoc定義されていますか?
フローリアンF

6
これは私の質問に答えません:XMLを含む文字列をどのようにフォーマットするのですか?この回答はすでに、何らかの形でStringオブジェクトを別のオブジェクトに変換したことを前提としています。
スティーブマクロード

135

これが私自身の質問に対する答えです。さまざまな結果からの回答を組み合わせて、XMLをきれいに出力するクラスを作成しました。

無効なXMLまたは大きなドキュメントでどのように応答するかは保証されません。

package ecb.sdw.pretty;

import org.apache.xml.serialize.OutputFormat;
import org.apache.xml.serialize.XMLSerializer;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;

/**
 * Pretty-prints xml, supplied as a string.
 * <p/>
 * eg.
 * <code>
 * String formattedXml = new XmlFormatter().format("<tag><nested>hello</nested></tag>");
 * </code>
 */
public class XmlFormatter {

    public XmlFormatter() {
    }

    public String format(String unformattedXml) {
        try {
            final Document document = parseXmlFile(unformattedXml);

            OutputFormat format = new OutputFormat(document);
            format.setLineWidth(65);
            format.setIndenting(true);
            format.setIndent(2);
            Writer out = new StringWriter();
            XMLSerializer serializer = new XMLSerializer(out, format);
            serializer.serialize(document);

            return out.toString();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    private Document parseXmlFile(String in) {
        try {
            DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
            DocumentBuilder db = dbf.newDocumentBuilder();
            InputSource is = new InputSource(new StringReader(in));
            return db.parse(is);
        } catch (ParserConfigurationException e) {
            throw new RuntimeException(e);
        } catch (SAXException e) {
            throw new RuntimeException(e);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) {
        String unformattedXml =
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?><QueryMessage\n" +
                        "        xmlns=\"http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message\"\n" +
                        "        xmlns:query=\"http://www.SDMX.org/resources/SDMXML/schemas/v2_0/query\">\n" +
                        "    <Query>\n" +
                        "        <query:CategorySchemeWhere>\n" +
                        "   \t\t\t\t\t         <query:AgencyID>ECB\n\n\n\n</query:AgencyID>\n" +
                        "        </query:CategorySchemeWhere>\n" +
                        "    </Query>\n\n\n\n\n" +
                        "</QueryMessage>";

        System.out.println(new XmlFormatter().format(unformattedXml));
    }

}

13
この回答ではXercesを使用する必要があることに注意してください。この依存関係を追加したくない場合は、標準のjdkライブラリとjavax.xml.transform.Transformerを使用するだけです(下記の私の回答を参照)
khylo

45
これは2008年に良い答えでしたが、今ではすべて、Apacheクラスではなく標準のJDKクラスで実行できます。xerces.apache.org/xerces2-j/faq-general.html#faq-6を参照してください。はい、これはXerces FAQですが、答えは標準のJDKクラスをカバーしています。これらのクラスの最初の1.5実装には多くの問題がありましたが、1.6以降はすべて正常に動作します。FAQのLSSerializerの例をコピーし、「...」ビットを切り取っwriter.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE);て、LSSerializer writer = ...行の後に追加します。
George Hawkins、

2
私はApacheが提供したサンプルを使用して小さなクラスを作成しました。これには@GeorgeHawkinsがリンクを提供しました。変数のdocument初期化方法が欠けていたので、減速度を追加して、それから簡単な例を作ろうと思いました。私は何か、変更する必要がある場合、私に教えてくださいpastebin.com/XL7932aC
サムウェル

jdkだけでそれができるとは限りません。少なくとも確実ではありません。これは、デフォルトではjdk7u72でアクティブにならない内部レジストリ実装に依存しています。そのため、Apacheのものを直接使用する方がよいでしょう。
user1050755 2014年

依存関係のないソリューションは次のとおりです:stackoverflow.com/a/33541820/363573
ステファン

131

この答えに基づいたより簡単な解決策

public static String prettyFormat(String input, int indent) {
    try {
        Source xmlInput = new StreamSource(new StringReader(input));
        StringWriter stringWriter = new StringWriter();
        StreamResult xmlOutput = new StreamResult(stringWriter);
        TransformerFactory transformerFactory = TransformerFactory.newInstance();
        transformerFactory.setAttribute("indent-number", indent);
        Transformer transformer = transformerFactory.newTransformer(); 
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.transform(xmlInput, xmlOutput);
        return xmlOutput.getWriter().toString();
    } catch (Exception e) {
        throw new RuntimeException(e); // simple exception handling, please review it
    }
}

public static String prettyFormat(String input) {
    return prettyFormat(input, 2);
}

テストケース:

prettyFormat("<root><child>aaa</child><child/></root>");

戻り値:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <child>aaa</child>
  <child/>
</root>

1
これは私がいつも使用していたコードですが、この会社では機能しませんでした。別のXML変換ライブラリを使用していると思います。私は別のラインとして工場を作り、それを作りましたfactory.setAttribute("indent-number", 4);そして今それは機能します。
エイドリアン・スミス

出力に含まれないようにするにはどうすればよい<?xml version="1.0" encoding="UTF-8"?>ですか?
タンファン

4
@Harry:transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
jjmontes、2011年

5
こんにちは私はこの正確なコードを使用しており、最初の要素を除いて適切にフォーマットします。つまり、これ<?xml version="1.0" encoding="UTF-8"?><root>はすべて1行です。何かアイデアはありますか?
CodyK 2015年

2
@Codemiester:バグのようです(stackoverflow.com/a/18251901/3375325を参照)。追加transformer.setOutputProperty(OutputKeys.DOCTYPE_PUBLIC, "yes");は私のために働いた。
jansohn 2016

99

今では2012年になり、JavaはXMLを使用する場合よりも多くのことができるようになりました。私の受け入れられた答えに代替を追加したいと思います。これには、Java 6以外の依存関係はありません。

import org.w3c.dom.Node;
import org.w3c.dom.bootstrap.DOMImplementationRegistry;
import org.w3c.dom.ls.DOMImplementationLS;
import org.w3c.dom.ls.LSSerializer;
import org.xml.sax.InputSource;

import javax.xml.parsers.DocumentBuilderFactory;
import java.io.StringReader;

/**
 * Pretty-prints xml, supplied as a string.
 * <p/>
 * eg.
 * <code>
 * String formattedXml = new XmlFormatter().format("<tag><nested>hello</nested></tag>");
 * </code>
 */
public class XmlFormatter {

    public String format(String xml) {

        try {
            final InputSource src = new InputSource(new StringReader(xml));
            final Node document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(src).getDocumentElement();
            final Boolean keepDeclaration = Boolean.valueOf(xml.startsWith("<?xml"));

        //May need this: System.setProperty(DOMImplementationRegistry.PROPERTY,"com.sun.org.apache.xerces.internal.dom.DOMImplementationSourceImpl");


            final DOMImplementationRegistry registry = DOMImplementationRegistry.newInstance();
            final DOMImplementationLS impl = (DOMImplementationLS) registry.getDOMImplementation("LS");
            final LSSerializer writer = impl.createLSSerializer();

            writer.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE); // Set this to true if the output needs to be beautified.
            writer.getDomConfig().setParameter("xml-declaration", keepDeclaration); // Set this to true if the declaration is needed to be outputted.

            return writer.writeToString(document);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) {
        String unformattedXml =
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?><QueryMessage\n" +
                        "        xmlns=\"http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message\"\n" +
                        "        xmlns:query=\"http://www.SDMX.org/resources/SDMXML/schemas/v2_0/query\">\n" +
                        "    <Query>\n" +
                        "        <query:CategorySchemeWhere>\n" +
                        "   \t\t\t\t\t         <query:AgencyID>ECB\n\n\n\n</query:AgencyID>\n" +
                        "        </query:CategorySchemeWhere>\n" +
                        "    </Query>\n\n\n\n\n" +
                        "</QueryMessage>";

        System.out.println(new XmlFormatter().format(unformattedXml));
    }
}

インデントはありませんが、次のように機能します:System.setProperty(DOMImplementationRegistry.PROPERTY、 "com.sun.org.apache.xerces.internal.dom.DOMImplementationSourceImpl");
ggb667 2013年

1
この例にどのようにインデントを追加しますか?
ggb667 2013年

2
@DanTemple LSOutputを使用してエンコーディングを制御する必要があるようです。chipkillmar.net/2009/03/25/pretty-print-xml-from-a-domを
Joshua Davis

1
Andriodでこれを使用しようとしましたが、 `DOMImplementationRegistryパッケージを見つけることができません。私は、java 8.使用しています
Chintan曽爾

2
インポートリストも含めてくれてありがとう、そうでなければ必要な組み合わせを理解するために利用できる非常に多くの競合するパッケージ..
Leon

54

最高評価の回答にはxercesを使用する必要があることに注意してください。

この外部依存関係を追加したくない場合は、標準のjdkライブラリ(実際には内部でxercesを使用して構築されています)を使用できます。

注意jdkバージョン1.5にバグがありました。http://bugs.sun.com/bugdatabase/view_bug.do?bug_id = 6296446を参照してください。

(エラーが発生した場合、元のテキストが返されます)

package com.test;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

public class XmlTest {
    public static void main(String[] args) {
        XmlTest t = new XmlTest();
        System.out.println(t.formatXml("<a><b><c/><d>text D</d><e value='0'/></b></a>"));
    }

    public String formatXml(String xml){
        try{
            Transformer serializer= SAXTransformerFactory.newInstance().newTransformer();
            serializer.setOutputProperty(OutputKeys.INDENT, "yes");
            //serializer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
            serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
            //serializer.setOutputProperty("{http://xml.customer.org/xslt}indent-amount", "2");
            Source xmlSource=new SAXSource(new InputSource(new ByteArrayInputStream(xml.getBytes())));
            StreamResult res =  new StreamResult(new ByteArrayOutputStream());            
            serializer.transform(xmlSource, res);
            return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
        }catch(Exception e){
            //TODO log error
            return xml;
        }
    }

}

この場合、左のタブは使用されません。すべてのタグは、通常のテキストと同様に、行の最初の記号から始まります。
ルスラン

バイトと文字列を相互に変換するときに文字セットを指定する必要はありませんか?
Will Glass

2
バイト配列/文字列との間で変換を行う必要はありません。少なくとも、そうするときは文字セットを指定する必要があります。InputSourceおよびStreamResultでラップされたStringReaderおよびStringWriterクラスを使用することをお勧めします。
maximdim 2012

機能していません。内部レジストリの実装をいじる必要があります。
user1050755 2014年

このソリューションのより簡単なバリアントは次のとおりです。stackoverflow.com
Stephan

32

私は過去にorg.dom4j.io.OutputFormat.createPrettyPrint()メソッドを使用してかなり印刷しました

public String prettyPrint(final String xml){  

    if (StringUtils.isBlank(xml)) {
        throw new RuntimeException("xml was null or blank in prettyPrint()");
    }

    final StringWriter sw;

    try {
        final OutputFormat format = OutputFormat.createPrettyPrint();
        final org.dom4j.Document document = DocumentHelper.parseText(xml);
        sw = new StringWriter();
        final XMLWriter writer = new XMLWriter(sw, format);
        writer.write(document);
    }
    catch (Exception e) {
        throw new RuntimeException("Error pretty printing xml:\n" + xml, e);
    }
    return sw.toString();
}

3
受け入れられたソリューションは、私の場合、ネストされたタグを適切にインデントしません。
チェイスセイバート

3
行末のすべての末尾のスペースを削除してこれを組み合わせて使用​​しました:prettyPrintedString.replaceAll("\\s+\n", "\n")
jediz

19

dom4jを使用してこれを行う方法を次に示します

輸入:

import org.dom4j.Document;  
import org.dom4j.DocumentHelper;  
import org.dom4j.io.OutputFormat;  
import org.dom4j.io.XMLWriter;

コード:

String xml = "<your xml='here'/>";  
Document doc = DocumentHelper.parseText(xml);  
StringWriter sw = new StringWriter();  
OutputFormat format = OutputFormat.createPrettyPrint();  
XMLWriter xw = new XMLWriter(sw, format);  
xw.write(doc);  
String result = sw.toString();

1
これは私にはうまくいきませんでした。それはちょうど次のようなものを与えました:<?xml version...1つの行と他のすべての行。
sixtyfootersdude

14

から始めているStringので、を使用する前に、DOMオブジェクト(などNode)に変換する必要がありますTransformer。ただし、XML文字列が有効であることがわかっていて、文字列をDOMに解析するメモリオーバーヘッドを発生させたくない場合は、DOM上で変換を実行して文字列を取得します。文字ごとの解析。すべての</...>文字の後に改行とスペースを挿入し、カウンターごとに(スペースの数を決定するために)インデントし、表示されるごとにカウンター<...>をデクリメントし</...>ます。

免責事項-以下の関数のカット/ペースト/テキスト編集を行ったので、そのままコンパイルできない可能性があります。

public static final Element createDOM(String strXML) 
    throws ParserConfigurationException, SAXException, IOException {

    DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
    dbf.setValidating(true);
    DocumentBuilder db = dbf.newDocumentBuilder();
    InputSource sourceXML = new InputSource(new StringReader(strXML));
    Document xmlDoc = db.parse(sourceXML);
    Element e = xmlDoc.getDocumentElement();
    e.normalize();
    return e;
}

public static final void prettyPrint(Node xml, OutputStream out)
    throws TransformerConfigurationException, TransformerFactoryConfigurationError, TransformerException {
    Transformer tf = TransformerFactory.newInstance().newTransformer();
    tf.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
    tf.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
    tf.setOutputProperty(OutputKeys.INDENT, "yes");
    tf.transform(new DOMSource(xml), new StreamResult(out));
}

1
「ただし、XML文字列が有効であることがわかっている場合は...」以下のこのアプローチに基づく私のソリューションを参照してください。
David Easley、

12

サードパーティのXMLライブラリを使用しても問題がない場合は、現在最も投票されている 回答が示唆するものよりもはるかに単純なもので済ますことができます。

入力と出力の両方が文字列である必要があると述べたので、これを行うユーティリティメソッドをXOMライブラリで実装します。

import nu.xom.*;
import java.io.*;

[...]

public static String format(String xml) throws ParsingException, IOException {
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    Serializer serializer = new Serializer(out);
    serializer.setIndent(4);  // or whatever you like
    serializer.write(new Builder().build(xml, ""));
    return out.toString("UTF-8");
}

私はそれが機能することをテストしました、そして結果あなたのJREバージョンまたはそのようなものに依存しません。出力形式を好みに合わせてカスタマイズする方法については、SerializerAPI をご覧ください。

これは実際には思ったよりも長く出てきました- 書き込みSerializerたいので、いくつかの追加の行が必要でしたOutputStream。ただし、実際のXMLをいじるコードはほとんどありません。

(この回答は、XOMの私の評価の一部です。これは、dom4jを置き換えるのに最適なJava XMLライブラリについての私の質問の 1つのオプションとして提案されました。XMLWriterと、andOutputFormat編集:.. .mlo55 の回答に示されているように。)


2
ありがとう、それが私が探していたものです。「Document」オブジェクト内のXOMで解析済みのXMLがある場合は、それをserializer.write(document);に直接渡すことができます。
Thibault D.

12

Kevin Hakanson氏は、次のように述べています。「ただし、XML文字列が有効であり、文字列をDOMに解析するメモリオーバーヘッドが発生しないようにするには、DOMに対して変換を実行して文字列を取得します。昔ながらの文字を文字ごとに解析するだけです。すべての文字の後に改行とスペースを挿入し、<...>ごとにインクリメントし、表示されるごとにインクリメントするカウンター(スペースの数を決定するため)を保持してインデントします。

同意した。このようなアプローチははるかに高速で、依存関係がはるかに少なくなります。

ソリューションの例:

/**
 * XML utils, including formatting.
 */
public class XmlUtils
{
  private static XmlFormatter formatter = new XmlFormatter(2, 80);

  public static String formatXml(String s)
  {
    return formatter.format(s, 0);
  }

  public static String formatXml(String s, int initialIndent)
  {
    return formatter.format(s, initialIndent);
  }

  private static class XmlFormatter
  {
    private int indentNumChars;
    private int lineLength;
    private boolean singleLine;

    public XmlFormatter(int indentNumChars, int lineLength)
    {
      this.indentNumChars = indentNumChars;
      this.lineLength = lineLength;
    }

    public synchronized String format(String s, int initialIndent)
    {
      int indent = initialIndent;
      StringBuilder sb = new StringBuilder();
      for (int i = 0; i < s.length(); i++)
      {
        char currentChar = s.charAt(i);
        if (currentChar == '<')
        {
          char nextChar = s.charAt(i + 1);
          if (nextChar == '/')
            indent -= indentNumChars;
          if (!singleLine)   // Don't indent before closing element if we're creating opening and closing elements on a single line.
            sb.append(buildWhitespace(indent));
          if (nextChar != '?' && nextChar != '!' && nextChar != '/')
            indent += indentNumChars;
          singleLine = false;  // Reset flag.
        }
        sb.append(currentChar);
        if (currentChar == '>')
        {
          if (s.charAt(i - 1) == '/')
          {
            indent -= indentNumChars;
            sb.append("\n");
          }
          else
          {
            int nextStartElementPos = s.indexOf('<', i);
            if (nextStartElementPos > i + 1)
            {
              String textBetweenElements = s.substring(i + 1, nextStartElementPos);

              // If the space between elements is solely newlines, let them through to preserve additional newlines in source document.
              if (textBetweenElements.replaceAll("\n", "").length() == 0)
              {
                sb.append(textBetweenElements + "\n");
              }
              // Put tags and text on a single line if the text is short.
              else if (textBetweenElements.length() <= lineLength * 0.5)
              {
                sb.append(textBetweenElements);
                singleLine = true;
              }
              // For larger amounts of text, wrap lines to a maximum line length.
              else
              {
                sb.append("\n" + lineWrap(textBetweenElements, lineLength, indent, null) + "\n");
              }
              i = nextStartElementPos - 1;
            }
            else
            {
              sb.append("\n");
            }
          }
        }
      }
      return sb.toString();
    }
  }

  private static String buildWhitespace(int numChars)
  {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < numChars; i++)
      sb.append(" ");
    return sb.toString();
  }

  /**
   * Wraps the supplied text to the specified line length.
   * @lineLength the maximum length of each line in the returned string (not including indent if specified).
   * @indent optional number of whitespace characters to prepend to each line before the text.
   * @linePrefix optional string to append to the indent (before the text).
   * @returns the supplied text wrapped so that no line exceeds the specified line length + indent, optionally with
   * indent and prefix applied to each line.
   */
  private static String lineWrap(String s, int lineLength, Integer indent, String linePrefix)
  {
    if (s == null)
      return null;

    StringBuilder sb = new StringBuilder();
    int lineStartPos = 0;
    int lineEndPos;
    boolean firstLine = true;
    while(lineStartPos < s.length())
    {
      if (!firstLine)
        sb.append("\n");
      else
        firstLine = false;

      if (lineStartPos + lineLength > s.length())
        lineEndPos = s.length() - 1;
      else
      {
        lineEndPos = lineStartPos + lineLength - 1;
        while (lineEndPos > lineStartPos && (s.charAt(lineEndPos) != ' ' && s.charAt(lineEndPos) != '\t'))
          lineEndPos--;
      }
      sb.append(buildWhitespace(indent));
      if (linePrefix != null)
        sb.append(linePrefix);

      sb.append(s.substring(lineStartPos, lineEndPos + 1));
      lineStartPos = lineEndPos + 1;
    }
    return sb.toString();
  }

  // other utils removed for brevity
}

2
これは、その方法です。文字列レベルでオンザフライでフォーマットします。これは、無効または不完全なXMLをフォーマットする唯一のソリューションです。
フロリアンF

11

うーん...このような何かに直面し、それは既知のバグです...このOutputPropertyを追加するだけです..

transformer.setOutputProperty(OutputPropertiesFactory.S_KEY_INDENT_AMOUNT, "8");

お役に立てれば ...


2
このOutputPropertiesFactoryはどこから来たのですか?
helenov 2016年

import com.sun.org.apache.xml.internal.serializer。*;
gaurav

9

「最初にDOMツリーを構築する必要がある」というコメントについて:いいえ、その必要はありませんし、すべきではありません。

代わりに、StreamSource(新しいStreamSource(new StringReader(str))を作成し、それを前述のIDトランスフォーマーにフィードします。これにより、SAXパーサーが使用され、結果がはるかに速くなります。中間ツリーの構築は、この場合の純粋なオーバーヘッドです。それ以外の場合は、上位の回答が適切です。


1
私は心から同意します。中間のDOMツリーを構築することは、メモリの浪費です。その答えをありがとう。
フロリアンF

9

Scalaを使用する:

import xml._
val xml = XML.loadString("<tag><nested>hello</nested></tag>")
val formatted = new PrettyPrinter(150, 2).format(xml)
println(formatted)

scala-library.jarに依存している場合は、Javaでもこれを行うことができます。次のようになります。

import scala.xml.*;

public class FormatXML {
    public static void main(String[] args) {
        String unformattedXml = "<tag><nested>hello</nested></tag>";
        PrettyPrinter pp = new PrettyPrinter(150, 3);
        String formatted = pp.format(XML.loadString(unformattedXml), TopScope$.MODULE$);
        System.out.println(formatted);
    }
}

PrettyPrinter目的は2つのint、最初ある最大行の長さと押し込み工程である第2で構成されています。


9

milosmnsからのわずかに改善されたバージョン...

public static String getPrettyXml(String xml) {
    if (xml == null || xml.trim().length() == 0) return "";

    int stack = 0;
    StringBuilder pretty = new StringBuilder();
    String[] rows = xml.trim().replaceAll(">", ">\n").replaceAll("<", "\n<").split("\n");

    for (int i = 0; i < rows.length; i++) {
        if (rows[i] == null || rows[i].trim().length() == 0) continue;

        String row = rows[i].trim();
        if (row.startsWith("<?")) {
            pretty.append(row + "\n");
        } else if (row.startsWith("</")) {
            String indent = repeatString(--stack);
            pretty.append(indent + row + "\n");
        } else if (row.startsWith("<") && row.endsWith("/>") == false) {
            String indent = repeatString(stack++);
            pretty.append(indent + row + "\n");
            if (row.endsWith("]]>")) stack--;
        } else {
            String indent = repeatString(stack);
            pretty.append(indent + row + "\n");
        }
    }

    return pretty.toString().trim();
}

private static String repeatString(int stack) {
     StringBuilder indent = new StringBuilder();
     for (int i = 0; i < stack; i++) {
        indent.append(" ");
     }
     return indent.toString();
} 

どこにrepeatString(stack ++); 方法..?
user1912935

2
private static String repeatString(int stack){StringBuilder indent = new StringBuilder(); for(int i = 0; i <スタック; i ++){indent.append( ""); } return indent.toString(); }
codekraps 2015年

インデントは変更に終了tags.Youの必要性で正常に動作していない} else if (row.startsWith("</")) {これに一部:else if (row.startsWith("</")) { String indent = repeatIdent(--stack); if (pretty.charAt(pretty.length() - 1) == '\n') { pretty.append(indent + row + "\n"); } else { pretty.append(row + "\n"); } }
チャバTenkes

8

将来の参考のために、ここで私のために働いた解決策があります(@George Hawkinsが回答の1つに投稿したコメントのおかげです):

DOMImplementationRegistry registry = DOMImplementationRegistry.newInstance();
DOMImplementationLS impl = (DOMImplementationLS) registry.getDOMImplementation("LS");
LSSerializer writer = impl.createLSSerializer();
writer.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE);
LSOutput output = impl.createLSOutput();
ByteArrayOutputStream out = new ByteArrayOutputStream();
output.setByteStream(out);
writer.write(document, output);
String xmlStr = new String(out.toByteArray());

6

有効なXMLが確実にある場合、これは単純であり、XML DOMツリーを回避します。多分いくつかのバグがあります、何かを見たらコメントしてください

public String prettyPrint(String xml) {
            if (xml == null || xml.trim().length() == 0) return "";

            int stack = 0;
            StringBuilder pretty = new StringBuilder();
            String[] rows = xml.trim().replaceAll(">", ">\n").replaceAll("<", "\n<").split("\n");

            for (int i = 0; i < rows.length; i++) {
                    if (rows[i] == null || rows[i].trim().length() == 0) continue;

                    String row = rows[i].trim();
                    if (row.startsWith("<?")) {
                            // xml version tag
                            pretty.append(row + "\n");
                    } else if (row.startsWith("</")) {
                            // closing tag
                            String indent = repeatString("    ", --stack);
                            pretty.append(indent + row + "\n");
                    } else if (row.startsWith("<")) {
                            // starting tag
                            String indent = repeatString("    ", stack++);
                            pretty.append(indent + row + "\n");
                    } else {
                            // tag data
                            String indent = repeatString("    ", stack);
                            pretty.append(indent + row + "\n");
                    }
            }

            return pretty.toString().trim();
    }

2
repeatStringメソッドはどこにありますか。
user1912935

3
private static String repeatString(int stack){StringBuilder indent = new StringBuilder(); for(int i = 0; i <スタック; i ++){indent.append( ""); } return indent.toString(); }
codekraps

はい[user1912935]、@ codeskrapsが書いたものは、十分に単純である必要があります:)
milosmns

ループ内でのStringBuilderとの連結:悪い習慣。
james.garriss 2015

@ james.garrissしかし、新しい行に分割するのは非常に簡単です。これは、DOMツリーを使用しない単純なアプローチを示しているだけです。
milosmns

5

上記のすべての解決策がうまくいかなかったので、これを見つけました http://myshittycode.com/2014/02/10/java-properly-indenting-xml-string/

手がかりはXPathで空白を取り除くことです

    String xml = "<root>" +
             "\n   " +
             "\n<name>Coco Puff</name>" +
             "\n        <total>10</total>    </root>";

try {
    Document document = DocumentBuilderFactory.newInstance()
            .newDocumentBuilder()
            .parse(new InputSource(new ByteArrayInputStream(xml.getBytes("utf-8"))));

    XPath xPath = XPathFactory.newInstance().newXPath();
    NodeList nodeList = (NodeList) xPath.evaluate("//text()[normalize-space()='']",
                                                  document,
                                                  XPathConstants.NODESET);

    for (int i = 0; i < nodeList.getLength(); ++i) {
        Node node = nodeList.item(i);
        node.getParentNode().removeChild(node);
    }

    Transformer transformer = TransformerFactory.newInstance().newTransformer();
    transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
    transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
    transformer.setOutputProperty(OutputKeys.INDENT, "yes");
    transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");

    StringWriter stringWriter = new StringWriter();
    StreamResult streamResult = new StreamResult(stringWriter);

    transformer.transform(new DOMSource(document), streamResult);

    System.out.println(stringWriter.toString());
}
catch (Exception e) {
    e.printStackTrace();
}

1
'{ xml.apache.org/xslt } indent-amount'プロパティを使用すると、特定のトランスフォーマー実装に関連付けられます。
vallismortis 2015年

1
すべてのソリューションから、これが最も効果的でした。私はすでにXMLにスペースと改行があり、プロジェクトに依存関係を追加したくありませんでした。XMLを解析する必要がなかったと思いますが、まあ。
Fabio

5

以下のこのコードは完全に機能します

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

String formattedXml1 = prettyFormat("<root><child>aaa</child><child/></root>");

public static String prettyFormat(String input) {
    return prettyFormat(input, "2");
}

public static String prettyFormat(String input, String indent) {
    Source xmlInput = new StreamSource(new StringReader(input));
    StringWriter stringWriter = new StringWriter();
    try {
        TransformerFactory transformerFactory = TransformerFactory.newInstance();
        Transformer transformer = transformerFactory.newTransformer();
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", indent);
        transformer.transform(xmlInput, new StreamResult(stringWriter));

        String pretty = stringWriter.toString();
        pretty = pretty.replace("\r\n", "\n");
        return pretty;              
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}

5

私はそれらすべてを混ぜて、1つの小さなプログラムを書いています。xmlファイルから読み取って印刷しています。xzyの代わりにファイルパスを指定します。

    public static void main(String[] args) throws Exception {
    DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
    dbf.setValidating(false);
    DocumentBuilder db = dbf.newDocumentBuilder();
    Document doc = db.parse(new FileInputStream(new File("C:/Users/xyz.xml")));
    prettyPrint(doc);

}

private static String prettyPrint(Document document)
        throws TransformerException {
    TransformerFactory transformerFactory = TransformerFactory
            .newInstance();
    Transformer transformer = transformerFactory.newTransformer();
    transformer.setOutputProperty(OutputKeys.INDENT, "yes");
    transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
    transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
    transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
    DOMSource source = new DOMSource(document);
    StringWriter strWriter = new StringWriter();
    StreamResult result = new StreamResult(strWriter);transformer.transform(source, result);
    System.out.println(strWriter.getBuffer().toString());

    return strWriter.getBuffer().toString();

}

4

私たちのために働くちょうど別のソリューション

import java.io.StringWriter;
import org.dom4j.DocumentHelper;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;

**
 * Pretty Print XML String
 * 
 * @param inputXmlString
 * @return
 */
public static String prettyPrintXml(String xml) {

    final StringWriter sw;

    try {
        final OutputFormat format = OutputFormat.createPrettyPrint();
        final org.dom4j.Document document = DocumentHelper.parseText(xml);
        sw = new StringWriter();
        final XMLWriter writer = new XMLWriter(sw, format);
        writer.write(document);
    }
    catch (Exception e) {
        throw new RuntimeException("Error pretty printing xml:\n" + xml, e);
    }
    return sw.toString();
}

3

jdom2の使用:http ://www.jdom.org/

import java.io.StringReader;
import org.jdom2.input.SAXBuilder;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

String prettyXml = new XMLOutputter(Format.getPrettyFormat()).
                         outputString(new SAXBuilder().build(new StringReader(uglyXml)));

3

回答する代わりに、最大codeskrapsデビッド・イーズリーmilosmns:、私の軽量、高性能プリティプリンタのライブラリを見ていXML-フォーマッタを

// construct lightweight, threadsafe, instance
PrettyPrinter prettyPrinter = PrettyPrinterBuilder.newPrettyPrinter().build();

StringBuilder buffer = new StringBuilder();
String xml = ..; // also works with char[] or Reader

if(prettyPrinter.process(xml, buffer)) {
     // valid XML, print buffer
} else {
     // invalid XML, print xml
}

時々、モックされたSOAPサービスをファイルから直接実行するときのように、すでにきれいに印刷されたXMLも処理するきれいなプリンターを用意するとよいでしょう。

PrettyPrinter prettyPrinter = PrettyPrinterBuilder.newPrettyPrinter().ignoreWhitespace().build();

一部の人がコメントしたように、プリティプリンティングは、XMLをより人間が読める形式で表示する方法にすぎません。空白は、XMLデータに厳密には属していません。

このライブラリは、ロギングの目的でプリティプリントすることを目的としており、CDATAおよびテキストノードでのXMLのフィルタリング(サブツリーの削除/匿名化)およびプリティプリントのための関数も含まれています。



2

Underscore-javaには静的メソッドがありU.formatXml(string)ます。私はプロジェクトのメンテナーです。実例

import com.github.underscore.lodash.U;

public class MyClass {
    public static void main(String args[]) {
        String xml = "<tag><nested>hello</nested></tag>";

        System.out.println(U.formatXml("<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>" + xml + "</root>"));
    }
}

出力:

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <tag>
      <nested>hello</nested>
   </tag>
</root>

これはすごい!
上級者、

1

xmlstarlet(http://xmlstar.sourceforge.net/)と呼ばれる非常に素晴らしいコマンドラインxmlユーティリティがあります。)があり、多くの人々が使用する多くのことを実行できます。

Runtime.execを使用してこのプログラムをプログラムで実行し、フォーマットされた出力ファイルを読み込むことができます。数行のJavaコードが提供できるよりも多くのオプションとより良いエラー報告があります。

xmlstarletをダウンロード:http ://sourceforge.net/project/showfiles.php?group_id=66612&package_id=64589


1

Java 1.6.0_32では、XML 文字列をきれいに出力する通常の方法(ヌルまたはアイデンティティxsltを使用したトランスフォーマーを使用)が、タグが空白で区切られているだけではなく、区切り文字がない場合と同じように動作しないことがわかりましたテキスト。私が使用してみました<xsl:strip-space elements="*"/>無駄に私のテンプレートに。私が見つけた最も簡単な解決策は、SAXSourceとXMLフィルターを使用して、スペースを希望どおりに取り除くことでした。私のソリューションはロギング用だったので、これを拡張して不完全なXMLフラグメントで動作するようにしました。DOMSourceを使用する場合は通常の方法で問題なく動作するように見えますが、不完全さとメモリオーバーヘッドのため、これを使用したくありませんでした。

public static class WhitespaceIgnoreFilter extends XMLFilterImpl
{

    @Override
    public void ignorableWhitespace(char[] arg0,
                                    int arg1,
                                    int arg2) throws SAXException
    {
        //Ignore it then...
    }

    @Override
    public void characters( char[] ch,
                            int start,
                            int length) throws SAXException
    {
        if (!new String(ch, start, length).trim().equals("")) 
               super.characters(ch, start, length); 
    }
}

public static String prettyXML(String logMsg, boolean allowBadlyFormedFragments) throws SAXException, IOException, TransformerException
    {
        TransformerFactory transFactory = TransformerFactory.newInstance();
        transFactory.setAttribute("indent-number", new Integer(2));
        Transformer transformer = transFactory.newTransformer();
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
        StringWriter out = new StringWriter();
        XMLReader masterParser = SAXHelper.getSAXParser(true);
        XMLFilter parser = new WhitespaceIgnoreFilter();
        parser.setParent(masterParser);

        if(allowBadlyFormedFragments)
        {
            transformer.setErrorListener(new ErrorListener()
            {
                @Override
                public void warning(TransformerException exception) throws TransformerException
                {
                }

                @Override
                public void fatalError(TransformerException exception) throws TransformerException
                {
                }

                @Override
                public void error(TransformerException exception) throws TransformerException
                {
                }
            });
        }

        try
        {
            transformer.transform(new SAXSource(parser, new InputSource(new StringReader(logMsg))), new StreamResult(out));
        }
        catch (TransformerException e)
        {
            if(e.getCause() != null && e.getCause() instanceof SAXParseException)
            {
                if(!allowBadlyFormedFragments || !"XML document structures must start and end within the same entity.".equals(e.getCause().getMessage()))
                {
                    throw e;
                }
            }
            else
            {
                throw e;
            }
        }
        out.flush();
        return out.toString();
    }

1

Java 1.6以降でここで見つけたソリューションは、コードがすでにフォーマットされている場合、コードを再フォーマットしません。私のために働いた(そしてすでにフォーマットされたコードを再フォーマットした)ものは次のとおりでした。

import org.apache.xml.security.c14n.CanonicalizationException;
import org.apache.xml.security.c14n.Canonicalizer;
import org.apache.xml.security.c14n.InvalidCanonicalizerException;
import org.w3c.dom.Element;
import org.w3c.dom.bootstrap.DOMImplementationRegistry;
import org.w3c.dom.ls.DOMImplementationLS;
import org.w3c.dom.ls.LSSerializer;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
import java.io.IOException;
import java.io.StringReader;

public class XmlUtils {
    public static String toCanonicalXml(String xml) throws InvalidCanonicalizerException, ParserConfigurationException, SAXException, CanonicalizationException, IOException {
        Canonicalizer canon = Canonicalizer.getInstance(Canonicalizer.ALGO_ID_C14N_OMIT_COMMENTS);
        byte canonXmlBytes[] = canon.canonicalize(xml.getBytes());
        return new String(canonXmlBytes);
    }

    public static String prettyFormat(String input) throws TransformerException, ParserConfigurationException, IOException, SAXException, InstantiationException, IllegalAccessException, ClassNotFoundException {
        InputSource src = new InputSource(new StringReader(input));
        Element document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(src).getDocumentElement();
        Boolean keepDeclaration = input.startsWith("<?xml");
        DOMImplementationRegistry registry = DOMImplementationRegistry.newInstance();
        DOMImplementationLS impl = (DOMImplementationLS) registry.getDOMImplementation("LS");
        LSSerializer writer = impl.createLSSerializer();
        writer.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE);
        writer.getDomConfig().setParameter("xml-declaration", keepDeclaration);
        return writer.writeToString(document);
    }
}

これは、フルストリングxml比較のための単体テストで使用するのに適したツールです。

private void assertXMLEqual(String expected, String actual) throws ParserConfigurationException, IOException, SAXException, CanonicalizationException, InvalidCanonicalizerException, TransformerException, IllegalAccessException, ClassNotFoundException, InstantiationException {
    String canonicalExpected = prettyFormat(toCanonicalXml(expected));
    String canonicalActual = prettyFormat(toCanonicalXml(actual));
    assertEquals(canonicalExpected, canonicalActual);
}

1

XMLが100%有効であることを必要としない、素早くて汚いソリューションを探している人のために。たとえば、REST / SOAPロギングの場合(他のユーザーが何を送信するかはわかりません;-))

私はオンラインで見つけたコードを見つけて高度化しましたが、有効な可能なアプローチとしてここではまだ見当たらないと思います。

public static String prettyPrintXMLAsString(String xmlString) {
    /* Remove new lines */
    final String LINE_BREAK = "\n";
    xmlString = xmlString.replaceAll(LINE_BREAK, "");
    StringBuffer prettyPrintXml = new StringBuffer();
    /* Group the xml tags */
    Pattern pattern = Pattern.compile("(<[^/][^>]+>)?([^<]*)(</[^>]+>)?(<[^/][^>]+/>)?");
    Matcher matcher = pattern.matcher(xmlString);
    int tabCount = 0;
    while (matcher.find()) {
        String str1 = (null == matcher.group(1) || "null".equals(matcher.group())) ? "" : matcher.group(1);
        String str2 = (null == matcher.group(2) || "null".equals(matcher.group())) ? "" : matcher.group(2);
        String str3 = (null == matcher.group(3) || "null".equals(matcher.group())) ? "" : matcher.group(3);
        String str4 = (null == matcher.group(4) || "null".equals(matcher.group())) ? "" : matcher.group(4);

        if (matcher.group() != null && !matcher.group().trim().equals("")) {
            printTabs(tabCount, prettyPrintXml);
            if (!str1.equals("") && str3.equals("")) {
                ++tabCount;
            }
            if (str1.equals("") && !str3.equals("")) {
                --tabCount;
                prettyPrintXml.deleteCharAt(prettyPrintXml.length() - 1);
            }

            prettyPrintXml.append(str1);
            prettyPrintXml.append(str2);
            prettyPrintXml.append(str3);
            if (!str4.equals("")) {
                prettyPrintXml.append(LINE_BREAK);
                printTabs(tabCount, prettyPrintXml);
                prettyPrintXml.append(str4);
            }
            prettyPrintXml.append(LINE_BREAK);
        }
    }
    return prettyPrintXml.toString();
}

private static void printTabs(int count, StringBuffer stringBuffer) {
    for (int i = 0; i < count; i++) {
        stringBuffer.append("\t");
    }
}

public static void main(String[] args) {
    String x = new String(
            "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\"><soap:Body><soap:Fault><faultcode>soap:Client</faultcode><faultstring>INVALID_MESSAGE</faultstring><detail><ns3:XcbSoapFault xmlns=\"\" xmlns:ns3=\"http://www.someapp.eu/xcb/types/xcb/v1\"><CauseCode>20007</CauseCode><CauseText>INVALID_MESSAGE</CauseText><DebugInfo>Problems creating SAAJ object model</DebugInfo></ns3:XcbSoapFault></detail></soap:Fault></soap:Body></soap:Envelope>");
    System.out.println(prettyPrintXMLAsString(x));
}

これが出力です:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <soap:Fault>
        <faultcode>soap:Client</faultcode>
        <faultstring>INVALID_MESSAGE</faultstring>
        <detail>
            <ns3:XcbSoapFault xmlns="" xmlns:ns3="http://www.someapp.eu/xcb/types/xcb/v1">
                <CauseCode>20007</CauseCode>
                <CauseText>INVALID_MESSAGE</CauseText>
                <DebugInfo>Problems creating SAAJ object model</DebugInfo>
            </ns3:XcbSoapFault>
        </detail>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

1

私はを使用して1つの回答を見たScalaのでGroovy、誰かが面白いと思った場合に備えて、ここにの別の回答があります。デフォルトのインデントは2ステップで、XmlNodePrinterコンストラクターに別の値を渡すこともできます。

def xml = "<tag><nested>hello</nested></tag>"
def stringWriter = new StringWriter()
def node = new XmlParser().parseText(xml);
new XmlNodePrinter(new PrintWriter(stringWriter)).print(node)
println stringWriter.toString()

Groovy jarがクラスパスにある場合のJavaからの使用

  String xml = "<tag><nested>hello</nested></tag>";
  StringWriter stringWriter = new StringWriter();
  Node node = new XmlParser().parseText(xml);
  new XmlNodePrinter(new PrintWriter(stringWriter)).print(node);
  System.out.println(stringWriter.toString());

1

インデントがそれほど必要ない場合は、数行の改行で十分ですが、単に正規表現で十分です...

String leastPrettifiedXml = uglyXml.replaceAll("><", ">\n<");

インデントがないための結果ではなく、コードは適切です。


(インデントのある解決策については、他の回答を参照してください。)


1
うーん...大声で考えるだけで、誰がそのような解決策を必要とするでしょうか?私が見ることができる唯一の領域は、いくつかのWebサービスから取得したデータであり、そのデータとその有効性をテストするためだけです。それ以外の場合は適切なオプションではありません...
Sudhakar Chavali

1
@SudhakarChavali私は開発者です。ダーティなprintln()とlog.debug()のハックにはそれが必要かもしれません。つまり、時々、プログラムをまともな段階的にデバッグする代わりに、(シェルアクセスの代わりにWeb管理インターフェースを使用して)制限されたサーバー環境内からのみログファイルを使用できます。
コモナード
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.