Spring Web MVC框架(一) 搭建環境
學過Java的都知道SSH,也就是Struts、Spring和Hibernate。其中Struts是一個Web MVC框架,Hibernate是ORM框架,Spring是一組框架。不過由於Struts設計較早,其中有些設計已經過時了,框架漏洞也比較多。而且Struts的編寫也不方便(例如控制器必須繼承Controller類),所以現在Struts用的比較少了。現在更加常用的Web MVC框架是Spring Web MVC。所以我們今天就來介紹一下它。
新建專案
首先要做的就是搭建環境。我們需要新建一個Java Web專案,可以直接新建一個專案,也可以使用Maven或Gradle這樣的構建工具。在這裡我用的是Gradle和IDEA。首先使用IDEA新建一個Gradle專案,在新建時選擇Java和Web兩個選項。然後點選完成。稍等片刻就會生成一個Gradle專案。然後我們開啟build.gradle
group 'yitian.learn'
version '1.0-SNAPSHOT'
apply plugin: 'java'
apply plugin: 'war'
apply from: 'https://raw.github.com/akhikhl/gretty/master/pluginScripts/gretty.plugin'
sourceCompatibility = 1.8
repositories {
jcenter()
}
ext {
springVersion = '4.3.6.RELEASE'
thymeleafVersion = '3.0.3.RELEASE'
}
dependencies {
testCompile group: 'junit', name: 'junit', version: '4.12'
compile group: 'org.springframework', name: 'spring-webmvc', version: springVersion
compile group: 'javax.servlet.jsp.jstl', name: 'javax.servlet.jsp.jstl-api', version: '1.2.1'
compile group: 'org.glassfish.web' , name: 'jstl-impl', version: '1.2'
}
稍等片刻,等待IDEA更新專案配置。完畢之後,我們檢視一下專案的依賴,可以發現已經添加了所需的Spring依賴項,Spring依賴注入、事務管理、面向切面程式設計等依賴都已新增,非常方便。
配置Spring
我們可以根據需要配置一個或多個ApplicationContext,常見的做法是配置一個根ApplicationContext和一個前端ApplicationContext。前端ApplicationContext定義網路相關的配置,根ApplicationContext配置資料庫等網路無關的元件。這樣的話就需要web.xml
寫成類似這樣的。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value>
</context-param>
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<!--如果只需要一個ApplicationContext,值留空-->
<param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</web-app>
如果只需要一個ApplicationContext,Servlet初始化引數的contextConfigLocation
值留空即可。在上面的配置中,我們建立了兩個ApplicationContext,一個是全域性的,另一個是前端控制器dispatcher-servlet使用的。這裡有一個命名規範,如果Spring前端控制器的名稱是X,那麼Spring會尋找X-servlet.xml作為其配置檔案的名稱。當然這是針對沒有顯式配置contextConfigLocation的情況。如果像上面一樣配置了contextConfigLocation,那麼相應的Spring配置檔名就是任意的。
這裡的ApplicationContext其實是一個WebApplicationContext,它可以配置一些網路相關的元件,例如檢視解析器、異常解析器、主題解析器等等。
定義控制器
新建一個Java檔案,然後寫為如下這樣。這樣就定義了一個控制器。Spring MVC框架非常靈活,我們只需要應用@Controller註解即可定義一個控制器,不像Struts2那樣必須繼承一個控制器基類。在控制器中我們可以定義若干方法,每個方法管理相應的URL請求。控制器方法的返回值不是任意的,必須遵循一定的規範。如果返回字串,那麼這個字串代表著是相應檢視的名稱,然後會由檢視解析器解析為相應的檢視檔案。Spring MVC框架非常靈活,利用檢視解析器將具體的檢視技術和MVC框架的檢視層分離,我們可以應用Thymeleaf、JSP、FreeMarker等不同的檢視技術,只要配置了相應的檢視解析器。
package yitian.learn.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class MainController {
@RequestMapping("/hello")
public String hello(@RequestParam(defaultValue = "苟") String name, Model model) {
model.addAttribute("name", name);
return "hello";
}
@RequestMapping("/index")
public String index() {
return "index";
}
}
配置檢視
配置檢視解析器
在dispatcher-servlet.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/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
<property name="prefix" value="/WEB-INF/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
<mvc:default-servlet-handler/>
<mvc:annotation-driven/>
<context:component-scan base-package="yitian.learn"/>
</beans>
名為viewResolver
的Bean定義了一個檢視解析器,對於不同的檢視技術有不同的檢視解析器,這裡用InternalResourceViewResolver
來解析JSP頁面。如果需要在JSP中使用JSTL,還需要新增viewClass
屬性並設定為org.springframework.web.servlet.view.JstlView
,這樣才能讓Spring正確處理JSTL。另外兩個屬性是字首和字尾,Spring會用這些前後綴查詢具體的檢視檔名稱。假如控制器傳過來的檢視名為index
,那麼新增前後綴之後的就是該檢視的真正檔名/WEB-INF/jsp/index.jsp
。
為什麼不直接在webapp
資料夾下放置JSP檔案?由於webapp
資料夾下的JSP可以直接被客戶端訪問到,因此不利於服務端的控制。例如我們有一個使用者資訊頁面需要在使用者登入之後才能顯示具體使用者資訊。如果放到webapp
下,使用者可能在沒有登入的情況下就訪問到該頁面。將頁面全部放到WEB-INF
下,客戶端無法直接訪問,這樣就提高了程式的安全性。
<mvc:default-servlet-handler/>
指定讓Spring的DispatcherServlet作為預設Servlet,這樣我們就可以讓Spring處理根路徑/
的請求了。如果不加這個,那麼根路徑的請求預設會由伺服器來處理。<mvc:annotation-driven/>
啟用MVC的註解支援。如果不新增這個,那麼我們就需要在XML檔案中為每個控制器寫一個Bean配置,想想就知道很麻煩。<context:component-scan base-package="yitian.learn"/>
告訴Spring從哪裡搜尋註解,如果不新增這個,Spring就無法查詢我們編寫的控制器等檔案了。
上面的配置可以使用mvc名稱空間簡化。我們可以使用如下的配置替代上面的檢視解析器配置。
<mvc:view-resolvers>
<mvc:jsp view-class="org.springframework.web.servlet.view.JstlView"
prefix="/WEB-INF/jsp/"
suffix=".jsp"/>
</mvc:view-resolvers>
新增檢視
由於上面我們在配置檢視解析器的時候配置了JSP,那麼我們就需要新建JSP檔案。在上面的控制器中我們返回了index
和hello
兩個檢視,那麼根據檢視解析器的配置,我們需要在/WEB-INF/jsp/
下新建JSP檔案。
index.jsp
檔案如下。
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>主頁</title>
</head>
<body>
<h1>歡迎</h1>
<h2><a href="<c:url value="/hello"/>">問候</a></h2>
</body>
</html>
hello.jsp
檔案如下。由於上面的控制器向檢視傳遞了一個引數name
,所以我們可以使用EL表示式在JSP中直接使用該引數。
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>hello</title>
</head>
<body>
<h1>你好,${name} </h1>
<h2><a href="<c:url value="/index"/>">返回主頁</a></h2>
</body>
</html>
最後使用命令gradle tomcatRun
來執行一下程式。如果成功的出現了主頁和問候頁面,那麼我們的Spring Web MVC環境就配置成功了。這樣,我們就可以進行下一步的學習了。