spring自定义标签之三 —— 自我实现

      引言： 最近心情比较难以平静，周末的两天就跑出去散心了，西湖边上走走，看日落，还是不错的。回来博客上发现，在自定义标签上，最后一步实现忘记加上了。其实，人生的路程中，我们总是实现着自我的价值，让自己的生活更有意义。

      在标签的定义完，也只是自我实现的一半，对于按我们的要求所定义的配置信息，自然而然的需要为这些定义各个属性进行解析和进一步的操作处理了。

 

      进一步问题： 对于前一篇（spring自定义标签之二 —— 规范定义XSD ）定义下来的xml的标签定义，如何对其进行解析的问题了。

      自定义的标签如下：

<mysql:client id="sqlMapClient" datasouceip="localhsost"  characterEncoding="utf8" 
            dbname="freebug"   username="root" password="root"
            configLocation="classpath:SqlMapCommonConfig.xml" />

     

      具体实现：

      对于在spring的配置文件中已经进行了声明标签，这些可以上（上一节的规范定义已经说明了）。在上一节中也提到了，需要在资源文件中加入几个文件。

   

      其中springtag.xsd及spring.schemas是为标签定义使用的，而spring.handlers是为了进行声明解释实handler现使用的。

      在解析自定义的标签时，对于基本简单的自定义标签可以使用如下方式。继承，两个基类，进行实现。

 

 

图1. 实现自定义标签的实现类图

      被继承的基类，为spring中带有的基类:

      1、NamespaceHandlerSupport

      2、AbstractSimpleBeanDefinitionParser

      实现类为:

      1、TagsNamespaceHandler

 

package config;

import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

/**
 * 注册定自义标签对应的解析类
 * 
 * @author sammor
 * @date 2011-6-27 上午10:52:44
 */
public class TagsNamespaceHandler extends NamespaceHandlerSupport {

	@Override
	public void init() {
                //自定义标签中的element标签名为client解析注册使用MysqlMapClientPraser进行.
                registerBeanDefinitionParser("client", new MysqlMapClientPraser());
	}
}

      2、MysqlMapClientPraser

package config;

import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSimpleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.core.io.ClassPathResource;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.orm.ibatis.SqlMapClientFactoryBean;
import org.springframework.orm.ibatis.SqlMapClientTemplate;
import org.w3c.dom.Element;

/**
 * 标签解析处理
 * 
 * @author sammor
 * @date 2011-6-27
 */
public class MysqlMapClientPraser extends AbstractSimpleBeanDefinitionParser {

	/**
	 * element 相当于对应的element元素 parserContext 解析的上下文 builder 用于该标签的实现
	 */
	@Override
	protected void doParse(Element element, ParserContext parserContext,
			BeanDefinitionBuilder builder) {

		// 从标签中取出对应的属性值
		String dbname = element.getAttribute("dbname");
		String datasouceip = element.getAttribute("datasouceip");
		String username = element.getAttribute("username");
		String password = element.getAttribute("password");
		String characterEncoding = element.getAttribute("characterEncoding");
		String configLocation = element.getAttribute("configLocation");
		final String driverClassName = "com.mysql.jdbc.Driver";

		// System.out.println("dbname" + dbname);
		// System.out.println("datasouceip" + datasouceip);
		// System.out.println("username" + username);
		// System.out.println("password" + password);
		// System.out.println("characterEncoding" + characterEncoding);
		// System.out.println("configLocation" + configLocation);

		final StringBuffer url = new StringBuffer("jdbc:mysql://");
		url.append(datasouceip).append("/").append(dbname).append(
				"?useUnicode=true").append("&").append(
				"characterEncoding=" + characterEncoding).append(
				"&autoReconnect=true");

		// 创建 datasource实例
		DriverManagerDataSource datasource = new DriverManagerDataSource();
		datasource.setDriverClassName(driverClassName);
		// System.out.println(url.toString());
		datasource.setUrl(url.toString());
		datasource.setUsername(username);
		datasource.setPassword(password);

		// 创建SqlMapClientFactoryBean实例
		SqlMapClientFactoryBean sqlmapclient = new SqlMapClientFactoryBean();
		sqlmapclient.setDataSource(datasource);
		sqlmapclient.setConfigLocation(new ClassPathResource(configLocation));
		try {
			sqlmapclient.afterPropertiesSet();
		} catch (Exception e) {
			parserContext.getReaderContext().error(
					"sqlmapclient.afterPropertiesSet error", e);
		}

		// 把创建完的实例对应的传到该标签类实现的相应属性中
		builder.addPropertyValue("dataSource", datasource);
		builder.addPropertyValue("sqlMapClient", sqlmapclient.getObject());
		;
	}

	@Override
	protected Class getBeanClass(Element element) {
		// 返回该标签所定义的类实现,在这里是为了创建出SqlMapClientTemplate对象
		return SqlMapClientTemplate.class;
	}

}

    对标签的实现类写完之后，需要声明该handler。通过spring.handlers 文件进行声明：

 http\://sammor.javaeye.com/schema/tags=config.TagsNamespaceHandler

 

 

    测试环节:

    配置完成，进行测试。

    1、spring配置文件填写配置信息

<mysql:client id="sqlMapClientTemplate" datasouceip="localhost"
		dbname="freebug" characterEncoding="utf8" username="root" password="root"
		configLocation="SqlMapCommonConfig.xml" />

<bean id="usersinfoDAO" class="com.dbms.dao.UsersinfoDAOImpl">
		<property name="sqlMapClientTemplate" ref="sqlMapClientTemplate"></property>
</bean>

    2、单元测试

ApplicationContext ac = new ClassPathXmlApplicationContext(
				"classpath:applicationContext.xml");

		UsersinfoDAO user = (UsersinfoDAO) ac.getBean("usersinfoDAO");
		System.out.println("记录数：" + user.selectByExample(null).size());

   3、测试结果：

记录数：6 

   结论

         个人觉得自定义标签的应用可以很广，但如何去利用好这个便利才是一个问题，并不是把什么都自定义化才是最好的。自定义标签的目的是为了更好的方便我们的开发，对一些繁琐而又固定的东西，进行一次的封装配置化以减少问题等实现其价值的自我实现。

 

 

   相关文档：

   spring自定义标签之一 —— 意义思考

   spring自定义标签之二 —— 规范定义XSD

 

评论

2 楼 haywing 2011-07-18  

有木有源码下载学习

1 楼 sammor 2011-06-27  

  	<!-- cache标签 -->
	<xsd:element name="cache">
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="beans:identifiedType">
					<xsd:sequence minOccurs="0">
						<xsd:element name="config">
							<xsd:complexType>
								<xsd:choice minOccurs="1" maxOccurs="unbounded">
									<xsd:element name="servername" type="xsd:string" />
								</xsd:choice>
								<xsd:attribute name="cacheType" type="xsd:string"
									default="READ_ONLY">
								</xsd:attribute>
								<xsd:attribute name="cacheRegion" type="xsd:string"
									default="" />
								<xsd:attribute name="cacheName" type="xsd:string"
									default="USER_MEMCACHE" use="optional" />
								<xsd:attribute name="refresh.period" type="xsd:int" />
								<xsd:attribute name="capacity" type="xsd:int" />
							</xsd:complexType>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>

对下面的定义

   <kb:cache id="cache">
		<kb:config refresh.period="5000" capacity="156564">
			<kb:servername>mc1.member.cache.net:11211</kb:servername>
			<kb:servername>mc1.member.cache.net:11211</kb:servername>
			<kb:servername>mc1.member.cache.net:11211</kb:servername>
			<kb:servername>mc1.member.cache.net:11211</kb:servername>
		</kb:config>
	</kb:cache>