项目中通常采用的写xml文件的方法

在项目中，通常需要将请求返回的内容写成xml的形式，然后再发送出去，并且为了提高程序的鲁棒性，通常要求如果写xml出错，即抛出异常，而不是传入一个错误的xml(很可能只有一半，进而导致掩盖错误，是程序处于未知状态)。所以通常的做法是，先写一个**.xml.tmp文件，在写结束后才将其rename为**.xml文件，如果写过程出错，那么就不会有后面的renmae操作，导致最后生成**.xml文件不存在，进而发现错误。

首先简要提提xml文件的格式

文件头

     Element

           subElement

                  subsubElement

                            .......

    Element

文件尾

每个Element中有多个Attribute。

这里是从File中读取内容，然后写入到xml文件中

public class ClassA{

    private String xmlFileNameTmp;     //临时文件名
    
    private String xmlFileName;             //最终需要生成的文件名

    private XMLStreamWriter xmlStreamWriter;   （重要） 
   
    public ClassA(String xmlFileName, Set<String> keys) {
        this.xmlFileName = xmlFileName;
        this.xmlFileNameTmp = xmlFileName + ".tmp";

     //try中是基本的从file转成xml的方法
        try {
            File file = new File(xmlFileNameTmp);
            FileOutputStream fileOutputStream = new FileOutputStream(file);
            XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
            xmlStreamWriter = new IndentingXMLStreamWriter(
                    outputFactory.createXMLStreamWriter(fileOutputStream, "utf-8"));
            
        } catch (FileNotFoundException e) {
            throw new LiveShowRtException("construct fail in RoomXmlDataRewriteProcessor", e);
        } catch (XMLStreamException e) {
            throw new LiveShowRtException("construct fail in RoomXmlDataRewriteProcessor", e);
        }
    }

     //初始方法
    public void init() {    
        try {
            xmlStreamWriter.writeStartDocument(RoomXmlDataRewriteConstant.ENCODEING, RoomXmlDataRewriteConstant.VERSION);
            xmlStreamWriter.writeStartElement(RoomXmlDataRewriteConstant.ADD);
        } catch (XMLStreamException e) {
            throw new LiveShowRtException("fail to start document", e);
        }
    }
   

    //注意，init方法中的writeStartDocument(String encoding,String version) 与doFinal方法中的writeEndDocument();方法是一一对应的

inti方法中的writeStartElement(String localName) 与doFinal()方法中的writeEndElement();是一一对应的。

    //结束方法
    public void doFinal() {
        
        try {
            xmlStreamWriter.writeEndElement();
            xmlStreamWriter.writeEndDocument();
            
            new File(xmlFileNameTmp).renameTo(new File(xmlFileName));
        } catch (XMLStreamException e) {
            throw new LiveShowRtException("fail to end document", e);
        }
    }

    //关闭xmlStreamWriter方法
    public void close(){
        try {
            if(null != xmlStreamWriter){
                xmlStreamWriter.close();
            }
        } catch (XMLStreamException e) {
            logger.error("fail to close xmlStreamWriter");
        }
    }

      //写入某个Element方法

    private void writeElement(String key, String value) {
        try {
            xmlStreamWriter.writeStartElement(RoomXmlDataRewriteConstant.FIELD);
            xmlStreamWriter.writeAttribute(RoomXmlDataRewriteConstant.NAME, key);
            xmlStreamWriter.writeCharacters(value);
       
            xmlStreamWriter.writeEndElement();
        } catch (XMLStreamException e) {
            throw new LiveShowRtException("fail to  process document", e);
        }
    }

//如上方法中的 RoomXmlDataRewriteconstant.FIELD和RoomXmlDataRewriteconstant.NAME都是宏定义String，表示Element的起始标志名和Attribute的name

同样滴，注意写入任何一个Element时，都会有writeStartElement和writeEndElement搭配使用