XDoclet Spring+Struts HowTo zz

XDoclet Spring+Struts HowTo zz

http://www.logemann.org/day/archives/000148.html

For all those out there using Spring together with Struts, i created a small howTo regarding automatic generation of relevant files, especially the boring action-servlet-xml file which must be in synch with your struts-config.xml, at least for all Struts actions which should be injected by Spring.

Lets start with the Action class:

/** * Action to delete a Client * Date: 09.02.2005 * Time: 15:29:15 * * @author Logemann - Logentis e.K. ([email protected]) * @version $Id$ * @struts.action path="clientDelete" validate="false" * type="org.springframework.web.struts.DelegatingActionProxy" * name="emptyform" * @struts.action-forward name="back" * path="/clientManager.html" redirect="true" * @spring.bean name="clientDelete" */ public class ClientDeleteAction extends Action { ClientManager clientManagerService; /** * Spring injection * * @param clientManagerService clientManagerService * @spring.property ref="clientManagerService" */ public void setClientManagerService(ClientManager clientManagerService) { this.clientManagerService = clientManagerService; } [..]

With this tags, the ant build target outlined below will create a struts-config.xml and the necessary action-servlet.xml needed by Spring. Lets see how the target looks:

<path id="classpath"> <fileset dir="c:/xdoclet-1.2.2" includes="*.jar"/> <fileset dir="c:/j2sdkee1.3.1/lib" includes="*.jar"/> <fileset dir="c:/struts/lib" includes="struts.jar"/> </path> <taskdef name="springdoclet" classname="xdoclet.modules.spring.SpringDocletTask" classpathref="classpath"/> <taskdef name="webdoclet" classname="xdoclet.modules.web.WebDocletTask" classpathref="classpath"/> <target name="myTest"> <webdoclet destDir="c:\" force="true" verbose="true"> <fileset dir="${src.dir}"> <include name="**/*Form.java" /> <include name="**/*Action.java" /> <include name="**/*Servlet.java" /> </fileset> <strutsconfigxml version="1.1" validateXml="true"/> </webdoclet> <springdoclet destDir="c:\" verbose="true"> <fileset dir="${src.dir}"> <include name="**/*Action.java" /> </fileset> <springxml destinationFile="action-servlet.xml"/> </springdoclet> </target>

Be sure to modify the classpath definition and the destDir values of springdoclet and webdoclet to suit your needs. Right now the Spring task only searches for Actions in order to create action-servlet.xml, if you also want to create your normal service beans like ClientManagerService, you should create another springdoclet task and output things to applicationContext.xml if you like.

But this is mostly users choice, as you know, Spring supports from one to many bean definition files and its up to you how you want to have your spring xml world.

This will be created when you run the mentioned target:

(action-servlet.xml)

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> <beans default-autowire="no" default-lazy-init="false" default-dependency-check="none" > <bean name="clientDelete" class="de.logentis.versysng.action.clientmanager.ClientDeleteAction" > <property name="clientManagerService"> <ref bean="clientManagerService"/> </property> </bean> <!-- To include additional bean definitions for Spring in the generated application context file, add a file to your XDoclet merge directory called spring-beans.xml that contains the <bean></bean> markup. --> </beans>

(struts-config.xml)

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE struts-config PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 1.1//EN" "http://jakarta.apache.org/struts/dtds/struts-config_1_1.dtd">

<struts-config>

<!-- ========== Data Sources Definitions =================================== -->
<!--
Define your Struts data sources in a file called struts-data-sources.xml and place
it in your merge directory.
-->

<!-- ========== Form Bean Definitions =================================== -->
<form-beans>

<!--
If you have non XDoclet forms, define them in a file called struts-forms.xml and
place it in your merge directory.
-->
</form-beans>

<!-- ========== Global Exceptions Definitions =================================== -->
<!--
Define your exceptions in a file called global-exceptions.xml and place
it in your merge directory.
-->

<!-- ========== Global Forward Definitions =================================== -->
<!--
Define your forwards in a file called global-forwards.xml and place
it in your merge directory.
-->

<!-- ========== Action Mapping Definitions =================================== -->
<action-mappings>
<action
path="clientDelete"
type="org.springframework.web.struts.DelegatingActionProxy"
name="emptyform"
scope="request"
unknown="false"
validate="false"
>
<forward
name="back"
path="/clientManager.html"
redirect="true"
/>
</action>

<!-- If you have non XDoclet actions, define them in a file called struts-actions.xml and place it in your merge directory. -->
</action-mappings>

<!-- Define your Struts controller in a file called struts-controller.xml and place it in your merge directory. -->

<!-- Define your Struts message-resources in a file called struts-message-resources.xml and place it in your merge directory. -->

<!-- Define your Struts plugins in a file called struts-plugins.xml and place it in your merge directory. -->

</struts-config>