Java Web系列:Spring MVC基礎

王剛發表於2016-01-15

1.Web MVC基礎

MVC的本質是表現層模式,我們以檢視模型為中心,將檢視和控制器分離出來。就如同分層模式一樣,我們以業務邏輯為中心,把表現層和資料訪問層程式碼分離出來是一樣的方法。框架只能在技術層面上給我們幫助,無法在思考和過程上幫助我們,而我們很多人都不喜歡思考和嘗試。

Java Web系列:Spring MVC基礎

2.實現Web MVC的基礎

實現Web MVC基礎可以概括為1個前段控制器和2個對映。

(1)前端控制器FrontController

ASP.NET和JSP都是以Page路徑和URL一一對應,Web MVC要通過URL對映Controller和View,就需要一個前端控制器統一接收和解析請求,再根據的URL將請求分發到Controller。由於ASP.NET和Java分別以IHttpHandler和Servlet作為核心,因此ASP.NET MVC和Spring MVC分別使用實現了對應介面的MvcHandler和DispatcherServlet作為前段控制器。

Java Web系列:Spring MVC基礎

ASP.NET中通過HttpModule的實現類處理URL對映,UrlRoutingModule根據URL將請求轉發給前端控制器MvcHandler。Spring MVC中,則根據URL的配置,直接將請求轉發給前端控制器DispatcherServlet。

(2)URL和Contrller的對映

ASP.NET MVC將URL和Controller的對映規則儲存在RouteCollection中,前端控制器MvcHandler通過IController介面查詢控制器。Spring MVC則通過RequestMapping和Controller註解標識對映規則,無需通過介面依賴實現控制i器。

(3)URL和View的對映

ASP.NET MVC 預設通過RazorViewEngine來根據URL和檢視名稱查詢檢視,核心介面是IViewEngine。Spring MVC 通過internalResourceViewResolver根據URL和檢視名稱查詢檢視,核心介面是ViewResolver。

3.Spring MVC的基礎配置

(1)前端控制器DispatcherServlet初始化:AbstractAnnotationConfigDispatcherServletInitializer

ASP.NET MVC初始化需要我們在HttpApplication.Application_Start方法中註冊預設的URL和Controller規則,Spring MVC由於採用註解對映URL和Controller,因此沒有對應的步驟。ASP.NET在根web.config中配置了UrlRoutingModule可以將請求轉發給MvcHandler,Spring MVC我們需要我們配置DispatcherServlet以及其對應的URL來達到接管所有請求的目的,Spring已經利用Servlet3.0定義的ServletContainerInitializer機制,為我們提供了內建的AbstractAnnotationConfigDispatcherServletInitializer,只要只需要像繼承HttpApplication的MvcApplication一樣,寫一個MvcInitializer。

package s4s;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class MvcInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[] { };
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[] { MvcConfig.class };
    }

    @Override
    protected String[] getServletMappings() {
        return new String[] { "/" };
    }

}

(2)URL和View的對映:WebMvcConfigurerAdapter

ASP.NET的RazorViewEngine內建了View的Path和副檔名.cshtml的規則。Spring MVC的internalResourceViewResolver沒有提供預設值,一般我們會指定將View放置在統一的檢視目錄中,使用特定的副檔名。Spring同樣提供了內建的WebMvcConfigurerAdapter,我們只需寫一個自己的MvcConfig繼承它,重寫configureViewResolvers方法即可。

package s4s;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

@EnableWebMvc
@ComponentScan
@Configuration
public class MvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/views/");
        viewResolver.setSuffix(".jsp");
        registry.viewResolver(viewResolver);
    }
}

4.Spring MVC的Controller、Model和View

(1)URL和Controller的對映:

Spring MVC和ASP.NET MVC的不同,不通過IController介面標識Controller,也不通過RouteCollection定義URL和Controller,取而代之的是兩個註解:Controller和RequestMapping。因此我們在普通的POJO類上應用@Controller和@RequestMapping即可。

package s4s;

import javax.validation.Valid;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MyController {

    @ResponseBody
    @RequestMapping(value = "/")
    public String home() {
        return "home";
    }

    @RequestMapping(value = "/register")
    public String register(@ModelAttribute("model") RegisterUserModel model) {
        return "register";
    }

    @RequestMapping(value = "/register", method = RequestMethod.POST)
    public String register(@ModelAttribute("model") @Valid RegisterUserModel model, BindingResult result) {
        if (!result.hasErrors()) {
            return "redirect:/account";
        }
        return "register";
    }
}

(2)Model:

通過使用@ModelAttribute、@Valid和BindingResult引數,我們可以指定Model的Name是否參與驗證並獲取驗證結果。為在Model上使用註解驗證,還需要引入validation-api和hibernate-validator。

ASP.NET將檢視最終編譯為WebViewPage<object>,View和Model是一一對應並且型別匹配的,Model可以是任意的POCO。Spring MVC中View和Model是一對多的,提供了ModelMap和其子類ModelAndView提供類似ASP.NET MVC中ViewResult的功能。ModelMap的基類是LinkedHashMap<String, Object>。

Spring MVC中沒有ViewResult型別。在Spring MVC中,我們一般返回String型別,可以有多種含義:

a.返回View的名稱。

b.返回文字:在Action上應用@ResponseBody註解時。

c.返回跳轉:以”redirect:”開頭時。如:return “redirect:/success”

模型的驗證:

(1)在Model欄位上使用JSR-303定義的註解(需要引入hibernate validator)。

(2)在Controller的Model引數上應用@ModelAttribute、@Valid

(3)在View中使用<form:errors>標籤

Spring MVC需要新增jstl和spring的tag支援才能完成模型相關的操作。由於Spring MVC中的View和ASP.NET MVC中的區別較大,沒有辦法指定View持有的Model型別也就沒有了智慧提示和錯誤檢測的優勢。

package s4s;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class RegisterUserModel {
    @Size(max = 20, min = 5)
    private String userName;
    @Size(max = 20, min = 5)
    private String password;
    @NotNull
    private String confirmPassword;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getConfirmPassword() {
        return confirmPassword;
    }

    public void setConfirmPassword(String confirmPassword) {
        this.confirmPassword = confirmPassword;
    }
}

register.jsp

<%@ page language="java" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<%@ taglib uri="http://www.springframework.org/tags" prefix="s"%>
<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form"%>
<!DOCTYPE HTML>
<html>
<head>
<title>Getting Started: Serving Web Content</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <h2>Register</h2>
    <form:form modelAttribute="model">
        <s:bind path="*">
            <c:if test="${status.error}">
                <div id="message" class="error">Form has errors</div>
            </c:if>
        </s:bind>
        <div>
            <form:label path="userName">userName</form:label>
            <form:input path="userName" />
            <form:errors path="userName" cssClass="error" />
        </div>
        <div>
            <form:label path="password">password</form:label>
            <form:password path="password" />
            <form:errors path="password" cssClass="error" />
        </div>
        <div>
            <form:label path="confirmPassword">confirmPassword</form:label>
            <form:password path="confirmPassword" />
            <form:errors path="confirmPassword" cssClass="error" />
        </div>
        <input type="submit" value="submit">
    </form:form>
</html>

5.Spring MVC的初始化機制

Spring實現了Servlet 3.0規範定義的javax.servlet.ServletContainerInitializer介面並通過javax.servlet.annotation.HandlesTypes註解引用了WebApplicationInitializer介面。因此在Servlet容器初始化時,在當前class path路徑下的WebApplicationInitializer實現類的onStartup方法會自動執行(這和ASP.NET的Application_Start作用類似,在系列中的Java Web基礎時曾經提到過)。

ASP.NET中我們在Application_Start中初始化依賴注入容器。在Spring MVC中,我們實現WebApplicationInitializer介面同樣可以執行依賴注入的初始化。在Web環境中,我們使用的ApplicationContext介面的實現類為基於註解的AnnotationConfigWebApplicationContext(在系列中的Spring依賴注入基礎中曾經提到過),但我們無需直接實現WebApplicationInitializer並手動初始化AnnotationConfigWebApplicationContext物件,因為Spring已經定義了AbstractAnnotationConfigDispatcherServletInitializer作為WebApplicationInitializer介面的實現類,已經包含了AnnotationConfigWebApplicationContext的初始化。

採用基於Annotation註解時可以通過@Configurateion指定POJO來替代web.xml配置依賴注入。同樣,@ComponentScan可以替代web.xml中的掃描配置功能,使用ComponentScan配合Configurateion可以達到0xml配置的方式。上文中提到的Contrller相關的註解,都是啟用ComponentScan後才會被掃描生效。

AbstractAnnotationConfigDispatcherServletInitializer類的父類AbstractDispatcherServletInitializer中已經包含DispatcherServlet的初始化。相關類圖如下:

Java Web系列:Spring MVC基礎

5.Spring MVC的Action Filter

.NET MVC提供了眾多Filter介面和一個ActionFilterAttribute抽象類作為Filter的基礎,其中以實現了IAuthorizationFilter介面的AuthorizeAttribute攔截器最為我們熟知。Spring MVC則提供了基於HandlerInterceptor介面的眾多介面、抽象類和實現類,其中也有和.NET MVC類似的許可權驗證UserRoleAuthorizationInterceptor攔截器。內建的攔截器可以滿足大部分需求,為了省事圖就畫在一張上了,上面是Spring MVC的,下面是.NET MVC的。

Java Web系列:Spring MVC基礎

總結

(1)MVC實現的要點是前端控制器、URL和Controller的對映、URL和View的對映

(2)MvcHandler和DispatcherServlet

(3)ServletContainerInitializer和HttpApplication.Application_Start

(4)RazorViewEngine和internalResourceViewResolver

(5)IMvcFilter和HandlerInterceptor

目前沒有找到類似ASP.NET中的從特性(註解)生成客戶端JavaScript驗證的方式,如果大家有相關資料分享,提前謝謝大家。

參考:

(1)http://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html

(2)http://spring.oschina.mopaas.com/validation.html#validation-binder

(3)http://www.mkyong.com/spring-mvc/spring-3-mvc-and-jsr303-valid-example/

隨筆裡的文章都是乾貨,都是解決實際問題的,這些問題我在網上找不到更好的解決方法,才會有你看到的這一篇篇隨筆,因此如果這篇部落格內容對您稍有幫助或略有借鑑,請您推薦它幫助更多的人。如果你有提供實際可行的更好方案,請推薦給我。

相關文章