REST風格框架實戰：從MVC到前后端分離(附完整Demo)

本文轉載自查看原文 2017-12-29 15:54 6679 REST MVC 前端后端前后端

既然MVC模式這么好，難道它就沒有不足的地方嗎？我認為MVC至少有以下三點不足：
(1)每次請求必須經過“控制器->模型->視圖”這個流程，用戶才能看到最終的展現的界面，這個過程似乎有些復雜；
(2)實際上視圖是依賴於模型的，換句話說，如果沒有模型，視圖也無法呈現出最終的效果；
(3)渲染視圖的過程是在服務端來完成的，最終呈現給瀏覽器的是帶有模型的視圖頁面，性能無法得到很好的優化。

為了使數據展現過程更加直接，並且提供更好的用戶體驗，我們有必要對MVC模式進行改進。不妨這樣來嘗試：
首先從瀏覽器發送AJAX請求，然后服務端接受該請求並返回JSON數據返回給瀏覽器，最后在瀏覽器中進行界面渲染。改進后的MVC模式如下圖所示：

前后端分離的好處：

后端的復用
前后端更加自由的獨立作業
分工造成專業
按照標准交付（后端可以做兼職了）

新事物的產生：

前端高速發展
JS框架
CSS腳本化
前端編譯技術
Single-page Application
接口相關技術
類似 Swagger 一樣的接口標准
REST具有更高的可行性
數據傳輸標准 JSend, JSON API
HTTP2 對請求的合並
后端細化
為接口而生的 PHP 框架
路由層的顯現

作者：馬文Marvin
鏈接：http://www.jianshu.com/p/c8bb5f9be522
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。

沒有前后端分離時的開發模式：

后端是跟數據庫跟服務器打交道的，前端是跟瀏覽器打交道的。似乎沒有什么問題，大家都這么認為的。當然這沒有什么錯，我們一直以來都認為僅僅是以瀏覽器作分界，把這兩部分的代碼分離出來。但是前后端分離的初衷是為了分離前后端開發人員的職責，同時解決開發模式的問題。但似乎他們的職責在以前甚至於現在都並不明確，雖然前端是跟瀏覽器打交道，但是最終瀏覽器拿到的頁面是服務器通過模板生成的一個臨時靜態頁面而已。所以，實際上后端也摻和進來了，因為他要處理模板。

當然，一般傳統上的開發協作模式有兩種：

一種是前端先寫一個靜態頁面，寫好后，讓后端去套模板。靜態頁面可以本地開發，也無需考慮業務邏輯只需要實現View即可。不足是還需要后端套模板，這些前端代碼后端需要瀏覽一遍，以免出錯。

另一種協作模式是，前端直接去寫模板，這樣做的問題在於，前端編寫過程中很依賴與后端環境，如果當后端沒寫完的情況下，前端幾乎沒法干活。

顯然這兩種方式似乎都有很多問題，但至少這還是目前為止大部分公司所采用的模式。他們從物理層來區分前后端的開發，同時淡化了前端在邏輯上的色彩。
由於前端所做的事情就是來實現一個頁面的靜態版本，所以，大多數公司又給前端工程師們找了點活干。你去看現在公司在招聘的時候前端工程師的要求，除了對頁面的基本制作技能外還有額外的設計職責。

作者：Rainey
鏈接：http://www.jianshu.com/p/f1287e1aee50
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。

摘要：

　　本人在前輩《從MVC到前后端分離（REST-個人也認為是目前比較流行和比較好的方式）》一文的基礎上，實現了一個基於Spring的符合REST風格的完整Demo，具有MVC分層結構並實現前后端分離，該項目體現了一個具有REST風格項目的基本特征，即具有統一響應結構、前后台數據流轉機制(HTTP消息與Java對象的互相轉化機制)、統一的異常處理機制、參數驗證機制、Cors跨域請求機制以及鑒權機制。此外，該項目的完整源碼可移步到我的Github參考，項目地址：https://github.com/githubofrico/RestSpringMVCDemo。

　　本文原創作者：書呆子Rico
　　作者博客地址：http://blog.csdn.net/justloveyou_/

　　本文是在CSDN博友shao.bing的專欄的《從MVC到前后端分離（REST-個人也認為是目前比較流行和比較好的方式）》一文基礎上整理而成，實現了文中所述的REST框架並進行分享，相關源碼移步至我的Github進行下載，項目地址：https://github.com/githubofrico/RestSpringMVCDemo。

　　本文旨在分享與交流，若涉及侵權，請留言或郵件(rico@tju.edu.cn)聯系。

一. MVC 概述

1. 理解 MVC

　　MVC是一種經典的設計模式，全名為Model-View-Controller，即模型-視圖-控制器。其中，模型是用於封裝數據的載體，例如，在Java中一般通過一個簡單的POJO（Plain Ordinary Java Object）來表示，其本質是一個普通的java Bean，包含一系列的成員變量及其getter/setter方法。對於視圖而言，它更加偏重於展現，也就是說，視圖決定了界面到底長什么樣子，在Java中可通過JSP來充當視圖，或者通過純HTML的方式進行展現，而后者才是目前的主流。模型和視圖需要通過控制器來進行粘合，例如，用戶發送一個HTTP請求，此時該請求首先會進入控制器，然后控制器去獲取數據並將其封裝為模型，最后將模型傳遞到視圖中進行展現。綜上所述，MVC的交互過程如下圖所示。

　　　　　　　　　　　　　　 MVC.jpg-21.5kB

2. MVC 模式的優點與不足

　　MVC模式早在上個世紀70年代就誕生了，直到今天它依然存在，可見生命力相當之強。MVC模式最早應用於Smalltalk語言中，最后在其它許多開發語言中都得到了很好的應用。隨着包括Struts、Spring MVC在內的MVC框架的出現，MVC模式真正落地，並使得開發更加高效、代碼耦合度盡量減小、應用程序各部分的職責更加清晰。

　　既然MVC模式這么好，難道它就沒有不足的地方嗎？我認為MVC至少有以下三點不足：

每次請求必須經過“控制器->模型->視圖”這個流程，用戶才能看到最終的展現的界面，這個過程似乎有些復雜；
實際上視圖是依賴於模型的，換句話說，如果沒有模型，視圖也無法呈現出最終的效果；
渲染視圖的過程是在服務端來完成的，最終呈現給瀏覽器的是帶有模型的視圖頁面，性能無法得到很好的優化。

　　為了使數據展現過程更加直接，並且提供更好的用戶體驗，我們有必要對MVC模式進行改進。不妨這樣來嘗試：首先從瀏覽器發送AJAX請求，然后服務端接受該請求並返回JSON數據返回給瀏覽器，最后在瀏覽器中進行界面渲染。改進后的MVC模式如下圖所示：

　　　　　　　　　　　　　　

　　也就是說，我們輸入的是AJAX請求，輸出的是JSON數據，市面上有這樣的技術來實現這個功能嗎？答案是REST。

　　REST全稱是Representational State Transfer（表述性狀態轉移），它是Roy Fielding博士在2000年寫的一篇關於軟件架構風格的論文，此文一出，威震四方！國內外許多知名互聯網公司紛紛開始采用這種輕量級的Web服務，大家習慣將其稱為RESTful Web Services，或簡稱REST服務。]

　　如果將瀏覽器這一端視為前端，而服務器那一端視為后端的話，可以將以上改進后的MVC模式簡化為以下前后端分離模式，如下圖所示：

　　　　　　　　　　　　　　　　

　　可見，采用REST分格的架構可以使得前端關注界面展現，后端關注業務邏輯，分工明確，職責清晰。那么，如何使用REST架構將應用程序進行前后端分離呢？我們接下來繼續探討，首先我們需要認識REST。

二. 認識 REST

　　REST本質上是使用URL來訪問資源的一種方式。眾所周知，URL(Uniform Resoure Locator:統一資源定位器)就是我們平常使用的請求地址了，其中包括兩部分：請求方式與請求路徑，比較常見的請求方式是GET與POST，但在REST中又提出了幾種其它類型的請求方式，匯總起來有六種：GET、POST、PUT、DELETE、HEAD、OPTIONS。尤其是前四種，正好與CRUD（Create-Retrieve-Update-Delete，增刪改查）四種操作相對應，例如，GET（查）、POST（增）、PUT（改）、DELETE（刪），這正是REST與CRUD的異曲同工之妙！需要強調的是，REST是面向資源(ROA)的，這里提到的資源，實際上就是我們常說的領域對象，在系統設計過程中，我們經常通過領域對象來進行數據建模。

　　REST是一個無狀態的架構模式，因為在任何時候都可以由客戶端發出請求到服務端，最終返回自己想要的數據，當前請求不會受到上次請求的影響。也就是說，服務端將內部資源發布REST服務，客戶端通過URL來定位這些資源並通過HTTP協議來訪問它們。下面我們舉幾個例子對REST請求進行簡單描述：

　　　　　　　　　　　　　　　　 REST例子.jpg-41.7kB

　　可見，請求路徑相同但請求方式不同，所代表的業務操作也不同，例如，/advertiser/1這個請求，帶有GET、PUT、DELETE三種不同的請求方式，對應三種不同的業務操作。

　　雖然REST看起來還是很簡單的，實際上我們往往需要提供一個REST框架，讓其實現前后端分離架構，讓開發人員將精力集中在業務上，而並非那些具體的技術細節。下面我們將使用Java技術來實現這個REST框架，整體框架會基於Spring進行開發。

三. 實現REST框架

1、統一響應結構

　　使用REST框架實現前后端分離架構，我們需要首先確定返回的JSON響應結構是統一的，也就是說，每個REST請求將返回相同結構的JSON響應結構。不妨定義一個相對通用的JSON響應結構，其中包含兩部分：元數據與返回值，其中，元數據表示操作是否成功與返回值消息等，返回值對應服務端方法所返回的數據。該JSON響應結構如下：

    {
        "meta": {
            "success": true,
            "message": "ok"
        },
        "data": ...
    }

　　為了在框架中映射以上JSON響應結構，我們需要編寫一個Response類與其對應：

/**
 * Title: 統一響應結構 
 * Description:使用REST框架實現前后端分離架構，我們需要首先確定返回的JSON響應結構是統一的，
 * 也就是說，每個REST請求將返回相同結構的JSON響應結構。不妨定義一個相對通用的JSON響應結構，其
 * 中包含兩部分：元數據與返回值，其中，元數據表示操作是否成功與返回值消息等，返回值對應服務端方法所返回的數據。
 * { "meta": { "success": true, "message": "ok" }, "data": ... }
 * 
 * @author rico
 * @created 2017年7月4日 下午5:06:00
 */
public class Response {

    private static final String OK = "ok";
    private static final String ERROR = "error";

    private Meta meta;     // 元數據
    private Object data;   // 響應內容

    public Response success() {
        this.meta = new Meta(true, OK);
        return this;
    }

    public Response success(Object data) {
        this.meta = new Meta(true, OK);
        this.data = data;
        return this;
    }

    public Response failure() {
        this.meta = new Meta(false, ERROR);
        return this;
    }

    public Response failure(String message) {
        this.meta = new Meta(false, message);
        return this;
    }

    public Meta getMeta() {
        return meta;
    }

    public Object getData() {
        return data;
    }

    /**
     * Title: 請求元數據
     * @author rico
     * @created 2017年7月4日 下午5:08:12
     */
    public class Meta {

        private boolean success;
        private String message;

        public Meta(boolean success) {
            this.success = success;
        }

        public Meta(boolean success, String message) {
            this.success = success;
            this.message = message;
        }

        public boolean isSuccess() {
            return success;
        }

        public String getMessage() {
            return message;
        }
    }
}

以上Response類包括兩類通用返回值消息：ok 與 error，還包括兩個常用的操作方法：success( )與failure( )，通過一個內部類來展現元數據結構，我們在下文中多次會使用該Response類。

　　實現該REST框架需要考慮許多問題，首當其沖的就是前后數據流轉問題，即HTTP消息與Java對象之間的轉化問題。

2、前后台數據流轉
　　
　　前后台數據流轉問題具體指的是什么？不妨通過一些例子進行說明。比如，通過瀏覽器發送了一個普通的HTTP請求，該請求攜帶了一個JSON格式的參數，在服務端需要將該JSON參數轉換為普通的Java對象；再比如，在服務端獲取了數據，此時該數據是一個普通的Java對象，然后需要將這個Java對象轉換為JSON字符串，並將其返回到瀏覽器中進行渲染，這個過程就涉及HTTP消息與Java對象之間的轉化問題。

　　實際上，Spring MVC已經為我們提供了這類轉化特性，只需在Controller的方法參數中使用@RequestBody注解定義需要轉化的參數即可；
類似地，若需要對Controller的方法返回值進行轉化，則需要在該返回值上使用@ResponseBody注解來定義，如以下代碼片段：

@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(UserController.class);

    public UserService getUserService() {
        return userService;
    }

    @Resource(name = "userService")
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    @RequestMapping(value = "/user", method = RequestMethod.PUT, produces = "application/json", 
            consumes = "application/json")
    @ResponseBody     // 將 Java 對象轉化為特定的HTTP消息
    public User addUser(@RequestBody User user) {  // 將接收到的HTTP消息轉化為Java對象
        userService.addUser(user);
        log.debug("添加用戶 :" + user);
        return user;
    }
}

　　當然，@ResponseBody注解也可以定義在類上，這樣所有的方法都繼承了該特性。由於經常會使用到@ResponseBody注解，所以Spring提供了一個名為@RestController的注解來取代以上的@Controller注解，這樣我們就可以省略返回值前面的@ResponseBody注解了，但參數前面的@RequestBody注解是無法省略的。實際上，看看Spring中對應@RestController注解的源碼便可知曉：

@Target({ElementType.TYPE})  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
@Controller  
@ResponseBody  
public @interface RestController {  

    String value() default "";  
}

可見，@RestController注解已經被@Controller與@ResponseBody注解定義過了，Spring框架會識別這類注解。需要注意的是，該特性在Spring 4.0中才引入。
因此，我們可將以上代碼進行如下改寫：

@RestController
@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(UserController.class);

    public UserService getUserService() {
        return userService;
    }

    @Resource(name = "userService")
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    @RequestMapping(value = "/user", method = RequestMethod.PUT, produces = "application/json", 
            consumes = "application/json")
    public User addUser(@RequestBody User user) {  // 將接收到的HTTP消息轉化為Java對象
        userService.addUser(user);
        log.debug("添加用戶 :" + user);
        return user;
    }
}

　　除了使用注解來定義消息轉化行為以外，我們還需要添加Jackson包進行支持，Maven依賴如下：

<!-- JSON: jackson -->
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.12</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-lgpl</artifactId>
    <version>1.9.12</version>
</dependency>

　　在Spring配置文件中添加以下配置即可：

    <!-- 該配置會自動注冊RequestMappingHandlerMapping與RequestMappingHandlerAdapter兩個Bean，
    這是SpringMVC為@Controllers分發請求所必需的，並提供了數據綁定支持、@NumberFormatannotation支持、
    @DateTimeFormat支持、@Valid支持、讀寫XML的支持和讀寫JSON的支持等功能。 -->
    <mvc:annotation-driven />

　　通過以上過程，我們已經完成了一個基於SpringMVC的REST框架，只不過該框架還非常單薄，還缺乏很多關鍵性特性，尤其是異常處理。

3、處理異常行為

　　在Spring MVC中，我們可以使用AOP技術，編寫一個全局的異常處理切面類，用它來統一處理所有的異常行為，在Spring 3.2中才開始提供。使用很簡單，只需定義一個類，並通過@ControllerAdvice注解將其標注即可，同時需要使用@ResponseBody注解表示返回值可序列化為JSON字符串。
代碼如下：

/**        
 * Title: 全局異常處理切面    
 * Description: 利用 @ControllerAdvice + @ExceptionHandler 組合處理Controller層RuntimeException異常
 * @author rico       
 * @created 2017年7月4日 下午4:29:07    
 */      
@ControllerAdvice   // 控制器增強
@ResponseBody
public class ExceptionAspect {

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(ExceptionAspect.class);

    /**
     * 400 - Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public Response handleHttpMessageNotReadableException(
            HttpMessageNotReadableException e) {
        log.error("could_not_read_json...", e);
        return new Response().failure("could_not_read_json");
    }

    /**
     * 400 - Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public Response handleValidationException(MethodArgumentNotValidException e) {
        log.error("parameter_validation_exception...", e);
        return new Response().failure("parameter_validation_exception");
    }

    /**
     * 405 - Method Not Allowed。HttpRequestMethodNotSupportedException
     * 是ServletException的子類,需要Servlet API支持
     */
    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public Response handleHttpRequestMethodNotSupportedException(
            HttpRequestMethodNotSupportedException e) {
        log.error("request_method_not_supported...", e);
        return new Response().failure("request_method_not_supported");
    }

    /**
     * 415 - Unsupported Media Type。HttpMediaTypeNotSupportedException
     * 是ServletException的子類,需要Servlet API支持
     */
    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler({ HttpMediaTypeNotSupportedException.class })
    public Response handleHttpMediaTypeNotSupportedException(Exception e) {
        log.error("content_type_not_supported...", e);
        return new Response().failure("content_type_not_supported");
    }

    /**
     * 500 - Internal Server Error
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(TokenException.class)
    public Response handleTokenException(Exception e) {
        log.error("Token is invaild...", e);
        return new Response().failure("Token is invaild");
    }

    /**
     * 500 - Internal Server Error
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public Response handleException(Exception e) {
        log.error("Internal Server Error...", e);
        return new Response().failure("Internal Server Error");
    }
}

　　可見，在ExceptionAdvice類中包含一系列的異常處理方法，每個方法都通過@ResponseStatus注解定義了響應狀態碼，此外還通過@ExceptionHandler注解指定了具體需要攔截的異常類。以上過程只是包含了一部分的異常情況，若需處理其它異常，可添加方法具體的方法。需要注意的是，在運行時從上往下依次調用每個異常處理方法，匹配當前異常類型是否與@ExceptionHandler注解所定義的異常相匹配，若匹配，則執行該方法，同時忽略后續所有的異常處理方法，最終會返回經JSON序列化后的Response對象。

4、支持參數驗證

　　我們回到上文所提到的示例，這里處理一個普通的PUT請求，代碼如下：

@RestController
@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(UserController.class);

    public UserService getUserService() {
        return userService;
    }

    @Resource(name = "userService")
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    @RequestMapping(value = "/user", method = RequestMethod.PUT, produces = "application/json", 
            consumes = "application/json")
    public User addUser(@RequestBody User user) {  // 將接收到的HTTP消息轉化為Java對象
        userService.addUser(user);
        log.debug("添加用戶 :" + user);
        return user;
    }

    ...
}

　　其中，User參數包含若干屬性，通過以下類結構可見，它是一個傳統的POJO：

public class User implements Serializable{

    private static final long serialVersionUID = 1L;

    private int id;
    private String uname;
    private String passwd;
    private String gentle;
    private String email;
    private String city;

    public User() {
        super();
    }

    // getter/setter

    // toString
}

　　如果業務上需要確保User對象的uname屬性必填，如何實現呢？若將這類參數驗證的代碼寫死在Controller中，勢必會與正常的業務邏輯攪在一起，導致責任不夠單一，違背於“單一責任原則”。建議將其參數驗證行為從Controller中剝離出來，放到另外的類中，這里僅通過@Valid注解來定義uname參數，並通過Bean Validation的參考實現Hibernate Validator的@NotEmpty注解來定義User類中的uname屬性，就像下面這樣：

@RestController
@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(UserController.class);

    public UserService getUserService() {
        return userService;
    }

    @Resource(name = "userService")
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    @RequestMapping(value = "/user", method = RequestMethod.PUT, produces = "application/json", 
            consumes = "application/json")
    public User addUser(@RequestBody  @Valid User user) {  // 將接收到的HTTP消息轉化為Java對象
        userService.addUser(user);
        log.debug("添加用戶 :" + user);
        return user;
    }

    ...
}

public class User implements Serializable{

    private static final long serialVersionUID = 1L;

    private int id;
    @NotEmpty
    private String uname;
    private String passwd;
    private String gentle;
    private String email;
    private String city;

    public User() {
        super();
    }

    // getter/setter

    // toString
}

　　這里的@Valid注解實際上是Validation Bean規范提供的注解，該規范已由Hibernate Validator框架實現，因此需要添加以下Maven依賴到pom.xml文件中：

<dependency>  
    <groupId>org.hibernate</groupId>  
    <artifactId>hibernate-validator</artifactId>  
    <version>${hibernate-validator.version}</version>  
</dependency>

　　需要注意的是，Hibernate Validator與Hibernate沒有任何依賴關系，唯一有聯系的只是都屬於JBoss公司的開源項目而已。然后，我們需要在Spring配置文件中開啟該特性，需添加如下配置：

<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>

　　最后，我們在全局異常處理類中添加對參數驗證異常的處理方法，代碼如下：

@ControllerAdvice  
@ResponseBody  
public class ExceptionAdvice {  

    /** 
     * 400 - Bad Request 
     */  
    @ResponseStatus(HttpStatus.BAD_REQUEST)  
    @ExceptionHandler(ValidationException.class)  
    public Response handleValidationException(ValidationException e) {  
        logger.error("參數驗證失敗", e);  
        return new Response().failure("validation_exception");  
    }  
}

　　至此，REST框架已集成了Bean Validation特性，我們可以使用各種注解來完成所需的參數驗證行為了。

看似該框架可以在本地成功跑起來，整個架構包含兩個應用，前端應用提供純靜態的HTML頁面，后端應用發布REST API，前端需要通過AJAX調用后端發布的REST API，然而AJAX是不支持跨域訪問的，也就是說，前后端兩個應用必須在同一個域名下才能訪問。這是非常嚴重的技術障礙，一定需要找到解決方案。

5、解決跨域問題

　　比如，前端應用為靜態站點且部署在http://web.xxx.com域下，后端應用發布REST API並部署在http://api.xxx.com域下，如何使前端應用通過AJAX跨域訪問后端應用呢？這需要使用到CORS技術來實現，這也是目前最好的解決方案了。

　　CORS全稱為Cross Origin Resource Sharing（跨域資源共享），服務端只需添加相關響應頭信息，即可實現客戶端發出AJAX跨域請求。

　　CORS技術非常簡單，易於實現，目前絕大多數瀏覽器均已支持該技術（IE8瀏覽器也支持了），服務端可通過任何編程語言來實現，只要能將CORS響應頭寫入response對象中即可。

　　下面我們繼續擴展REST框架，通過CORS技術實現AJAX跨域訪問。首先，我們需要編寫一個Filter，用於過濾所有的HTTP請求，並將CORS響應頭寫入response對象中，代碼如下：

/**        
 * Title: 跨域訪問處理(跨域資源共享)    
 * Description: 解決前后端分離架構中的跨域問題
 * @author rico       
 * @created 2017年7月4日 下午5:00:09    
 */      
public class CorsFilter implements Filter {

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(UserController.class);

    private String allowOrigin;
    private String allowMethods;
    private String allowCredentials;
    private String allowHeaders;
    private String exposeHeaders;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        allowOrigin = filterConfig.getInitParameter("allowOrigin");
        allowMethods = filterConfig.getInitParameter("allowMethods");
        allowCredentials = filterConfig.getInitParameter("allowCredentials");
        allowHeaders = filterConfig.getInitParameter("allowHeaders");
        exposeHeaders = filterConfig.getInitParameter("exposeHeaders");
    }


    /** 
     * @description 通過CORS技術實現AJAX跨域訪問,只要將CORS響應頭寫入response對象中即可
     * @author rico       
     * @created 2017年7月4日 下午5:02:38      
     * @param req
     * @param res
     * @param chain
     * @throws IOException
     * @throws ServletException     
     * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)     
     */  
    @Override
    public void doFilter(ServletRequest req, ServletResponse res,
            FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;
        String currentOrigin = request.getHeader("Origin");
        log.debug("currentOrigin : " + currentOrigin);
        if (StringUtil.isNotEmpty(allowOrigin)) {
            List<String> allowOriginList = Arrays
                    .asList(allowOrigin.split(","));
            log.debug("allowOriginList : " + allowOrigin);
            if (CollectionUtil.isNotEmpty(allowOriginList)) {
                if (allowOriginList.contains(currentOrigin)) {
                    response.setHeader("Access-Control-Allow-Origin",
                            currentOrigin);
                }
            }
        }
        if (StringUtil.isNotEmpty(allowMethods)) {
            response.setHeader("Access-Control-Allow-Methods", allowMethods);
        }
        if (StringUtil.isNotEmpty(allowCredentials)) {
            response.setHeader("Access-Control-Allow-Credentials",
                    allowCredentials);
        }
        if (StringUtil.isNotEmpty(allowHeaders)) {
            response.setHeader("Access-Control-Allow-Headers", allowHeaders);
        }
        if (StringUtil.isNotEmpty(exposeHeaders)) {
            response.setHeader("Access-Control-Expose-Headers", exposeHeaders);
        }
        chain.doFilter(req, res);
    }

    @Override
    public void destroy() {
    }
}

　　以上CorsFilter將從web.xml中讀取相關Filter初始化參數，並將在處理HTTP請求時將這些參數寫入對應的CORS響應頭中，下面大致描述一下這些CORS響應頭的意義：

Access-Control-Allow-Origin：允許訪問的客戶端域名，例如：http://web.xxx.com，若為*，則表示從任意域都能訪問，即不做任何限制；
Access-Control-Allow-Methods：允許訪問的方法名，多個方法名用逗號分割，例如：GET,POST,PUT,DELETE,OPTIONS；
Access-Control-Allow-Credentials：是否允許請求帶有驗證信息，若要獲取客戶端域下的cookie時，需要將其設置為true；
Access-Control-Allow-Headers：允許服務端訪問的客戶端請求頭，多個請求頭用逗號分割，例如：Content-Type；
Access-Control-Expose-Headers：允許客戶端訪問的服務端響應頭，多個響應頭用逗號分割。

　需要注意的是，CORS規范中定義Access-Control-Allow-Origin只允許兩種取值，要么為*，要么為具體的域名，也就是說，不支持同時配置多個域名。為了解決跨多個域的問題，需要在代碼中做一些處理，這里將Filter初始化參數作為一個域名的集合（用逗號分隔），只需從當前請求中獲取Origin請求頭，就知道是從哪個域中發出的請求，若該請求在以上允許的域名集合中，則將其放入Access-Control-Allow-Origin響應頭，這樣跨多個域的問題就輕松解決了。以下是web.xml中配置CorsFilter的方法：

<!-- 通過CORS技術實現AJAX跨域訪問 -->
    <filter>
        <filter-name>corsFilter</filter-name>
        <filter-class>cn.edu.tju.rico.filter.CorsFilter</filter-class>
        <init-param>
            <param-name>allowOrigin</param-name>
            <param-value>http://localhost:8020</param-value>
        </init-param>
        <init-param>
            <param-name>allowMethods</param-name>
            <param-value>GET,POST,PUT,DELETE,OPTIONS</param-value>
        </init-param>
        <init-param>
            <param-name>allowCredentials</param-name>
            <param-value>true</param-value>
        </init-param>
        <init-param>
            <param-name>allowHeaders</param-name>
            <param-value>Content-Type,X-Token</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>corsFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

　　完成以上過程即可實現AJAX跨域功能了，但似乎還存在另外一個問題，由於REST是無狀態的，后端應用發布的REST API可在用戶未登錄的情況下被任意調用，這顯然是不安全的，如何解決這個問題呢？我們需要為REST請求提供安全機制。

6、提供安全機制

　　解決REST安全調用問題，可以做得很復雜，也可以做得特簡單，可按照以下過程提供REST安全機制：

　　(1). 當用戶登錄成功后，在服務端生成一個token，並將其放入內存中（可放入JVM或Redis中），同時將該token返回到客戶端；

　　(2). 在客戶端中將返回的token寫入cookie中，並且每次請求時都將token隨請求頭一起發送到服務端；

　　(3). 提供一個AOP切面，用於攔截所有的Controller方法，在切面中判斷token的有效性；

　　(4). 當登出時，只需清理掉cookie中的token即可，服務端token可設置過期時間，使其自行移除。

　　首先，我們需要定義一個用於管理token的接口，包括創建token與檢查token有效性的功能。代碼如下：

/**        
 * Title: REST 鑒權   
 * Description: 登錄用戶的身份鑒權
 * @author rico       
 * @created 2017年7月4日 下午4:41:43    
 */      
public interface TokenManager {

    String createToken(String username);  

    boolean checkToken(String token); 

    void deleteToken(String token);
}

　　然后，我們可提供一個簡單的TokenManager實現類，將token存儲到JVM內存中。代碼如下：

/**        
 * Title: TokenManager的默認實現    
 * Description: 管理 Token
 * @author rico       
 * @created 2017年7月4日 下午4:41:32    
 */      
public class DefaultTokenManager implements TokenManager {

    /** 將token存儲到JVM內存(ConcurrentHashMap)中   (@author: rico) */      
    private static Map<String, String> tokenMap = new ConcurrentHashMap<String, String>();

    /** 
     * @description 利用UUID創建Token(用戶登錄時，創建Token)
     * @author rico       
     * @created 2017年7月4日 下午4:46:46      
     * @param username
     * @return     
     * @see cn.edu.tju.rico.authorization.TokenManager#createToken(java.lang.String)     
     */  
    public String createToken(String username) {
        String token = CodecUtil.createUUID();
        tokenMap.put(token, username);
        return token;
    }


    /** 
     * @description Token驗證(用戶登錄驗證)
     * @author rico       
     * @created 2017年7月4日 下午4:46:50      
     * @param token
     * @return     
     * @see cn.edu.tju.rico.authorization.TokenManager#checkToken(java.lang.String)     
     */  
    public boolean checkToken(String token) {
        return !StringUtil.isEmpty(token) && tokenMap.containsKey(token);
    }


    /** 
     * @description Token刪除(用戶登出時，刪除Token)
     * @author rico       
     * @created 2017年7月4日 下午4:46:54      
     * @param token     
     * @see cn.edu.tju.rico.authorization.TokenManager#deleteToken(java.lang.String)     
     */  
    @Override
    public void deleteToken(String token) {
        // TODO Auto-generated method stub
        tokenMap.remove(token);
    }
}

　　需要注意的是，如果需要做到分布式集群，建議基於Redis提供一個實現類，將token存儲到Redis中，並利用Redis與生俱來的特性，做到token的分布式一致性。

然后，我們可以基於Spring AOP寫一個切面類，用於攔截Controller類的方法，並從請求頭中獲取token，最后對token有效性進行判斷。代碼如下：

/**
 * Title:安全檢查切面(是否登錄檢查) 
 * Description: 通過驗證Token維持登錄狀態
 * 
 * @author rico
 * @created 2017年7月4日 下午4:32:34
 */
@Component
@Aspect
public class SecurityAspect {

    /** Log4j日志處理(@author: rico) */
    private static final Logger log = Logger.getLogger(SecurityAspect.class);

    private TokenManager tokenManager;

    @Resource(name = "tokenManager")
    public void setTokenManager(TokenManager tokenManager) {
        this.tokenManager = tokenManager;
    }

    @Around("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
    public Object execute(ProceedingJoinPoint pjp) throws Throwable {
        // 從切點上獲取目標方法
        MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
        log.debug("methodSignature : " + methodSignature);
        Method method = methodSignature.getMethod();
        log.debug("Method : " + method.getName() + " : "
                + method.isAnnotationPresent(IgnoreSecurity.class));
        // 若目標方法忽略了安全性檢查,則直接調用目標方法
        if (method.isAnnotationPresent(IgnoreSecurity.class)) {
            return pjp.proceed();
        }

        // 從 request header 中獲取當前 token
        String token = WebContextUtil.getRequest().getHeader(
                Constants.DEFAULT_TOKEN_NAME);
        // 檢查 token 有效性
        if (!tokenManager.checkToken(token)) {
            String message = String.format("token [%s] is invalid", token);
            log.debug("message : " + message);
            throw new TokenException(message);
        }
        // 調用目標方法
        return pjp.proceed();
    }
}

　　若要使SecurityAspect生效，則需要在SpringMVC配置文件中添加如下Spring 配置：

    <!-- 啟用注解掃描，並定義組件查找規則 ，mvc層只負責掃描@Controller、@ControllerAdvice -->
    <!-- base-package 如果多個，用“,”分隔 -->
    <context:component-scan base-package="cn.edu.tju.rico"
        use-default-filters="false">
        <!-- 掃描 @Controller -->
        <context:include-filter type="annotation"
            expression="org.springframework.stereotype.Controller" />
        <!-- 控制器增強，使一個Contoller成為全局的異常處理類，類中用@ExceptionHandler方法注解的方法可以處理所有Controller發生的異常 -->
        <context:include-filter type="annotation"
            expression="org.springframework.web.bind.annotation.ControllerAdvice" />
    </context:component-scan>

    <!-- 支持Controller的AOP代理 -->
    <aop:aspectj-autoproxy />

最后，別忘了在web.xml中添加允許的X-Token響應頭，配置如下：

<init-param>  
    <param-name>allowHeaders</param-name>  
    <param-value>Content-Type,X-Token</param-value>  
</init-param>

四. 關於Demo部署的若干建議

　　本項目是一個使用Maven進行構建的項目，關於Maven的了解、使用推薦大家看孤傲蒼狼的《Maven學習總結》一系列博客；

　　關於REST服務的調試推薦大家使用Postman這款工具，請大家自行下載與安裝，具體見《postman的安裝與使用（模擬請求）》；

五. 總結

　　本文從經典的MVC模式開始，對MVC模式是什么以及該模式存在的不足進行了簡述。然后引出了如何對MVC模式的改良，讓其轉變為前后端分離架構，以及解釋了為何要進行前后端分離。最后通過REST服務將前后端進行解耦，並提供了一款基於Java的REST框架的主要實現過程，尤其是需要注意的核心技術問題及其解決方案。希望本文對正在探索前后端分離的讀者們有所幫助，期待與大家共同探討。
　　

六. 更多

　　本項目的全部完整源碼可以在我的GitHub上找到，項目名為RestSpringMVCDemo，項目地址為：https://github.com/githubofrico/RestSpringMVCDemo。

　　更多關於REST的介紹，請移步我的博文《理解RESTful架構》。

　　更多關於 Java Web 方面的內容，請關注我的專欄《Java Web 成神之路》。本專欄全面記錄了Java Web開發相關知識，不但包括對http, servlet,session等基礎知識的講解，還包括對流行框架(SSM,SpringMVC等)、中間件(Redis等)等進階知識的深入分析。筆者將持續跟進最新Web技術，期望對大家能夠起到拋磚引玉的效果。

引用

從MVC到前后端分離（REST-個人也認為是目前比較流行和比較好的方式）

http://blog.csdn.net/justloveyou_/article/details/74379479

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 前后端分離開發,基於SpringMVC符合Restful API風格Maven項目實戰（附完整Demo）！使用REST風格完成MVC前后端分離前后端分離之mockjs實戰demo Restful風格的前后端分離從MVC到前后端分離 Aspnet Mvc 前后端分離項目手記（三）關於restful 風格Url設計從MVC到前后端分離 SSM前后端分離/不分離對比Demo 前后端分離框架基於MVC的RESTFul風格API實戰