轉(zhuǎn)自:http://www.admin10000.com/document/6755.html
1. 理解MVC
MVC是一種經(jīng)典的設(shè)計模式悲关,全名為Model-View-Controller谎僻,即模型-視圖-控制器。
其中寓辱,模型是用于封裝數(shù)據(jù)的載體艘绍,例如,在Java中一般通過一個簡單的POJO(Plain Ordinary Java Object)來表示秫筏,其本質(zhì)是一個普通的Java Bean诱鞠,包含一系列的成員變量及其getter/setter方法。對于視圖而言跳昼,它更加偏重于展現(xiàn)般甲,也就是說,視圖決定了界面到底長什么樣子鹅颊,在Java中可通過JSP來充當(dāng)視圖敷存,或者通過純HTML的方式進(jìn)行展現(xiàn),而后者才是目前的主流。模型和視圖需要通過控制器來進(jìn)行粘合锚烦,例如觅闽,用戶發(fā)送一個HTTP請求,此時該請求首先會進(jìn)入控制器涮俄,然后控制器去獲取數(shù)據(jù)并將其封裝為模型蛉拙,最后將模型傳遞到視圖中進(jìn)行展現(xiàn)。
綜上所述彻亲,MVC的交互過程如圖1所示孕锄。
2. MVC模式的優(yōu)點與不足
MVC模式早在上個世紀(jì)70年代就誕生了,直到今天它依然存在苞尝,可見生命力相當(dāng)之強畸肆。MVC模式最早用于Smalltalk語言中,最后在其它許多開發(fā)語言中都得到了很好的應(yīng)用宙址,例如轴脐,Java中的Struts、Spring MVC等框架抡砂。正是因為這些MVC框架的出現(xiàn)大咱,才讓MVC模式真正落地,讓開發(fā)更加高效注益,讓代碼耦合度盡量減小碴巾,讓應(yīng)用程序各部分的職責(zé)更加清晰。
既然MVC模式這么好丑搔,難道它就沒有不足的地方嗎餐抢?我認(rèn)為MVC至少有以下三點不足:
- 每次請求必須經(jīng)過“控制器->模型->視圖”這個流程,用戶才能看到最終的展現(xiàn)的界面低匙,這個過程似乎有些復(fù)雜旷痕。
- 實際上視圖是依賴于模型的,換句話說顽冶,如果沒有模型欺抗,視圖也無法呈現(xiàn)出最終的效果。
- 渲染視圖的過程是在服務(wù)端來完成的强重,最終呈現(xiàn)給瀏覽器的是帶有模型的視圖頁面绞呈,性能無法得到很好的優(yōu)化。
為了使數(shù)據(jù)展現(xiàn)過程更加直接间景,并且提供更好的用戶體驗佃声,我們有必要對MVC模式進(jìn)行改進(jìn)。不妨這樣來嘗試倘要,首先從瀏覽器發(fā)送AJAX請求圾亏,然后服務(wù)端接受該請求并返回JSON數(shù)據(jù)返回給瀏覽器十拣,最后在瀏覽器中進(jìn)行界面渲染。
改進(jìn)后的MVC模式如圖2所示志鹃。
也就是說夭问,我們輸入的是AJAX請求,輸出的是JSON數(shù)據(jù)曹铃,市面上有這樣的技術(shù)來實現(xiàn)這個功能嗎缰趋?答案是REST。
REST全稱是Representational State Transfer(表述性狀態(tài)轉(zhuǎn)移)陕见,它是Roy Fielding博士在2000年寫的一篇關(guān)于軟件架構(gòu)風(fēng)格的論文秘血,此文一出,威震四方评甜!國內(nèi)外許多知名互聯(lián)網(wǎng)公司紛紛開始采用這種輕量級的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)識REST蚂会。
3. 認(rèn)識REST
REST本質(zhì)上是使用URL來訪問資源種方式淋样。眾所周知,URL就是我們平常使用的請求地址了胁住,其中包括兩部分:請求方式與請求路徑趁猴,比較常見的請求方式是GET與POST,但在REST中又提出了幾種其它類型的請求方式彪见,匯總起來有六種:GET儡司、POST、PUT余指、DELETE捕犬、HEAD、OPTIONS。尤其是前四種或听,正好與CRUD(Create-Retrieve-Update-Delete探孝,增刪改查)四種操作相對應(yīng),例如誉裆,GET(查)顿颅、POST(增)、PUT(改)足丢、DELETE(刪)粱腻,這正是REST與CRUD的異曲同工之妙!需要強調(diào)的是斩跌,REST是“面向資源”的绍些,這里提到的資源,實際上就是我們常說的領(lǐng)域?qū)ο笠唬谙到y(tǒng)設(shè)計過程中柬批,我們經(jīng)常通過領(lǐng)域?qū)ο髞磉M(jìn)行數(shù)據(jù)建模。
REST是一個“無狀態(tài)”的架構(gòu)模式袖订,因為在任何時候都可以由客戶端發(fā)出請求到服務(wù)端氮帐,最終返回自己想要的數(shù)據(jù),當(dāng)前請求不會受到上次請求的影響洛姑。也就是說上沐,服務(wù)端將內(nèi)部資源發(fā)布REST服務(wù),客戶端通過URL來訪問這些資源楞艾,這不就是SOA所提倡的“面向服務(wù)”的思想嗎参咙?所以,REST也被人們看做是一種“輕量級”的SOA實現(xiàn)技術(shù)硫眯,因此在企業(yè)級應(yīng)用與互聯(lián)網(wǎng)應(yīng)用中都得到了廣泛應(yīng)用蕴侧。
下面我們舉幾個例子對REST請求進(jìn)行簡單描述:
可見,請求路徑相同两入,但請求方式不同戈盈,所代表的業(yè)務(wù)操作也不同,例如谆刨,/advertiser/1這個請求塘娶,帶有GET、PUT痊夭、DELETE三種不同的請求方式刁岸,對應(yīng)三種不同的業(yè)務(wù)操作。
雖然REST看起來還是很簡單的她我,實際上我們往往需要提供一個REST框架虹曙,讓其實現(xiàn)前后端分離架構(gòu)迫横,讓開發(fā)人員將精力集中在業(yè)務(wù)上,而并非那些具體的技術(shù)細(xì)節(jié)酝碳。下面我們將使用Java技術(shù)來實現(xiàn)這個REST框架矾踱,整體框架會基于Spring進(jìn)行開發(fā)。
4. 實現(xiàn)REST框架
4.1 統(tǒng)一響應(yīng)結(jié)構(gòu)
使用REST框架實現(xiàn)前后端分離架構(gòu)疏哗,我們需要首先確定返回的JSON響應(yīng)結(jié)構(gòu)是統(tǒng)一的呛讲,也就是說,每個REST請求將返回相同結(jié)構(gòu)的JSON響應(yīng)結(jié)構(gòu)返奉。不妨定義一個相對通用的JSON響應(yīng)結(jié)構(gòu)贝搁,其中包含兩部分:元數(shù)據(jù)與返回值,其中芽偏,元數(shù)據(jù)表示操作是否成功與返回值消息等雷逆,返回值對應(yīng)服務(wù)端方法所返回的數(shù)據(jù)。該JSON響應(yīng)結(jié)構(gòu)如下:
{
"meta": {
"success": true,
"message": "ok"
},
"data": ...
}
為了在框架中映射以上JSON響應(yīng)結(jié)構(gòu)污尉,我們需要編寫一個Response類與其對應(yīng):
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;
}
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( ),通過一個內(nèi)部類來展現(xiàn)元數(shù)據(jù)結(jié)構(gòu)被碗,我們在下文中多次會使用該Response類某宪。
實現(xiàn)該REST框架需要考慮許多問題,首當(dāng)其沖的就是對象序列化問題蛮放。
4.2 實現(xiàn)對象序列化
想要解釋什么是對象序列化?不妨通過一些例子進(jìn)行說明奠宜。比如包颁,通過瀏覽器發(fā)送了一個普通的HTTP請求,該請求攜帶了一個JSON格式的參數(shù)压真,在服務(wù)端需要將該JSON參數(shù)轉(zhuǎn)換為普通的Java對象娩嚼,這個轉(zhuǎn)換過程稱為序列化。再比如滴肿,在服務(wù)端獲取了數(shù)據(jù)岳悟,此時該數(shù)據(jù)是一個普通的Java對象,然后需要將這個Java對象轉(zhuǎn)換為JSON字符串泼差,并將其返回到瀏覽器中進(jìn)行渲染贵少,這個轉(zhuǎn)換過程稱為反序列化。不管是序列化還是反序列化堆缘,我們一般都稱為序列化滔灶。
實際上,Spring MVC已經(jīng)為我們提供了這類序列化特性吼肥,只需在Controller的方法參數(shù)中使用@RequestBody注解定義需要反序列化的參數(shù)即可录平,如以下代碼片段:
@Controller
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
...
}
}
若需要對Controller的方法返回值進(jìn)行序列化麻车,則需要在該返回值上使用@ResponseBody注解來定義,如以下代碼片段:
@Controller
public class AdvertiserController {
@RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)
public @ResponseBody Response getAdvertiser(@PathVariable("id") String advertiserId) {
...
}
}
當(dāng)然斗这,@ResponseBody注解也可以定義在類上动猬,這樣所有的方法都繼承了該特性。由于經(jīng)常會使用到@ResponseBody注解表箭,所以Spring提供了一個名為@RestController的注解來取代以上的@Controller注解赁咙,這樣我們就可以省略返回值前面的@ResponseBody注解了,但參數(shù)前面的@RequestBody注解是無法省略的燃逻。實際上序目,看看Spring中對應(yīng)@RestController注解的源碼便可知曉:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
String value() default "";
}
可見,@RestController注解已經(jīng)被@Controller與@ResponseBody注解定義過了伯襟,Spring框架會識別這類注解猿涨。需要注意的是,該特性在Spring 4.0中才引入姆怪。
因此叛赚,我們可將以上代碼進(jìn)行如下改寫:
@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配置文件中只需添加以下配置即可:
<mvc:annotation-driven>
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
</mvc:message-converters>
</mvc:annotation-driven>
若需要對Jackson的序列化行為進(jìn)行定制俺附,比如,排除值為空屬性溪掀、進(jìn)行縮進(jìn)輸出事镣、將駝峰轉(zhuǎn)為下劃線、進(jìn)行日期格式化等揪胃,這又如何實現(xiàn)呢璃哟?
首先,我們需要擴展Jackson提供的ObjectMapper類喊递,代碼如下:
public 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配置如下:
<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)完成了一個基于Spring MVC的REST框架铐伴,只不過該框架還非常單薄,還缺乏很多關(guān)鍵性特性俏讹,尤其是異常處理当宴。
4.3 處理異常行為
在Spring MVC中,我們可以使用AOP技術(shù)泽疆,編寫一個全局的異常處理切面類即供,用它來統(tǒng)一處理所有的異常行為,在Spring 3.2中才開始提供于微。使用法很簡單逗嫡,只需定義一個類青自,并通過@ControllerAdvice注解將其標(biāo)注即可,同時需要使用@ResponseBody注解表示返回值可序列化為JSON字符串驱证。代碼如下:
@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)前請求方法", 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ù)運行異常", e);
return new Response().failure(e.getMessage());
}
}
可見延窜,在ExceptionAdvice類中包含一系列的異常處理方法,每個方法都通過@ResponseStatus注解定義了響應(yīng)狀態(tài)碼抹锄,此外還通過@ExceptionHandler注解指定了具體需要攔截的異常類逆瑞。以上過程只是包含了一部分的異常情況,若需處理其它異常伙单,可添加方法具體的方法获高。需要注意的是,在運行時從上往下依次調(diào)用每個異常處理方法吻育,匹配當(dāng)前異常類型是否與@ExceptionHandler注解所定義的異常相匹配念秧,若匹配,則執(zhí)行該方法布疼,同時忽略后續(xù)所有的異常處理方法摊趾,最終會返回經(jīng)JSON序列化后的Response對象。
4.4 支持參數(shù)驗證
我們回到上文所提到的示例游两,這里處理一個普通的POST請求砾层,代碼如下:
@RestController
public class AdvertiserController {
@RequestMapping(value = "/advertiser", method = RequestMethod.POST)
public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
...
}
}
其中,AdvertiserParam參數(shù)包含若干屬性贱案,通過以下類結(jié)構(gòu)可見肛炮,它是一個傳統(tǒng)的POJO:
public class AdvertiserParam {
private String advertiserName;
private String description;
// 省略 getter/setter 方法
}
如果業(yè)務(wù)上需要確保AdvertiserParam對象的advertiserName屬性必填,如何實現(xiàn)呢?
若將這類參數(shù)驗證的代碼寫死在Controller中,勢必會與正常的業(yè)務(wù)邏輯攪在一起,導(dǎo)致責(zé)任不夠單一,違背于“單一責(zé)任原則”叹话。建議將其參數(shù)驗證行為從Controller中剝離出來,放到另外的類中仗岖,這里僅提供一個@Valid注解來定義AdvertiserParam參數(shù)慰丛,并在AdvertiserParam類中通過@NotEmpty注解來定義advertiserName屬性,就像下面這樣:
@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注解實際上是Validation Bean規(guī)范提供的注解套鹅,該規(guī)范已由Hibernate Validator框架實現(xiàn)站蝠,因此需要添加以下Maven依賴到pom.xml文件中:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>${hibernate-validator.version}</version>
</dependency>
需要注意的是,Hibernate Validator與Hibernate沒有任何依賴關(guān)系卓鹿,唯一有聯(lián)系的只是都屬于JBoss公司的開源項目而已菱魔。
要實現(xiàn)@NotEmpty注解的功能,我們需要做以下幾件事情吟孙。
首先澜倦,定義一個@NotEmpty注解類聚蝶,代碼如下:
@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三個屬性碘勉,因為這是規(guī)范所要求的,此外桩卵,需要通過@Constraint注解指定一個驗證器類验靡,這里對應(yīng)的是NotEmptyValidator,其代碼如下:
public class NotEmptyValidator implements ConstraintValidator<NotEmpty, String> {
@Override
public void initialize(NotEmpty constraintAnnotation) {
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
return StringUtil.isNotEmpty(value);
}
}
以上驗證器類實現(xiàn)了ConstraintValidator接口雏节,并在該接口的isValid( )方法中完成了具體的參數(shù)驗證邏輯胜嗓。需要注意的是,實現(xiàn)接口時需要指定泛型钩乍,第一個參數(shù)表示驗證注解類型(NotEmpty)辞州,第二個參數(shù)表示需要驗證的參數(shù)類型(String)。
然后件蚕,我們需要在Spring配置文件中開啟該特性孙技,需添加如下配置:
<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>
最后,需要在全局異常處理類中添加參數(shù)驗證處理方法排作,代碼如下:
@ControllerAdvice
@ResponseBody
public class ExceptionAdvice {
/**
* 400 - Bad Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(ValidationException.class)
public Response handleValidationException(ValidationException e) {
logger.error("參數(shù)驗證失敗", e);
return new Response().failure("validation_exception");
}
}
至此牵啦,REST框架已集成了Bean Validation特性,我們可以使用各種注解來完成所需的參數(shù)驗證行為了妄痪。
看似該框架可以在本地成功跑起來哈雏,整個架構(gòu)包含兩個應(yīng)用,前端應(yīng)用提供純靜態(tài)的HTML頁面衫生,后端應(yīng)用發(fā)布REST API裳瘪,前端需要通過AJAX調(diào)用后端發(fā)布的REST API,然而AJAX是不支持跨域訪問的罪针,也就是說彭羹,前后端兩個應(yīng)用必須在同一個域名下才能訪問。這是非常嚴(yán)重的技術(shù)障礙泪酱,一定需要找到解決方案派殷。
4.5 解決跨域問題
比如,前端應(yīng)用為靜態(tài)站點且部署在http://web.xxx.com域下墓阀,后端應(yīng)用發(fā)布REST API并部署在http://api.xxx.com域下毡惜,如何使前端應(yīng)用通過AJAX跨域訪問后端應(yīng)用呢?這需要使用到CORS技術(shù)來實現(xiàn)斯撮,這也是目前最好的解決方案了经伙。
[CORS全稱為Cross Origin Resource Sharing(跨域資源共享),服務(wù)端只需添加相關(guān)響應(yīng)頭信息勿锅,即可實現(xiàn)客戶端發(fā)出AJAX跨域請求帕膜。]
CORS技術(shù)非常簡單枣氧,易于實現(xiàn),目前絕大多數(shù)瀏覽器均已支持該技術(shù)(IE8瀏覽器也支持了)垮刹,服務(wù)端可通過任何編程語言來實現(xiàn)作瞄,只要能將CORS響應(yīng)頭寫入response對象中即可。
下面我們繼續(xù)擴展REST框架危纫,通過CORS技術(shù)實現(xiàn)AJAX跨域訪問宗挥。
首先,我們需要編寫一個Filter种蝶,用于過濾所有的HTTP請求契耿,并將CORS響應(yīng)頭寫入response對象中,代碼如下:
public 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請求時將這些參數(shù)寫入對應(yīng)的CORS響應(yīng)頭中搪桂,下面大致描述一下這些CORS響應(yīng)頭的意義:
- Access-Control-Allow-Origin:允許訪問的客戶端域名,例如:http://web.xxx.com盯滚,若為*踢械,則表示從任意域都能訪問,即不做任何限制魄藕。
- Access-Control-Allow-Methods:允許訪問的方法名内列,多個方法名用逗號分割,例如:GET,POST,PUT,DELETE,OPTIONS背率。
- Access-Control-Allow-Credentials:是否允許請求帶有驗證信息话瞧,若要獲取客戶端域下的cookie時,需要將其設(shè)置為true寝姿。
- Access-Control-Allow-Headers:允許服務(wù)端訪問的客戶端請求頭交排,多個請求頭用逗號分割,例如:Content-Type饵筑。
- Access-Control-Expose-Headers:允許客戶端訪問的服務(wù)端響應(yīng)頭埃篓,多個響應(yīng)頭用逗號分割。
需要注意的是根资,CORS規(guī)范中定義Access-Control-Allow-Origin只允許兩種取值架专,要么為*,要么為具體的域名嫂冻,也就是說胶征,不支持同時配置多個域名塞椎。為了解決跨多個域的問題桨仿,需要在代碼中做一些處理,這里將Filter初始化參數(shù)作為一個域名的集合(用逗號分隔)案狠,只需從當(dāng)前請求中獲取Origin請求頭服傍,就知道是從哪個域中發(fā)出的請求钱雷,若該請求在以上允許的域名集合中,則將其放入Access-Control-Allow-Origin響應(yīng)頭吹零,這樣跨多個域的問題就輕松解決了罩抗。
以下是web.xml中配置CorsFilter的方法:
<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>
完成以上過程即可實現(xiàn)AJAX跨域功能了,但似乎還存在另外一個問題灿椅,由于REST是無狀態(tài)的套蒂,后端應(yīng)用發(fā)布的REST API可在用戶未登錄的情況下被任意調(diào)用,這顯然是不安全的茫蛹,如何解決這個問題呢操刀?我們需要為REST請求提供安全機制。
4.6 提供安全機制
解決REST安全調(diào)用問題婴洼,可以做得很復(fù)雜骨坑,也可以做得特簡單,可按照以下過程提供REST安全機制:
- 當(dāng)用戶登錄成功后柬采,在服務(wù)端生成一個token欢唾,并將其放入內(nèi)存中(可放入JVM或Redis中),同時將該token返回到客戶端粉捻。
- 在客戶端中將返回的token寫入cookie中礁遣,并且每次請求時都將token隨請求頭一起發(fā)送到服務(wù)端。
- 提供一個AOP切面肩刃,用于攔截所有的Controller方法亡脸,在切面中判斷token的有效性。
- 當(dāng)?shù)浅鰰r树酪,只需清理掉cookie中的token即可浅碾,服務(wù)端token可設(shè)置過期時間,使其自行移除续语。
首先垂谢,我們需要定義一個用于管理token的接口,包括創(chuàng)建token與檢查token有效性的功能疮茄。代碼如下:
public interface TokenManager {
String createToken(String username);
boolean checkToken(String token);
}
然后滥朱,我們可提供一個簡單的TokenManager實現(xiàn)類,將token存儲到JVM內(nèi)存中力试。代碼如下:
public 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提供一個實現(xiàn)類畸裳,將token存儲到Redis中缰犁,并利用Redis與生俱來的特性,做到token的分布式一致性。
然后帅容,我們可以基于Spring AOP寫一個切面類颇象,用于攔截Controller類的方法,并從請求頭中獲取token并徘,最后對token有效性進(jìn)行判斷遣钳。代碼如下:
public 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 {
// 從切點上獲取目標(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 配置:
<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)頭,配置如下:
<init-param>
<param-name>allowHeaders</param-name>
<param-value>Content-Type,X-Token</param-value>
</init-param>
總結(jié)
本文從經(jīng)典的MVC模式開始姐直,對MVC模式是什么以及該模式存在的不足進(jìn)行了簡述荐开。然后引出了如何對MVC模式的改良,讓其轉(zhuǎn)變?yōu)榍昂蠖朔蛛x架構(gòu)简肴,以及解釋了為何要進(jìn)行前后端分離晃听。最后通過REST服務(wù)將前后端進(jìn)行解耦,并提供了一款基于Java的REST框架的主要實現(xiàn)過程砰识,尤其是需要注意的核心技術(shù)問題及其解決方案能扒。希望本文對正在探索前后端分離的讀者們有所幫助,期待與大家共同探討辫狼。