使用REST風格完成MVC先後端分離

一個具備REST風格項目的基本特徵：

1. 具備統一響應結構
2. 先後臺數據流起色制(HTTP消息與Java對象的互相轉化機制)
3. 統一的異常處理機制
4. 參數驗證機制
5. Cors跨域請求機制
6. 鑑權機制

一：統一響應結構

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

{
     "success": true,
     "message": "ok",
     "data": ...
}

 

爲了在框架中映射以上JSON響應結構，咱們須要編寫一個Response類與其對應：

public class Result implements Serializable {
    /**
     * Comment for <code>serialVersionUID</code>
     */
    private static final long serialVersionUID = -1776835663544058134L;

    /**
     * 處理結果
     */
    private boolean success = true;
    /**
     * 返回信息
     */
    private String message = "";
    /**
     * error code
     */
    private String code = "0";

    public Object data;

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        if (!code.equals("0")) {
            success = false;
        }
        this.code = code;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

}

 

 

二：先後臺數據流轉 

java對象與json的轉換問題

只需在Controller的方法參數中使用@RequestBody註解定義須要轉化的參數便可；相似地，若須要對Controller的方法返回值進行轉化，則須要在該返回值上使用@ResponseBody註解來定義。

或者使用：@RestController註解來取代以上的@Controller註解，這樣咱們就能夠省略返回值前面的@ResponseBody註解了。

須要注意的是，該特性在Spring 4.0中才引入。

除了使用註解來定義消息轉化行爲之外，咱們還須要添加Jackson或者fastjsoon包進行支持。

 在Spring配置文件中添加如下配置便可：

 <!-- 該配置會自動註冊RequestMappingHandlerMapping與RequestMappingHandlerAdapter兩個Bean，
    這是SpringMVC爲@Controllers分發請求所必需的，並提供了數據綁定支持、@NumberFormatannotation支持、
    @DateTimeFormat支持、@Valid支持、讀寫XML的支持和讀寫JSON的支持等功能。 -->
    <mvc:annotation-driven />

 

三：處理異常行爲

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

/**        
 * Title: 全局異常處理切面    
 * Description: 利用 @ControllerAdvice + @ExceptionHandler 組合處理Controller層RuntimeException異常
 * @author rico       
 * @created 2017年7月4日 下午4:29:07    
 */      
@ControllerAdvice   // 控制器加強
@ResponseBody
public class ExceptionAspect {

    /** Log4j日誌處理(@author: rico) */
    private static final Logger log = Logger.getLogger(ExceptionAspect.class);

    /**
     * 400 - Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public Result 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 Result().failure("parameter_validation_exception");
    }

    /**
     * 405 - Method Not Allowed。HttpRequestMethodNotSupportedException
     * 是ServletException的子類,須要Servlet API支持
     */
    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public Result handleHttpRequestMethodNotSupportedException(
            HttpRequestMethodNotSupportedException e) {
        log.error("request_method_not_supported...", e);
        return new Result().failure("request_method_not_supported");
    }

    /**
     * 415 - Unsupported Media Type。HttpMediaTypeNotSupportedException
     * 是ServletException的子類,須要Servlet API支持
     */
    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler({ HttpMediaTypeNotSupportedException.class })
    public Result handleHttpMediaTypeNotSupportedException(Exception e) {
        log.error("content_type_not_supported...", e);
        return new Result().failure("content_type_not_supported");
    }

    /**
     * 500 - Internal Server Error
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(TokenException.class)
    public Result handleTokenException(Exception e) {
        log.error("Token is invaild...", e);
        return new Result().failure("Token is invaild");
    }

    /**
     * 500 - Internal Server Error
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e) {
        log.error("Internal Server Error...", e);
        return new Result().failure("Internal Server Error");
    }
}

在ExceptionAdvice類中包含一系列的異常處理方法，每一個方法都經過@ResponseStatus註解定義了響應狀態碼，此外還經過@ExceptionHandler註解指定了具體須要攔截的異常類。以上過程只是包含了一部分的異常狀況，若需處理其它異常，可添加方法具體的方法。須要注意的是，在運行時從上往下依次調用每一個異常處理方法，匹配當前異常類型是否與@ExceptionHandler註解所定義的異常相匹配，若匹配，則執行該方法，同時忽略後續全部的異常處理方法，最終會返回經JSON序列化後的Result對象。

 

四：支持參數驗證

咱們回到上文所提到的示例，這裏處理一個普通的PUT請求，代碼以下：

@RestController
@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日誌處理(@author: rico) */
    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消息轉化爲Java對象
        userService.addUser(user);
        log.debug("添加用戶 :" + user);
        return user;
    }

    ...
}

其中，User參數包含若干屬性，經過如下類結構可見，它是一個傳統的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
}

若是業務上須要確保User對象的uname屬性必填，如何實現呢？若將這類參數驗證的代碼寫死在Controller中，勢必會與正常的業務邏輯攪在一塊兒，致使責任不夠單一，違背於「單一責任原則」。建議將其參數驗證行爲從Controller中剝離出來，放到另外的類中，這裏僅經過@Valid註解來定義uname參數，並經過Bean Validation的參考實現Hibernate Validator的@NotEmpty註解來定義User類中的uname屬性，就像下面這樣：

@RestController
@RequestMapping("/users")
public class UserController {

    private UserService userService;

    /** Log4j日誌處理(@author: rico) */
    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消息轉化爲Java對象
        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註解其實是Validation Bean規範提供的註解，該規範已由Hibernate Validator框架實現，所以須要添加如下Maven依賴到pom.xml文件中：

<dependency>  
    <groupId>org.hibernate</groupId>  
    <artifactId>hibernate-validator</artifactId>  
    <version>${hibernate-validator.version}</version>  
</dependency> 

須要注意的是，Hibernate Validator與Hibernate沒有任何依賴關係，惟一有聯繫的只是都屬於JBoss公司的開源項目而已。而後，咱們須要在Spring配置文件中開啓該特性，需添加以下配置：

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

最後，咱們在全局異常處理類中添加對參數驗證異常的處理方法，代碼以下：

@ControllerAdvice  
@ResponseBody  
public class ExceptionAdvice {  

    /** 
     * 400 - Bad Request 
     */  
    @ResponseStatus(HttpStatus.BAD_REQUEST)  
    @ExceptionHandler(ValidationException.class)  
    public Result handleValidationException(ValidationException e) {  
        logger.error("參數驗證失敗", e);  
        return new Result().failure("validation_exception");  
    }  
}  

至此，REST框架已集成了Bean Validation特性，咱們可使用各類註解來完成所需的參數驗證行爲了。 
看似該框架能夠在本地成功跑起來，整個架構包含兩個應用，前端應用提供純靜態的HTML頁面，後端應用發佈REST API，前端須要經過AJAX調用後端發佈的REST API，然而AJAX是不支持跨域訪問的，也就是說，先後端兩個應用必須在同一個域名下才能訪問。

五：解決跨域問題

好比，前端應用爲靜態站點且部署在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對象中，代碼以下：

/**        
 * Title: 跨域訪問處理(跨域資源共享)    
 * Description: 解決先後端分離架構中的跨域問題
 * @author zhuzhen
 * @created 2018年04月17日 下午5:00:09    
 */      
public class CorsFilter implements Filter {

    /** Log4j日誌處理(@author: rico) */
    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技術實現AJAX跨域訪問,只要將CORS響應頭寫入response對象中便可
     * @author zhuzhen
     * @created 2018年04月17日 下午5:02:38      
     * @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中讀取相關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的方法：

<!-- 經過CORS技術實現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>

完成以上過程便可實現AJAX跨域功能了，但彷佛還存在另一個問題，因爲REST是無狀態的，後端應用發佈的REST API可在用戶未登陸的狀況下被任意調用，這顯然是不安全的，如何解決這個問題呢？咱們須要爲REST請求提供安全機制。

六：提供安全機制

解決REST安全調用問題，能夠作得很複雜，也能夠作得特簡單，可按照如下過程提供REST安全機制：

　　(1). 當用戶登陸成功後，在服務端生成一個token，並將其放入內存中（可放入JVM或Redis中），同時將該token返回到客戶端；

　　(2). 在客戶端中將返回的token寫入cookie中，而且每次請求時都將token隨請求頭一塊兒發送到服務端；

　　(3). 提供一個AOP切面，用於攔截全部的Controller方法，在切面中判斷token的有效性；

　　(4). 當登出時，只需清理掉cookie中的token便可，服務端token可設置過時時間，使其自行移除。

首先，咱們須要定義一個用於管理token的接口，包括建立token與檢查token有效性的功能。代碼以下：

/**        
 * Title: REST 鑑權   
 * Description: 登陸用戶的身份鑑權
 * @author zhuzhen
 * @created 2018年04月17日 下午4:41:43    
 */      
public interface TokenManager {

    String createToken(String username);  

    boolean checkToken(String token); 

    void deleteToken(String token);
}

而後，咱們可提供一個簡單的TokenManager實現類，將token存儲到JVM內存中。代碼以下：

/**        
 * Title: TokenManager的默認實現    
 * Description: 管理 Token
 * @author rico       
 * @created 2017年7月4日 下午4:41:32    
 */      
public class DefaultTokenManager implements TokenManager {

    /** 將token存儲到JVM內存(ConcurrentHashMap)中   (@author: rico) */      
    private static Map<String, String> tokenMap = new ConcurrentHashMap<String, String>();

    /** 
     * @description 利用UUID建立Token(用戶登陸時，建立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驗證(用戶登陸驗證)
     * @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刪除(用戶登出時，刪除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提供一個實現類，將token存儲到Redis中，並利用Redis與生俱來的特性，作到token的分佈式一致性。 
而後，咱們能夠基於Spring AOP寫一個切面類，用於攔截Controller類的方法，並從請求頭中獲取token，最後對token有效性進行判斷。代碼以下：

/**
 * Title:安全檢查切面(是否登陸檢查) 
 * Description: 經過驗證Token維持登陸狀態
 * 
 * @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 {
        // 從切點上獲取目標方法
        MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
        log.debug("methodSignature : " + methodSignature);
        Method method = methodSignature.getMethod();
        log.debug("Method : " + method.getName() + " : "
                + method.isAnnotationPresent(IgnoreSecurity.class));
        // 若目標方法忽略了安全性檢查,則直接調用目標方法
        if (method.isAnnotationPresent(IgnoreSecurity.class)) {
            return pjp.proceed();
        }

        // 從 request header 中獲取當前 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);
        }
        // 調用目標方法
        return pjp.proceed();
    }
}

若要使SecurityAspect生效，則須要在SpringMVC配置文件中添加以下Spring 配置：

 <!-- 啓用註解掃描，並定義組件查找規則 ，mvc層只負責掃描@Controller、@ControllerAdvice -->
    <!-- base-package 若是多個，用「,」分隔 -->
    <context:component-scan base-package="cn.edu.tju.rico"
        use-default-filters="false">
        <!-- 掃描 @Controller -->
        <context:include-filter type="annotation"
            expression="org.springframework.stereotype.Controller" />
        <!-- 控制器加強，使一個Contoller成爲全局的異常處理類，類中用@ExceptionHandler方法註解的方法能夠處理全部Controller發生的異常 -->
        <context:include-filter type="annotation"
            expression="org.springframework.web.bind.annotation.ControllerAdvice" />
    </context:component-scan>

    <!-- 支持Controller的AOP代理 -->
    <aop:aspectj-autoproxy />

最後，別忘了在web.xml中添加容許的X-Token響應頭，配置以下：

<init-param>  
    <param-name>allowHeaders</param-name>  
    <param-value>Content-Type,X-Token</param-value>  
</init-param>