从MVC到前后端分离(附完整Demo)

最新推荐文章于 2024-08-01 12:19:19 发布

a1405

最新推荐文章于 2024-08-01 12:19:19 发布

阅读量830

点赞数 1

分类专栏：各种理论文章标签：前后端分离

原文链接：https://mp.weixin.qq.com/s?__biz=MzUxNDA1NDI3OA==&mid=2247484660&idx=1&sn=3b81935dfb

版权

各种理论专栏收录该内容

11 篇文章 2 订阅

订阅专栏

一. MVC 概述

1. 理解 MVC

MVC是一种经典的设计模式，全名为Model-View-Controller，即模型-视图-控制器。

其中，模型是用于封装数据的载体，例如，在Java中一般通过一个简单的POJO（Plain Ordinary Java Object）来表示，其本质是一个普通的java Bean，包含一系列的成员变量及其getter/setter方法。

对于视图而言，它更加偏重于展现，也就是说，视图决定了界面到底长什么样子，在Java中可通过JSP来充当视图，或者通过纯HTML的方式进行展现，而后者才是目前的主流。

模型和视图需要通过控制器来进行粘合，例如，用户发送一个HTTP请求，此时该请求首先会进入控制器，然后控制器去获取数据并将其封装为模型，最后将模型传递到视图中进行展现。综上所述，MVC的交互过程如下图所示。

2. MVC 模式的优点与不足

MVC模式早在上个世纪70年代就诞生了，直到今天它依然存在，可见生命力相当之强。MVC模式最早应用于Smalltalk语言中，最后在其它许多开发语言中都得到了很好的应用。随着包括Struts、Spring MVC在内的MVC框架的出现，MVC模式真正落地，并使得开发更加高效、代码耦合度尽量减小、应用程序各部分的职责更加清晰。

既然MVC模式这么好，难道它就没有不足的地方吗？我认为MVC至少有以下三点不足：

每次请求必须经过“控制器->模型->视图”这个流程，用户才能看到最终的展现的界面，这个过程似乎有些复杂；

实际上视图是依赖于模型的，换句话说，如果没有模型，视图也无法呈现出最终的效果；

渲染视图的过程是在服务端来完成的，最终呈现给浏览器的是带有模型的视图页面，性能无法得到很好的优化。

为了使数据展现过程更加直接，并且提供更好的用户体验，我们有必要对MVC模式进行改进。不妨这样来尝试：首先从浏览器发送AJAX请求，然后服务端接受该请求并返回JSON数据返回给浏览器，最后在浏览器中进行界面渲染。改进后的MVC模式如下图所示：

也就是说，我们输入的是AJAX请求，输出的是JSON数据，市面上有这样的技术来实现这个功能吗？答案是REST。

REST全称是Representational State Transfer（表述性状态转移），它是Roy Fielding博士在2000年写的一篇关于软件架构风格的论文，此文一出，威震四方！国内外许多知名互联网公司纷纷开始采用这种轻量级的Web服务，大家习惯将其称为RESTful Web Services，或简称REST服务。如果将浏览器这一端视为前端，而服务器那一端视为后端的话，可以将以上改进后的MVC模式简化为以下前后端分离模式，如下图所示：

可见，采用REST分格的架构可以使得前端关注界面展现，后端关注业务逻辑，分工明确，职责清晰。那么，如何使用REST架构将应用程序进行前后端分离呢？我们接下来继续探讨，首先我们需要认识REST。

二. 认识 REST

REST本质上是使用URL来访问资源的一种方式。

众所周知，URL(Uniform Resoure Locator:统一资源定位器)就是我们平常使用的请求地址了，其中包括两部分：请求方式与请求路径，比较常见的请求方式是GET与POST，但在REST中又提出了几种其它类型的请求方式，汇总起来有六种：GET、POST、PUT、DELETE、HEAD、OPTIONS。尤其是前四种，正好与CRUD（Create-Retrieve-Update-Delete，增删改查）四种操作相对应，例如，GET（查）、POST（增）、PUT（改）、DELETE（删），这正是REST与CRUD的异曲同工之妙！需要强调的是，REST是面向资源(ROA)的，这里提到的资源，实际上就是我们常说的领域对象，在系统设计过程中，我们经常通过领域对象来进行数据建模。

REST是一个无状态的架构模式，因为在任何时候都可以由客户端发出请求到服务端，最终返回自己想要的数据，当前请求不会受到上次请求的影响。也就是说，服务端将内部资源发布REST服务，客户端通过URL来定位这些资源并通过HTTP协议来访问它们。下面我们举几个例子对REST请求进行简单描述：

可见，请求路径相同但请求方式不同，所代表的业务操作也不同，例如，/advertiser/1这个请求，带有GET、PUT、DELETE三种不同的请求方式，对应三种不同的业务操作。

虽然REST看起来还是很简单的，实际上我们往往需要提供一个REST框架，让其实现前后端分离架构，让开发人员将精力集中在业务上，而并非那些具体的技术细节。下面我们将使用Java技术来实现这个REST框架，整体框架会基于Spring进行开发。

三. 实现REST框架

1、统一响应结构

使用REST框架实现前后端分离架构，我们需要首先确定返回的JSON响应结构是统一的，也就是说，每个REST请求将返回相同结构的JSON响应结构。不妨定义一个相对通用的JSON响应结构，其中包含两部分：元数据与返回值，其中，元数据表示操作是否成功与返回值消息等，返回值对应服务端方法所返回的数据。该JSON响应结构如下：

{

       "meta": {

           "success": true,

           "message": "ok"

       },

       "data": ...

   }

为了在框架中映射以上JSON响应结构，我们需要编写一个Response类与其对应：

/**

* Title: 统一响应结构

* Description:使用REST框架实现前后端分离架构，我们需要首先确定返回的JSON响应结构是统一的，

* 也就是说，每个REST请求将返回相同结构的JSON响应结构。不妨定义一个相对通用的JSON响应结构，其

* 中包含两部分：元数据与返回值，其中，元数据表示操作是否成功与返回值消息等，返回值对应服务端方法所返回的数据。

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

*/

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;

   }

   /**

    * Title: 请求元数据 

    */

   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( )，通过一个内部类来展现元数据结构，我们在下文中多次会使用该Response类。

实现该REST框架需要考虑许多问题，首当其冲的就是前后数据流转问题，即HTTP消息与Java对象之间的转化问题。

2、前后台数据流转

前后台数据流转问题具体指的是什么？不妨通过一些例子进行说明。比如，通过浏览器发送了一个普通的HTTP请求，该请求携带了一个JSON格式的参数，在服务端需要将该JSON参数转换为普通的Java对象；再比如，在服务端获取了数据，此时该数据是一个普通的Java对象，然后需要将这个Java对象转换为JSON字符串，并将其返回到浏览器中进行渲染，这个过程就涉及HTTP消息与Java对象之间的转化问题。

实际上，Spring MVC已经为我们提供了这类转化特性，只需在Controller的方法参数中使用@RequestBody注解定义需要转化的参数即可；类似地，若需要对Controller的方法返回值进行转化，则需要在该返回值上使用@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 对象转化为特定的HTTP消息

   public User addUser(@RequestBody User user) {  // 将接收到的HTTP消息转化为Java对象

       userService.addUser(user);

       log.debug("添加用户 :" + user);

       return user;

   }

}

当然，@ResponseBody注解也可以定义在类上，这样所有的方法都继承了该特性。由于经常会使用到@ResponseBody注解，所以Spring提供了一个名为@RestController的注解来取代以上的@Controller注解，这样我们就可以省略返回值前面的@ResponseBody注解了，但参数前面的@RequestBody注解是无法省略的。实际上，看看Spring中对应@RestController注解的源码便可知晓：

@Target({ElementType.TYPE})  

@Retention(RetentionPolicy.RUNTIME)  

@Documented  

@Controller  

@ResponseBody  

public @interface RestController {  

   String value() default "";  

}

可见，@RestController注解已经被@Controller与@ResponseBody注解定义过了，Spring框架会识别这类注解。需要注意的是，该特性在Spring 4.0中才引入。因此，我们可将以上代码进行如下改写：

@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消息转化为Java对象

       userService.addUser(user);

       log.debug("添加用户 :" + user);

       return user;

   }

}

除了使用注解来定义消息转化行为以外，我们还需要添加Jackson包进行支持，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配置文件中添加以下配置即可：

<!-- 该配置会自动注册RequestMappingHandlerMapping与RequestMappingHandlerAdapter两个Bean，

   这是SpringMVC为@Controllers分发请求所必需的，并提供了数据绑定支持、@NumberFormatannotation支持、

   @DateTimeFormat支持、@Valid支持、读写XML的支持和读写JSON的支持等功能。 -->

   <mvc:annotation-driven />

通过以上过程，我们已经完成了一个基于SpringMVC的REST框架，只不过该框架还非常单薄，还缺乏很多关键性特性，尤其是异常处理。

3、处理异常行为

在Spring MVC中，我们可以使用AOP技术，编写一个全局的异常处理切面类，用它来统一处理所有的异常行为，在Spring 3.2中才开始提供。使用很简单，只需定义一个类，并通过@ControllerAdvice注解将其标注即可，同时需要使用@ResponseBody注解表示返回值可序列化为JSON字符串。代码如下：

/**        

* Title: 全局异常处理切面    

* Description: 利用 @ControllerAdvice + @ExceptionHandler 组合处理Controller层RuntimeException异常

*/      

@ControllerAdvice   // 控制器增强

@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类中包含一系列的异常处理方法，每个方法都通过@ResponseStatus注解定义了响应状态码，此外还通过@ExceptionHandler注解指定了具体需要拦截的异常类。以上过程只是包含了一部分的异常情况，若需处理其它异常，可添加方法具体的方法。需要注意的是，在运行时从上往下依次调用每个异常处理方法，匹配当前异常类型是否与@ExceptionHandler注解所定义的异常相匹配，若匹配，则执行该方法，同时忽略后续所有的异常处理方法，最终会返回经JSON序列化后的Response对象。

4、支持参数验证

我们回到上文所提到的示例，这里处理一个普通的PUT请求，代码如下：

@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消息转化为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日志处理 */

   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 Response handleValidationException(ValidationException e) {  

       logger.error("参数验证失败", e);  

       return new Response().failure("validation_exception");  

   }  

}

至此，REST框架已集成了Bean Validation特性，我们可以使用各种注解来完成所需的参数验证行为了。

看似该框架可以在本地成功跑起来，整个架构包含两个应用，前端应用提供纯静态的HTML页面，后端应用发布REST API，前端需要通过AJAX调用后端发布的REST API，然而AJAX是不支持跨域访问的，也就是说，前后端两个应用必须在同一个域名下才能访问。这是非常严重的技术障碍，一定需要找到解决方案。

5、解决跨域问题

比如，前端应用为静态站点且部署在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: 解决前后端分离架构中的跨域问题

*/      

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对象中即可

    * @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请求提供安全机制。

6、提供安全机制

解决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: 登录用户的身份鉴权

*/      

public interface TokenManager {

   String createToken(String username);  

   boolean checkToken(String token);

   void deleteToken(String token);

}

然后，我们可提供一个简单的TokenManager实现类，将token存储到JVM内存中。代码如下：

/**        

* Title: TokenManager的默认实现    

* Description: 管理 Token  

*/      

public class DefaultTokenManager implements TokenManager {

   /** 将token存储到JVM内存(ConcurrentHashMap)中   (@author: rico) */      

   private static Map<String, String> tokenMap = new ConcurrentHashMap<String, String>();

   /**

    * @description 利用UUID创建Token(用户登录时，创建Token)

    * @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验证(用户登录验证)

    * @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)
    
    * @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维持登录状态

*/

@Component

@Aspect

public class SecurityAspect {

   /** Log4j日志处理 */

   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>

四. 总结

本文从经典的MVC模式开始，对MVC模式是什么以及该模式存在的不足进行了简述。然后引出了如何对MVC模式的改良，让其转变为前后端分离架构，以及解释了为何要进行前后端分离。最后通过REST服务将前后端进行解耦，并提供了一款基于Java的REST框架的主要实现过程，尤其是需要注意的核心技术问题及其解决方案。希望本文对正在探索前后端分离的读者们有所帮助，期待与大家共同探讨。