MVC是一種經(jīng)典的設(shè)計(jì)模式，全名為Model-View-Controller，即模型-視圖-控制器。
其中，模型是用于封裝數(shù)據(jù)的載體，例如，在
Java中一般通過一個(gè)簡單的POJO（Plain Ordinary
Java Object）來表示，其本質(zhì)是一個(gè)普通的
java Bean，包含一系列的成員變量及其getter/setter方法。對(duì)于視圖而言，它更加偏重于展現(xiàn)，也就是說，視圖決定了界面到底長什么樣子，在Java中可通過JSP來充當(dāng)視圖，或者通過純HTML的方式進(jìn)行展現(xiàn)，而后者才是目前的主流。模型和視圖需要通過控制器來進(jìn)行粘合，例如，用戶發(fā)送一個(gè)HTTP請(qǐng)求，此時(shí)該請(qǐng)求首先會(huì)進(jìn)入控制器，然后控制器去獲取數(shù)據(jù)并將其封裝為模型，最后將模型傳遞到視圖中進(jìn)行展現(xiàn)。
綜上所述，MVC的交互過程如圖1所示。
2. MVC模式的優(yōu)點(diǎn)與不足
MVC模式早在上個(gè)世紀(jì)70年代就誕生了，直到今天它依然存在，可見生命力相當(dāng)之強(qiáng)。MVC模式最早用于Smalltalk語言中，最后在其它許多開發(fā)語言中都得到了很好的應(yīng)用，例如，Java中的Struts、
spring MVC等框架。正是因?yàn)檫@些MVC框架的出現(xiàn)，才讓MVC模式真正落地，讓開發(fā)更加高效，讓代碼耦合度盡量減小，讓應(yīng)用程序各部分的職責(zé)更加清晰。
既然MVC模式這么好，難道它就沒有不足的地方嗎？我認(rèn)為MVC至少有以下三點(diǎn)不足：
每次請(qǐng)求必須經(jīng)過“控制器->模型->視圖”這個(gè)流程，用戶才能看到最終的展現(xiàn)的界面，這個(gè)過程似乎有些復(fù)雜。
實(shí)際上視圖是依賴于模型的，換句話說，如果沒有模型，視圖也無法呈現(xiàn)出最終的效果。
渲染視圖的過程是在服務(wù)端來完成的，最終呈現(xiàn)給瀏覽器的是帶有模型的視圖頁面，性能無法得到很好的優(yōu)化。
為了使數(shù)據(jù)展現(xiàn)過程更加直接，并且提供更好的用戶體驗(yàn)，我們有必要對(duì)MVC模式進(jìn)行改進(jìn)。不妨這樣來嘗試，首先從瀏覽器發(fā)送AJAX請(qǐng)求，然后服務(wù)端接受該請(qǐng)求并返回JSON數(shù)據(jù)返回給瀏覽器，最后在瀏覽器中進(jìn)行界面渲染。
改進(jìn)后的MVC模式如圖2所示。
也就是說，我們輸入的是AJAX請(qǐng)求，輸出的是JSON數(shù)據(jù)，市面上有這樣的技術(shù)來實(shí)現(xiàn)這個(gè)功能嗎？答案是REST。
REST全稱是Representational State Transfer（表述性狀態(tài)轉(zhuǎn)移），它是Roy Fielding博士在2000年寫的一篇關(guān)于軟件
架構(gòu)風(fēng)格的論文，此文一出，威震四方！國內(nèi)外許多知名互聯(lián)網(wǎng)公司紛紛開始采用這種輕量級(jí)的Web服務(wù)，大家習(xí)慣將其稱為RESTful Web Services，或簡稱REST服務(wù)。]
如果將瀏覽器這一端視為前端，而服務(wù)器那一端視為后端的話，可以將以上改進(jìn)后的MVC模式簡化為以下前后端分離模式，如圖3所示。
可見，有了REST服務(wù)，前端關(guān)注界面展現(xiàn)，后端關(guān)注業(yè)務(wù)邏輯，分工明確，職責(zé)清晰。那么，如何使用REST服務(wù)將應(yīng)用程序進(jìn)行前后端分離呢？我們接下來繼續(xù)探討，首先我們需要認(rèn)識(shí)REST。
3. 認(rèn)識(shí)REST
REST本質(zhì)上是使用URL來訪問資源種方式。眾所周知，URL就是我們平常使用的請(qǐng)求地址了，其中包括兩部分：請(qǐng)求方式與請(qǐng)求路徑，比較常見的請(qǐng)求方式是GET與POST，但在REST中又提出了幾種其它類型的請(qǐng)求方式，匯總起來有六種：GET、POST、PUT、DELETE、HEAD、OPTIONS。尤其是前四種，正好與CRUD（Create-Retrieve-Update-Delete，增刪改查）四種操作相對(duì)應(yīng)，例如，GET（查）、POST（增）、PUT（改）、DELETE（刪），這正是REST與CRUD的異曲同工之妙！需要強(qiáng)調(diào)的是，REST是“面向資源”的，這里提到的資源，實(shí)際上就是我們常說的領(lǐng)域?qū)ο?，在系統(tǒng)設(shè)計(jì)過程中，我們經(jīng)常通過領(lǐng)域?qū)ο髞磉M(jìn)行數(shù)據(jù)建模。
REST是一個(gè)“無狀態(tài)”的架構(gòu)模式，因?yàn)樵谌魏螘r(shí)候都可以由客戶端發(fā)出請(qǐng)求到服務(wù)端，最終返回自己想要的數(shù)據(jù)，當(dāng)前請(qǐng)求不會(huì)受到上次請(qǐng)求的影響。也就是說，服務(wù)端將內(nèi)部資源發(fā)布REST服務(wù)，客戶端通過URL來訪問這些資源，這不就是SOA所提倡的“面向服務(wù)”的思想嗎？所以，REST也被人們看做是一種“輕量級(jí)”的SOA實(shí)現(xiàn)技術(shù)，因此在企業(yè)級(jí)應(yīng)用與互聯(lián)網(wǎng)應(yīng)用中都得到了廣泛應(yīng)用。
下面我們舉幾個(gè)例子對(duì)REST請(qǐng)求進(jìn)行簡單描述：
可見，請(qǐng)求路徑相同，但請(qǐng)求方式不同，所代表的業(yè)務(wù)操作也不同，例如，/advertiser/1這個(gè)請(qǐng)求，帶有GET、PUT、DELETE三種不同的請(qǐng)求方式，對(duì)應(yīng)三種不同的業(yè)務(wù)操作。
雖然REST看起來還是很簡單的，實(shí)際上我們往往需要提供一個(gè)REST框架，讓其實(shí)現(xiàn)前后端分離架構(gòu)，讓開發(fā)人員將精力集中在業(yè)務(wù)上，而并非那些具體的技術(shù)細(xì)節(jié)。下面我們將使用Java技術(shù)來實(shí)現(xiàn)這個(gè)REST框架，整體框架會(huì)基于Spring進(jìn)行開發(fā)。
4. 實(shí)現(xiàn)REST框架
4.1 統(tǒng)一響應(yīng)結(jié)構(gòu)
使用REST框架實(shí)現(xiàn)前后端分離架構(gòu)，我們需要首先確定返回的JSON響應(yīng)結(jié)構(gòu)是統(tǒng)一的，也就是說，每個(gè)REST請(qǐng)求將返回相同結(jié)構(gòu)的JSON響應(yīng)結(jié)構(gòu)。不妨定義一個(gè)相對(duì)通用的JSON響應(yīng)結(jié)構(gòu)，其中包含兩部分：元數(shù)據(jù)與返回值，其中，元數(shù)據(jù)表示操作是否成功與返回值消息等，返回值對(duì)應(yīng)服務(wù)端方法所返回的數(shù)據(jù)。該JSON響應(yīng)結(jié)構(gòu)如下：
{ "meta": { "success": true, "message": "ok" }, "data": ...}為了在框架中映射以上JSON響應(yīng)結(jié)構(gòu)，我們需要編寫一個(gè)Response類與其對(duì)應(yīng)：[java]
view plaincopypublic 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;
}
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，還包括兩個(gè)常用的操作方法：success( )與failure( )，通過一個(gè)內(nèi)部類來展現(xiàn)元數(shù)據(jù)結(jié)構(gòu)，我們?cè)谙挛闹卸啻螘?huì)使用該Response類。實(shí)現(xiàn)該REST框架需要考慮許多問題，首當(dāng)其沖的就是對(duì)象序列化問題。
4.2 實(shí)現(xiàn)對(duì)象序列化
想要解釋什么是對(duì)象序列化？不妨通過一些例子進(jìn)行說明。比如，通過瀏覽器發(fā)送了一個(gè)普通的HTTP請(qǐng)求，該請(qǐng)求攜帶了一個(gè)JSON格式的參數(shù)，在服務(wù)端需要將該JSON參數(shù)轉(zhuǎn)換為普通的Java對(duì)象，這個(gè)轉(zhuǎn)換過程稱為序列化。再比如，在服務(wù)端獲取了數(shù)據(jù)，此時(shí)該數(shù)據(jù)是一個(gè)普通的Java對(duì)象，然后需要將這個(gè)Java對(duì)象轉(zhuǎn)換為JSON字符串，并將其返回到瀏覽器中進(jìn)行渲染，這個(gè)轉(zhuǎn)換過程稱為反序列化。不管是序列化還是反序列化，我們一般都稱為序列化。
實(shí)際上，Spring MVC已經(jīng)為我們提供了這類序列化特性，只需在Controller的方法參數(shù)中使用@RequestBody注解定義需要反序列化的參數(shù)即可，如以下代碼片段：
[java]
view plaincopy@Controller
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
...
}
}
若需要對(duì)Controller的方法返回值進(jìn)行序列化，則需要在該返回值上使用@ResponseBody注解來定義，如以下代碼片段：[java]
view plaincopy@Controller
public class AdvertiserController {
@RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)
public @ResponseBody Response getAdvertiser(@PathVariable("id") String advertiserId) {
...
}
}
當(dāng)然，@ResponseBody注解也可以定義在類上，這樣所有的方法都繼承了該特性。由于經(jīng)常會(huì)使用到@ResponseBody注解，所以Spring提供了一個(gè)名為@RestController的注解來取代以上的@Controller注解，這樣我們就可以省略返回值前面的@ResponseBody注解了，但參數(shù)前面的@RequestBody注解是無法省略的。實(shí)際上，看看Spring中對(duì)應(yīng)@RestController注解的源碼便可知曉：[java]
view plaincopy@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
String value() default "";
}
可見，@RestController注解已經(jīng)被@Controller與@ResponseBody注解定義過了，Spring框架會(huì)識(shí)別這類注解。需要注意的是，該特性在Spring 4.0中才引入。因此，我們可將以上代碼進(jìn)行如下改寫：
[java]
view plaincopy@RestController
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
...
}
@RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)
public Response getAdvertiser(@PathVariable("id") String advertiserId) {
...
}
}
除了使用注解來定義序列化行為以外，我們還需要使用Jackson來提供JSON的序列化操作，在Spring配置文件中只需添加以下配置即可：
[xml]
view plaincopy<mvc:annotation-driven>
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
</mvc:message-converters>
</mvc:annotation-driven>
若需要對(duì)Jackson的序列化行為進(jìn)行定制，比如，排除值為空屬性、進(jìn)行縮進(jìn)輸出、將駝峰轉(zhuǎn)為下劃線、進(jìn)行日期格式化等，這又如何實(shí)現(xiàn)呢？首先，我們需要擴(kuò)展Jackson提供的ObjectMapper類，代碼如下：
[java]
view plaincopypublic class CustomObjectMapper extends ObjectMapper {
private boolean camelCaseToLowerCaseWithUnderscores = false;
private String dateFormatPattern;
public void setCamelCaseToLowerCaseWithUnderscores(boolean camelCaseToLowerCaseWithUnderscores) {
this.camelCaseToLowerCaseWithUnderscores = camelCaseToLowerCaseWithUnderscores;
}
public void setDateFormatPattern(String dateFormatPattern) {
this.dateFormatPattern = dateFormatPattern;
}
public void init() {
// 排除值為空屬性
setSerializationInclusion(JsonInclude.Include.NON_NULL);
// 進(jìn)行縮進(jìn)輸出
configure(SerializationFeature.INDENT_OUTPUT, true);
// 將駝峰轉(zhuǎn)為下劃線
if (camelCaseToLowerCaseWithUnderscores) {
setPropertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);
}
// 進(jìn)行日期格式化
if (StringUtil.isNotEmpty(dateFormatPattern)) {
DateFormat dateFormat = new SimpleDateFormat(dateFormatPattern);
setDateFormat(dateFormat);
}
}
}
然后，將CustomObjectMapper注入到MappingJackson2HttpMessageConverter中，Spring配置如下：[xml]
view plaincopy<bean id="objectMapper" class="com.xxx.api.json.CustomObjectMapper" init-method="init">
<property name="camelCaseToLowerCaseWithUnderscores" value="true"/>
<property name="dateFormatPattern" value="yyyy-MM-dd HH:mm:ss"/>
</bean>
<mvc:annotation-driven>
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper" ref="objectMapper"/>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
通過以上過程，我們已經(jīng)完成了一個(gè)基于Spring MVC的REST框架，只不過該框架還非常單薄，還缺乏很多關(guān)鍵性特性，尤其是異常處理。4.3 處理異常行為
在Spring MVC中，我們可以使用AOP技術(shù)，編寫一個(gè)全局的異常處理切面類，用它來統(tǒng)一處理所有的異常行為，在Spring 3.2中才開始提供。使用法很簡單，只需定義一個(gè)類，并通過@ControllerAdvice注解將其標(biāo)注即可，同時(shí)需要使用@ResponseBody注解表示返回值可序列化為JSON字符串。代碼如下：
[java]
view plaincopy@ControllerAdvice
@ResponseBody
public class ExceptionAdvice {
/**
* 400 - Bad Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
public Response handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
logger.error("參數(shù)解析失敗", e);
return new Response().failure("could_not_read_json");
}
/**
* 405 - Method Not Allowed
*/
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
public Response handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
logger.error("不支持當(dāng)前請(qǐng)求方法", e);
return new Response().failure("request_method_not_supported");
}
/**
* 415 - Unsupported Media Type
*/
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
public Response handleHttpMediaTypeNotSupportedException(Exception e) {
logger.error("不支持當(dāng)前媒體類型", e);
return new Response().failure("content_type_not_supported");
}
/**
* 500 - Internal Server Error
*/
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler(Exception.class)
public Response handleException(Exception e) {
logger.error("服務(wù)運(yùn)行異常", e);
return new Response().failure(e.getMessage());
}
}
可見，在ExceptionAdvice類中包含一系列的異常處理方法，每個(gè)方法都通過@ResponseStatus注解定義了響應(yīng)狀態(tài)碼，此外還通過@ExceptionHandler注解指定了具體需要攔截的異常類。以上過程只是包含了一部分的異常情況，若需處理其它異常，可添加方法具體的方法。需要注意的是，在運(yùn)行時(shí)從上往下依次調(diào)用每個(gè)異常處理方法，匹配當(dāng)前異常類型是否與@ExceptionHandler注解所定義的異常相匹配，若匹配，則執(zhí)行該方法，同時(shí)忽略后續(xù)所有的異常處理方法，最終會(huì)返回經(jīng)JSON序列化后的Response對(duì)象。4.4 支持參數(shù)驗(yàn)證
我們回到上文所提到的示例，這里處理一個(gè)普通的POST請(qǐng)求，代碼如下：
[java]
view plaincopy@RestController
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
...
}
}
其中，AdvertiserParam參數(shù)包含若干屬性，通過以下類結(jié)構(gòu)可見，它是一個(gè)傳統(tǒng)的POJO：[java]
view plaincopypublic class AdvertiserParam {
private String advertiserName;
private String description;
// 省略 getter/setter 方法
}
如果業(yè)務(wù)上需要確保AdvertiserParam對(duì)象的advertiserName屬性必填，如何實(shí)現(xiàn)呢？若將這類參數(shù)驗(yàn)證的代碼寫死在Controller中，勢必會(huì)與正常的業(yè)務(wù)邏輯攪在一起，導(dǎo)致責(zé)任不夠單一，違背于“單一責(zé)任原則”。建議將其參數(shù)驗(yàn)證行為從Controller中剝離出來，放到另外的類中，這里僅提供一個(gè)@Valid注解來定義AdvertiserParam參數(shù)，并在AdvertiserParam類中通過@NotEmpty注解來定義advertiserName屬性，就像下面這樣：
[java]
view plaincopy@RestController
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody @Valid AdvertiserParam advertiserParam) {
...
}
}
public class AdvertiserParam {
@NotEmpty
private String advertiserName;
private String description;
// 省略 getter/setter 方法
}
這里的@Valid注解實(shí)際上是Validation Bean規(guī)范提供的注解，該規(guī)范已由Hibernate Validator框架實(shí)現(xiàn)，因此需要添加以下Maven依賴到pom.xml文件中：[xml]
view plaincopy<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>${hibernate-validator.version}</version>
</dependency>
需要注意的是，Hibernate Validator與Hibernate沒有任何依賴關(guān)系，唯一有聯(lián)系的只是都屬于JBoss公司的開源項(xiàng)目而已。要實(shí)現(xiàn)@NotEmpty注解的功能，我們需要做以下幾件事情。
首先，定義一個(gè)@NotEmpty注解類，代碼如下：
[java]
view plaincopy@Documented
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NotEmptyValidator.class)
public @interface NotEmpty {
String message() default "not_empty";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
以上注解類必須包含message、groups、payload三個(gè)屬性，因?yàn)檫@是規(guī)范所要求的，此外，需要通過@Constraint注解指定一個(gè)驗(yàn)證器類，這里對(duì)應(yīng)的是NotEmptyValidator，其代碼如下：[java]
view plaincopypublic class NotEmptyValidator implements ConstraintValidator<NotEmpty, String> {
@Override
public void initialize(NotEmpty constraintAnnotation) {
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
return StringUtil.isNotEmpty(value);
}
}
以上驗(yàn)證器類實(shí)現(xiàn)了ConstraintValidator接口，并在該接口的isValid( )方法中完成了具體的參數(shù)驗(yàn)證邏輯。需要注意的是，實(shí)現(xiàn)接口時(shí)需要指定泛型，第一個(gè)參數(shù)表示驗(yàn)證注解類型（NotEmpty），第二個(gè)參數(shù)表示需要驗(yàn)證的參數(shù)類型（String）。然后，我們需要在Spring配置文件中開啟該特性，需添加如下配置：
[xml]
view plaincopy<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>
最后，需要在全局異常處理類中添加參數(shù)驗(yàn)證處理方法，代碼如下：
[java]
view plaincopy@ControllerAdvice
@ResponseBody
public class ExceptionAdvice {
/**
* 400 - Bad Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(ValidationException.class)
public Response handleValidationException(ValidationException e) {
logger.error("參數(shù)驗(yàn)證失敗", e);
return new Response().failure("validation_exception");
}
}
至此，REST框架已集成了Bean Validation特性，我們可以使用各種注解來完成所需的參數(shù)驗(yàn)證行為了?？此圃摽蚣芸梢栽诒镜爻晒ε芷饋恚麄€(gè)架構(gòu)包含兩個(gè)應(yīng)用，前端應(yīng)用提供純靜態(tài)的HTML頁面，后端應(yīng)用發(fā)布REST API，前端需要通過AJAX調(diào)用后端發(fā)布的REST API，然而AJAX是不支持跨域訪問的，也就是說，前后端兩個(gè)應(yīng)用必須在同一個(gè)域名下才能訪問。這是非常嚴(yán)重的技術(shù)障礙，一定需要找到解決方案。
4.5 解決跨域問題
比如，前端應(yīng)用為靜態(tài)站點(diǎn)且部署在http://web.xxx.com域下，后端應(yīng)用發(fā)布REST API并部署在http://api.xxx.com域下，如何使前端應(yīng)用通過AJAX跨域訪問后端應(yīng)用呢？這需要使用到CORS技術(shù)來實(shí)現(xiàn)，這也是目前最好的解決方案了。
[CORS全稱為Cross Origin Resource Sharing（跨域資源共享），服務(wù)端只需添加相關(guān)響應(yīng)頭信息，即可實(shí)現(xiàn)客戶端發(fā)出AJAX跨域請(qǐng)求。]
CORS技術(shù)非常簡單，易于實(shí)現(xiàn)，目前絕大多數(shù)瀏覽器均已支持該技術(shù)（IE8瀏覽器也支持了），服務(wù)端可通過任何編程語言來實(shí)現(xiàn)，只要能將CORS響應(yīng)頭寫入response對(duì)象中即可。
下面我們繼續(xù)擴(kuò)展REST框架，通過CORS技術(shù)實(shí)現(xiàn)AJAX跨域訪問。
首先，我們需要編寫一個(gè)Filter，用于過濾所有的HTTP請(qǐng)求，并將CORS響應(yīng)頭寫入response對(duì)象中，代碼如下：
[java]
view plaincopypublic class CorsFilter implements Filter {
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");
}
@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) res;
if (StringUtil.isNotEmpty(allowOrigin)) {
List<String> allowOriginList = Arrays.asList(allowOrigin.split(","));
if (CollectionUtil.isNotEmpty(allowOriginList)) {
String currentOrigin = request.getHeader("Origin");
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中讀取相關(guān)Filter初始化參數(shù)，并將在處理HTTP請(qǐng)求時(shí)將這些參數(shù)寫入對(duì)應(yīng)的CORS響應(yīng)頭中，下面大致描述一下這些CORS響應(yīng)頭的意義：Access-Control-Allow-Origin：允許訪問的客戶端域名，例如：http://web.xxx.com，若為*，則表示從任意域都能訪問，即不做任何限制。
Access-Control-Allow-Methods：允許訪問的方法名，多個(gè)方法名用逗號(hào)分割，例如：GET,POST,PUT,DELETE,OPTIONS。
Access-Control-Allow-Credentials：是否允許請(qǐng)求帶有驗(yàn)證信息，若要獲取客戶端域下的cookie時(shí)，需要將其設(shè)置為true。
Access-Control-Allow-Headers：允許服務(wù)端訪問的客戶端請(qǐng)求頭，多個(gè)請(qǐng)求頭用逗號(hào)分割，例如：Content-Type。
Access-Control-Expose-Headers：允許客戶端訪問的服務(wù)端響應(yīng)頭，多個(gè)響應(yīng)頭用逗號(hào)分割。
需要注意的是，CORS規(guī)范中定義Access-Control-Allow-Origin只允許兩種取值，要么為*，要么為具體的域名，也就是說，不支持同時(shí)配置多個(gè)域名。為了解決跨多個(gè)域的問題，需要在代碼中做一些處理，這里將Filter初始化參數(shù)作為一個(gè)域名的集合（用逗號(hào)分隔），只需從當(dāng)前請(qǐng)求中獲取Origin請(qǐng)求頭，就知道是從哪個(gè)域中發(fā)出的請(qǐng)求，若該請(qǐng)求在以上允許的域名集合中，則將其放入Access-Control-Allow-Origin響應(yīng)頭，這樣跨多個(gè)域的問題就輕松解決了。
以下是web.xml中配置CorsFilter的方法：
[xml]
view plaincopy<filter>
<filter-name>corsFilter</filter-name>
<filter-class>com.xxx.api.cors.CorsFilter</filter-class>
<init-param>
<param-name>allowOrigin</param-name>
<param-value>http://web.xxx.com</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</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>corsFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
完成以上過程即可實(shí)現(xiàn)AJAX跨域功能了，但似乎還存在另外一個(gè)問題，由于REST是無狀態(tài)的，后端應(yīng)用發(fā)布的REST API可在用戶未登錄的情況下被任意調(diào)用，這顯然是不安全的，如何解決這個(gè)問題呢？我們需要為REST請(qǐng)求提供安全機(jī)制。4.6 提供安全機(jī)制
解決REST安全調(diào)用問題，可以做得很復(fù)雜，也可以做得特簡單，可按照以下過程提供REST安全機(jī)制：
當(dāng)用戶登錄成功后，在服務(wù)端生成一個(gè)token，并將其放入內(nèi)存中（可放入JVM或Redis中），同時(shí)將該token返回到客戶端。
在客戶端中將返回的token寫入cookie中，并且每次請(qǐng)求時(shí)都將token隨請(qǐng)求頭一起發(fā)送到服務(wù)端。
提供一個(gè)AOP切面，用于攔截所有的Controller方法，在切面中判斷token的有效性。
當(dāng)?shù)浅鰰r(shí)，只需清理掉cookie中的token即可，服務(wù)端token可設(shè)置過期時(shí)間，使其自行移除。
首先，我們需要定義一個(gè)用于管理token的接口，包括創(chuàng)建token與檢查token有效性的功能。代碼如下：
[java]
view plaincopypublic interface TokenManager {
String createToken(String username);
boolean checkToken(String token);
}
然后，我們可提供一個(gè)簡單的TokenManager實(shí)現(xiàn)類，將token存儲(chǔ)到JVM內(nèi)存中。代碼如下：[java]
view plaincopypublic class DefaultTokenManager implements TokenManager {
private static Map<String, String> tokenMap = new ConcurrentHashMap<>();
@Override
public String createToken(String username) {
String token = CodecUtil.createUUID();
tokenMap.put(token, username);
return token;
}
@Override
public boolean checkToken(String token) {
return !StringUtil.isEmpty(token) && tokenMap.containsKey(token);
}
}
需要注意的是，如果需要做到分布式集群，建議基于Redis提供一個(gè)實(shí)現(xiàn)類，將token存儲(chǔ)到Redis中，并利用Redis與生俱來的特性，做到token的分布式一致性。然后，我們可以基于Spring AOP寫一個(gè)切面類，用于攔截Controller類的方法，并從請(qǐng)求頭中獲取token，最后對(duì)token有效性進(jìn)行判斷。代碼如下：
[java]
view plaincopypublic class SecurityAspect {
private static final String DEFAULT_TOKEN_NAME = "X-Token";
private TokenManager tokenManager;
private String tokenName;
public void setTokenManager(TokenManager tokenManager) {
this.tokenManager = tokenManager;
}
public void setTokenName(String tokenName) {
if (StringUtil.isEmpty(tokenName)) {
tokenName = DEFAULT_TOKEN_NAME;
}
this.tokenName = tokenName;
}
public Object execute(ProceedingJoinPoint pjp) throws Throwable {
// 從切點(diǎn)上獲取目標(biāo)方法
MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
Method method = methodSignature.getMethod();
// 若目標(biāo)方法忽略了安全性檢查，則直接調(diào)用目標(biāo)方法
if (method.isAnnotationPresent(IgnoreSecurity.class)) {
return pjp.proceed();
}
// 從 request header 中獲取當(dāng)前 token
String token = WebContext.getRequest().getHeader(tokenName);
// 檢查 token 有效性
if (!tokenManager.checkToken(token)) {
String message = String.format("token [%s] is invalid", token);
throw new TokenException(message);
}
// 調(diào)用目標(biāo)方法
return pjp.proceed();
}
}
若要使SecurityAspect生效，則需要添加如下Spring 配置：[xml]
view plaincopy<bean id="securityAspect" class="com.xxx.api.security.SecurityAspect">
<property name="tokenManager" ref="tokenManager"/>
<property name="tokenName" value="X-Token"/>
</bean>
<aop:config>
<aop:aspect ref="securityAspect">
<aop:around method="execute" pointcut="@annotation(org.springframework.web.bind.annotation.RequestMapping)"/>
</aop:aspect>
</aop:config>
最后，別忘了在web.xml中添加允許的X-Token響應(yīng)頭，配置如下：[xml]
view plaincopy<init-param>
<param-name>allowHeaders</param-name>
<param-value>Content-Type,X-Token</param-value>
</init-param>
總結(jié)
本文從經(jīng)典的MVC模式開始，對(duì)MVC模式是什么以及該模式存在的不足進(jìn)行了簡述。然后引出了如何對(duì)MVC模式的改良，讓其轉(zhuǎn)變?yōu)榍昂蠖朔蛛x架構(gòu)，以及解釋了為何要進(jìn)行前后端分離。最后通過REST服務(wù)將前后端進(jìn)行解耦，并提供了一款基于Java的REST框架的主要實(shí)現(xiàn)過程，尤其是需要注意的核心技術(shù)問題及其解決方案。希望本文對(duì)正在探索前后端分離的讀者們有所幫助，期待與大家共同探討。
