SSH实战OA 02:SSH框架搭建

上一节对项目功能、设计已经编码规范等做了说明，这一节主要是对项目进行环境搭建，主要是搭建SSH开发环境、日志打印和单元测试Junit环境的搭建等。

SSH整合

SSH简介

SSH是 struts+spring+hibernate的一个集成框架，是目前比较流行的一种Web应用程序开源框架。
集成SSH框架的系统从职责上分为四层：表示层、业务逻辑层、数据持久层和域模块层，以帮助开发人员在短期内搭建结构清晰、可复用性好、维护方便的Web应用程序。其中使用Struts作为系统的整体基础架构，负责MVC的分离，在Struts框架的模型部分，控制业务跳转，利用Hibernate框架对持久层提供支持，Spring做管理，管理struts和hibernate。具体做法是：用面向对象的分析方法根据需求提出一些模型，将这些模型实现为基本的Java对象，然后编写基本的DAO(Data Access Objects)接口，并给出Hibernate的DAO实现，采用Hibernate架构实现的DAO类来实现Java类与数据库之间的转换和访问，最后由Spring做管理，管理struts和hibernate。

——百度百科

需要的jar包

使用别人写好的框架的第一步就是引入所需要的包,如引用jQuery的时候需要引入jquery.js包，使用SSH框架的时候需要引入以下的jar包:
- antlr-2.7.6.jar
- aspectjrt.jar
- aspectjweaver.jar
- c3p0-0.9.1.jar
- cglib-nodep-2.1_3.jar
- commons-beanutils-1.7.0.jar
- commons-codec.jar
- commons-collections-3.1.jar
- commons-fileupload-1.2.1.jar
- commons-io-1.3.2.jar
- commons-lang-2.5.jar
- commons-logging.jar
- dom4j-1.6.1.jar
- ezmorph-1.0.3.jar
- freemarker-2.3.15.jar
- hibernate-jpa-2.0-api-1.0.0.Final.jar
- hibernate3.jar
- javassist-3.12.0.GA.jar
- json-lib-2.1-jdk15.jar
- jstl-1.2.jar
- jta-1.1.jar
- log4j-1.2.15.jar
- mysql-connector-java-5.1.5-bin.jar
- ognl-2.7.3.jar
- slf4j-api-1.5.0.jar
- slf4j-log4j12-1.5.0.jar
- spring-test.jar
- spring.jar
- struts2-core-2.1.8.1.jar
- struts2-json-plugin-2.1.8.1.jar
- struts2-spring-plugin-2.1.8.1.jar
- xwork-core-2.1.6.jar

新建项目

1. 新建工程，类型为Web Project，设置默认编码为UTF-8，并创建如下文件夹:
   Source Folder
    –src : 项目源码
    –config : 配置文件
    –test : 单元测试
2. 普通文件夹
    –WebRoot/style css与图片等文件
    –WebRoot/script js脚本文件
    –WebRoot/WEB-INF/jsp jsp页面文件
3. 包结构
   a. 实体
      com.shizongger.oa.domain
   b. Dao
      com.shizongger.dao   Dao接口
      com.shizongger.oa.dao.impl   Dao实现类
   c. Service
      com.shizongger.oa.service   Service接口
      com.shizongger.oa.service.impl   Service实现类
   d. View(Struts2)
      com.shizongger.oa.strtus2.action
   e. 其他
      com.shizongger.oa.util  工具类

新建成功之后的项目结构如图：

配置项目

1.首先配置Struts2的过滤器，web.xml的内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    version="2.5">

    <!-- 配置Spring的监听器，用于初始化ApplicationContext对象 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:applicationContext*.xml</param-value>
    </context-param>

    <filter>
        <filter-name>struts2</filter-name>
        <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>struts2</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>index.html</welcome-file>
    </welcome-file-list>
</web-app>

listener节点内容是Srping容器的监听器,而filter是对Struts2的url拦截。Struts2对应的拦截器是：

org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter

拦截的地址是:

/*

这样以后每个请求地址都会经过我们的拦截器，以便于action进行拦截处理。

2.配置Struts.xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
    <!-- 配置为开发模式 -->
    <constant name="struts.devMode" value="true" />
    <!-- 配置扩展名为action -->
    <constant name="struts.action.extension" value="action" />

    <package name="default" namespace="/" extends="struts-default">
        <!-- 测试用的action，当与Spring整合后，class属性写的就是Spring中bean的名称 -->
        <action name="user" class="userAction">
            <result name="welcome">/WEB-INF/jsp/welcome.jsp</result>
            <result></result>
        </action>

    </package>
</struts>

这里边用到我们的一个action:userAction

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Controller;

import com.opensymphony.xwork2.ActionSupport;
import com.shizongger.oa.domain.User;
import com.shizongger.oa.service.UserService;

@Controller("userAction")
@Scope("prototype")
public class UserAction extends ActionSupport {

    @Autowired
    private UserService userService;

    @Override
    public String execute() throws Exception {
        User user = new User();
        user.setName("admin");
        userService.add(user);

        return "welcome";
    }
}

这个action属于单例模式，并且用@Controller(“userAction”)注解把我们的action交与spring容器管理，所以在Struts.xml的action元素中就没有必要把action的全称写出来，只需要写userAction就足够了，它自动会在容器中找到兑现的action。

3.配置Hibernate的配置文件hibernate.cfg.xml

<!DOCTYPE hibernate-configuration PUBLIC
    "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
<session-factory>

    <!-- 数据库信息（连接信息写到spring的配置文件中） -->
    <property name="dialect">org.hibernate.dialect.MySQL5Dialect</property>
    <!-- 其他配置 -->
    <property name="show_sql">true</property>
    <property name="hbm2ddl.auto">update</property>

    <!-- 导入映射配置 --> 
    <mapping resource="com/shizongger/oa/domain/User.hbm.xml" />

</session-factory>
</hibernate-configuration>

由于这儿需要与Spring整合，所以hibernate的核心信息都交付到spring的配置文件中去，这里只需要配置连接的数据库类型，是否打印输出sql,以及hibernate创建数据库表的方式就足够了。对了，还有每张表对应的hbm.xml的位置。

4.Spring的配置文件applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
    http://www.springframework.org/schema/context 
    http://www.springframework.org/schema/context/spring-context-2.5.xsd
    http://www.springframework.org/schema/tx 
    http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">

    <!-- 自动扫描与装配bean -->
    <context:component-scan base-package="com.shizongger.oa" />

    <!-- 加载外部的properties配置文件 -->
    <context:property-placeholder location="classpath:jdbc.properties"/>

    <!-- 配置数据库连接池（c3p0） -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <!-- 基本信息 -->
        <property name="jdbcUrl" value="${jdbcUrl}"></property>
        <property name="driverClass" value="${driverClass}"></property>
        <property name="user" value="${username}"></property>
        <property name="password" value="${password}"></property>
        <!-- 其他配置 -->
        <!--初始化时获取三个连接，取值应在minPoolSize与maxPoolSize之间。Default: 3 -->
        <property name="initialPoolSize" value="3"></property>
        <!--连接池中保留的最小连接数。Default: 3 -->
        <property name="minPoolSize" value="3"></property>
        <!--连接池中保留的最大连接数。Default: 15 -->
        <property name="maxPoolSize" value="5"></property>
        <!--当连接池中的连接耗尽的时候c3p0一次同时获取的连接数。Default: 3 -->
        <property name="acquireIncrement" value="3"></property>
        <!-- 控制数据源内加载的PreparedStatements数量。如果maxStatements与maxStatementsPerConnection均为0，则缓存被关闭。Default: 0 -->
        <property name="maxStatements" value="8"></property>
        <!-- maxStatementsPerConnection定义了连接池内单个连接所拥有的最大缓存statements数。Default: 0 -->
        <property name="maxStatementsPerConnection" value="5"></property>
        <!--最大空闲时间,1800秒内未使用则连接被丢弃。若为0则永不丢弃。Default: 0 -->
        <property name="maxIdleTime" value="1800"></property>
    </bean>

    <!-- 配置SessionFactory -->
    <bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
        <property name="configLocation" value="classpath:hibernate.cfg.xml"></property>
    </bean>

    <!-- 配置声明式的事务管理（采用基于注解的方式） -->
    <bean id="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">
        <property name="sessionFactory" ref="sessionFactory"></property>
    </bean>
    <tx:annotation-driven transaction-manager="transactionManager"/>

</beans>

这个spring的配置文件主要是配置了自动扫描路径，jdbc的properies文件位置，数据库连接池（c3p0）的主要信息，刚才没有在hibernate配置的内容是因为拿到了这儿。

spring与hibernate的整合，我们与Dao 层的sessionFactory事务交付给spring来托管。

5.数据库的连接信息文件：jdbc.properties

jdbcUrl     = jdbc:mysql:///oa
driverClass = com.mysql.jdbc.Driver
username    = root
password    = root

这里我已经在我的ubuntu系统中安装好了我的mysql数据库，并用下列的sql语句创建好了我的oa数据库。

    mysql> create database oa default character set utf8;
    Query OK, 1 row affected (0.03 sec)
    mysql> show create database oa;
    +--------------+-----------------------------------------------------------------------+
    | Database     | Create Database                                                       |
    +--------------+-----------------------------------------------------------------------+
    | oa | CREATE DATABASE `oa` /*!40100 DEFAULT CHARACTER SET utf8 */ |
    +--------------+-----------------------------------------------------------------------+
    1 row in set (0.02 sec)

第一句sql的含义是创建一个默认编码为utf-8的数据库oa,第二句sql的含义是显示刚才创建的数据库的编码。显然我创建的数据库正式我所需要的。

6.log4j日志打印的配置log4j.proprites

### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### direct messages to file hibernate.log ###
#log4j.appender.file=org.apache.log4j.FileAppender
#log4j.appender.file.File=hibernate.log
#log4j.appender.file.layout=org.apache.log4j.PatternLayout
#log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### set log levels - for more verbose logging change 'info' to 'debug' ###

log4j.rootLogger=info, stdout

#log4j.logger.org.hibernate=info
#log4j.logger.org.hibernate=debug

### log HQL query parser activity
#log4j.logger.org.hibernate.hql.ast.AST=debug

### log just the SQL
#log4j.logger.org.hibernate.SQL=debug

### log JDBC bind parameters ###
#log4j.logger.org.hibernate.type=info
#log4j.logger.org.hibernate.type=debug

### log schema export/update ###
#log4j.logger.org.hibernate.tool.hbm2ddl=debug

### log HQL parse trees
#log4j.logger.org.hibernate.hql=debug

### log cache activity ###
#log4j.logger.org.hibernate.cache=debug

### log transaction activity
#log4j.logger.org.hibernate.transaction=debug

### log JDBC resource acquisition
#log4j.logger.org.hibernate.jdbc=debug

### enable the following line if you want to track down connection ###
### leakages when using DriverManagerConnectionProvider ###
#log4j.logger.org.hibernate.connection.DriverManagerConnectionProvider=trace

这儿暂时把它定为info级别，log有5中级别，分别是debug,info,warm,error,fatal,一般在开发过程中我们输出打印的应该是debug级别，这样有利于我们观察变量的值。上面定义为info级别，下面的项目中我们要对其进行更改。

集成测试

搭建好了框架，我们就可以对其进行集成测试了。我们直接用上诉讲到的userAction对项目功能进行测试。
userAction

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Controller;

import com.opensymphony.xwork2.ActionSupport;
import com.shizongger.oa.domain.User;
import com.shizongger.oa.service.UserService;

@Controller("userAction")
@Scope("prototype")
public class UserAction extends ActionSupport {

    @Autowired
    private UserService userService;

    @Override
    public String execute() throws Exception {
        User user = new User();
        user.setName("admin");
        userService.add(user);

        return "welcome";
    }
}

接下来是创建userService和它的实现类userServiceImpl
userServcie接口

import com.shizongger.oa.domain.User;

public interface UserService {
    public void add(User user);
}

userServiceImpl实现类

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.shizongger.oa.dao.UserDao;
import com.shizongger.oa.domain.User;
import com.shizongger.oa.service.UserService;

@Service("userService")
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @Override
    public void add(User user) {
        try {
            userDao.add(user);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

需要用到我们的userDao
userDao接口

import com.shizongger.oa.base.BaseDao;
import com.shizongger.oa.domain.User;

public interface UserDao extends BaseDao<User> {

    public User getUserByNamdAndPasswd(String username, String password);
}

userDaoImple接口实现类

import com.shizongger.oa.base.BaseDaoImpl;
import com.shizongger.oa.dao.UserDao;
import com.shizongger.oa.domain.User;

public class UserDaoImpl extends BaseDaoImpl<User> implements UserDao {

    /**
     * 检测用户的合法性
     */
    @Override
    public User getUserByNamdAndPasswd(String username, String password) {
        return null;
    }

}

还需要我们对实体的映射，为了方便测试，我们就只需给我们的User实体一个id和一个name的属性。

public class User {
    private Long id;
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

user的hibenate的映射实体:user.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
        "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
        "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

<hibernate-mapping package="com.shizongger.oa.domain">

    <class name="User" table="itcast_user">
        <id name="id">
            <generator class="native"/>
        </id>
        <property name="name"/>
    </class>

</hibernate-mapping>

如果你在hibernate.cfg.xml中没有把这个xml的位置添加上去会报错的，或者说如果参照本案例，而实体不是user那么需要在hibernate.cfg.xml中添加如下内容:

<!-- 导入映射配置 --> 
<mapping resource="com/shizongger/oa/domain/你的实体名称.hbm.xml" />

到此，你可以启动你的项目了，在你的浏览器中输入：

localhost:8080/MyOa/user

如果能够跳转到你的welcome.jsp则表明我们搭配的Spring和Struts没问题，这时候在你的数据库中应该生成一张user表，只有id和nage两个字段，如果你的数据库中也有这张表生成，那么恭喜你，我们的SSH框架环境搭建成功。

项目代码已经托管到GitHub项目地址