XBlink关于如何实现扩展的几点思考

XBlink在1.0.0版开始编码前，想过究竟怎么才能做成一个比较灵活易于扩展的框架。（毕竟之前的太不灵活）

灵活易于扩展，即是指很多地方可以让用户去决定，给用户更大的选择权。

序列化最终是生成可阅读的文本格式，所以只有在这上面下文章了。

经过几个朋友的讨论与个人思考，确定了至少有两点要做到。

一，对于一个对象转换生成的文字与其格式，用户可以设定。

二，对于一个用户自己定义的文本格式（或是XBlink默认没有支持的格式），用户可以有办法实现。

第一点，生成的文字与格式。

比如日期型，用人需要日月年信息就好，有人还要加上时间，这种个性化需求，就很常见。

还比如一个list，有人喜欢正常的XML格式，有人想把他们作为一行数据展示出来，例如下面这样：

 

<list>
    <int>1</int>
    <int>2</int>
    <int>3</int>
</list>

<list>{1,2,3}</list>

 

甚至还有对于这个list，用户还有自己觉得更合理的展示方式，那能不能也实现呢。

第二点，未知的文本格式。

最初的XBlink只关注XML，没有其他想法。

直到后来Nutz的作者灰灰看了XBlink后，提出能不能支持下Yaml格式的想法。

经过思考，发现其实做成一个通用性框架也不是那么困难。

首先序列化XML，就是pojo-->xml的过程，而序列化yaml，也就是pojo-->yaml，两者除了输出格式不同，其他没有什么大的区别。

在序列化XML的时候，就是一个分析对象，拿到对象值，将值转换成文字，再按照XML格式写到文本的过程。那么想要支持yaml的话，就把最后一步，按照XML格式写到文本变成按照yaml格式写到文本就好了。

有了上面的思路，下面说下XBlink是如何实现这两点的。

第一点，生成的文字与格式。

 

如果你看过了这篇使用手册，那么扩展API这部分的讲解，就是对于第一点的实现。

个性化日期与只有一行的list那种要求已经可以实现了，但是用户自定义格式的问题，还有待解决。

如果用户在转换器里可以定制格式，那么序列化与反序列化必须一起写才行，必须达到一个平衡，就是你定义的格式，反序列化必须能正确解析。

这样对用户的要求就比较高了，因为本来仅仅是对象与文字之间的转换，基本没有什么难度，但加入了格式的制定与解析，用户需要了解的内容就大幅增加，而且及其容易错误。

目前想到的解决方案就是，一定要把这部分的文档写好，让用户了解这个格式到底是如何解析的，他才会正确的使用。同时更重要的，要实现一个工具，可以帮助用户检查写出的转换器是否能正常工作。这样才能保证其可用性。

第二点，未知的文本格式。

 

如果你看过源码，你会发现，在大部分代码里，没有针对XML做什么特别的事情，因为它已经被封装到一个较为底层的类中，而要实现未知文本格式的支持，你就需要提供这样一个类似的底层类。

 

 

秘密就在org.xblink.core.doc包下。

DocReader封装了对于文本格式的读操作。

DocWriter封装了对于文本格式的写操作。

而具体是什么格式，怎么个写法，你只要搞一个实现类，放到impl包下就好了。

 

/**
 * 定义了读取文本文件的几个动作。
 * 
 * @author 胖五(pangwu86@gmail.com)
 */
public interface DocReader {

	/**
	 * 是否还存在子节点。
	 * 
	 * @return
	 */
	public boolean hasMoreChildren();

	/**
	 * 进去下一个节点。
	 */
	public void moveDown();

	/**
	 * 退到上一个节点。
	 */
	public void moveUp();

	/**
	 * 获得当前节点的名称。
	 * 
	 * @return
	 */
	public String getNodeName();

	/**
	 * 获得当前节点文字值。
	 * 
	 * @return
	 */
	public String getTextValue();

	/**
	 * 获得当期节点的属性数量。
	 * 
	 * @return
	 */
	public int getAttributeCount();

	/**
	 * 获得当前节点所有属性名称的迭代器。
	 * 
	 * @return
	 */
	public Iterator<String> getAttributeNames();

	/**
	 * 根据指定名称获得当前节点的属性值。
	 * 
	 * @param name
	 * @return
	 */
	public String getAttribute(String name);

	/**
	 * 根据指定名称获得当前节点的属性值(通过索引值)。
	 * 
	 * @param index
	 * @return
	 */
	public String getAttribute(int index);

	/**
	 * 关闭输入流。
	 */
	public void close();

	/**
	 * 获得内容的Reader。
	 * 
	 * @return
	 */
	public Reader getReader();

}

 

 

/**
 * 定义了书写文本文件的几个动作。
 * 
 * @author 胖五(pangwu86@gmail.com)
 */
public interface DocWriter {

	/**
	 * 设置XBlink运行时设置项，可以对文本格式进行部分调整。
	 * 
	 * @param xbConfig
	 */
	public void setXBConfig(XBConfig xbConfig);

	/**
	 * 编写文档开头。
	 * 
	 * @throws Exception
	 *             异常
	 */
	public void writeStartDocument() throws Exception;

	/**
	 * 编写文档结尾。(一定要先调用writeStartDocument)
	 * 
	 * @throws Exception
	 *             异常
	 */
	public void writeEndDocument() throws Exception;

	/**
	 * 编写开始标签。
	 * 
	 * @param tagName
	 *            标签名称
	 * @throws Exception
	 *             异常
	 */
	public void writeStartTag(String tagName) throws Exception;

	/**
	 * 编写结束标签。(一定要先调用writeStartTag)
	 * 
	 * @param tagName
	 *            标签名称
	 * @throws Exception
	 *             异常
	 */
	public void writeEndTag(String tagName) throws Exception;

	/**
	 * 编写属性。(一定要先调用writeStartTag)
	 * 
	 * @param name
	 *            属性名称
	 * @param value
	 *            属性值
	 * @throws Exception
	 *             异常
	 */
	public void writeAttribute(String name, String value) throws Exception;

	/**
	 * 编写内容。
	 * 
	 * @param text
	 *            内容
	 * @throws Exception
	 *             异常
	 */
	public void writeText(String text) throws Exception;

	/**
	 * 编写元素。
	 * 
	 * @param tagName
	 *            元素名称
	 * @param text
	 *            内容
	 * @throws Exception
	 *             异常
	 */
	public void writeElementText(String tagName, String text) throws Exception;

	/**
	 * 编写引用节点。(一定要先调用writeStartTag)
	 * 
	 * @param tagName
	 *            元素名称
	 * @param refName
	 *            引用属性名称
	 * @param text
	 *            引用路径
	 * @throws Exception
	 *             异常
	 */
	public void writeReference(String tagName, String refName, String text) throws Exception;

	/**
	 * 关闭当前Writer。
	 * 
	 * @throws Exception
	 *             异常
	 */
	public void close() throws Exception;

	/**
	 * 输出当前内容。
	 * 
	 * @throws Exception
	 *             异常
	 */
	public void flush() throws Exception;

	/**
	 * 返回生成的文本。
	 * 
	 * @return 文本内容
	 */
	public String getString();

	/**
	 * 获得内部的Writer。
	 * 
	 * @return
	 */
	public Writer getWriter();

}

 

 

通过上面的代码你可以看到，这里的操作基本没有针对某个文本格式（除了对Attribute的操作）。

这样你就很容易写出一个JSON的实现，一个YAML的实现，一个你自己的实现。

理论上，对于一个新的文本格式的支持，例如这个文本格式叫做OOXX，那么你只要写两个类，一个OOXXReader，一个OOXXWriter，足以。

当时这只是理论上的，能不能像ME想的这样简单，还要用代码用事实来证明。

 

毕竟暂时还没有第二个格式的Reader与Writer诞生。

 

所以ME将义无反顾的继续充当小白鼠，来为大家淌出一条血路

 

请期待JSON与YAML的到来。