A
📖 Wiki
中

SSH 环境搭建与工程结构

📄 框架与环境 38 min read 103 views Updated 2026-10-25 Chinese only

导读

「SSH 环境搭建与工程结构」看似基础,实际藏着不少细节,下面按结论优先的方式展开。

这一篇解决"从零到能跑起来"的问题:依赖包怎么选、目录怎么放、三个 Spring 配置文件各自负责什么、Struts 怎么交给 Spring 托管、以及 XDoclet 怎么自动生成 Hibernate 映射。


一、依赖包清单

全部 jar 放在 WebRoot/WEB-INF/lib 下即可(这是一个传统 Web 工程,没有用 Maven)。

类别 jar
Struts 1.x struts.jar、commons-beanutils.jar、commons-digester.jar、commons-validator.jar、commons-fileupload.jar、jakarta-oro.jar、commons-logging-1.0.4.jar
Spring 2.0 spring.jar、aspectjrt.jar、aspectjweaver.jar(AOP 事务需要)、cglib-2.1.3.jar、asm.jar、asm-attrs.jar
Hibernate 3 hibernate3.jar、antlr-2.7.6.jar、dom4j-1.6.1.jar、javassist.jar、jaxen-1.1-beta-7.jar、c3p0-0.9.0.jar(连接池)、ehcache-1.2.jar(二级缓存)、jta.jar
jBPM 3.1 jbpm-jpdl.jar、jbpm-identity.jar、bsh.jar、jcr-1.0.jar + jboss 相关(jboss-common.jar、jboss-jmx.jar、jboss-system.jar、jboss-cache.jar、jgroups-2.2.8.jar、concurrent-1.3.2.jar)
Spring-jBPM 桥接 spring-modules-jbpm31.jar(来自 spring-modules-0.8)
DWR 2.0 dwr.jar
Freemarker freemarker.jar
数据库 mysql-connector-java-3.1.13-bin.jar
视图 jstl.jar、standard.jar、pager-taglib.jar
日志 log4j-1.2.11.jar
构建 ant-1.6.5.jar、ant-*.jar、junit-3.8.1.jar

提示:jBPM 3.1 自带一批依赖,最省事的做法是把 jBPM 发行包 lib 目录下与 Hibernate/Spring 不冲突的 jar 全部拷进来。


二、工程目录结构

oa/
├── src/                               源码根目录(classpath 根)
│   ├── applicationContext-common.xml  SessionFactory、事务、jBPM 配置
│   ├── applicationContext-beans.xml   业务层 Manager
│   ├── applicationContext-actions.xml Struts Action(由 Spring 创建)
│   ├── hibernate.cfg.xml              连接信息与映射文件清单
│   ├── jbpm.cfg.xml                   jBPM 配置
│   ├── init_datas.xml                 初始化演示数据
│   ├── log4j.properties
│   ├── MessageResources.properties    Struts 国际化资源
│   └── com/oa/
│       ├── model/                     实体 + XDoclet 注释
│       ├── managers/                  业务接口
│       ├── managers/impl/             业务实现
│       ├── web/actions/               Struts Action
│       ├── web/forms/                 ActionForm
│       ├── web/                       Filter、EL 函数、转换器
│       ├── freemarker/templates/      .ftl 模板
│       └── dwr/                       DWR 暴露的 Java 类
├── test/                              测试代码(JUnit)
│   └── flow/                          示例流程定义(processdefinition.xml + 流程图)
├── WebRoot/
│   ├── WEB-INF/
│   │   ├── web.xml
│   │   ├── struts-config.xml
│   │   ├── dwr.xml
│   │   ├── my.tld                     自定义 EL 函数描述
│   │   └── lib/                       依赖 jar
│   ├── common/                        公共提示页(新增/修改/删除成功、异常页)
│   ├── org/ person/ user/ role/ acl/  按模块划分的 JSP
│   ├── document/ workflow/ form/ meetingroom/
│   └── script/                        Dojo 前端库
└── build.xml                          Ant + XDoclet 构建脚本

三、web.xml:把四大基础设施串起来

<!-- 1. Spring 容器启动 -->
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/applicationContext-*.xml,classpath*:applicationContext-*.xml</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<!-- 2. Struts 核心 Servlet -->
<servlet>
    <servlet-name>action</servlet-name>
    <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
    <init-param><param-name>config</param-name><param-value>/WEB-INF/struts-config.xml</param-value></init-param>
    <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>action</servlet-name>
    <url-pattern>*.do</url-pattern>
</servlet-mapping>

<!-- 3. OpenSessionInView:把 Session 的生命周期延长到一次请求结束 -->
<filter>
    <filter-name>hibernateFilter</filter-name>
    <filter-class>org.springframework.orm.hibernate3.support.OpenSessionInViewFilter</filter-class>
</filter>
<filter-mapping><filter-name>hibernateFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping>

<!-- 4. 中文编码过滤器(注意顺序要放在最前) -->
<filter>
    <filter-name>Spring character encoding filter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param><param-name>encoding</param-name><param-value>GBK</param-value></init-param>
</filter>
<filter-mapping><filter-name>Spring character encoding filter</filter-name><url-pattern>/*</url-pattern></filter-mapping>

<!-- 5. 分页过滤器:把 pager.offset 写进 ThreadLocal -->
<filter>
    <filter-name>pagerFilter</filter-name>
    <filter-class>com.oa.web.PagerFilter</filter-class>
</filter>
<filter-mapping><filter-name>pagerFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping>

<!-- 6. DWR -->
<servlet>
    <servlet-name>dwr-invoker</servlet-name>
    <servlet-class>org.directwebremoting.servlet.DwrServlet</servlet-class>
    <init-param><param-name>debug</param-name><param-value>true</param-value></init-param>
</servlet>
<servlet-mapping><servlet-name>dwr-invoker</servlet-name><url-pattern>/dwr/*</url-pattern></servlet-mapping>

<!-- 7. 日期转换器注册 Servlet -->
<servlet>
    <servlet-name>utilDateConverter</servlet-name>
    <servlet-class>com.oa.web.UtilDateConverterInitServlet</servlet-class>
    <load-on-startup>3</load-on-startup>
</servlet>

过滤器顺序很关键:CharacterEncodingFilter 必须排在所有读取请求参数的组件之前,否则取到的中文已经是乱码。


四、三个 Spring 配置文件

4.1 applicationContext-common.xml —— 基础设施

<!-- SessionFactory 直接复用 hibernate.cfg.xml -->
<bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
    <property name="configLocation"><value>classpath:hibernate.cfg.xml</value></property>
</bean>

<bean id="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">
    <property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>

<!-- 所有 Manager 方法都纳入事务 -->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
    <tx:attributes>
        <tx:method name="*" propagation="REQUIRED"/>
    </tx:attributes>
</tx:advice>

<aop:config>
    <aop:pointcut id="allManagerMethod" expression="execution (* com.oa.managers.*.*(..))"/>
    <aop:advisor advice-ref="txAdvice" pointcut-ref="allManagerMethod"/>
</aop:config>

<!-- jBPM 交给 Spring 创建 -->
<bean id="jbpmConfiguration"
      class="org.springmodules.workflow.jbpm31.LocalJbpmConfigurationFactoryBean">
    <property name="configuration" value="classpath:jbpm.cfg.xml"/>
</bean>

实际项目中更精细的做法是按方法名区分读写:

<tx:method name="add*"    propagation="REQUIRED"/>
<tx:method name="del*"    propagation="REQUIRED"/>
<tx:method name="update*" propagation="REQUIRED"/>
<tx:method name="deploy*" propagation="REQUIRED"/>
<tx:method name="submit*" propagation="REQUIRED"/>
<tx:method name="*"       read-only="true"/>

4.2 applicationContext-beans.xml —— 业务层

业务实现类继承 HibernateDaoSupport,注入 sessionFactory 即可:

<bean id="orgManager" class="com.oa.managers.impl.OrgManagerImpl">
    <property name="sessionFactory" ref="sessionFactory"/>
</bean>
<bean id="aclManager" class="com.oa.managers.impl.AclManagerImpl">
    <property name="sessionFactory" ref="sessionFactory"/>
</bean>
<bean id="workflowManager" class="com.oa.managers.impl.WorkflowManagerImpl">
    <property name="sessionFactory" ref="sessionFactory"/>
    <property name="jbpmConfiguration" ref="jbpmConfiguration"/>
</bean>
<bean id="documentManager" class="com.oa.managers.impl.DocumentManagerImpl">
    <property name="sessionFactory" ref="sessionFactory"/>
    <property name="workflowManager" ref="workflowManager"/>
</bean>

4.3 applicationContext-actions.xml —— 控制层

Bean 的 name 必须与 struts-config.xml 中 action 的 path 一致,这是 Struts-Spring 整合的约定:

<bean name="/org" class="com.oa.web.actions.OrgAction" scope="prototype">
    <property name="orgManager" ref="orgManager"/>
</bean>
<bean name="/document" class="com.oa.web.actions.DocumentAction">
    <property name="documentManager" ref="documentManager"/>
    <property name="workflowManager" ref="workflowManager"/>
    <property name="formManager" ref="formManager"/>
</bean>

Struts 的 Action 不是线程安全的,有状态 Action 必须声明 scope="prototype"。


五、struts-config.xml

<form-beans>
    <form-bean name="orgForm"   type="com.oa.web.forms.OrgActionForm"/>
    <form-bean name="userForm"  type="com.oa.web.forms.UserActionForm"/>
    ...
</form-beans>

<!-- 全局异常处理:所有异常统一交给自定义 Handler -->
<global-exceptions>
    <exception key="errors.detail"
               type="java.lang.Exception"
               path="/common/exception.jsp"
               scope="request"
               handler="com.oa.web.SystemExceptionHandler"/>
</global-exceptions>

<!-- 全局跳转:增删改成功后的公共提示页 -->
<global-forwards>
    <forward name="pub_add_success"    path="/common/pub_add_success.jsp"/>
    <forward name="pub_update_success" path="/common/pub_update_success.jsp"/>
    <forward name="pub_del_success"    path="/common/pub_del_success.jsp"/>
    <forward name="login"              path="/index.jsp" redirect="true"/>
</global-forwards>

<action-mappings>
    <action path="/org"
            type="org.springframework.web.struts.DelegatingActionProxy"
            name="orgForm"
            scope="request"
            parameter="method">
        <forward name="index"     path="/org/index.jsp"/>
        <forward name="add_input" path="/org/add_input.jsp"/>
        <forward name="select"    path="/org/select.jsp"/>
    </action>
</action-mappings>

三个关键点:

  1. type 写成 DelegatingActionProxy,Struts 不再自己 new Action,而是去 Spring 容器里按 path 找同名 Bean。
  2. parameter="method" 配合 DispatchAction,用 /org.do?method=add 就能分发到 add() 方法。
  3. global-exceptions 把散落各处的 try-catch 收敛成一个统一处理点。

六、hibernate.cfg.xml

<hibernate-configuration>
  <session-factory>
    <property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property>
    <property name="hibernate.connection.url">jdbc:mysql://127.0.0.1/oa</property>
    <property name="hibernate.connection.username">root</property>
    <property name="hibernate.connection.password">root</property>
    <property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
    <property name="hibernate.show_sql">true</property>
    <property name="hibernate.hbm2ddl.auto">update</property>
    <property name="hibernate.cache.provider_class">org.hibernate.cache.HashtableCacheProvider</property>

    <!-- 业务映射 -->
    <mapping resource="com/oa/model/ACL.hbm.xml"/>
    <mapping resource="com/oa/model/Organization.hbm.xml"/>
    ...

    <!-- jBPM 映射(必须加,否则流程表不会建) -->
    <mapping resource="org/jbpm/graph/action/Script.hbm.xml"/>
    <mapping resource="org/jbpm/identity/User.hbm.xml"/>
    <mapping resource="org/jbpm/identity/Group.hbm.xml"/>
    <mapping resource="org/jbpm/identity/Membership.hbm.xml"/>
    <mapping resource="org/jbpm/db/hibernate.queries.hbm.xml"/>
    ...
  </session-factory>
</hibernate-configuration>

hbm2ddl.auto=update 让系统在启动时自动补齐表结构,开发期非常方便,生产环境应改为 validate 或交给 DBA 维护脚本。


七、用 Ant + XDoclet 生成映射文件

手写 hbm.xml 很枯燥,XDoclet 的思路是:把映射信息写成 Java 注释,用 Ant 任务自动生成配置文件与映射文件。

实体写法示例:

/**
 * @hibernate.class table="T_ACL"
 */
public class ACL {
    /**
     * @hibernate.id generator-class="native"
     */
    private int id;

    /**
     * @hibernate.property not-null="true"
     */
    private String principalType;
}

build.xml 的两个核心 Target:

<project name="OA系统构建脚本" default="生成Hibernate配置文件" basedir=".">
    <property name="src.dir" value="${basedir}/src"/>
    <property name="xdoclet.home" value="D:/tools/xdoclet-plugins-1.0.3"/>

    <path id="xdoclet.task.classpath">
        <fileset dir="${xdoclet.home}/lib"><include name="**/*.jar"/></fileset>
        <fileset dir="${xdoclet.home}/plugins"><include name="**/*.jar"/></fileset>
    </path>
    <taskdef name="xdoclet" classname="org.xdoclet.ant.XDocletTask"
             classpathref="xdoclet.task.classpath"/>

    <!-- 生成 hibernate.cfg.xml -->
    <target name="生成Hibernate配置文件">
        <xdoclet>
            <fileset dir="${src.dir}/com/oa/model"><include name="**/*.java"/></fileset>
            <component classname="org.xdoclet.plugin.hibernate.HibernateConfigPlugin"
                       destdir="${src.dir}" version="3.0" hbm2ddlauto="update"
                       jdbcurl="jdbc:mysql://127.0.0.1/oa"
                       jdbcdriver="com.mysql.jdbc.Driver"
                       jdbcusername="root" jdbcpassword="root"
                       dialect="org.hibernate.dialect.MySQLDialect"
                       showsql="true"/>
        </xdoclet>
    </target>

    <!-- 生成各实体的 *.hbm.xml -->
    <target name="生成hibernate映射文件">
        <xdoclet>
            <fileset dir="${src.dir}/com/oa/model"><include name="**/*.java"/></fileset>
            <component classname="org.xdoclet.plugin.hibernate.HibernateMappingPlugin"
                       destdir="${src.dir}" version="3.0"/>
        </xdoclet>
    </target>
</project>

常用 XDoclet 注释速查:

注释 含义
@hibernate.class table="T_Xxx" 类映射到表
@hibernate.id generator-class="native" 主键与生成策略
@hibernate.property not-null="true" unique="true" 普通属性
@hibernate.many-to-one column="parentId" 多对一(如机构父节点)
@hibernate.set / @hibernate.collection-one-to-many 一对多集合
@hibernate.bag + @hibernate.collection-many-to-many 多对多

注意:一旦手工改过 hibernate.cfg.xml(比如加了 jBPM 映射),就不要再跑"生成 Hibernate 配置文件"这个 Target,否则手动添加的内容会被覆盖。实际做法是先生成一次,再手工维护。


八、启动检查清单

  1. MySQL 已创建数据库 oa,字符集支持中文(老版本建议 gb2312/gbk)。
  2. hibernate.cfg.xml 的连接串、账号、密码正确。
  3. WebRoot/WEB-INF/lib 下 jar 完整且无版本冲突(尤其注意不要把多个版本的 asm、cglib、commons-logging 同时放进去)。
  4. 启动 Tomcat,观察日志:应能看到 Hibernate 的建表 DDL 输出;若开启 jBPM,还会看到 JBPM_* 表的创建。
  5. 访问 http://localhost:8080/oa/ 出现登录页即成功。

要点小结

  • 全部 jar 放在 WebRoot/WEB-INF/lib 下即可(这是一个传统 Web 工程,没有用 Maven)。
  • 
    
    

由站内小编编辑整理

Related