搭建Spring4+Spring MVC web工程的最佳實踐
Spring是個非常非常非常優秀的java框架,主要是用它的IOC容器幫我們依賴注入和管理一些程式中的Bean元件,實現低耦合關聯,最終提高系統可擴充套件性和可維護性,用它來輔助我們構建web工程將會感覺非常非常非常地愉悅。
Spring旗下的Spring MVC又是後來居上,設計得非常非常非常的優雅,可以用來替代Struts來做介面檢視的控制(Controller)等。
現在我們就來搭建一個利用Spring和Spring MVC結合的web工程最佳實踐的例子。以Spring Framework 4.2.0為例,IDE為Myeclipse。
首先,New一個Dynamic
Web Project
加入spring-context及其依賴的jar包
加入Spring MVC相關jar包
完整的jar包如下
現在開始準備配置Spring和Spring MVC的IOC容器,理論上說,可以只需要Spring MVC的IOC容器即可,所有的bean都放到裡面讓Spring MVC容器來管理,但是這樣做並不優雅,我們可以讓Spring MVC容器只管理和它本身相關的東西,像資料來源、事務管理以及自己程式中需要用到的Bean等可以用Spring的IOC容器來管理。
在web.xml中配置以啟動Spring的IOC容器:
<!-- 啟動 Spring 的IOC容器 --> <context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/beans.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener>
這段配置的意思是給ServletContext傳入一個名為“contextConfigLocation”的配置資訊,然後新增一個Spring為我們提供好的用來啟動Spring容器的監聽器,web應用啟動的時候這個監聽器就會從ServletContext中取名”contextConfigLocation”的配置資訊,即Spring配置檔案的所在路徑,如果有就會從指定路徑讀取配置檔案啟動Spring容器,如果沒有就從預設路徑讀取,這裡我們指定為WEB-INF下的beans.xml檔案,下面是一個最基本的beans.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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd"> <context:component-scan base-package="com.cpwl"> </context:component-scan> </beans>
以上配置指定了需要掃描元件的包,base-package表示需要掃描的包,Spring會掃描它及其所有子包中的元件(加了某些註解的類,如:@Component、@Controller、@Service、@Repository等),然後將其建立例項並放入IOC容器。
然後我們再來配置一下啟動Spring MVC容器的必要配置,回到web.xml,將下面的配置貼上進去:
<!-- 啟動 Spring MVC 的IOC容器 -->
<servlet>
<servlet-name>springDispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springDispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
因為Spring MVC主要是用來作為前端控制器,所以它底層自然是Servlet實現的咯,上面配置的意思是配置一個Spring為我們提供好的用來啟動Spring MVC的Servlet,讀取指定路徑的Spring MVC配置檔案,並指定它攔截所有請求(Spring MVC會將請求交給指定請求路徑的Controller去處理)。這裡我們指定的路徑為WEB-INF目錄下的spring-mvc.xml檔案作為Spring MVC的配置檔案。
來到WEB-INF目錄,新建一個spring-mvc.xml檔案,和beans.xml檔案一樣的格式。
我們主要利用Spring MVC來寫Controller,每個Controller可以對映任意多個路徑,利用註解來標註Controller非常方便和優雅,我們需要用到@Controller註解來指定Controller物件,用@RequestMapping來指定某方法對映某路徑,這時只需要在spring-mvc.xml中加入<mvc:annotation-driven></mvc:annotation-driven>即可。
但是攔截所有請求,一些靜態資源外界就不好訪問,這時我們希望讓伺服器自身預設的Servlet去幫我們處理靜態資源的響應,只需要再spring-mvc.xml檔案裡面配個<mvc:default-servlet-handler/>就行,用到了mvc名稱空間,自然也就需要匯入mvc名稱空間了。
別急,還需要指定Spring MVC掃描元件的包,在spring-mvc.xml中加入類似這種的配置:<context:component-scanbase-package="com.cpwl"use-default-filters="false"></context:component-scan>
注意,use-default-filters置為false。
這時完整的spring-mvc.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:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd">
<mvc:default-servlet-handler/>
<mvc:annotation-driven></mvc:annotation-driven>
<context:component-scan base-package="com.cpwl" use-default-filters="false">
</context:component-scan>
</beans>
現在,我們可以來寫一個Controller了:
package com.cpwl.springtest.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;
@Controller
public class TestController {
public TestController() {
System.out.println("TestController constructed......");
}
@RequestMapping(value="/test",method=RequestMethod.GET)
public ModelAndView testMVC(){
ModelAndView modelAndView = new ModelAndView("/WEB-INF/views/test.jsp");
modelAndView.addObject("info", "陳鵬萬里");
return modelAndView;
}
}
該Controller的testMVC方法映射了”/test”的路徑,訪問它的時候它將設定一個資訊,然後轉發給/WEB-INF/views/test.jsp來顯示輸出頁面給客戶端。
在WEB-INF目錄下新建一個views目錄,進入該目錄再新建一個test.jsp,如下:
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Spring MVC Test</title>
</head>
<body>
Hello ${info} !!!!!
</body>
</html>
現在web工程的專案結構如下:
OK,現在我們將其部署到伺服器,啟動伺服器後用瀏覽器訪問testMVC()所對映的路徑:
哎喲,不錯喲。
但是!我們看下控制檯輸出的資訊:
TestConstructor被建立了兩次,Why???
這是因為我們用了兩個容器,一個Spring一個SpringMVC,給它們所指定掃描的包都相同,所以所有元件都會被建立兩次。
怎麼解決?兩種方案。
方案一:把Spring MVC容器需要掃描的元件單獨放到一個包下,比如:com.cpwl.springtest.controller,然後在component-scan的base-package屬性指定為改包的包名,Spring容器也類似這樣做。但是這樣並不是很好,實際開發中有時很難做到這樣。
方案二:component-scan中指定filter,舉個栗子,
spring-mvc.xml中的component-scan這樣寫:
<context:component-scan base-package="com.cpwl"
use-default-filters="false">
<context:include-filter type="annotation"
expression="org.springframework.stereotype.Controller" />
<context:include-filter type="annotation"
expression="org.springframework.web.bind.annotation.ControllerAdvice" />
</context:component-scan>
beans.xml中的component-scan這樣寫:
<context:component-scan base-package="com.cpwl">
<context:exclude-filter type="annotation"
expression="org.springframework.stereotype.Controller" />
<context:exclude-filter type="annotation"
expression="org.springframework.web.bind.annotation.ControllerAdvice"/>
</context:component-scan>
意思是讓Spring MVC的容器只掃描和Controller相關的註解,Spring的容器就只不掃描和Controller相關的註解,這樣它們就相安無事,可以一起愉快地為我們服務了。
其實還可以改進一些,在spring-mvc.xml中加入如下配置:
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"></property>
<property name="suffix" value=".jsp"></property>
</bean>
配置一個內部資源檢視解析器,假如你在Controller裡返回一個檢視,它的路徑就可以簡寫了,省略字首和字尾,之前我們寫的是:/WEB-INF/views/test.jsp,現在可以簡寫成:test
我們只需要返回一個簡寫的內部資源路徑的字串就行,這樣,我們也沒必要建立ModelAndView了,直接讓方法的引數給我們提供一個Map,我們向裡面寫點資料然後交給檢視去顯示就行了,testMVC方法改寫如下:
@RequestMapping(value="/test",method=RequestMethod.GET)
public String testMVC(Map<String,Object> map){
map.put("info", "陳鵬萬里");
return "test";
}
用瀏覽器訪問結果和之前一模一樣,prettygood!
初來乍到,經驗尚淺,若有不對之處還望各位不吝賜教,歡迎指正:)