搭建SSI开发框架原理

Spring2.5、Struts2、Ibatis开发框架搭建（一）

ssi, ibatis

一、框架下载

1.1   Struts2框架
Struts2框架发展于WebWork，现在捐献给了Apache开源组织，最新版本的Struts2框架可以从位于Apache官方网站的Struts2项目中获取，Struts2框架的项目主页地址为：http://struts.apache.org/ ，下载页面地址为:
http://struts.apache.org/download.cgi，打开下载地址以后自己选择最新发布的版本即可，新手的话下载Full Distribution的版本，例http://struts.apache.org/download.cgi#struts2014中的struts-2.0.14-full.zip。
为了让struts2能够支持json格式的返回数据，还需要下载json插件，下载地址为http://code.google.com/p/jsonplugin/，下载文件为jsonplugin-0.31.jar  文件。

1.2   Spring3.1框架
Spring框架的官方网站地址：http://www.springframework.org/，下载页面为：http://www.springsource.org/download
，打开下载页面以后选择Get the latest Spring releases here中的发行包去下载使用，注意Spring官方网站中包含的框架有很多，包括流程处理、安全、Web服务等很多种框架，我们需要下载的框架是Spring FrameWork 的某个版本，不是其它的那些框架。

1.3   Ibatis框架
iBATIS框架的主页是http://ibatis.apache.org/,在打开的网站界面中选择 选择左边的Get software中的for java连接，在打开的界面中选择下载连接。

1.4   其它（数据库缓冲池框架等）

如果需要使用Ms Sql Server数据库的话，还需要在项目中加入jtds的JDBC驱动程序，下载地址http://jtds.sourceforge.net/，找到download连接，按提示信息下载即可。下载DBCP数据库缓冲池框架，下载地址为http://commons.apache.org/dbcp/，下载最新版本即可，因为DBCP框架是apache开源软件组织的众多框架中的一部分，要让DBCP工作的话，还需要common-pool框架，自行到apache官方网站下载

二、向项目中加入Spring Struts iBATIS框架

2.1 准备工作

将下载的三个框架分别解压缩。新建一个Web Project。

2.2 向项目中加入Spring框架
   将Spring解压缩以后spring-framework-2.5.6-with-dependencies\spring-framework-2.5.6\dist目录中的spring.jar复制到Web项目的WEB-INF/lib目录中。
   复制spring-framework-2.5.6-with-dependencies\spring-framework-2.5.6\lib\log4j中的log4j相关的jar文件到项目中WEB-INF/lib目录中。
   打开WEB项目中的WEB-INF目录中的web.xml文件，添加及结合项目实际情况配置以下内容

<!-- 以为是应用程序名称 -->
          <display-name>JI</display-name>
          <!-- 以下是应用程序描述说明性文字 -->
       <description>Job Integration</description>   

<!-- 上下文参数,用于log4j以及spring中使用 -->
          <context-param>
                   <param-name>webAppRootKey</param-name>
                   <param-value>ji.root</param-value>
          </context-param>        

       <!-- 应用程序上下文参数,指定log4j日志框架使用的配置参数文件位置 -->
          <context-param>
                   <param-name>log4jConfigLocation</param-name>
                   <param-value>/WEB-INF/log4j.properties</param-value>
          </context-param>

    <!-- 应用程序上下文参数,指定spring配置文件位置 -->
          <context-param>
                   <param-name>contextConfigLocation</param-name>
                   <param-value>   在这里写Spring参数配置文件的路径例如 /WEB-INF/spring/applicationContext.xml</param-value>
          </context-param>

       <!-- 用于初始化log4j日志框架的 -->
       <listener>
              <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
       </listener>

       <!-- 用于初始化spring框架 -->

       <listener>

              <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

       </listener>

2.3 向项目中添加Struts2框架

打开解压缩以后的Struts2框架目录，找到\struts-版本-all\struts-版本\lib目录，复制*.jar文件到WEB项目的WEB-INF/lib目录中。

复制jsonplugin-0.31.jar  到项目的WEB-INF/lib目录中。

打开WEB项目中的WEB-INF/web.xml文件，添加以下内容：

      <!-- 过滤器,struts2使用的,用于销毁某些不再使用的对象等-->
    <filter>
        <filter-name>struts-cleanup</filter-name>
        <filter-class>org.apache.struts2.dispatcher.ActionContextCleanUp</filter-class>
    </filter>
    <!--过滤器,struts2使用的 -->
    <filter>
             <filter-name>struts</filter-name>
           <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
       </filter>

    <!-- 以下是struts2使用的用于清除或销毁某些对象的过滤器,要保证在struts过滤器映射之前配置这一项 -->
       <filter-mapping>
             <filter-name>struts-cleanup</filter-name>
             <url-pattern>/*</url-pattern>
       </filter-mapping>

       <!-- struts2用于的过滤器映射 -->
       <filter-mapping>
             <filter-name>struts</filter-name>
             <url-pattern>/*</url-pattern>
       </filter-mapping>

找到项目的源程序目录，一般在Eclipse开发工具中都是src目录，添加以下几个文件（注意大小写），struts.properties，struts.xml，globalMessages.properties ，其中

struts.properties文件中的内容为：

struts.custom.i18n.resources=globalMessages
struts.objectFactory=spring
struts.objectFactory.spring.autoWire=type
struts.ui.theme=**
struts.locale =zh_CN
struts.i18n.encoding=UTF-8
struts.configuration.xml.reload=true
struts.multipart.parser=jakarta
struts.multipart.maxSize=10000000
struts.devMode=false

globalMessages.properties文件中的内容为：

SMSPageTitle=\u5b89\u5fbd\u7701\u8840\u6db2\u4fe1\u606f\u77ed\u4fe1\u5e73\u53f0

login.error=\u60a8\u8f93\u5165\u7684\u7528\u6237\u540d\u6216\u5bc6\u7801\u9519\u8bef\uff01

userId.required=\u60a8\u7684\u7528\u6237\u540d\u4e0d\u80fd\u4e3a\u7a7a\uff01\uff01

passward.required=\u60a8\u7684\u5bc6\u7801\u4e0d\u80fd\u4e3a\u7a7a\uff01\uff01

datebase.error=\u6570\u636e\u5e93\u64cd\u4f5c\u9519\u8bef\uff01\uff01\uff01

validCode_error=\u9a8c\u8bc1\u7801\u9519\u8bef\uff01\uff01

retistSdk.error=\u6ce8\u518cSDK\u5931\u8d25\uff01\u8bf7\u68c0\u67e5\u5e8f\u5217\u53f7\u548c\u5bc6\u7801\uff01\uff01

retistSdk.success=\u8f6f\u4ef6SDK\u6ce8\u518c\u6210\u529f\uff01\uff01\uff01

logoutSdk.success=\u60a8\u5df2\u6210\u529f\u6ce8\u9500SDK\uff01\uff01

logoutSdk.error=\u6ce8\u9500SDK\u5931\u8d25\uff0c\u68c0\u67e5\u7f51\u7edc\u8fde\u63a5\uff01\uff01\uff01

chargUp.error=\u5145\u503c\u5931\u8d25\uff0c\u8bf7\u68c0\u67e5\u5361\u53f7\u548c\u5bc6\u7801\uff01\uff01

sdkNotReg=\u7cfb\u7edfSDK\u6ca1\u6709\u6ce8\u518c\uff01\uff01\uff01\uff01

struts.messages.error.uploading=\u6587\u4ef6\u65e0\u6cd5\u6b63\u5e38\u4e0a\u4f20

struts.messages.error.file.too.large=\u6587\u4ef6\u5927\u5c0f\u8d85\u8fc7\u6700\u5927\u5141\u8bb8\u503c

struts.messages.error.content.type.not.allowed=\u6587\u4ef6\u7c7b\u578b\u4e0d\u5728\u4e0a\u4f20\u6587\u4ef6\u5141\u8bb8\u7c7b\u578b\u4e2d

　　最后一个文件是struts.xml中的内容，这个文件是struts的参数配置文件，参考配置内容：

<?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.i18n.encoding" value="UTF-8"></constant>
       <package name="login" extends="struts-default">
              <action name="login" class="edu.xw.ji.action.LoginAction" method="login">
                     <result name="success">/dev_test/login.jsp</result>
              </action>
       </package>
       <package name="ji_common" extends="json-default">
              <interceptors>
                     <interceptor-stack name="myDefaultStack">
                            <interceptor-ref name="defaultStack" />
                     </interceptor-stack>
              </interceptors>
              <default-interceptor-ref name="myDefaultStack"></default-interceptor-ref>
              <global-results>
                     <result name="error">/pages/errorMessage.jsp</result>
                     <result name="warn">/pages/warnMessage.jsp</result>
              </global-results>
       </package>
       <include file="edu/xw/ji/action/dict/struts2_dict.xml" />

       </struts>

　　注意上面的struts.xml配置文件中有两个示例package，名称为login的package是从struts-default包继承下来的，不能够实现json格式的action返回，后面的ji_common是从json-default包继承下来的，以后在项目中所有程序开发人员自己编写的action中使用到json格式的返回结果时可以从ji_common包继承下来。

2.4 向项目中添加iBATIS框架
     找到解压缩的iBATIS压缩包中的ibatis-2.3.4.726\lib目录，复制里面的.jar文件到项目中的WEB-INF/lib目录中。

2.5 添加数据库缓冲池框架

复制DBCP缓冲池框架中的commons-dbcp-x.x.x.jar文件到项目中WEB-INF/lib目录中去，复制DBCP框架工作时需要使用的common-pool相关的jar文件到项目中的WEB-INF/lib目录中去，DBCP在项目中是被配置到spring当中去使用，所以接下来的一系列工作都与spring的配置有关。

三、整合Spring2.5,Struts2,iBATIS,DBCP,Log4j中的问题解答

3.1 what’s the point？

为什么要“整合”这些框架呢？在程序代码中由程序员负责处理与控制一切不是很好吗？要这么多的框架搭配在一起工作有什么好处呢？答案只有一个，“省事”，节省程序员开发程序的时间。

整合这些框架的关键一点就是Spring，Spring是所有这些框架在一起工作的粘合剂，整合的工作重心就是将web MVC框架、ORM框架、数据库缓冲池框架、日志框架等全部交给Spring管理，由Spring调配使用这些框架综合在一起工作。

3.2 Spring如何让Web项目加载？

在第2.2小节中的配置参数中有一个listener是用来让我们的web项目在启动时就可以自动加载Spring框架及其参数配置文件的，即下面的这一行配置参数。

<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener>

3.3 Spring的参数配置文件如何被自动加载上？

配置了Spring自动加载以后，在web项目的WEB-INF/web.xml中应该配置Spring参数文件的加载位置，即在2.2小节中需要配置的

 <!-- 应用程序上下文参数,指定spring配置文件位置 -->

       <context-param>
              <param-name>contextConfigLocation</param-name>
              <param-value>/WEB-INF/spring/applicationContext.xml  /WEB-INF/spring/ibatis_dao.xml /WEB-INF/spring/struts_action.xml</param-value>
       </context-param>

　　在<param-value>后面配置Spring参数文件的路径,有多个Spring的参数配置文件存在时，各个参数文件之间用空格分隔开。

3.4 如何让Spring管理Struts2？

要让Spring管理Struts2的action bean的创建等工作，需要在项目的src目录中的struts.properties文件中指定

struts.objectFactory=spring

struts.objectFactory.spring.autoWire=type

　　       即2.3 小节配置参数中包含的这两行。

3.5 如何让Spring管理数据库缓冲池？

DBCP或者C3p0等数据库缓冲池可以在Spring的参数配置文件当中去配置使用，例如在项目中配置DBCP数据库缓冲池的话可以指定以下格式的参数配置：

  <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"  destroy-method="close">
              <property name="driverClassName" value="${jdbc.driverClassName}" />
              <property name="url" value="${jdbc.url}" />
              <property name="username" value="${jdbc.username}" />
              <property name="password" value="${jdbc.password}" />
              <property name="initialSize" value="4" />
              <property name="maxActive" value="20" />
              <property name="testWhileIdle" value="true" />
              <property name="validationQuery" value="select count(0) from t_db_history where 1=2" />
              <property name="testOnBorrow" value="true" />
 </bean>

上面各个参数值中有的使用的是$符号加{}的形式进行配置的，这种配置格式需要在Spring当中配置一个能够加载.propertis文件的bean，如以下格式：

 <bean id="propertyConfigurer"  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
       <property name="locations">
             <list>
                 <value>WEB-INF/jdbc.properties</value>
             </list>
       </property>
 </bean>

上面配置参数中的list元素后面跟随.properties文件列表。当然，如果不想把参数文件写在Spring以外，也可以在配置DBCP的时候直接将连接数据库URL，用户，密码等等参数写死在Spring当中也是可以的。

3.6 如果整合iBATIS框架？

iBATIS框架要工作的话，需要指定一个全局的iBATIS参数配置文件，即在Spring中需要告诉iBATIS框架，你工作时需要使用的参数文件在哪里可以找到，另外，Spring框架对常见的ORM框架等等都进行了封装，所以要在Spring当中配置iBATIS框架的话，实际上要配置的类是Spring框架当中的某个类，如下：

<bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">
     <property name="configLocations" value="WEB-INF/sql-map-config.xml" />
      <property name="dataSource" ref="dataSource" />
 </bean>  

上面的配置参数中的value="WEB-INF/sql-map-config.xml"即是用来告诉iBATIS框架它要使用的配置参数文件存放在哪个位置。

以上配置参数中的property name="dataSource"
ref="dataSource"即是用来告诉iBATIS框架，它要使用的数据源是在3.5小节中配置的数据库缓冲池。

  3.7 如何使用Spring
2.5 提供的AutoWired功能？

在Spring的参数配置文件中加入如下一行配置参数即可：

<context:annotation-config />

3.8 如何通过数据库的表自动生成实体类以及参数配置文件等等？

需要使用iBATIS官方网站提供的iBATOR，在Eclipse当中可以安装该插件，Eclipse当中安装插件的方法这里不做描述。

安装好iBATOR插件以后，用Eclipse的新建功能向项目中加入一个用于自动生成iBATIS实体类等的参数配置文件，在该文件当中指定本机上的JDBC数据驱动以及连接数据库的参数等等，配置好要生成的实体类，DAO，SQL映射文件的存放路径，如果一切正常，配置完成以后即可自动根据数据库当中的表结构来产生实体类以及DAO等等。

3.9 iBATOR生成的实体类以及DAO等如何应用？

第一步需要先将生成的SQL映射文件添加到iBATIS的全局参数配置文件当中去，具体是哪一个文件是iBATIS框架的参数配置文件呢？

3.6小节中的<property name="configLocations"
value="WEB-INF/sql-map-config.xml" />这一行配置的是哪一个文件，那么那个文件就是iBATIS框架的全局配置参数文件。

向里面加入某一个实体类对应的SQL映射文件的配置参数是如下格式：

<sqlMap
resource="edu/xw/ji/sqlmaps/t_db_history_SqlMap.xml" />

 

iBATOR代码生成工具自动生成的DAO类的实现类有些特殊，即DAO实现类在实例化的时候需要传入一个构造参数，在3.6小节当中配置的那个类的数据类型就是这个构造函数要传入的参数数据类型，那么在Spring当中配置DAO实例时告诉它构造函数的参数是什么就可以了，如下：

<bean id="sys_job_type_dao"   class="edu.xw.ji.dao.SysJobTypeDAOImpl">
          
   <constructor-arg>
                
    <ref bean="sqlMapClient" />
          
   </constructor-arg>
       </bean>

3.11 Spring如何管理Struts2的Action类？

要让Struts2的Action类与Spring一起工作，需要先在Spring当中定义bean,即将Struts2的Action当成普通的bean定义在Spring当中，唯一需要注意的地方是要在Spring的配置参数当中加一句scope="prototype"。

然后在Struts2的参数配置文件中再去使用这个在Spring当中定义好的bean id就行了。