使用安卓内置的pull解析器解析xml文档,并自动映射成bean

安卓本身内置XmlPullParser解析器,默认也是使用这个解析器进行xml文档的解析。这里自己写了一个方法来使用XmlPullParser解析器,解析xml文档,并自动转换为对应实体bean。


package com.example.org.suju.pullxmldemo;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Stack;

import org.xmlpull.v1.XmlPullParser;
import android.util.Log;
import android.util.Xml;

public class PullXmlUtils<T> {
	
	/** 当前索引的xml标签值  */
	private String tagname = null;
	
	/** 实体类class */
	private Class<T> cls;
	
	/** 保存实体类对象list集合  */
	private List<T> objs;
	
	/** 存放对应实体类和起复合成员变量对象的method[]数组的 hash表 */
	private Map<Class<?>, Method[]> methodmap;
	
	/** 用于保存当前正在操作实体类的栈,里面保存有实体类和其复合成员字段的实体类  */
	private Stack<Object> stack;
	
	/**
	 * 初始化类
	 * @param cls
	 */
	public PullXmlUtils(Class<T> cls)
	{
		this.cls = cls;
		this.stack = new Stack<Object>();
		this.methodmap = new HashMap<Class<?>, Method[]>();
		this.methodmap.put(cls, cls.getDeclaredMethods());
	}
	
	/**
	 * 解析标签方法,返回包装解析内容的bean集合
	 * @param inputStream   输入解析流
	 * @return				解析bean类集合
	 * @throws Exception
	 */
	public List<T> parse(InputStream inputStream) throws Exception
	{
		XmlPullParser pull = Xml.newPullParser();
		//默认utf-8解析编码
		pull.setInput(inputStream, "UTF-8");
		
		//获取pull解析事件类型
		int type = pull.getEventType();
		while (type != XmlPullParser.END_DOCUMENT) {
			switch (type) {
				//文档开始事件
				case XmlPullParser.START_DOCUMENT:
					objs = new ArrayList<T>();
					break;
				//开始解析标签事件
				case XmlPullParser.START_TAG:
					startTag(pull);
					break;
				//标签结束事件
				case XmlPullParser.END_TAG:
					endTag(pull.getName());
					break;
			}
			type = pull.next();
		}
		return objs;
	}
	
	/**
	 * 标签结束处理
	 * @param qName  当前标签名称
	 */
	private void endTag(String qName)
	{
		//当前标签值是实体类标签,stack出栈,并添加到实体类集合中
		if (cls.getSimpleName().equals(qName)) {
			objs.add((T) stack.pop());
		} else if (!stack.empty()) {
			try {
				//当栈不为空时,获取栈顶元素的class名称,判断是否对应qName标签值
				String clsname = stack.peek().getClass().getSimpleName();
				if (clsname.equals(qName)) {
					/*
					 * 第一次弹出栈的obj为实体类对应的set方法的形参对象,
					 * 出栈后,栈顶元素就为调用改set方法的对象。
					 */
					Object parent = stack.pop();
					invokeSetMethod(stack.peek(), qName, parent);
				}
			} catch (Exception e) {
				Log.d("log", e.toString());
			}
		}
		tagname = null;
	}
	
	/**
	 * 解析标签内容体
	 * @param pull  xml解析器对象
	 */
	private void parseTag(XmlPullParser pull)
	{
		//解析字符内容
		if (tagname == null) return;
		
		String name = null;
		Method[] methods = stack.empty() ?
							methodmap.get(cls) : methodmap.get(stack.peek().getClass());
		
		//遍历method数组,如果当前tagname标签对应其中一个method,则执行该method
		for (Method method: methods) {
			name = setMethodName(tagname);
			if (name.equals(method.getName())) {
				try {
					/*
					 * 当前栈顶元素为调用改method方法的对象
					 * new String(ch, start, length) 为标签值
					 */
					invokeSetMethod(stack.peek(), tagname, pull.nextText());
					break;
				} catch (Exception e) {
					Log.d("log", e.toString());
				}
			}
		}
	}
	
	/**
	 * 标签开始解析处理
	 * @param pull   xml解析器对象
	 * @throws Exception
	 */
	private void startTag(XmlPullParser pull) throws Exception
	{
		String qName = pull.getName();
		//根据栈是否为空来获取默认实体类或者字段所对应qName名称的方法
		Method method = stack.empty() ? 
						getMethod(cls, qName) : getMethod(stack.peek().getClass(), qName);
		
		try {
			if (method != null) {
				//获取方法形参类型,这里定义set方法只有一个参数
				Class<?> paramtype = method.getParameterTypes()[0];
				//获取对应参数类型的枚举值,并设置标签属性值
				TypeEnum te = TypeEnum.valueOfTE(paramtype.getSimpleName());
				if (te == TypeEnum.EMPTY) {
					setAttr(paramtype, pull);
				}
			} else if (cls.getSimpleName().equals(qName)) {
				//当前标签为实体类标签时,设置实体类对应的xml标签属性值
				setAttr(cls, pull);
			}
		} catch (Exception e) {
			Log.d("log", e.toString());
		}
		//设置当前索引到的标签
		tagname = qName;
		parseTag(pull);
	}
	
	/**
	 * 
	 * @param paramtype     形参类型
	 * @param attributes    属性值对象
	 * @throws Exception
	 */
	private void setAttr(Class<?> paramtype, XmlPullParser pull) throws Exception
	{
		//实例化形参class对应的对象,并入栈
		stack.push(paramtype.newInstance());
		if (!methodmap.containsKey(paramtype)) {
			//如果method的hash表不包含此class的方法,则保存方法数组到hash表
			methodmap.put(paramtype, paramtype.getDeclaredMethods());
		}
		//遍历设置属性值
		for (int i=0; i < pull.getAttributeCount(); i++) {
			invokeSetMethod(stack.peek(), pull.getAttributeName(i), pull.getAttributeValue(i));
		}
	}
	
	/**
	 * 
	 * @param cls   实体类中方法的形参参数类型
	 * @param obj	实体类set方法传入的参数对象
	 * @return      根据参数类型转换参数对象值
	 */
	private Object changeType(Class<?> cls, Object obj)
	{
		//根据cls名称获取对应类型枚举值,没有返回EMPTY
		TypeEnum te = TypeEnum.valueOfTE(cls.getSimpleName());
		String value = obj.toString();
		switch (te) {
			case BOOLEAN:
				return Boolean.valueOf(value);
			case BYTE:
				return Byte.valueOf(value);
			case CHAR:
				return value.charAt(0);
			case DOUBLE:
				return Double.valueOf(value);
			case SHORT:
				return Short.valueOf(value);
			case FLOAT:
				return Float.valueOf(value);
			case INT:
				return Integer.valueOf(value);
			case LONG:
				return Long.valueOf(value);
			case STRING:
				return value;
			default:
				//不对应以上java自带基本类型,返回原始obj对象
				return obj;
		}
	}
	
	/**
	 * 此方法待合并
	 * @param    name 符合javabean规范的类的方法名
	 * @return   返回getXXX形式无参数方法名
	 */
	private String setMethodName(String name)
	{
		StringBuilder sb = new StringBuilder(name);
		//替换首字符为大写
		char first = sb.charAt(0);
		sb.setCharAt(0, Character.toUpperCase(first));
		sb.insert(0, "set");
		return sb.toString();
	}
	
	/**
	 * 
	 * @param obj        执行方法的对象
	 * @param mname      方法名称
	 * @param args       方法参数列表
	 * @throws Exception
	 */
	private void invokeSetMethod(
			Object obj, String mname, Object...args
			) throws Exception
	{
		//根据对象class和方法名称获取method,这里指定set方法不重复,并且只有一个形参
		Method method = getMethod(obj.getClass(), mname);
		//得到该方法的形参class列表
		Class<?>[] types = method.getParameterTypes();
		method.invoke(obj, changeType(types[0], args[0]));
	}
	
	/**
	 * 
	 * @param cls     获取method的class类
	 * @param name    方法名称
	 * @return        返回获取的method,没有则返回null
	 */
	private Method getMethod(Class<?> cls, String name)
	{
		name = setMethodName(name);
		//在已有的method数组hash表中获取已经保存的方法数组
		Method[] methods = methodmap.get(cls);
		for (Method method: methods) {
			if (name.equals(method.getName())) {
				return method;
			}
		}
		return null;
	}
}


你可能感兴趣的:(使用安卓内置的pull解析器解析xml文档,并自动映射成bean)