最近接了一家供应商,他们的服务端采用webservice,但只能通过http进行请求,请求的返回值是如下这种格式:
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<res:Response state="success" ID="myProduct">
<res:List HotelId="888888" tip="不能取消" dateTime="2019-02-20 09:53:46">
<res:Tests>
<res:Test name="大床房" currency="CNY" code="123456" productName="豪华大床房" roomId="666666">
<res:Elements>
<res:Elements price="200" date="2019-02-20"/>
<res:Elements price="225" date="2019-02-21"/>
</res:Elements>
</res:Test>
<res:Test name="双床房" currency="CNY" code="654321" productName="豪华双床房" roomId="333333">
<res:Elements>
<res:Elements price="400" date="2019-02-20"/>
<res:Elements price="500" date="2019-02-21"/>
</res:Elements>
</res:Test>
</res:Tests>
</res:List>
</res:Response>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
网上搜了一下解析方式,如下:
MessageFactory messageFactory;
messageFactory = MessageFactory.newInstance();
SOAPMessage reqMsg = messageFactory.createMessage(new MimeHeaders(),new ByteArrayInputStream(soapString.getBytes("UTF-8")));
reqMsg.saveChanges();
SOAPBody body = reqMsg.getSOAPBody();
Iterator<SOAPElement> iterator = body.getChildElements();
while (iterator.hasNext()) {
SOAPElement element = (SOAPElement) iterator.next();
if ("res:Response".equals(element.getNodeName())) {
String status = element.getAttribute("Status");
if ("success".equals(status)) {
Iterator<SOAPElement> childIterator = element.getChildElements();
String HotelId=element.getAttribute("HotelId"));
while (childIterator.hasNext()) {
}
}
}
}
大致就是先将返回值解析为 SOAPBody,然后对 SOAPBody 里面的子元素循环迭代取出来需要的字段值解析。这是最简单,快速的解决方案。略微思考一下发现,可维护行非常差,而且代码非常冗余,于是经过反复的修改的与验证,提取出了如下的工具类:
import javax.xml.soap.*;
import java.io.ByteArrayInputStream;
import java.util.*;
public class SoapUtil {
/**
* 将webservice 的返回值各个元素存储到map中
* @param res
* @return
*/
public static Map<String,Object> doSoapToXml(String res){
if(res==null) return null;
Map<String,Object> map=new HashMap<>();
try {
MessageFactory messageFactory = MessageFactory.newInstance();
SOAPMessage reqMsg = messageFactory.createMessage(
new MimeHeaders(),
new ByteArrayInputStream(res.getBytes("UTF-8")));
reqMsg.saveChanges();
SOAPBody soapBody= reqMsg.getSOAPBody();
serialXml(soapBody,map);
} catch (Exception ex) {
ex.printStackTrace();
return null;
}
return map;
}
/**
* 将soap中获取的元素转为list
* @return
*/
public static List<SOAPElement> soap2List(Map<String,Object> map,String elementName) {
List<SOAPElement> soapElementList=new ArrayList<>();
Object obj=map.get(elementName);
if(obj==null)return soapElementList;
if(obj instanceof SOAPElement){
SOAPElement picture= (SOAPElement) obj;
soapElementList.add(picture);
}else if(obj instanceof List){
List<SOAPElement> pictures= (List<SOAPElement>) obj;
soapElementList.addAll(pictures);
}
return soapElementList;
}
/**
* 将 SOAPElement 中的元素若只有一个,则存储value值为单个的SOAPElement对象,若有多个相同的元素,则存储为 List<SOAPElement> 对象
* @param soapElement
* @param map
*/
public static void serialXml(SOAPElement soapElement, Map<String,Object> map){
String nodeName=soapElement.getNodeName();
if(map.containsKey(nodeName)){
List<SOAPElement> list=new ArrayList<>();
list.add(soapElement);
Object obj=map.get(nodeName);
if(obj instanceof SOAPElement){
SOAPElement origSOAPElement= (SOAPElement) map.get(nodeName);
list.add(origSOAPElement);
}else if(obj instanceof List){
List<SOAPElement> origList= (List<SOAPElement>) map.get(nodeName);
list.addAll(origList);
}
map.put(nodeName,list);
}else{
map.put(nodeName,soapElement);
}
Iterator iterator=soapElement.getChildElements();
if(iterator.hasNext()){
while (iterator.hasNext()){
Object obj=iterator.next();
if(obj instanceof SOAPElement){
SOAPElement childSoapElement= (SOAPElement) obj;
serialXml(childSoapElement,map);
}
}
}
}
}
整个工具类形成的思路就是将 SOAPBody 中的各个元素通过递归的方式,nodeName 节点名作为key, 节点所对应的SOAPElement 元素 作为value存储到Map中,若是单个节点,就存储为对象。若是节点数组,则存储为 List对象。
soap2List 方法方便从Map 中取出对应的数组元素,有可能此数组元素只有一个,所以统一转为LIst中存储。
最后发散一下,我们在处理类似这种在元素中循环迭代的问题时,都可以采用递归的方式将其抽象出来,这样在代码中就能专注业务逻辑,同时我们的代码质量也会变得更高