学习笔记:
基于事件驱动,逐条解析,读取一点解析一点,适用于只读取不修改dom结构,占用内存小。
- xml格式如下:
<?xml version="1.0" encoding="UTF-8"?> <beans> <bean id="1" class="com.lvzheng.channel.bean.Book"> <property name="author" value="恶犬"/> <property name="name" value="我与虎谋早餐"/> <property name="price">10.0</property> </bean> <bean id="2" class="com.lvzheng.channel.bean.Book"> <property name="author" value="飞雪"/> <property name="name" value="蜀内大雨连绵"/> <property name="price">15.0</property> </bean> </beans>
- 创建xml事件处理器
import com.alibaba.fastjson.JSON;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang3.StringUtils;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import java.lang.reflect.Field;
import java.util.*;
/**
* xml事件处理器
* 可以实现ContentHandler 或者继承DefaultHandler
* 最好继承DefaultHandler,因为实现ContentHandler需要实现所有的方法
* 而DefaultHandler本身是一个实现了ContentHandler 接口的类,空实现了所有的方法
* 继承DefaultHandler只需要重写需要的方法即可
*/
public class BookHandler extends DefaultHandler {
private List<Object> objList;
private String clazz;
private Map<String, String> map;
private String content = StringUtils.EMPTY;
private String name;
/**
* 文档解析前调用,只会被调用一次
*
* @throws SAXException
*/
@Override
public void startDocument() throws SAXException {
System.out.println("==开始解析xml文件==");
}
/**
* 标签节点开始解析时调用
*
* @param uri
* @param localName
* @param qName 标签名称
* @param attributes 标签的属性集
* @throws SAXException
*/
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
// 解析至名字为bean的节点时,创建对象
if (StringUtils.equalsIgnoreCase(qName, "beans")) {
objList = new ArrayList<>();
map = new HashMap<>();
} else if (StringUtils.equalsIgnoreCase(qName, "bean")) {
String id = attributes.getValue("id");
clazz = attributes.getValue("class");
map.put("id", id);
} else if (StringUtils.equalsIgnoreCase(qName, "property")) {
name = attributes.getValue("name");
String value = attributes.getValue("value");
map.put(name, value);
}
}
/**
* 解析标签内容的时候调用
*
* @param ch 当前读取内容的字节数组
* @param start 字节开始位置
* @param length 当前读取内容的长度
* @throws SAXException
*/
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
// 获取节点内容
content = new String(ch, start, length);
}
/**
* 标签节点结束时调用
*
* @param uri
* @param localName
* @param qName
* @throws SAXException
*/
@Override
public void endElement(String uri, String localName, String qName) throws SAXException {
if (StringUtils.equalsIgnoreCase(qName, "bean")) {
setProperty();
} else if (StringUtils.equalsIgnoreCase(qName, "property")) {
if (StringUtils.isNotBlank(content)) {
map.put(name, content);
}
name = StringUtils.EMPTY;
}
}
/**
* 文档解析结束后调用,只会调用一次
*
* @throws SAXException
*/
@Override
public void endDocument() throws SAXException {
System.out.println("==结束解析xml文件==");
System.out.println(JSON.toJSON(objList));
}
private void setProperty() {
if (StringUtils.isBlank(clazz)) {
return;
}
try {
Class<?> aClass = Class.forName(clazz);
Object obj = aClass.newInstance();
Field[] fields = aClass.getDeclaredFields();
for (Field field : fields) {
Object object = MapUtils.getObject(map, field.getName());
if (Objects.nonNull(object)) {
field.setAccessible(true);
if (Objects.equals(field.getType(), Integer.class)) {
field.set(obj, Integer.valueOf((String) object));
} else if (Objects.equals(field.getType(), String.class)) {
field.set(obj, object);
}
}
}
objList.add(obj);
map.clear();
} catch (Exception e) {
e.printStackTrace();
}
}
}
3.创建测试类
import org.xml.sax.XMLReader;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
public class TestSax {
public static void main(String[] args) throws Exception {
// 创建sax解析器工厂
SAXParserFactory factory = SAXParserFactory.newInstance();
// 创建sax解析器
SAXParser saxParser = factory.newSAXParser();
// 创建xml读取器
XMLReader reader = saxParser.getXMLReader();
BookHandler bh = new BookHandler();
// 绑定事件处理器
reader.setContentHandler(bh);
reader.parse("src/main/resources/beans.xml");
}
}
输出结果为
[{"author":"恶犬","id":1,"name":"我与虎谋早餐","price":"10.0"},{"author":"飞雪","id":2,"name":"蜀内大雨连绵","price":"15.0"}]
spring中使用的是sax解析,对bean标签的解析最为复杂
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
// 解析bean标签
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
// 解析id属性
String id = ele.getAttribute(ID_ATTRIBUTE);
// 解析name属性
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isDebugEnabled()) {
logger.debug("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
// 如果不存在beanName,按照spring的规则生成beanName
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
beanName = this.readerContext.generateBeanName(beanDefinition);
// Register an alias for the plain bean class name, if still possible,
// if the generator returned the class name plus a suffix.
// This is expected for Spring 1.2/2.0 backwards compatibility.
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isDebugEnabled()) {
logger.debug("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
@Nullable
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
// 解析元数据
parseMetaElements(ele, bd);
// 解析 lookup-method
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
// 解析 replace-method
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
// 解析构造器
parseConstructorArgElements(ele, bd);
// 解析property
parsePropertyElements(ele, bd);
// 解析qualifier
parseQualifierElements(ele, bd);
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
catch (ClassNotFoundException ex) {
error("Bean class [" + className + "] not found", ele, ex);
}
catch (NoClassDefFoundError err) {
error("Class that bean class [" + className + "] depends on not found", ele, err);
}
catch (Throwable ex) {
error("Unexpected failure during bean definition parsing", ele, ex);
}
finally {
this.parseState.pop();
}
return null;
}