精簡web開發配置文件

作爲web開發初學者，面對各種框架的配置文件時常感到知其然不知其所以然。這是因爲很多配置文件其實有多種寫法都可以達到同樣目的。最近研究了spring整合mybatis的工程，終於把這些門道大致摸清了。

web開發領域一向推崇MVC模式，於是有了SSH之類的組合框架。不過我總感覺SSH有點臃腫，甚至即便只用spring的MVC模塊，我都覺得沒有自己寫servlet理解起來直接，於是採用更簡潔的spring+mybatis+servlet的結構。mybatis是輕量級的orm框架。除非回到自己手寫jdbc的sql語句原始途徑上去，否則這點複雜性還是需要的，而且mybatis的映射語句就是sql，學習曲線並不高。

本來spring也可以不用，但是表多了、dao接口多了，手工管理起來也有點麻煩。所以還是用spring管理起來，至少xml文件能少寫很多很多行。

作爲對“簡潔”事務的執着追求者，我把這些配置文件都精簡到了最短，多出的文字只是解釋。

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" 
id="courseware" version="2.5">

  <!-- 標準servlet定義 -->
  <servlet>
    <servlet-name>CheckName</servlet-name>
    <servlet-class>com.zjc.servlet.CheckName</servlet-class>
  </servlet>
  
  <!-- 在servlet中使用spring上下文中的bean時，需要寫一個SpringServlet作爲中介。這些servlet都指向這個中介。當然這些servlet也要註冊在spring的配置文件中 -->
  <servlet>
    <servlet-name>InitServlet</servlet-name>
    <servlet-class>com.zjc.servlet.SpringServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet>
    <servlet-name>Test</servlet-name>
    <servlet-class>com.zjc.servlet.SpringServlet</servlet-class>
  </servlet>
  
  <!-- 指定spring的配置文件及設置監聽，在啓動時加載sping框架 -->
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>WEB-INF/config/application-Context.xml</param-value>
  </context-param>
  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>
  
  <!-- 指定log4j屬性文件位置及設置監聽，啓動spring時啓動log4j -->
  <context-param>  
        <param-name>log4jConfigLocation</param-name>  
        <param-value>WEB-INF/config/log4j.properties</param-value>  
  </context-param>
  <listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
  </listener>
  
  <!-- 使用spring的字符編碼過濾器，降低產生亂碼的概率 -->
  <filter>
      <filter-name>encodingFilter</filter-name>
      <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
      <init-param>
       <param-name>encoding</param-name>
       <param-value>utf-8</param-value>
      </init-param>
      <init-param>
       <param-name>forceEncoding</param-name>
       <param-value>true</param-value>
    </init-param>
  </filter>
  <filter-mapping>
      <filter-name>encodingFilter</filter-name>
      <url-pattern>/*</url-pattern>
  </filter-mapping>
   
  <!-- servlet映射 -->
  <servlet-mapping>
    <servlet-name>CheckName</servlet-name>
    <url-pattern>/CheckName</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
    <servlet-name>Test</servlet-name>
    <url-pattern>/test</url-pattern>
  </servlet-mapping>

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

spring的配置文件：application-Context.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:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/mvc 
       http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
		http://www.springframework.org/schema/beans 
                http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
		http://www.springframework.org/schema/context 
                http://www.springframework.org/schema/context/spring-context-4.1.xsd">
                
    <!-- 引用屬性文件，也可以不用屬性文件直接寫在這。但個人認爲屬性文件還是必要的，直接修改這個文件是不易懂的 -->
    <context:property-placeholder location="WEB-INF/config/jdbc.properties"/>
    
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    	<property name="driverClassName" value="${jdbc.driver}"/>
    	<property name="url" value="${jdbc.url}"/>
    	<property name="username" value="${jdbc.username}"/>
    	<property name="password" value="${jdbc.password}"/>
    </bean>
    
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    	<!-- 引用上面的數據源 -->
    	<property name="dataSource" ref="dataSource"/>
    	<!-- 指定mybatis核心配置文件  --> 
    	<property name="configLocation" value="WEB-INF/config/mybatis.xml"/>
    	<!-- 指定所有mapper映射文件 *.xml位置，自動查找 -->
    	<property name="mapperLocations" value="classpath*:com/zjc/dao/*.xml"/>
    </bean>
    
    <!-- 自動掃描接口（mapper）文件，生成代理類對象，並加入到spring上下文中。
    !bean id默認首字母小寫，即如接口名是單個首字母大寫，則自動換成首字母小寫，並且自動與*.xml中的映射語句關聯起來。與xml的文件名無關。接口前可加入@Repository註解 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    	<property name="basePackage" value="com.zjc.dao"/>
    	
    	<!-- 本來從邏輯上說，此處還應該再加一個sqlSessionFactory屬性的引用，但只要加了就會導致jdbc.properties引用值不正確。在只有一個數據源的情況下，不加這一句反倒不會出錯，於是省略。 
    	!如加上此句：property name="annotationClass" value="org.springframework.stereotype.Repository" 表示只有被@Repository註解的接口才被掃描，不加表示掃描全部，故省略。-->
    </bean>
    <!--有了上面的自動掃描，就無需逐個手工定義Mapper bean了，以下示例是手工定義的模板，此處不需要
     <bean id="userMapper" class="com.zjc.bean.User">
		<property name="mapperInterface" value="com.zjc.dao.IUserMapper"/>
		<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
     -->
    
    <!-- 使用spring事務管理 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    	<property name="dataSource" ref="dataSource"/>
    </bean>
    
    <!-- 將servlet定義在spring中，和web.xml中的內容保持一致，當然如果用到了mybatis bean，也要作爲屬性注入 -->
    <bean id="initServlet" class="com.zjc.servlet.InitServlet"/>
    <bean id="test" class="com.zjc.test.UserAccess">
    	<property name="um" ref="userMapper"/>
    	<!-- 此處引用爲spring上下文中的bean名字，所以不能是類似com.zjc.dao.UserMapper這樣的接口名 -->
    </bean>
</beans>

mybatis配置文件：mybatis.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	<!-- 通知mybatis，日誌系統是什麼 -->
	<settings>
    	<setting name="logImpl" value="LOG4J"/>
    </settings>
    
    <!-- 定義mybatis使用的別名,映射文件*.xml中所用的名稱依賴於此 -->
	<typeAliases>
		<!-- 
		<typeAlias alias="User" type="com.zjc.bean.User"/>  
		此處爲手工定義樣例。更常用的是自動掃描方法-->
		
		<package name="com.zjc.bean"/>
	</typeAliases>
	
	<!-- 使用spring自動掃描時，就需要把這段手工創建的映射關掉，否則衝突
    <mappers>
    	<mapper resource="com/zjc/bean/User.xml"/>
    </mappers>
     -->
</configuration>

jdbc屬性文件：jdbc.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/courseware
jdbc.username=courseware
jdbc.password=courseware

log4j屬性文件：log4j.properties

log4j.rootLogger=info,CA

#trace mybatis--If you need log mybatis sql statements,add Interface(Mapper) at here.
log4j.logger.com.zjc.dao.IUserMapper=TRACE
#log4j.logger.com.zjc.dao.ICommentMapper=TRACE

log4j.appender.CA=org.apache.log4j.ConsoleAppender
log4j.appender.CA.layout=org.apache.log4j.PatternLayout
log4j.appender.CA.layout.ConversionPattern=%d5p %c %x - %m%n

目錄結構：

代碼目錄：

修改了一點，但截圖還是舊的。接口名應該爲UserMapper.java