打造0配置文件的SSH框架-3

   前面一篇说到在hibernate.cfg.xml只配置一个package，然后由系统自动搜索该package下有@Entity标志的类，加载成hibernate域对象模型。这个功能hibernate没有提供，需要我们自己的实现，至于为什么需要这么做，我说说以前我遇到的一件事。

    前年的一个项目，我是该项目的技术负责人，采用的架构包括hibernate。该项目及其庞大，有300+张表。最开始大家生成了自己需要的域模型文件，然后自己将resource配置到hibernate.cfg.xml中，整个项目是由svn管理的。结果有一天开发人员A突然大叫，“我靠，我将才配置的十几个resource mapping怎么就没了”，然后我和他的team leader就过去看是怎么回事，查下来发现是开发人员B，改过hibernate.cfg.xml，但是他修改改之前没有更新，然后不管三七二十一就往上提交，提交有冲突，他不知道怎么折腾，把服务器上的给覆盖了。我当时真想抽他 。类似的事情后来又发生过几次，毕竟hibernate.cfg.xml是一个公用度很高的文件。于是和几个leader讨论，要把修改hibernate.cfg.xml的权限收到我这里，我一听，傻眼了，这么多resource mapping一个个加，不加死我。果不其然，刚这样做没多久，就有n人次找我修改该文件。于是我才想到要利用配置package的方式来加载域模型的方法，当然可能还有更好更简单的方法我没想到，如果有人告诉我，我肯定再次傻眼 。

    如果项目规模不大，只有十几个到几十个域模型文件，或者项目组成员素质都非常高，每个都能保证修改代码前更新，并且有冲突后会耐心的去解决，那这是大可不必的。

    于是我开始研究hibernate的代码，看加载的地方有没有什么切入点，后来在Configuration类中找到如下代码

protected void parseMappingElement(Element subelement, String name) {
	Attribute rsrc = subelement.attribute( "resource" );
	Attribute file = subelement.attribute( "file" );
	Attribute jar = subelement.attribute( "jar" );
	Attribute pkg = subelement.attribute( "package" );
	Attribute clazz = subelement.attribute( "class" );
	if ( rsrc != null ) {
		log.debug( name + "<-" + rsrc );
		addResource( rsrc.getValue() );
	}
	else if ( jar != null ) {
		log.debug( name + "<-" + jar );
		addJar( new File( jar.getValue() ) );
	}
	else if ( pkg != null ) {
		throw new MappingException(
			"An AnnotationConfiguration is required…" + pkg.getValue() + "\"/>"
		);
	}
	else if ( clazz != null ) {
		throw new MappingException(
			" An AnnotationConfiguration is required t…. " + clazz.getValue() + "\"/>"
		);
	}
	else {
		if ( file == null ) {
			throw new MappingException(
				"<mapping> element in configuration specifies no attributes"
			);
		}
		log.debug( name + "<-" + file );
		addFile( file.getValue() );
	}
}

   以上就是解析resource element的代码。很明显，hibernate支持package，但需要用AnnotationConfiguration，但在AnnotationConfiguration中，它的package是用来指定package-info.java，加载一些附属信息的。不过既然这个parseMappingElement是protected的，那么就可以扩展它。

    于是我自己写了一个类叫ExtendAnnotaionConfiguration，继承了AnnotationConfiguration，重载了parseMappingElement方法，可以照着原来的方法重写，然后加上对自定义的package解析的部分，我选择了调用super的原方法，然后捕获异常，当mapping节点上没有配置resource, file, jar, class, package任何一个属性时，会抛出异常。我捕获这个异常，然后去取节点上一个我自己定义的属性，然后搜索类路径，加载域模型。

@Override
protected void parseMappingElement(Element arg0, String arg1) {
	try {
		//正常情况调用父类的方法
		super.parseMappingElement(arg0, arg1);
	} catch (MappingException ex) {
		//出现异常,那么判断是否是因为pkg填写造成的,
		//如果是, 搜索该路径下的Entity类加载
		Attribute pkg = arg0.attribute( "pkg" );
		logger.debug("search annotation class in hibernate package: [" + pkg + "]");
		if (pkg != null) {
			try {
				//搜索entity类
				List<Class> list =.getPackageMapping(pkg.getValue());
				Iterator<Class> i = list.iterator();
				while (i.hasNext()) {
					//调用父类的Add方法进行域模型加载
super.addAnnotatedClass(i.next());
				}
			} catch (ClassNotFoundException e) {
				……
			}
		} else
			throw ex;			
	}
}

   使用时，不是通过AnnotationConfiguration来获取Session factory，而是用ExtendAnnotationConfiguration来获取。由于我们的项目中，开发人员都是通过一个我们自己开发的Util类，HBUtil.openSession来打开session的，所以ExtendAnnotationConfiguration对开发人员仍然是透明的。

    虽然我自己也认为，这样扩展方式，其实比较野蛮，dtd的校验也要跟着修改或者干脆不要，但hibernate并没有提供一个更好的切口，而且用下来效果也还不错，所以就一直保持这样了。同理，可以扩展Configuration来方便的加载用xml配置的域对象模型。

    真正的麻烦是在开发对类路径搜索功能的时候，那时我才渐渐明白为什么hibernate不提供这样的复杂功能。一个类路径对应的文件路径可能有多个，而且还有可能是打在jar包，war包，ear包中，如果要继续对各种包进行搜索，又可能根据打包工具或者应用服务器的不同，造成代码的微小差异。总之，结论就是，想要做一个非常通用的搜索类路径(包括搜索子目录)的方法，难！但在项目开发中，环境相对稳定，所以还是可以做的，只是不太通用而已，那段代码我一直觉得不太满意，但又没什么好方法去优化，就不贴出来露丑了。

评论

3 楼 tvjody 2009-09-04  

spring 中提供相关的包加载配置文件

<bean id="sessionFactory"
class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mappingJarLocations">
  <list>
      <value>
                   WEB-INF/lib/aa*
              </value>
  </list>
</property>
<property name="mappingLocations"> 
        <list> 
            <value>
classpath:cn/com/aa/bb/**/model/*.hbm.xml
</value>
<value>
classpath:cn/com/aa/sample/**/model/*.hbm.xml
</value>
        </list> 
    </property>

</bean>

2 楼 TaoistWar 2009-04-15  

要是SSH,一个人扔给他一个applicationContext.xml文件得了,让各自配各自的,用得着扩展?

1 楼 TaoistWar 2009-04-15  

我还以为是用注解呢!