SSH 基于注解的SSH將配置精簡到極致

2018-09-28 18:56 更新

基于注解的SSH將配置精簡到極致

很早之前就想寫一篇關(guān)于SSH整合的博客了,但是一直覺得使用SSH的時(shí)候那么多的配置文件,嚴(yán)重破壞了我們代碼整體性,比如你要看兩個(gè)實(shí)體的關(guān)系還得對照.hbm.xml文件,要屢清一個(gè)Action可能需要對照applicationContext.xml和struts*.xml文件??傊^多的配置文件壞破壞代碼的整體性,會(huì)打亂代碼的連續(xù)性,因?yàn)楹芏嗲闆r下你需要一邊看Java代碼,一邊看xml的配置,采用注解就能很好的解決這個(gè)問題。

當(dāng)然,即使采用注解的方式,也不能完全的丟掉配置文件,因?yàn)榕渲梦募浅绦虻娜肟?,是基礎(chǔ)。服務(wù)器啟動(dòng)最先加載web.xml文件,讀取其中的配置信息,將程序運(yùn)行所需要的信息進(jìn)行初始化。因?yàn)槭钦蟂SH,所以web.xml文件中需要配置Spring以及Struts的信息,同時(shí)Spring跟Struts也需要進(jìn)行一些基本的配置。

使用注解的方式,配置文件最少可以精簡到三個(gè),web.xml、applicationContext.xml和struts.xml。Hibernate可以完全交給Spring來管理,這樣連hibernate.cfg.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"   
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee   
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="SSH" version="2.5">  
  <display-name>ssh</display-name>  
  <welcome-file-list>  
    <welcome-file>addUser.jsp</welcome-file>  
  </welcome-file-list>  

  <!-- 配置Spring的監(jiān)聽器,用于初始化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>  

  <!-- struts2 的配置 -->  
  <filter>  
    <filter-name>struts2</filter-name>  
        <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>  
    <init-param>  
      <param-name>filterConfig</param-name>  
      <param-value>classpath:struts.xml</param-value>  
    </init-param>  

    <!-- 自動(dòng)掃描action -->  
    <init-param>  
      <param-name>actionPackages</param-name>  
      <param-value>com.ssh</param-value>  
    </init-param>  
  </filter>  

  <filter-mapping>  
    <filter-name>struts2</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
</web-app>  

web.xml中包含了Spring和struts的基本配置,自動(dòng)掃描Action的配置就是告訴tomcat,我要使用注解來配置struts。

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">      

    <!-- 自動(dòng)掃描與裝配bean -->      
    <context:component-scan base-package="com.tgb.ssh"></context:component-scan>      

    <!-- dbcp配置 -->    
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">      
        <property name="driverClassName">    
            <value>com.mysql.jdbc.Driver</value>    
        </property>    
        <property name="url">    
            <value>jdbc:mysql://127.0.0.1:3307/ssh</value>    
        </property>    
        <property name="username">    
            <value>root</value>    
        </property>    
        <property name="password">    
            <value>123456</value>    
        </property>    
    </bean>    

    <bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">    
        <property name="dataSource">    
            <ref local="dataSource" />    
        </property>    
        <property name="hibernateProperties">    
            <props>    
                <!--配置Hibernate的方言-->    
                <prop key="hibernate.dialect">    
                 org.hibernate.dialect.MySQLDialect    
                </prop>                    
                <prop key="hibernate.hbm2ddl.auto">update</prop>    

                <!--格式化輸出sql語句-->    
                <prop key="hibernate.show_sql">true</prop>    
                <prop key="hibernate.format_sql">true</prop>      
                <prop key="hibernate.use_sql_comments">false</prop>      
            </props>    
        </property>    

        <!--自動(dòng)掃描實(shí)體 -->    
        <property name="packagesToScan"  value="com.tgb.ssh.model" />    
    </bean>    

    <!-- 用注解來實(shí)現(xiàn)事務(wù)管理 -->    
    <bean id="txManager" class="org.springframework.orm.hibernate4.HibernateTransactionManager">    
        <property name="sessionFactory" ref="sessionFactory"></property>          
    </bean>    
    <tx:annotation-driven transaction-manager="txManager"/>    

</beans>   

applicationContext.xml里配置了數(shù)據(jù)庫連接的基本信息(對hibernate的管理),還有對所有bean的自動(dòng)裝配管理和事務(wù)的管理。struts.xml

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

<struts>    

    <!-- 開啟使用開發(fā)模式,詳細(xì)錯(cuò)誤提示 -->    
    <constant name="struts.devMode" value="true" />    
    <!-- 將對象交給spring管理 -->    
    <constant name="struts.objectFactory" value="spring" />    
    <!-- 指定資源編碼類型 -->    
    <constant name="struts.i18n.encoding" value="UTF-8" />     
    <!-- 指定每次請求到達(dá),重新加載資源文件 -->    
    <constant name="struts.i18n.reload" value="false" />    
    <!-- 指定每次配置文件更改后,自動(dòng)重新加載 -->    
    <constant name="struts.configuration.xml.reload" value="false" />    
    <!-- 默認(rèn)后綴名 -->    
    <constant name="struts.action.extension" value="action," />       

</struts>    

struts.xml里配置了一些struts的基本參數(shù),并告訴容器用Spring來管理自己。

到這里一個(gè)基本的SSH的配置就算完成了,配置很簡單,而且每一項(xiàng)配置都有說明,相信理解上不會(huì)有什么問題?;A(chǔ)的配置就這么多,下面就是我們的注解發(fā)揮作用的時(shí)候了。

userAdd.jsp

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>  
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
<html>  
  <head>  
    <title>添加用戶</title>  
  </head>  

  <body>  
      <form method="post" action="addUser">  
        用戶名:<input type="text" name="user.name"><br>  
        密碼:<input type="password" name="user.password"><br>          
        <input type="submit" value="登錄"/>  
    </form>      
  </body>  
</html>  

用戶添加頁面,將用戶信息提交給UserAction。

UserAction

package com.tgb.ssh.action;  

import javax.annotation.Resource;  

import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Result;  
import org.apache.struts2.convention.annotation.Results;  

import com.opensymphony.xwork2.ActionSupport;  
import com.tgb.ssh.model.User;  
import com.tgb.ssh.service.UserManager;  

@Results( { @Result(name="success",location="/success.jsp"),  
        @Result(name="failure",location="/failure.jsp") })   
public class UserAction extends ActionSupport {  
    @Resource  
    private UserManager userManager;  
    private User user;  

    @Action(value="addUser")  
    public String addUser() {  
        try {  
            userManager.addUser(user);          
        } catch (Exception e) {  
            e.printStackTrace();  
            return "failure";  
        }  
        return "success";  

    }      

    public User getUser() {  
        return user;  
    }  
    public void setUser(User user) {  
        this.user = user;  
    }  

}  

UserAction通過注解配置Action的名字和返回的頁面,通過@Resource活動(dòng)Spring注入的UserManager對象,然后進(jìn)行相應(yīng)的操作。Action里還有@Namespace、@InterceptorRef等很多注解可以用,根據(jù)自己需要選擇吧。

UserManager

package com.tgb.ssh.service;  

import javax.annotation.Resource;  

import org.springframework.stereotype.Service;  
import org.springframework.transaction.annotation.Transactional;  

import com.tgb.ssh.dao.UserDao;  
import com.tgb.ssh.model.User;  

@Service  
@Transactional  
public class UserManager {  
    @Resource  
    UserDao userDao;  

    public void addUser(User user) {  
        userDao.addUser(user);  
    }  

}  

UserManager通過@Service自動(dòng)裝配到Spring的容器,為其他組件提供服務(wù);通過@Transactional進(jìn)行事務(wù)的管理;通過@Resource注入U(xiǎn)serDao對象。

UserDao

package com.tgb.ssh.dao;  

import javax.annotation.Resource;  

import org.hibernate.Session;  
import org.hibernate.SessionFactory;  
import org.hibernate.Transaction;  
import org.springframework.orm.hibernate4.HibernateTemplate;  
import org.springframework.stereotype.Repository;  

import com.tgb.ssh.model.User;  

@Repository  
public class UserDao {  
    @Resource(name="sessionFactory")   
    private SessionFactory sessionFactory;  

    public void addUser(User user ) {  
        Session session = sessionFactory.getCurrentSession();  
        session.save(user);  
    }  

}  

UserDao通過@Repository自動(dòng)裝配到Spring的容器,通過@Resource獲得Sessionfactory,將User對象持久化。

User

package com.tgb.ssh.model;  

import javax.persistence.Entity;  
import javax.persistence.GeneratedValue;  
import javax.persistence.GenerationType;  
import javax.persistence.Id;  

@Entity(name="t_user")  
public class User {  
    @Id  
    @GeneratedValue(strategy = GenerationType.IDENTITY)  
    private int id;  
    private String name;  
    private String password;      

    public int getId() {  
        return id;  
    }  

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

    public String getName() {  
        return name;  
    }  

    public void setName(String name) {  
        this.name = name;  
    }  
    public String getPassword() {  
        return password;  
    }  
    public void setPassword(String password) {  
        this.password = password;  
    }  
}  

User通過@Entity將實(shí)體類映射到數(shù)據(jù)庫,生成t_user表,通過@Id定義表的Id,通過@GenerateValue定義Id的生成策略。

好了,到此為止,基于注解的SSH就算是搭建完成了。基礎(chǔ)的搭建已經(jīng)使注解簡潔的優(yōu)勢初現(xiàn)端倪,隨著開發(fā)的進(jìn)行,代碼不斷地增加,其簡潔的風(fēng)格相比傳統(tǒng)配置文件的方式會(huì)更加明顯。因?yàn)槿绻捎门渲梦募姆绞?,每增加一個(gè)Action都需要在struts.xml和applicationContext.xml文件增加一段代碼;每多一個(gè)實(shí)體,也需要多一個(gè)*.hbm.xml文件。配置文件泛濫是一件讓人頭疼的事情。

注解好處多多,而且也越來越流行,但配置文件也并不是一無是處。注解有注解的好,配置文件有配置文件的妙。還是那句話,技術(shù)沒有好壞之分,只有合適不合適之別。一味的追求技術(shù)的好與壞不是明智之舉,選擇一個(gè)合適的才是真正的設(shè)計(jì)之道。本文主旨不在于告訴你注解比配置文件好,而是向大家介紹另一種方式,可以多一種選擇,也許你會(huì)找到一種更合適的方式。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號