JAVA MVC RSET

allowtransparency="true" frameborder="0" scrolling="no" src="http://hits.sinajs.cn/A1/weiboshare.html?url=http%3A%2F%2Fwww.csdn.net%2Farticle%2F2015-10-25%2F2826033&type=3&count=&appkey=&title=MVC%E6%A8%A1%E5%BC%8F%E6%97%A9%E5%9C%A8%E4%B8%8A%E4%B8%AA%E4%B8%96%E7%BA%AA70%E5%B9%B4%E4%BB%A3%E5%B0%B1%E8%AF%9E%E7%94%9F%E4%BA%86%EF%BC%8C%E7%9B%B4%E5%88%B0%E4%BB%8A%E5%A4%A9%E5%AE%83%E4%BE%9D%E7%84%B6%E5%AD%98%E5%9C%A8%EF%BC%8C%E5%8F%AF%E8%A7%81%E7%94%9F%E5%91%BD%E5%8A%9B%E7%9B%B8%E5%BD%93%E4%B9%8B%E5%BC%BA%E3%80%82MVC%E6%A8%A1%E5%BC%8F%E6%9C%80%E6%97%A9%E7%94%A8%E4%BA%8ESmalltalk%E8%AF%AD%E8%A8%80%E4%B8%AD%EF%BC%8C%E6%9C%80%E5%90%8E%E5%9C%A8%E5%85%B6%E5%AE%83%E8%AE%B8%E5%A4%9A%E5%BC%80%E5%8F%91%E8%AF%AD%E8%A8%80%E4%B8%AD%E9%83%BD%E5%BE%97%E5%88%B0%E4%BA%86%E5%BE%88%E5%A5%BD%E7%9A%84%E5%BA%94%E7%94%A8%EF%BC%8C%E4%BE%8B%E5%A6%82%EF%BC%8CJava%E4%B8%AD%E7%9A%84Struts%E3%80%81Spring%20MVC%E7%AD%89%E6%A1%86%E6%9E%B6%E3%80%82&pic=&ralateUid=&language=zh_cn&rnd=1445828530525" width="22" height="16">摘要:MVC模式早在上個世紀70年代就誕生了,直到今天它依然存在,可見生命力相當之強。MVC模式最早用於Smalltalk語言中,最後在其它許多開發語言中都得到了很好的應用,例如,Java中的Struts、Spring MVC等框架。

1. 理解MVC

MVC是一種經典的設計模式,全名爲Model-View-Controller,即模型-視圖-控制器。

其中,模型是用於封裝數據的載體,例如,在Java中一般通過一個簡單的POJO(Plain Ordinary Java Object)來表示,其本質是一個普通的Java Bean,包含一系列的成員變量及其getter/setter方法。對於視圖而言,它更加偏重於展現,也就是說,視圖決定了界面到底長什麼樣子,在Java中可通過JSP來充當視圖,或者通過純HTML的方式進行展現,而後者纔是目前的主流。模型和視圖需要通過控制器來進行粘合,例如,用戶發送一個HTTP請求,此時該請求首先會進入控制器,然後控制器去獲取數據並將其封裝爲模型,最後將模型傳遞到視圖中進行展現。

綜上所述,MVC的交互過程如圖1所示。

2. MVC模式的優點與不足

MVC模式早在上個世紀70年代就誕生了,直到今天它依然存在,可見生命力相當之強。MVC模式最早用於Smalltalk語言中,最後在其它許多開發語言中都得到了很好的應用,例如,Java中的Struts、Spring MVC等框架。正是因爲這些MVC框架的出現,才讓MVC模式真正落地,讓開發更加高效,讓代碼耦合度儘量減小,讓應用程序各部分的職責更加清晰。

既然MVC模式這麼好,難道它就沒有不足的地方嗎?我認爲MVC至少有以下三點不足:

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

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

改進後的MVC模式如圖2所示。

 

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

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

如果將瀏覽器這一端視爲前端,而服務器那一端視爲後端的話,可以將以上改進後的MVC模式簡化爲以下前後端分離模式,如圖3所示。

 

可見,有了REST服務,前端關注界面展現,後端關注業務邏輯,分工明確,職責清晰。那麼,如何使用REST服務將應用程序進行前後端分離呢?我們接下來繼續探討,首先我們需要認識REST。

3. 認識REST

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

REST是一個“無狀態”的架構模式,因爲在任何時候都可以由客戶端發出請求到服務端,最終返回自己想要的數據,當前請求不會受到上次請求的影響。也就是說,服務端將內部資源發佈REST服務,客戶端通過URL來訪問這些資源,這不就是SOA所提倡的“面向服務”的思想嗎?所以,REST也被人們看做是一種“輕量級”的SOA實現技術,因此在企業級應用與互聯網應用中都得到了廣泛應用。

下面我們舉幾個例子對REST請求進行簡單描述:

 

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

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

4. 實現REST框架

4.1 統一響應結構

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

{
	"meta": {
		"success": true,
		"message": "ok"
	},
	"data": ...
}
爲了在框架中映射以上JSON響應結構,我們需要編寫一個Response類與其對應:

[java] view plaincopy
  1. public class Response {  
  2.   
  3.     private static final String OK = "ok";  
  4.     private static final String ERROR = "error";  
  5.   
  6.     private Meta meta;  
  7.     private Object data;  
  8.   
  9.     public Response success() {  
  10.         this.meta = new Meta(true, OK);  
  11.         return this;  
  12.     }  
  13.   
  14.     public Response success(Object data) {  
  15.         this.meta = new Meta(true, OK);  
  16.         this.data = data;  
  17.         return this;  
  18.     }  
  19.   
  20.     public Response failure() {  
  21.         this.meta = new Meta(false, ERROR);  
  22.         return this;  
  23.     }  
  24.   
  25.     public Response failure(String message) {  
  26.         this.meta = new Meta(false, message);  
  27.         return this;  
  28.     }  
  29.   
  30.     public Meta getMeta() {  
  31.         return meta;  
  32.     }  
  33.   
  34.     public Object getData() {  
  35.         return data;  
  36.     }  
  37.   
  38.     public class Meta {  
  39.   
  40.         private boolean success;  
  41.         private String message;  
  42.   
  43.         public Meta(boolean success) {  
  44.             this.success = success;  
  45.         }  
  46.   
  47.         public Meta(boolean success, String message) {  
  48.             this.success = success;  
  49.             this.message = message;  
  50.         }  
  51.   
  52.         public boolean isSuccess() {  
  53.             return success;  
  54.         }  
  55.   
  56.         public String getMessage() {  
  57.             return message;  
  58.         }  
  59.     }  
  60. }  
以上Response類包括兩類通用返回值消息:ok與error,還包括兩個常用的操作方法:success( )與failure( ),通過一個內部類來展現元數據結構,我們在下文中多次會使用該Response類。

實現該REST框架需要考慮許多問題,首當其衝的就是對象序列化問題。

4.2 實現對象序列化

想要解釋什麼是對象序列化?不妨通過一些例子進行說明。比如,通過瀏覽器發送了一個普通的HTTP請求,該請求攜帶了一個JSON格式的參數,在服務端需要將該JSON參數轉換爲普通的Java對象,這個轉換過程稱爲序列化。再比如,在服務端獲取了數據,此時該數據是一個普通的Java對象,然後需要將這個Java對象轉換爲JSON字符串,並將其返回到瀏覽器中進行渲染,這個轉換過程稱爲反序列化。不管是序列化還是反序列化,我們一般都稱爲序列化。

實際上,Spring MVC已經爲我們提供了這類序列化特性,只需在Controller的方法參數中使用@RequestBody註解定義需要反序列化的參數即可,如以下代碼片段:

[java] view plaincopy
  1. @Controller  
  2. public class AdvertiserController {  
  3.   
  4.     @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
  5.     public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {  
  6.         ...  
  7.     }  
  8. }  
若需要對Controller的方法返回值進行序列化,則需要在該返回值上使用@ResponseBody註解來定義,如以下代碼片段:

[java] view plaincopy
  1. @Controller  
  2. public class AdvertiserController {  
  3.   
  4.     @RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)  
  5.     public @ResponseBody Response getAdvertiser(@PathVariable("id") String advertiserId) {  
  6.         ...  
  7.     }  
  8. }  
當然,@ResponseBody註解也可以定義在類上,這樣所有的方法都繼承了該特性。由於經常會使用到@ResponseBody註解,所以Spring提供了一個名爲@RestController的註解來取代以上的@Controller註解,這樣我們就可以省略返回值前面的@ResponseBody註解了,但參數前面的@RequestBody註解是無法省略的。實際上,看看Spring中對應@RestController註解的源碼便可知曉:

[java] view plaincopy
  1. @Target({ElementType.TYPE})  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. @Documented  
  4. @Controller  
  5. @ResponseBody  
  6. public @interface RestController {  
  7.   
  8.     String value() default "";  
  9. }  
可見,@RestController註解已經被@Controller與@ResponseBody註解定義過了,Spring框架會識別這類註解。需要注意的是,該特性在Spring 4.0中才引入。

因此,我們可將以上代碼進行如下改寫:

[java] view plaincopy
  1. @RestController  
  2. public class AdvertiserController {  
  3.   
  4.     @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
  5.     public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {  
  6.         ...  
  7.     }  
  8.   
  9.     @RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)  
  10.     public Response getAdvertiser(@PathVariable("id") String advertiserId) {  
  11.         ...  
  12.     }  
  13. }  

除了使用註解來定義序列化行爲以外,我們還需要使用Jackson來提供JSON的序列化操作,在Spring配置文件中只需添加以下配置即可:

  1. <mvc:annotation-driven>  
  2.     <mvc:message-converters>  
  3.         <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>  
  4.     </mvc:message-converters>  
  5. </mvc:annotation-driven>  
若需要對Jackson的序列化行爲進行定製,比如,排除值爲空屬性、進行縮進輸出、將駝峯轉爲下劃線、進行日期格式化等,這又如何實現呢?

首先,我們需要擴展Jackson提供的ObjectMapper類,代碼如下:

[java] view plaincopy
  1. public class CustomObjectMapper extends ObjectMapper {  
  2.   
  3.     private boolean camelCaseToLowerCaseWithUnderscores = false;  
  4.     private String dateFormatPattern;  
  5.   
  6.     public void setCamelCaseToLowerCaseWithUnderscores(boolean camelCaseToLowerCaseWithUnderscores) {  
  7.         this.camelCaseToLowerCaseWithUnderscores = camelCaseToLowerCaseWithUnderscores;  
  8.     }  
  9.   
  10.     public void setDateFormatPattern(String dateFormatPattern) {  
  11.         this.dateFormatPattern = dateFormatPattern;  
  12.     }  
  13.   
  14.     public void init() {  
  15.         // 排除值爲空屬性  
  16.         setSerializationInclusion(JsonInclude.Include.NON_NULL);  
  17.         // 進行縮進輸出  
  18.         configure(SerializationFeature.INDENT_OUTPUT, true);  
  19.         // 將駝峯轉爲下劃線  
  20.         if (camelCaseToLowerCaseWithUnderscores) {  
  21.             setPropertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);  
  22.         }  
  23.         // 進行日期格式化  
  24.         if (StringUtil.isNotEmpty(dateFormatPattern)) {  
  25.             DateFormat dateFormat = new SimpleDateFormat(dateFormatPattern);  
  26.             setDateFormat(dateFormat);  
  27.         }  
  28.     }  
  29. }  
然後,將CustomObjectMapper注入到MappingJackson2HttpMessageConverter中,Spring配置如下:

  1. <bean id="objectMapper" class="com.xxx.api.json.CustomObjectMapper" init-method="init">  
  2.     <property name="camelCaseToLowerCaseWithUnderscores" value="true"/>  
  3.     <property name="dateFormatPattern" value="yyyy-MM-dd HH:mm:ss"/>  
  4. </bean>  
  5.   
  6. <mvc:annotation-driven>  
  7.     <mvc:message-converters>  
  8.         <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">  
  9.             <property name="objectMapper" ref="objectMapper"/>  
  10.         </bean>  
  11.     </mvc:message-converters>  
  12. </mvc:annotation-driven>  
通過以上過程,我們已經完成了一個基於Spring MVC的REST框架,只不過該框架還非常單薄,還缺乏很多關鍵性特性,尤其是異常處理。

4.3 處理異常行爲

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

[java] view plaincopy
  1. @ControllerAdvice  
  2. @ResponseBody  
  3. public class ExceptionAdvice {  
  4.   
  5.     /** 
  6.      * 400 - Bad Request 
  7.      */  
  8.     @ResponseStatus(HttpStatus.BAD_REQUEST)  
  9.     @ExceptionHandler(HttpMessageNotReadableException.class)  
  10.     public Response handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {  
  11.         logger.error("參數解析失敗", e);  
  12.         return new Response().failure("could_not_read_json");  
  13.     }  
  14.   
  15.     /** 
  16.      * 405 - Method Not Allowed 
  17.      */  
  18.     @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)  
  19.     @ExceptionHandler(HttpRequestMethodNotSupportedException.class)  
  20.     public Response handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {  
  21.         logger.error("不支持當前請求方法", e);  
  22.         return new Response().failure("request_method_not_supported");  
  23.     }  
  24.   
  25.     /** 
  26.      * 415 - Unsupported Media Type 
  27.      */  
  28.     @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)  
  29.     @ExceptionHandler(HttpMediaTypeNotSupportedException.class)  
  30.     public Response handleHttpMediaTypeNotSupportedException(Exception e) {  
  31.         logger.error("不支持當前媒體類型", e);  
  32.         return new Response().failure("content_type_not_supported");  
  33.     }  
  34.   
  35.     /** 
  36.      * 500 - Internal Server Error 
  37.      */  
  38.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)  
  39.     @ExceptionHandler(Exception.class)  
  40.     public Response handleException(Exception e) {  
  41.         logger.error("服務運行異常", e);  
  42.         return new Response().failure(e.getMessage());  
  43.     }  
  44. }  
可見,在ExceptionAdvice類中包含一系列的異常處理方法,每個方法都通過@ResponseStatus註解定義了響應狀態碼,此外還通過@ExceptionHandler註解指定了具體需要攔截的異常類。以上過程只是包含了一部分的異常情況,若需處理其它異常,可添加方法具體的方法。需要注意的是,在運行時從上往下依次調用每個異常處理方法,匹配當前異常類型是否與@ExceptionHandler註解所定義的異常相匹配,若匹配,則執行該方法,同時忽略後續所有的異常處理方法,最終會返回經JSON序列化後的Response對象。

4.4 支持參數驗證

我們回到上文所提到的示例,這裏處理一個普通的POST請求,代碼如下:

[java] view plaincopy
  1. @RestController  
  2. public class AdvertiserController {  
  3.   
  4.     @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
  5.     public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {  
  6.         ...  
  7.     }  
  8. }  
其中,AdvertiserParam參數包含若干屬性,通過以下類結構可見,它是一個傳統的POJO:

[java] view plaincopy
  1. public class AdvertiserParam {  
  2.   
  3.     private String advertiserName;  
  4.       
  5.     private String description;  
  6.   
  7.     // 省略 getter/setter 方法  
  8. }  
如果業務上需要確保AdvertiserParam對象的advertiserName屬性必填,如何實現呢?

若將這類參數驗證的代碼寫死在Controller中,勢必會與正常的業務邏輯攪在一起,導致責任不夠單一,違背於“單一責任原則”。建議將其參數驗證行爲從Controller中剝離出來,放到另外的類中,這裏僅提供一個@Valid註解來定義AdvertiserParam參數,並在AdvertiserParam類中通過@NotEmpty註解來定義advertiserName屬性,就像下面這樣:

[java] view plaincopy
  1. @RestController  
  2. public class AdvertiserController {  
  3.   
  4.     @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
  5.     public Response createAdvertiser(@RequestBody @Valid AdvertiserParam advertiserParam) {  
  6.         ...  
  7.     }  
  8. }  
  9.   
  10. public class AdvertiserParam {  
  11.   
  12.     @NotEmpty  
  13.     private String advertiserName;  
  14.       
  15.     private String description;  
  16.   
  17.     // 省略 getter/setter 方法  
  18. }  
這裏的@Valid註解實際上是Validation Bean規範提供的註解,該規範已由Hibernate Validator框架實現,因此需要添加以下Maven依賴到pom.xml文件中:

  1. <dependency>  
  2.     <groupId>org.hibernate</groupId>  
  3.     <artifactId>hibernate-validator</artifactId>  
  4.     <version>${hibernate-validator.version}</version>  
  5. </dependency>  
需要注意的是,Hibernate Validator與Hibernate沒有任何依賴關係,唯一有聯繫的只是都屬於JBoss公司的開源項目而已。

要實現@NotEmpty註解的功能,我們需要做以下幾件事情。

首先,定義一個@NotEmpty註解類,代碼如下:

[java] view plaincopy
  1. @Documented  
  2. @Target({ElementType.FIELD, ElementType.PARAMETER})  
  3. @Retention(RetentionPolicy.RUNTIME)  
  4. @Constraint(validatedBy = NotEmptyValidator.class)  
  5. public @interface NotEmpty {  
  6.   
  7.     String message() default "not_empty";  
  8.   
  9.     Class<?>[] groups() default {};  
  10.   
  11.     Class<? extends Payload>[] payload() default {};  
  12. }  
以上註解類必須包含message、groups、payload三個屬性,因爲這是規範所要求的,此外,需要通過@Constraint註解指定一個驗證器類,這裏對應的是NotEmptyValidator,其代碼如下:

[java] view plaincopy
  1. public class NotEmptyValidator implements ConstraintValidator<NotEmpty, String> {  
  2.   
  3.     @Override  
  4.     public void initialize(NotEmpty constraintAnnotation) {  
  5.     }  
  6.   
  7.     @Override  
  8.     public boolean isValid(String value, ConstraintValidatorContext context) {  
  9.         return StringUtil.isNotEmpty(value);  
  10.     }  
  11. }  
以上驗證器類實現了ConstraintValidator接口,並在該接口的isValid( )方法中完成了具體的參數驗證邏輯。需要注意的是,實現接口時需要指定泛型,第一個參數表示驗證註解類型(NotEmpty),第二個參數表示需要驗證的參數類型(String)。

然後,我們需要在Spring配置文件中開啓該特性,需添加如下配置:

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

最後,需要在全局異常處理類中添加參數驗證處理方法,代碼如下:

[java] view plaincopy
  1. @ControllerAdvice  
  2. @ResponseBody  
  3. public class ExceptionAdvice {  
  4.   
  5.     /** 
  6.      * 400 - Bad Request 
  7.      */  
  8.     @ResponseStatus(HttpStatus.BAD_REQUEST)  
  9.     @ExceptionHandler(ValidationException.class)  
  10.     public Response handleValidationException(ValidationException e) {  
  11.         logger.error("參數驗證失敗", e);  
  12.         return new Response().failure("validation_exception");  
  13.     }  
  14. }  
至此,REST框架已集成了Bean Validation特性,我們可以使用各種註解來完成所需的參數驗證行爲了。

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

4.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對象中,代碼如下:

[java] view plaincopy
  1. public class CorsFilter implements Filter {  
  2.   
  3.     private String allowOrigin;  
  4.     private String allowMethods;  
  5.     private String allowCredentials;  
  6.     private String allowHeaders;  
  7.     private String exposeHeaders;  
  8.   
  9.     @Override  
  10.     public void init(FilterConfig filterConfig) throws ServletException {  
  11.         allowOrigin = filterConfig.getInitParameter("allowOrigin");  
  12.         allowMethods = filterConfig.getInitParameter("allowMethods");  
  13.         allowCredentials = filterConfig.getInitParameter("allowCredentials");  
  14.         allowHeaders = filterConfig.getInitParameter("allowHeaders");  
  15.         exposeHeaders = filterConfig.getInitParameter("exposeHeaders");  
  16.     }  
  17.   
  18.     @Override  
  19.     public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {  
  20.         HttpServletRequest request = (HttpServletRequest) req;  
  21.         HttpServletResponse response = (HttpServletResponse) res;  
  22.         if (StringUtil.isNotEmpty(allowOrigin)) {  
  23.             List<String> allowOriginList = Arrays.asList(allowOrigin.split(","));  
  24.             if (CollectionUtil.isNotEmpty(allowOriginList)) {  
  25.                 String currentOrigin = request.getHeader("Origin");  
  26.                 if (allowOriginList.contains(currentOrigin)) {  
  27.                     response.setHeader("Access-Control-Allow-Origin", currentOrigin);  
  28.                 }  
  29.             }  
  30.         }  
  31.         if (StringUtil.isNotEmpty(allowMethods)) {  
  32.             response.setHeader("Access-Control-Allow-Methods", allowMethods);  
  33.         }  
  34.         if (StringUtil.isNotEmpty(allowCredentials)) {  
  35.             response.setHeader("Access-Control-Allow-Credentials", allowCredentials);  
  36.         }  
  37.         if (StringUtil.isNotEmpty(allowHeaders)) {  
  38.             response.setHeader("Access-Control-Allow-Headers", allowHeaders);  
  39.         }  
  40.         if (StringUtil.isNotEmpty(exposeHeaders)) {  
  41.             response.setHeader("Access-Control-Expose-Headers", exposeHeaders);  
  42.         }  
  43.         chain.doFilter(req, res);  
  44.     }  
  45.   
  46.     @Override  
  47.     public void destroy() {  
  48.     }  
  49. }  
以上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的方法:

  1. <filter>  
  2.     <filter-name>corsFilter</filter-name>  
  3.     <filter-class>com.xxx.api.cors.CorsFilter</filter-class>  
  4.     <init-param>  
  5.         <param-name>allowOrigin</param-name>  
  6.         <param-value>http://web.xxx.com</param-value>  
  7.     </init-param>  
  8.     <init-param>  
  9.         <param-name>allowMethods</param-name>  
  10.         <param-value>GET,POST,PUT,DELETE,OPTIONS</param-value>  
  11.     </init-param>  
  12.     <init-param>  
  13.         <param-name>allowCredentials</param-name>  
  14.         <param-value>true</param-value>  
  15.     </init-param>  
  16.     <init-param>  
  17.         <param-name>allowHeaders</param-name>  
  18.         <param-value>Content-Type</param-value>  
  19.     </init-param>  
  20. </filter>  
  21. <filter-mapping>  
  22.     <filter-name>corsFilter</filter-name>  
  23.     <url-pattern>/*</url-pattern>  
  24. </filter-mapping>  
完成以上過程即可實現AJAX跨域功能了,但似乎還存在另外一個問題,由於REST是無狀態的,後端應用發佈的REST API可在用戶未登錄的情況下被任意調用,這顯然是不安全的,如何解決這個問題呢?我們需要爲REST請求提供安全機制。

4.6 提供安全機制

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

  1. 當用戶登錄成功後,在服務端生成一個token,並將其放入內存中(可放入JVM或Redis中),同時將該token返回到客戶端。
  2. 在客戶端中將返回的token寫入cookie中,並且每次請求時都將token隨請求頭一起發送到服務端。
  3. 提供一個AOP切面,用於攔截所有的Controller方法,在切面中判斷token的有效性。
  4. 當登出時,只需清理掉cookie中的token即可,服務端token可設置過期時間,使其自行移除。

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

[java] view plaincopy
  1. public interface TokenManager {  
  2.   
  3.     String createToken(String username);  
  4.   
  5.     boolean checkToken(String token);  
  6. }  
然後,我們可提供一個簡單的TokenManager實現類,將token存儲到JVM內存中。代碼如下:

[java] view plaincopy
  1. public class DefaultTokenManager implements TokenManager {  
  2.   
  3.     private static Map<String, String> tokenMap = new ConcurrentHashMap<>();  
  4.   
  5.     @Override  
  6.     public String createToken(String username) {  
  7.         String token = CodecUtil.createUUID();  
  8.         tokenMap.put(token, username);  
  9.         return token;  
  10.     }  
  11.   
  12.     @Override  
  13.     public boolean checkToken(String token) {  
  14.         return !StringUtil.isEmpty(token) && tokenMap.containsKey(token);  
  15.     }  
  16. }  
需要注意的是,如果需要做到分佈式集羣,建議基於Redis提供一個實現類,將token存儲到Redis中,並利用Redis與生俱來的特性,做到token的分佈式一致性。

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

[java] view plaincopy
  1. public class SecurityAspect {  
  2.   
  3.     private static final String DEFAULT_TOKEN_NAME = "X-Token";  
  4.   
  5.     private TokenManager tokenManager;  
  6.     private String tokenName;  
  7.   
  8.     public void setTokenManager(TokenManager tokenManager) {  
  9.         this.tokenManager = tokenManager;  
  10.     }  
  11.   
  12.     public void setTokenName(String tokenName) {  
  13.         if (StringUtil.isEmpty(tokenName)) {  
  14.             tokenName = DEFAULT_TOKEN_NAME;  
  15.         }  
  16.         this.tokenName = tokenName;  
  17.     }  
  18.   
  19.     public Object execute(ProceedingJoinPoint pjp) throws Throwable {  
  20.         // 從切點上獲取目標方法  
  21.         MethodSignature methodSignature = (MethodSignature) pjp.getSignature();  
  22.         Method method = methodSignature.getMethod();  
  23.         // 若目標方法忽略了安全性檢查,則直接調用目標方法  
  24.         if (method.isAnnotationPresent(IgnoreSecurity.class)) {  
  25.             return pjp.proceed();  
  26.         }  
  27.         // 從 request header 中獲取當前 token  
  28.         String token = WebContext.getRequest().getHeader(tokenName);  
  29.         // 檢查 token 有效性  
  30.         if (!tokenManager.checkToken(token)) {  
  31.             String message = String.format("token [%s] is invalid", token);  
  32.             throw new TokenException(message);  
  33.         }  
  34.         // 調用目標方法  
  35.         return pjp.proceed();  
  36.     }  
  37. }  
若要使SecurityAspect生效,則需要添加如下Spring 配置:

  1. <bean id="securityAspect" class="com.xxx.api.security.SecurityAspect">  
  2.     <property name="tokenManager" ref="tokenManager"/>  
  3.     <property name="tokenName" value="X-Token"/>  
  4. </bean>  
  5.   
  6. <aop:config>  
  7.     <aop:aspect ref="securityAspect">  
  8.         <aop:around method="execute" pointcut="@annotation(org.springframework.web.bind.annotation.RequestMapping)"/>  
  9.     </aop:aspect>  
  10. </aop:config>  
最後,別忘了在web.xml中添加允許的X-Token響應頭,配置如下:

  1. <init-param>  
  2.     <param-name>allowHeaders</param-name>  
  3.     <param-value>Content-Type,X-Token</param-value>  
  4. </init-param>  

總結

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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章