一指郁、什么是REST
??REST是一種軟件架構(gòu)風(fēng)格，或者說是一種規(guī)范，其強(qiáng)調(diào)HTTP應(yīng)當(dāng)以資源為中心乱豆，并且規(guī)范了URI的風(fēng)格；規(guī)范了HTTP請(qǐng)求動(dòng)作（GET/PUT/POST/DELETE/HEAD/OPTIONS）的使用吊趾，具有對(duì)應(yīng)的語義宛裕。
核心概念包括：
資源（Resource）：
??在REST中，資源可以簡單的理解為URI论泛，表示一個(gè)網(wǎng)絡(luò)實(shí)體揩尸。比如，/users/1/name屁奏，對(duì)應(yīng)id=1的用戶的屬性name岩榆。既然資源是URI，就會(huì)具有以下特征：名詞了袁，代表一個(gè)資源朗恳；它對(duì)應(yīng)唯一的一個(gè)資源，是資源的地址载绿。
表現(xiàn)（Representation）：
??是資源呈現(xiàn)出來的形式粥诫，比如上述URI返回的HTML或JSON，包括HTTP Header等崭庸；
??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來定位這些資源并通過HTTP協(xié)議來訪問它們沙合。
例如：
??從上圖可以看出請(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é)欲芹。實(shí)際工作中，一般采用基于SSM（Spring+SpringMVC+Mybatis）框架實(shí)現(xiàn)REST風(fēng)格的軟件架構(gòu)全景。
二耀石、實(shí)踐中常見的問題
【定義資源】：一般采用關(guān)系型數(shù)據(jù)庫存儲(chǔ)相應(yīng)的資源實(shí)體
【HTTP協(xié)議】：URL格式：協(xié)議：//域名/路徑?查詢#HASH，在開發(fā)中爸黄，實(shí)際的一個(gè)HTTP請(qǐng)求包含請(qǐng)求頭Header,其中包含Cookie、Method等內(nèi)容揭鳞。資源的URI格式：協(xié)議：//域名/路徑,它只是URL的子集炕贵，表征一個(gè)資源實(shí)體；如xxx.com/users/1.
【理解Headers里參數(shù)的含義】:Request URL野崇、Request Method称开、status code、Remote Address乓梨、Referrer Policy鳖轰、Content-Encoding、Content-Length扶镀、Content-Type等蕴侣。如Status Code 200=ok 400 = 資源不存在，500=服務(wù)器端錯(cuò)誤
【REST操作】一般資源操作只有查詢臭觉，更新昆雀，新增辱志，刪除，即CRUD操作狞膘，依次對(duì)應(yīng)HTTP協(xié)議中的四類請(qǐng)求：GET,PUT,POST,DELETE,在查詢資源時(shí)揩懒，更多的參數(shù)如分頁，排序挽封，過濾條件已球，一般都會(huì)放在URL的查詢部分（Query String）;新增、更新資源以及資源實(shí)體的內(nèi)容辅愿，一般放在請(qǐng)求體（Request Body）中和悦。
【返回內(nèi)容】：對(duì)于刪除、新增渠缕、更新等操作鸽素，通常是返回操作是否成功的標(biāo)識(shí)；如果失敗亦鳞，需要返回錯(cuò)誤代碼和消息馍忽，方便客戶端做進(jìn)一步處理。如果是查詢操作燕差，通常包含實(shí)體或者實(shí)體列表遭笋。
在最佳實(shí)踐中，應(yīng)當(dāng)還應(yīng)該返回與此操作相關(guān)的其他操作徒探。比如瓦呼，查詢得到實(shí)體的響應(yīng)中，應(yīng)包含該實(shí)體的刪除测暗、更新操作的地址央串。
【返回格式】：常見的格式包括XML/JSON/HTML。
三碗啄、REST架構(gòu)的實(shí)現(xiàn)
1质和、統(tǒng)一響應(yīng)結(jié)構(gòu)
??實(shí)現(xiàn)REST風(fēng)格框架，我們需要首先確定返回的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)：
/**
* Title: 統(tǒng)一響應(yīng)結(jié)構(gòu)
* Description:使用REST框架剧蚣，我們需要首先確定返回的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ù)扎运。{ "meta": { "success": true, "message": "ok" }, "data": ... }
*/
public class Response {
private static final String OK = "ok";
private static final String ERROR = "error";
private Meta meta; // 元數(shù)據(jù)
private Object data; // 響應(yīng)內(nèi)容
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: 請(qǐng)求元數(shù)據(jù)
*/
public class Response {
private static final String OK = "ok";
private static final String ERROR = "error";
private Meta meta; // 元數(shù)據(jù)
private Object data; // 響應(yīng)內(nèi)容
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: 請(qǐng)求元數(shù)據(jù)
* @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，還包括兩個(gè)常用的操作方法：success( )與failure( )饮戳，通過一個(gè)內(nèi)部類來展現(xiàn)元數(shù)據(jù)結(jié)構(gòu).
實(shí)現(xiàn)該REST框架需要考慮許多問題豪治，首當(dāng)其沖的就是前后數(shù)據(jù)流轉(zhuǎn)問題，即HTTP消息與Java對(duì)象之間的轉(zhuǎn)化問題扯罐。
2负拟、前后臺(tái)數(shù)據(jù)流轉(zhuǎn)
??前后臺(tái)數(shù)據(jù)流轉(zhuǎn)問題具體指的是什么？不妨通過一些例子進(jìn)行說明歹河。比如掩浙，通過瀏覽器發(fā)送了一個(gè)普通的HTTP請(qǐng)求，該請(qǐng)求攜帶了一個(gè)JSON格式的參數(shù)秸歧，在服務(wù)端需要將該JSON參數(shù)轉(zhuǎn)換為普通的Java對(duì)象厨姚；再比如，在服務(wù)端獲取了數(shù)據(jù)键菱，此時(shí)該數(shù)據(jù)是一個(gè)普通的Java對(duì)象谬墙，然后需要將這個(gè)Java對(duì)象轉(zhuǎn)換為JSON字符串，并將其返回到瀏覽器中進(jìn)行渲染经备，這個(gè)過程就涉及HTTP消息與Java對(duì)象之間的轉(zhuǎn)化問題拭抬。
??實(shí)際上，Spring MVC已經(jīng)為我們提供了這類轉(zhuǎn)化特性弄喘，只需在Controller的方法參數(shù)中使用@RequestBody注解定義需要轉(zhuǎn)化的參數(shù)即可玖喘；類似地，若需要對(duì)Controller的方法返回值進(jìn)行轉(zhuǎn)化蘑志，則需要在該返回值上使用@ResponseBody注解來定義，如以下代碼片段：
@RequestMapping("/users")
public class UserController {
private UserService userService;
/** Log4j日志處理 */
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 對(duì)象轉(zhuǎn)化為特定的HTTP消息
public User addUser(@RequestBody User user) { // 將接收到的HTTP消息轉(zhuǎn)化為Java對(duì)象
userService.addUser(user);
log.debug("添加用戶 :" + user);
return user;
}
}
??當(dāng)然贬派，@ResponseBody注解也可以定義在類上急但，這樣所有的方法都繼承了該特性。由于經(jīng)常會(huì)使用到@ResponseBody注解搞乏，所以Spring提供了一個(gè)名為@RestController的注解來取代以上的@Controller注解波桩，這樣我們就可以省略返回值前面的@ResponseBody注解了，但參數(shù)前面的@RequestBody注解是無法省略的请敦。實(shí)際上镐躲，看看Spring中對(duì)應(yīng)@RestController注解的源碼便可知曉：
@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)行如下改寫：
@RestController
@RequestMapping("/users")
public class UserController {
private UserService userService;
/** Log4j日志處理 */
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消息轉(zhuǎn)化為Java對(duì)象
userService.addUser(user);
log.debug("添加用戶 :" + user);
return user;
}
}
除了使用注解來定義消息轉(zhuǎn)化行為以外端礼，我們還需要添加Jackson包進(jìn)行支持，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配置文件中添加以下配置即可：
<!-- 該配置會(huì)自動(dòng)注冊(cè)RequestMappingHandlerMapping與RequestMappingHandlerAdapter兩個(gè)Bean入录，
這是SpringMVC為@Controllers分發(fā)請(qǐng)求所必需的蛤奥，并提供了數(shù)據(jù)綁定支持、@NumberFormatannotation支持僚稿、
@DateTimeFormat支持凡桥、@Valid支持、讀寫XML的支持和讀寫JSON的支持等功能蚀同。 -->
<mvc:annotation-driven />
通過以上過程缅刽，我們已經(jīng)完成了一個(gè)基于SpringMVC的REST框架，只不過該框架還非常單薄唤崭，還缺乏很多關(guān)鍵性特性拷恨，尤其是異常處理。
3谢肾、處理異常行為
??在Spring MVC中腕侄，我們可以使用AOP技術(shù)，編寫一個(gè)全局的異常處理切面類芦疏，用它來統(tǒng)一處理所有的異常行為冕杠，在Spring 3.2中才開始提供。使用很簡單酸茴，只需定義一個(gè)類分预，并通過@ControllerAdvice注解將其標(biāo)注即可，同時(shí)需要使用@ResponseBody注解表示返回值可序列化為JSON字符串薪捍。代碼如下：
/**
* Title: 全局異常處理切面
* Description: 利用 @ControllerAdvice + @ExceptionHandler 組合處理Controller層RuntimeException異常
*/
@ControllerAdvice // 控制器增強(qiáng)
@ResponseBody
public class ExceptionAspect {
/** Log4j日志處理*/
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類中包含一系列的異常處理方法凳干，每個(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仿滔、支持參數(shù)驗(yàn)證
??處理一個(gè)普通的PUT請(qǐng)求，代碼如下：
@RestController
@RequestMapping("/users")
public class UserController {
private UserService userService;
/** Log4j日志處理 */
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消息轉(zhuǎn)化為Java對(duì)象
userService.addUser(user);
log.debug("添加用戶 :" + user);
return user;
}
...
}
其中犹芹，User參數(shù)包含若干屬性崎页，通過以下類結(jié)構(gòu)可見，它是一個(gè)傳統(tǒng)的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
}
??如果業(yè)務(wù)上需要確保User對(duì)象的uname屬性必填腰埂，如何實(shí)現(xiàn)呢飒焦？若將這類參數(shù)驗(yàn)證的代碼寫死在Controller中，勢(shì)必會(huì)與正常的業(yè)務(wù)邏輯攪在一起屿笼，導(dǎo)致責(zé)任不夠單一牺荠，違背于“單一責(zé)任原則”。建議將其參數(shù)驗(yàn)證行為從Controller中剝離出來驴一，放到另外的類中休雌，這里僅通過@Valid注解來定義uname參數(shù)，并通過Bean Validation的參考實(shí)現(xiàn)Hibernate Validator的@NotEmpty注解來定義User類中的uname屬性肝断，就像下面這樣：
@RestController
@RequestMapping("/users")
public class UserController {
private UserService userService;
/** Log4j日志處理*/
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消息轉(zhuǎn)化為Java對(duì)象
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注解實(shí)際上是Validation Bean規(guī)范提供的注解杈曲，該規(guī)范已由Hibernate Validator框架實(shí)現(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àng)目而已。然后趣钱，我們需要在Spring配置文件中開啟該特性涌献，需添加如下配置：
<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>
最后，我們?cè)谌之惓Ｌ幚眍愔刑砑訉?duì)參數(shù)驗(yàn)證異常的處理方法首有，代碼如下：
@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ù)障礙蝗锥，一定需要找到解決方案跃洛。
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ì)象中酷誓，代碼如下：
/**
* Title: 跨域訪問處理(跨域資源共享)
* Description: 解決前后端分離架構(gòu)中的跨域問題
*/
public class CorsFilter implements Filter {
/** Log4j日志處理 */
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技術(shù)實(shí)現(xiàn)AJAX跨域訪問,只要將CORS響應(yīng)頭寫入response對(duì)象中即可
* @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中讀取相關(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的方法：
<!-- 通過CORS技術(shù)實(shí)現(xiàn)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>
完成以上過程即可實(shí)現(xiàn)AJAX跨域功能了懊蒸，但似乎還存在另外一個(gè)問題荣倾，由于REST是無狀態(tài)的，后端應(yīng)用發(fā)布的REST API可在用戶未登錄的情況下被任意調(diào)用骑丸，這顯然是不安全的舌仍，如何解決這個(gè)問題呢？我們需要為REST請(qǐng)求提供安全機(jī)制通危。
6铸豁、提供安全機(jī)制
解決REST安全調(diào)用問題，可以做得很復(fù)雜菊碟，也可以做得特簡單节芥，可按照以下過程提供REST安全機(jī)制：
(1). 當(dāng)用戶登錄成功后，在服務(wù)端生成一個(gè)token逆害，并將其放入內(nèi)存中（可放入JVM或Redis中）头镊，同時(shí)將該token返回到客戶端；
(2). 在客戶端中將返回的token寫入cookie中魄幕，并且每次請(qǐng)求時(shí)都將token隨請(qǐng)求頭一起發(fā)送到服務(wù)端相艇；
(3). 提供一個(gè)AOP切面，用于攔截所有的Controller方法纯陨，在切面中判斷token的有效性坛芽；
(4). 當(dāng)?shù)浅鰰r(shí)留储，只需清理掉cookie中的token即可，服務(wù)端token可設(shè)置過期時(shí)間靡馁，使其自行移除欲鹏。
首先，我們需要定義一個(gè)用于管理token的接口臭墨，包括創(chuàng)建token與檢查token有效性的功能。代碼如下：
/**
* Title: REST 鑒權(quán)
* Description: 登錄用戶的身份鑒權(quán)
*/
public interface TokenManager {
String createToken(String username);
boolean checkToken(String token);
void deleteToken(String token);
}
然后膘盖，我們可提供一個(gè)簡單的TokenManager實(shí)現(xiàn)類胧弛，將token存儲(chǔ)到JVM內(nèi)存中。代碼如下：
/**
* Title: TokenManager的默認(rèn)實(shí)現(xiàn)
* Description: 管理 Token
* @author rico
* @created 2017年7月4日 下午4:41:32
*/
public class DefaultTokenManager implements TokenManager {
/** 將token存儲(chǔ)到JVM內(nèi)存(ConcurrentHashMap)中 (@author: rico) */
private static Map<String, String> tokenMap = new ConcurrentHashMap<String, String>();
/**
* @description 利用UUID創(chuàng)建Token(用戶登錄時(shí)侠畔，創(chuàng)建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驗(yàn)證(用戶登錄驗(yàn)證)
* @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刪除(用戶登出時(shí)结缚，刪除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提供一個(gè)實(shí)現(xiàn)類红竭，將token存儲(chǔ)到Redis中，并利用Redis與生俱來的特性喘落，做到token的分布式一致性茵宪。
然后，我們可以基于Spring AOP寫一個(gè)切面類瘦棋，用于攔截Controller類的方法稀火，并從請(qǐng)求頭中獲取token，最后對(duì)token有效性進(jìn)行判斷赌朋。代碼如下：
/**
* Title:安全檢查切面(是否登錄檢查)
* Description: 通過驗(yàn)證Token維持登錄狀態(tài)
*
* @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 {
// 從切點(diǎn)上獲取目標(biāo)方法
MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
log.debug("methodSignature : " + methodSignature);
Method method = methodSignature.getMethod();
log.debug("Method : " + method.getName() + " : "
+ method.isAnnotationPresent(IgnoreSecurity.class));
// 若目標(biāo)方法忽略了安全性檢查,則直接調(diào)用目標(biāo)方法
if (method.isAnnotationPresent(IgnoreSecurity.class)) {
return pjp.proceed();
}
// 從 request header 中獲取當(dāng)前 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);
}
// 調(diào)用目標(biāo)方法
return pjp.proceed();
}
}
若要使SecurityAspect生效凰狞，則需要在SpringMVC配置文件中添加如下Spring 配置：
<!-- 啟用注解掃描，并定義組件查找規(guī)則 沛慢，mvc層只負(fù)責(zé)掃描@Controller赡若、@ControllerAdvice -->
<!-- base-package 如果多個(gè)，用“,”分隔 -->
<context:component-scan base-package="cn.edu.tju.rico"
use-default-filters="false">
<!-- 掃描 @Controller -->
<context:include-filter type="annotation"
expression="org.springframework.stereotype.Controller" />
<!-- 控制器增強(qiáng)团甲，使一個(gè)Contoller成為全局的異常處理類逾冬，類中用@ExceptionHandler方法注解的方法可以處理所有Controller發(fā)生的異常 -->
<context:include-filter type="annotation"
expression="org.springframework.web.bind.annotation.ControllerAdvice" />
</context:component-scan>
<!-- 支持Controller的AOP代理 -->
<aop:aspectj-autoproxy />
最后，別忘了在web.xml中添加允許的X-Token響應(yīng)頭伐庭，配置如下：
<init-param>
<param-name>allowHeaders</param-name>
<param-value>Content-Type,X-Token</param-value>
</init-param>
