摘要:MVC模式早在上個世紀(jì)70年代就誕生了蛀序,直到今天它依然存在纤控,可見生命力相當(dāng)之強何恶。MVC模式最早用于Smalltalk語言中,最后在其它許多開發(fā)語言中都得到了很好的應(yīng)用嚼黔,例如细层,Java中的Struts、Spring MVC等框架唬涧。
MVC是一種經(jīng)典的設(shè)計模式疫赎,全名為Model-View-Controller,即模型-視圖-控制器碎节。
其中捧搞,模型是用于封裝數(shù)據(jù)的載體,例如狮荔,在Java中一般通過一個簡單的POJO(Plain OrdinaryJavaObject)來表示胎撇,其本質(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所示。
MVC模式早在上個世紀(jì)70年代就誕生了营曼,直到今天它依然存在,可見生命力相當(dāng)之強愚隧。MVC模式最早用于Smalltalk語言中蒂阱,最后在其它許多開發(fā)語言中都得到了很好的應(yīng)用,例如狂塘,Java中的Struts录煤、springMVC等框架。正是因為這些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特铝。
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.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):
[java]view plaincopy
publicclassResponse?{
privatestaticfinalString?OK?="ok";
privatestaticfinalString?ERROR?="error";
privateMeta?meta;
privateObject?data;
publicResponse?success()?{
this.meta?=newMeta(true,?OK);
returnthis;
}
publicResponse?success(Object?data)?{
this.meta?=newMeta(true,?OK);
this.data?=?data;
returnthis;
}
publicResponse?failure()?{
this.meta?=newMeta(false,?ERROR);
returnthis;
}
publicResponse?failure(String?message)?{
this.meta?=newMeta(false,?message);
returnthis;
}
publicMeta?getMeta()?{
returnmeta;
}
publicObject?getData()?{
returndata;
}
publicclassMeta?{
privatebooleansuccess;
privateString?message;
publicMeta(booleansuccess)?{
this.success?=?success;
}
publicMeta(booleansuccess,?String?message)?{
this.success?=?success;
this.message?=?message;
}
publicbooleanisSuccess()?{
returnsuccess;
}
publicString?getMessage()?{
returnmessage;
}
}
}
以上Response類包括兩類通用返回值消息:ok與error芝发,還包括兩個常用的操作方法:success( )與failure( )绪商,通過一個內(nèi)部類來展現(xiàn)元數(shù)據(jù)結(jié)構(gòu),我們在下文中多次會使用該Response類辅鲸。
實現(xiàn)該REST框架需要考慮許多問題格郁,首當(dāng)其沖的就是對象序列化問題。
想要解釋什么是對象序列化独悴?不妨通過一些例子進(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ù)即可,如以下代碼片段:
[java]view plaincopy
@Controller
publicclassAdvertiserController?{
@RequestMapping(value?="/advertiser",?method?=?RequestMethod.POST)
publicResponse?createAdvertiser(@RequestBodyAdvertiserParam?advertiserParam)?{
...
}
}
若需要對Controller的方法返回值進(jìn)行序列化迅涮,則需要在該返回值上使用@ResponseBody注解來定義废赞,如以下代碼片段:
[java]view plaincopy
@Controller
publicclassAdvertiserController?{
@RequestMapping(value?="/advertiser/{id}",?method?=?RequestMethod.GET)
public@ResponseBodyResponse?getAdvertiser(@PathVariable("id")?String?advertiserId)?{
...
}
}
當(dāng)然,@ResponseBody注解也可以定義在類上叮姑,這樣所有的方法都繼承了該特性唉地。由于經(jīng)常會使用到@ResponseBody注解据悔,所以Spring提供了一個名為@RestController的注解來取代以上的@Controller注解,這樣我們就可以省略返回值前面的@ResponseBody注解了耘沼,但參數(shù)前面的@RequestBody注解是無法省略的极颓。實際上,看看Spring中對應(yīng)@RestController注解的源碼便可知曉:
[java]view plaincopy
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public@interfaceRestController?{
String?value()default"";
}
可見群嗤,@RestController注解已經(jīng)被@Controller與@ResponseBody注解定義過了菠隆,Spring框架會識別這類注解。需要注意的是狂秘,該特性在Spring 4.0中才引入骇径。
因此,我們可將以上代碼進(jìn)行如下改寫:
[java]view plaincopy
@RestController
publicclassAdvertiserController?{
@RequestMapping(value?="/advertiser",?method?=?RequestMethod.POST)
publicResponse?createAdvertiser(@RequestBodyAdvertiserParam?advertiserParam)?{
...
}
@RequestMapping(value?="/advertiser/{id}",?method?=?RequestMethod.GET)
publicResponse?getAdvertiser(@PathVariable("id")?String?advertiserId)?{
...
}
}
除了使用注解來定義序列化行為以外者春,我們還需要使用Jackson來提供JSON的序列化操作破衔,在Spring配置文件中只需添加以下配置即可:
[xml]view plaincopy
若需要對Jackson的序列化行為進(jìn)行定制,比如钱烟,排除值為空屬性晰筛、進(jìn)行縮進(jìn)輸出、將駝峰轉(zhuǎn)為下劃線忠售、進(jìn)行日期格式化等传惠,這又如何實現(xiàn)呢迄沫?
首先稻扬,我們需要擴展Jackson提供的ObjectMapper類,代碼如下:
[java]view plaincopy
publicclassCustomObjectMapperextendsObjectMapper?{
privatebooleancamelCaseToLowerCaseWithUnderscores?=false;
privateString?dateFormatPattern;
publicvoidsetCamelCaseToLowerCaseWithUnderscores(booleancamelCaseToLowerCaseWithUnderscores)?{
this.camelCaseToLowerCaseWithUnderscores?=?camelCaseToLowerCaseWithUnderscores;
}
publicvoidsetDateFormatPattern(String?dateFormatPattern)?{
this.dateFormatPattern?=?dateFormatPattern;
}
publicvoidinit()?{
//?排除值為空屬性
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?=newSimpleDateFormat(dateFormatPattern);
setDateFormat(dateFormat);
}
}
}
然后羊瘩,將CustomObjectMapper注入到MappingJackson2HttpMessageConverter中泰佳,Spring配置如下:
[xml]view plaincopy
通過以上過程,我們已經(jīng)完成了一個基于Spring MVC的REST框架尘吗,只不過該框架還非常單薄逝她,還缺乏很多關(guān)鍵性特性,尤其是異常處理睬捶。
在Spring MVC中黔宛,我們可以使用AOP技術(shù),編寫一個全局的異常處理切面類擒贸,用它來統(tǒng)一處理所有的異常行為臀晃,在Spring 3.2中才開始提供。使用法很簡單介劫,只需定義一個類徽惋,并通過@ControllerAdvice注解將其標(biāo)注即可,同時需要使用@ResponseBody注解表示返回值可序列化為JSON字符串座韵。代碼如下:
[java]view plaincopy
@ControllerAdvice
@ResponseBody
publicclassExceptionAdvice?{
/**
*?400?-?Bad?Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
publicResponse?handleHttpMessageNotReadableException(HttpMessageNotReadableException?e)?{
logger.error("參數(shù)解析失敗",?e);
returnnewResponse().failure("could_not_read_json");
}
/**
*?405?-?Method?Not?Allowed
*/
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
publicResponse?handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException?e)?{
logger.error("不支持當(dāng)前請求方法",?e);
returnnewResponse().failure("request_method_not_supported");
}
/**
*?415?-?Unsupported?Media?Type
*/
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
publicResponse?handleHttpMediaTypeNotSupportedException(Exception?e)?{
logger.error("不支持當(dāng)前媒體類型",?e);
returnnewResponse().failure("content_type_not_supported");
}
/**
*?500?-?Internal?Server?Error
*/
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler(Exception.class)
publicResponse?handleException(Exception?e)?{
logger.error("服務(wù)運行異常",?e);
returnnewResponse().failure(e.getMessage());
}
}
可見险绘,在ExceptionAdvice類中包含一系列的異常處理方法,每個方法都通過@ResponseStatus注解定義了響應(yīng)狀態(tài)碼,此外還通過@ExceptionHandler注解指定了具體需要攔截的異常類宦棺。以上過程只是包含了一部分的異常情況瓣距,若需處理其它異常,可添加方法具體的方法渺氧。需要注意的是旨涝,在運行時從上往下依次調(diào)用每個異常處理方法,匹配當(dāng)前異常類型是否與@ExceptionHandler注解所定義的異常相匹配侣背,若匹配白华,則執(zhí)行該方法,同時忽略后續(xù)所有的異常處理方法贩耐,最終會返回經(jīng)JSON序列化后的Response對象弧腥。
我們回到上文所提到的示例,這里處理一個普通的POST請求潮太,代碼如下:
[java]view plaincopy
@RestController
publicclassAdvertiserController?{
@RequestMapping(value?="/advertiser",?method?=?RequestMethod.POST)
publicResponse?createAdvertiser(@RequestBodyAdvertiserParam?advertiserParam)?{
...
}
}
其中管搪,AdvertiserParam參數(shù)包含若干屬性,通過以下類結(jié)構(gòu)可見铡买,它是一個傳統(tǒng)的POJO:
[java]view plaincopy
publicclassAdvertiserParam?{
privateString?advertiserName;
privateString?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屬性拒啰,就像下面這樣:
[java]view plaincopy
@RestController
publicclassAdvertiserController?{
@RequestMapping(value?="/advertiser",?method?=?RequestMethod.POST)
publicResponse?createAdvertiser(@RequestBody@ValidAdvertiserParam?advertiserParam)?{
...
}
}
publicclassAdvertiserParam?{
@NotEmpty
privateString?advertiserName;
privateString?description;
//?省略?getter/setter?方法
}
這里的@Valid注解實際上是Validation Bean規(guī)范提供的注解,該規(guī)范已由Hibernate Validator框架實現(xiàn)完慧,因此需要添加以下Maven依賴到pom.xml文件中:
[xml]view plaincopy
org.hibernate
hibernate-validator
${hibernate-validator.version}
需要注意的是谋旦,Hibernate Validator與Hibernate沒有任何依賴關(guān)系,唯一有聯(lián)系的只是都屬于JBoss公司的開源項目而已屈尼。
要實現(xiàn)@NotEmpty注解的功能册着,我們需要做以下幾件事情。
首先鸿染,定義一個@NotEmpty注解類指蚜,代碼如下:
[java]view plaincopy
@Documented
@Target({ElementType.FIELD,?ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy?=?NotEmptyValidator.class)
public@interfaceNotEmpty?{
String?message()default"not_empty";
Class[]?groups()default{};
Class[]?payload()default{};
}
以上注解類必須包含message、groups涨椒、payload三個屬性摊鸡,因為這是規(guī)范所要求的绽媒,此外,需要通過@Constraint注解指定一個驗證器類免猾,這里對應(yīng)的是NotEmptyValidator是辕,其代碼如下:
[java]view plaincopy
publicclassNotEmptyValidatorimplementsConstraintValidator?{
@Override
publicvoidinitialize(NotEmpty?constraintAnnotation)?{
}
@Override
publicbooleanisValid(String?value,?ConstraintValidatorContext?context)?{
returnStringUtil.isNotEmpty(value);
}
}
以上驗證器類實現(xiàn)了ConstraintValidator接口,并在該接口的isValid( )方法中完成了具體的參數(shù)驗證邏輯猎提。需要注意的是获三,實現(xiàn)接口時需要指定泛型,第一個參數(shù)表示驗證注解類型(NotEmpty)锨苏,第二個參數(shù)表示需要驗證的參數(shù)類型(String)疙教。
然后,我們需要在Spring配置文件中開啟該特性伞租,需添加如下配置:
[xml]view plaincopy
最后贞谓,需要在全局異常處理類中添加參數(shù)驗證處理方法,代碼如下:
[java]view plaincopy
@ControllerAdvice
@ResponseBody
publicclassExceptionAdvice?{
/**
*?400?-?Bad?Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(ValidationException.class)
publicResponse?handleValidationException(ValidationException?e)?{
logger.error("參數(shù)驗證失敗",?e);
returnnewResponse().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ù)障礙择吊,一定需要找到解決方案李根。
比如,前端應(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對象中,代碼如下:
[java]view plaincopy
publicclassCorsFilterimplementsFilter?{
privateString?allowOrigin;
privateString?allowMethods;
privateString?allowCredentials;
privateString?allowHeaders;
privateString?exposeHeaders;
@Override
publicvoidinit(FilterConfig?filterConfig)throwsServletException?{
allowOrigin?=?filterConfig.getInitParameter("allowOrigin");
allowMethods?=?filterConfig.getInitParameter("allowMethods");
allowCredentials?=?filterConfig.getInitParameter("allowCredentials");
allowHeaders?=?filterConfig.getInitParameter("allowHeaders");
exposeHeaders?=?filterConfig.getInitParameter("exposeHeaders");
}
@Override
publicvoiddoFilter(ServletRequest?req,?ServletResponse?res,?FilterChain?chain)throwsIOException,?ServletException?{
HttpServletRequest?request?=?(HttpServletRequest)?req;
HttpServletResponse?response?=?(HttpServletResponse)?res;
if(StringUtil.isNotEmpty(allowOrigin))?{
List?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
publicvoiddestroy()?{
}
}
以上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的方法:
[xml]view plaincopy
corsFilter
com.xxx.api.cors.CorsFilter
allowOrigin
http://web.xxx.com
allowMethods
GET,POST,PUT,DELETE,OPTIONS
allowCredentials
true
allowHeaders
Content-Type
corsFilter
/*
完成以上過程即可實現(xiàn)AJAX跨域功能了秽誊,但似乎還存在另外一個問題,由于REST是無狀態(tài)的琳骡,后端應(yīng)用發(fā)布的REST API可在用戶未登錄的情況下被任意調(diào)用锅论,這顯然是不安全的,如何解決這個問題呢楣号?我們需要為REST請求提供安全機制最易。
解決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有效性的功能。代碼如下:
[java]view plaincopy
publicinterfaceTokenManager?{
String?createToken(String?username);
booleancheckToken(String?token);
}
然后惧磺,我們可提供一個簡單的TokenManager實現(xiàn)類颖对,將token存儲到JVM內(nèi)存中。代碼如下:
[java]view plaincopy
publicclassDefaultTokenManagerimplementsTokenManager?{
privatestaticMap?tokenMap?=newConcurrentHashMap<>();
@Override
publicString?createToken(String?username)?{
String?token?=?CodecUtil.createUUID();
tokenMap.put(token,?username);
returntoken;
}
@Override
publicbooleancheckToken(String?token)?{
return!StringUtil.isEmpty(token)?&&?tokenMap.containsKey(token);
}
}
需要注意的是豺妓,如果需要做到分布式集群惜互,建議基于Redis提供一個實現(xiàn)類布讹,將token存儲到Redis中琳拭,并利用Redis與生俱來的特性,做到token的分布式一致性描验。
然后白嘁,我們可以基于Spring AOP寫一個切面類,用于攔截Controller類的方法膘流,并從請求頭中獲取token絮缅,最后對token有效性進(jìn)行判斷鲁沥。代碼如下:
[java]view plaincopy
publicclassSecurityAspect?{
privatestaticfinalString?DEFAULT_TOKEN_NAME?="X-Token";
privateTokenManager?tokenManager;
privateString?tokenName;
publicvoidsetTokenManager(TokenManager?tokenManager)?{
this.tokenManager?=?tokenManager;
}
publicvoidsetTokenName(String?tokenName)?{
if(StringUtil.isEmpty(tokenName))?{
tokenName?=?DEFAULT_TOKEN_NAME;
}
this.tokenName?=?tokenName;
}
publicObject?execute(ProceedingJoinPoint?pjp)throwsThrowable?{
//?從切點上獲取目標(biāo)方法
MethodSignature?methodSignature?=?(MethodSignature)?pjp.getSignature();
Method?method?=?methodSignature.getMethod();
//?若目標(biāo)方法忽略了安全性檢查,則直接調(diào)用目標(biāo)方法
if(method.isAnnotationPresent(IgnoreSecurity.class))?{
returnpjp.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);
thrownewTokenException(message);
}
//?調(diào)用目標(biāo)方法
returnpjp.proceed();
}
}
若要使SecurityAspect生效耕魄,則需要添加如下Spring 配置:
[xml]view plaincopy
最后画恰,別忘了在web.xml中添加允許的X-Token響應(yīng)頭,配置如下:
[xml]view plaincopy
allowHeaders
Content-Type,X-Token
本文從經(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ù)問題及其解決方案糊治。希望本文對正在探索前后端分離的讀者們有所幫助,期待與大家共同探討罚舱。
轉(zhuǎn)載至http://blog.csdn.net/shaobingj126/article/details/49420145井辜,如有侵權(quán)請聯(lián)系我