扩展XDoclet对Spring List引用注入的支持

XDoclet是生成配置文件的强有力的工具，在使用Spring框架时，手动编写Spring配置文件极其繁琐，而且容易遗漏，利用XDoclet即可轻松生成配置文件。

XDoclet支持的Spring方法注入包括：ref，list，name和value。遗憾的是，在某个项目中，我需要注入一个包含Bean引用的List：

public void setHandlers(List handlers) {
  ...
}

然后，XDoclet并不支持元素为引用类型的List，倘若使用下列注释：

/**
 * @spring.property list="articleHandler,imageHandler"
 */
public void setHandlers(List handlers) {
  ...
}

生成的配置文件如下：

<property name="handlers">
  <list>
    <value>articleHandler</value>
    <value>imageHandler</value>
  </list>
</property>

毫无疑问，在Spring启动时，一个ClassCastException将被抛出，因为无法将String类型转化为我们自定义的Handler引用类型。

幸运的是，XDoclet良好的可扩展性使我们能够轻松扩展需要的配置，甚至不需要我们利用XDoclet提供的API编写代码。XDoclet提供一种XML结构的模版语言来生成配置文件，对于Spring配置文件，对应的XML配置文件在xdoclet-spring-module-1.2.3.jar/xdoclet/modules/spring/resources/spring_xml.xdt 中。

解开jar包，修改spring_xml.xdt，增加如下XML片断（红色部分）：

  <XDtMethod:forAllMethods superclasses="true">
   <XDtMethod:ifHasMethodTag tagName="spring.property">
    <property name="<XDtMethod:propertyName/>">
    <XDtMethod:ifHasMethodTag tagName="spring.property" paramName="value">
      <value><XDtMethod:methodTagValue tagName="spring.property" paramName="value"/></value>
    </XDtMethod:ifHasMethodTag>
    <XDtMethod:ifHasMethodTag tagName="spring.property" paramName="ref">
      <ref bean="<XDtMethod:methodTagValue tagName="spring.property" paramName="ref"/>"/>
    </XDtMethod:ifHasMethodTag>
    <XDtMethod:ifHasMethodTag tagName="spring.property" paramName="list">
      <list>
      <XDtMethod:forAllMethodTagTokens tagName="spring.property" paramName="list">
        <value><XDtMethod:currentToken/></value>
      </XDtMethod:forAllMethodTagTokens>
      </list>
    </XDtMethod:ifHasMethodTag>

    <XDtMethod:ifHasMethodTag tagName="spring.property" paramName="list.ref
">
      <list>
        <XDtMethod:forAllMethodTagTokens tagName="spring.property" paramName="list.ref">
          <ref bean="<XDtMethod:currentToken/>"/>
        </XDtMethod:forAllMethodTagTokens>
      </list>
    </XDtMethod:ifHasMethodTag>

    </property>
   </XDtMethod:ifHasMethodTag>
  </XDtMethod:forAllMethods>

注意红色部分的代码，我们仿照list，增加一个list.ref来实现引用类型的List。
现在，修改注释如下：

/**
 * @spring.property list.ref="articleHandler,imageHandler"
 */
public void setHandlers(List handlers) {
  ...
}

备份好原有的xdoclet-spring-module-1.2.3.jar，然后将修改后的目录打包：

jar cvf xdoclet-spring-module-1.2.3.jar .

 

替换原来的xdoclet-spring-module-1.2.3.jar，运行XDoclet，顺利生成预期配置：

<property name="handlers">
  <list>
    <ref bean="articleHandler"/>
    <ref bean="imageHandler"/>
  </list>
</property>

类似的，我们还可以增加XDoclet对Map注入的支持。