AXIS2中OMElement和Java對象之間的轉換*(詳細版)

AXIOM

Axis物件模型（AXIOM）是一個XML物件模型，設計用於提高XML處理期間的記憶體的使用率和效能，基於Pull解析。

Pull解析方式，基於STAX（Streaming API for XML），Pull解析是最近處理XML的一種趨勢，而SAX和DOM都是基於push的解析方式，也就是說解析控制在parser本身。Push解析方式很容易使用，但在處理XML文檔時效率並不好，（因為要在記憶體中產生完成的物件模型）。Pull解析方式顛倒了這種控制方式，增強了parser，只在使用者需要的時候才進行處理。使用者決定處理或者忽略parser產生的事件。

AXIOM（也稱為OM）可以控制解析過程，以提供延遲構建支援。延遲構建是指AXIOM不完全構建物件模型，模型的其餘部分基於使用者的需要構建。以下執行個體對此概念進行了說明：假定某個使用者需要從XML輸入資料流中獲得一個人的<Location>元素值，AXIOM構建的物件模型將一直包含到<Location>元素結束的內容，而讓其他內容保留在流中：

清單 1.物件模型的AXIOM部分構建

<Persons>
     <Person>
          <Name>DihInI Himahansi</Name>
          <Sex>Femal</Sex>
          <Location>Colomo,Sri LanKa</Location>
          <--物件模型僅在此之上建立-->
     </Person>
     <Person>
          <Name>DihInI Himahansi</Name>
          <Sex>Femal</Sex>
          <Location>Colomo,Sri LanKa</Location>
      </Person>
</Persons>

這裡的優勢在於，儘可能僅使用能滿足使用者需求的記憶體。如果使用者希望訪問較大的文檔中前面的數個位元組或數千個位元組，則延遲構建功能將改善應用程式的記憶體需求情況。

可以從任何元素獲得Stax事件，而不管是否完整構建了物件模型。在有些情況下，Axis2的此功能非常有用。例如，當Axis2作為中介傳遞時，如果僅需要讀取SOAP訊息的Header，AXIOM將防止其讀取整個SOAP訊息，使其具有很高的記憶體效率。另一個例子是，當Web服務實現能夠直接使用Stax事件時，由於採用了AXIOM，Web服務所需的記憶體非常小。

此外，AXIOM內建了訊息傳輸最佳化機制（Message Transfer Optimization Mechanism，MTOM）支援。對於AXIOM體繫結構，可以通過實現AXIOM介面並將其插入到Axis2中來執行自己的物件模型。

由於AXIOM最初是作為Axis2的物件模型而開發的，因此AXIOM提供了構建於基礎AXIOM API之上的SOAP介面。這允許您使用envelop.getHeaders和envelope.getBody之類的便利方法查看SOAP。

AXIS2會將Web Service方法中的參數或傳回值中的自訂對象、數組、List等類型統一映射為OMElement類型，這就是我們需要編寫OMElement於自訂類型之間的轉換方法，下面給出了幾個常用的方法：

CASE1：自訂對象產生OMElement方法：

Person man=new Person();
man.setName("Warlaze");
man.setAge(25);
man.setAddress("Bei jing");
man.setPhonenum("15900000000");
javax.xml.stream.XMLStreamReader reader=BeanUtil.getPullParser(man);
StreamWrapper parser=new StreamWrapper(reader);
StAXOMBuilder stAXOMBuilder=OMXMLBuilderFactory.createStAXOMBuilder(OMAbstractory.getOMFactory(), parser);
OMElement element=stAXOMBuilder.getDocumentElement();

CASE2：list或Array類型產生OMElement方法：

List<Person> list=new ArrayList<Person>();
list.add(man);
OMElement omElement=BeanUtil.getOMElement(new QName("root"),list.toArray(),new QName("person"),false,null);

CASE3：解析包含基本類型的List或Array產生的OMElement的方法：

private static List<String> getResults(OMElement element){
if(element==null){
       return null;
   }
Iterrator iterator=element.getChildElements();
List<String> list=new ArrayList<String>();
while(iterator.hasNext()){
         OMNode omNode=(OMNode)iterator.next();
          if(omNode.getType()==OMNode.ELEMENT_NODE){
                OMElement omElement=(OMElement)omNode;
                 if(omElement.getLocalName().equals("string")){
                      String temp=omElement.getText().trim();
                       System.out.println(temp);
                       list.add(temp);
                  }
           }
   }
   return list;
}

CASE4：解析包含自訂Java類型的List或Array的方法：

private static List<Person> getResults(OMElement element) throws AxisFault{
         if(element==null){
                  return null;
         }
         Iterator iterator=element.getChildElements();
         List<Person> list=new ArrayList<Person>();
         while(iterator.hasNext()){
               OMNode omNode=(OMNode)iterator.next();
               if(omElement.getType()==OMNode.ELEMENT_NODE){
                       OMElement omElement=(OMElement)omNode;
                        if(omElement.getLocalName().toLowerCase().equals("person")){
                            Person person=(Person)BeanUtil.processObject(omElement,Person.class,null,true,new DefaultObjectSupplier());
                             list.add(person);
                        }
               }
         }
    }

http://www.blogjava.net/juleven/archive/2006/12/08/86458.html

Axiom讀XML：

    // 首先構建parser，
    XMLStreamReader parser = XMLInputFactory.newInstance().createXMLStreamReader(
            new FileInputStream("5.xml"));
    // 還需要builder對象，
    StAXOMBuilder builder = new StAXOMBuilder(parser);
    // get the root element
    // OMElement documentElement = builder.getDocumentElement();
    OMDocument doc = builder.getDocument();

    OMElement cre = doc.getOMDocumentElement().getFirstChildWithName(new QName("fool"));

    // OMElement有一系列的get方法來獲得內容。

    cre.serialize(System.out); // cache on
    cre.serializeAndConsume(System.out); // cache off

    // will NOT build the OMTree in the memory.
    // So you are at your own risk of losing information.
    String creStr = cre.toStringWithConsume();
    // call toString, will build the OMTree in the memory.
    System.out.println(cre);

Axiom寫XML：

    // 可以構建writer做輸出器，
    XMLStreamWriter writer = XMLOutputFactory.newInstance().createXMLStreamWriter(
            new FileOutputStream("2.xml"));

    // 通常通過OMFactory來構造XML文檔中的element，下面是一些範例程式碼。
    OMFactory factory = OMAbstractFactory.getOMFactory();
     OMDocument doc = factory.createOMDocument();
    OMNamespace ns = factory.createOMNamespace("http://demo.axiom","x");
    OMNamespace ns1 = factory.createOMNamespace("http://ot.demo.axiom","y");
    OMElement root = factory.createOMElement("root",ns);
    OMElement elt11 = factory.createOMElement("fool",ns1);
    elt11.addChild(factory.createOMText("YY"));
    OMElement ele = factory.createOMElement("ele", "http://namespace", "ns");
    ele.addChild(factory.createOMText("ELE"));
    root.addAttribute(factory.createOMAttribute("attr", ns, "test attr"));
    root.addChild(elt11);
    root.addChild(ele);
    doc.addChild(root);
    root.serialize(writer); // cache on
    writer.flush();
    doc.serializeAndConsume(new FileOutputStream("3.xml"));
    OMOutputFormat oof = new OMOutputFormat();
    doc.serializeAndConsume(new FileOutputStream("5.xml"), oof);      //cache off //ele.detach();
    ele.serialize(System.out); // 即使detach()，依然會輸出ele
    doc.serialize(System.out); // 如果detach()，就不會有ele到document裡。

關於serialize和serializeAndConsume，前者會強制構建OMTree，或者則不會。
關於detach，它隻影響OMElement本身和OMTree的關係，並不影響OMElement本身。
與之對應的還有一個build方法，build會強制build整個OMTree出來。
這兩個方法通常用在處理OMElement與OMTree的關係上。從輸入資料流構建出OMElement(build)以及把OMElement從輸入資料流斷開(detach)，以便放到輸出資料流。輸入資料流和輸出資料流是不同的OMTree。

測試用的XML文檔（5.xml），

<?xml version='1.0' encoding='utf-8'?>
<x:root xmlns:x="http://demo.axiom" x:attr="test attr">
<y:fool xmlns:y="http://ot.demo.axiom">YY</y:fool>
<ns:ele xmlns:ns="http://namespace">ELE</ns:ele>
</x:root>

參考：
AXIOM Tutorial : http://ws.apache.org/commons/axiom/OMTutorial.html