从MVC到先后端分离（REST-我的也认为是目前比较流行和比较好的方式）

时间  2019-11-17 标签 mvc 先 后端 分离 rest 我的 认为是 目前 比较 流行 比较 好的 方式

摘要：MVC模式早在上个世纪70年代就诞生了，直到今天它依然存在，可见生命力至关之强。MVC模式最先用于Smalltalk语言中，最后在其它许多开发语言中都获得了很好的应用，例如，Java中的Struts、Spring MVC等框架。前端

1. 理解MVC

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

其中，模型是用于封装数据的载体，例如，在Java中通常经过一个简单的POJO（Plain Ordinary Java Object）来表示，其本质是一个普通的Java Bean，包含一系列的成员变量及其getter/setter方法。对于视图而言，它更加偏重于展示，也就是说，视图决定了界面到底长什么样子，在Java中可经过JSP来充当视图，或者经过纯HTML的方式进行展示，然后者才是目前的主流。模型和视图须要经过控制器来进行粘合，例如，用户发送一个HTTP请求，此时该请求首先会进入控制器，而后控制器去获取数据并将其封装为模型，最后将模型传递到视图中进行展示。web

综上所述，MVC的交互过程如图1所示。算法

2. MVC模式的优势与不足

MVC模式早在上个世纪70年代就诞生了，直到今天它依然存在，可见生命力至关之强。MVC模式最先用于Smalltalk语言中，最后在其它许多开发语言中都获得了很好的应用，例如，Java中的Struts、Spring MVC等框架。正是由于这些MVC框架的出现，才让MVC模式真正落地，让开发更加高效，让代码耦合度尽可能减少，让应用程序各部分的职责更加清晰。spring

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

  1. 每次请求必须通过“控制器->模型->视图”这个流程，用户才能看到最终的展示的界面，这个过程彷佛有些复杂。
  2. 实际上视图是依赖于模型的，换句话说，若是没有模型，视图也没法呈现出最终的效果。
  3. 渲染视图的过程是在服务端来完成的，最终呈现给浏览器的是带有模型的视图页面，性能没法获得很好的优化。

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

改进后的MVC模式如图2所示。后端

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

REST全称是Representational State Transfer（表述性状态转移），它是Roy Fielding博士在2000年写的一篇关于软件架构风格的论文，此文一出，威震四方！国内外许多知名互联网公司纷纷开始采用这种轻量级的Web服务，你们习惯将其称为RESTful Web Services，或简称REST服务。]api

若是将浏览器这一端视为前端，而服务器那一端视为后端的话，能够将以上改进后的MVC模式简化为如下先后端分离模式，如图3所示。

可见，有了REST服务，前端关注界面展示，后端关注业务逻辑，分工明确，职责清晰。那么，如何使用REST服务将应用程序进行先后端分离呢？咱们接下来继续探讨，首先咱们须要认识REST。

3. 认识REST

REST本质上是使用URL来访问资源种方式。众所周知，URL就是咱们日常使用的请求地址了，其中包括两部分：请求方式与请求路径，比较常见的请求方式是GET与POST，但在REST中又提出了几种其它类型的请求方式，汇总起来有六种：GET、POST、PUT、DELETE、HEAD、OPTIONS。尤为是前四种，正好与CRUD（Create-Retrieve-Update-Delete，增删改查）四种操做相对应，例如，GET（查）、POST（增）、PUT（改）、DELETE（删），这正是REST与CRUD的殊途同归之妙！须要强调的是，REST是“面向资源”的，这里提到的资源，实际上就是咱们常说的领域对象，在系统设计过程当中，咱们常常经过领域对象来进行数据建模。

REST是一个“无状态”的架构模式，由于在任什么时候候均可以由客户端发出请求到服务端，最终返回本身想要的数据，当前请求不会受到上次请求的影响。也就是说，服务端将内部资源发布REST服务，客户端经过URL来访问这些资源，这不就是SOA所提倡的“面向服务”的思想吗？因此，REST也被人们看作是一种“轻量级”的SOA实现技术，所以在企业级应用与互联网应用中都获得了普遍应用。

下面咱们举几个例子对REST请求进行简单描述：

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

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

4. 实现REST框架

4.1 统一响应结构

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

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

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

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

实现该REST框架须要考虑许多问题，首当其冲的就是对象序列化问题。

4.2 实现对象序列化

想要解释什么是对象序列化？不妨经过一些例子进行说明。好比，经过浏览器发送了一个普通的HTTP请求，该请求携带了一个JSON格式的参数，在服务端须要将该JSON参数转换为普通的Java对象，这个转换过程称为序列化。再好比，在服务端获取了数据，此时该数据是一个普通的Java对象，而后须要将这个Java对象转换为JSON字符串，并将其返回到浏览器中进行渲染，这个转换过程称为反序列化。无论是序列化仍是反序列化，咱们通常都称为序列化。

实际上，Spring MVC已经为咱们提供了这类序列化特性，只需在Controller的方法参数中使用@RequestBody注解定义须要反序列化的参数便可，如如下代码片断：

@Controller  
public class AdvertiserController {  
  
    @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
    public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {  
        ...  
    }  
}  

若须要对Controller的方法返回值进行序列化，则须要在该返回值上使用@ResponseBody注解来定义，如如下代码片断：

@Controller  
public class AdvertiserController {  
  
    @RequestMapping(value = "/advertiser/{id}", method = RequestMethod.GET)  
    public @ResponseBody Response getAdvertiser(@PathVariable("id") String advertiserId) {  
        ...  
    }  
}  

固然，@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  
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的序列化行为进行定制，好比，排除值为空属性、进行缩进输出、将驼峰转为下划线、进行日期格式化等，这又如何实现呢？

首先，咱们须要扩展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);  
        // 进行缩进输出  
        configure(SerializationFeature.INDENT_OUTPUT, true);  
        // 将驼峰转为下划线  
        if (camelCaseToLowerCaseWithUnderscores) {  
            setPropertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);  
        }  
        // 进行日期格式化  
        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>  

经过以上过程，咱们已经完成了一个基于Spring MVC的REST框架，只不过该框架还很是单薄，还缺少不少关键性特性，尤为是异常处理。

4.3 处理异常行为

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

@ControllerAdvice  
@ResponseBody  
public class ExceptionAdvice {  
  
    /** 
     * 400 - Bad Request 
     */  
    @ResponseStatus(HttpStatus.BAD_REQUEST)  
    @ExceptionHandler(HttpMessageNotReadableException.class)  
    public Response handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {  
        logger.error("参数解析失败", 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("不支持当前请求方法", 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("不支持当前媒体类型", 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("服务运行异常", e);  
        return new Response().failure(e.getMessage());  
    }  
}  

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

4.4 支持参数验证

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

@RestController  
public class AdvertiserController {  
  
    @RequestMapping(value = "/advertiser", method = RequestMethod.POST)  
    public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {  
        ...  
    }  
}  

其中，AdvertiserParam参数包含若干属性，经过如下类结构可见，它是一个传统的POJO：

public class AdvertiserParam {  
  
    private String advertiserName;  
      
    private String description;  
  
    // 省略 getter/setter 方法  
}  

若是业务上须要确保AdvertiserParam对象的advertiserName属性必填，如何实现呢？

若将这类参数验证的代码写死在Controller中，势必会与正常的业务逻辑搅在一块儿，致使责任不够单一，违背于“单一责任原则”。建议将其参数验证行为从Controller中剥离出来，放到另外的类中，这里仅提供一个@Valid注解来定义AdvertiserParam参数，并在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规范提供的注解，该规范已由Hibernate Validator框架实现，所以须要添加如下Maven依赖到pom.xml文件中：

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

须要注意的是，Hibernate Validator与Hibernate没有任何依赖关系，惟一有联系的只是都属于JBoss公司的开源项目而已。

要实现@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三个属性，由于这是规范所要求的，此外，须要经过@Constraint注解指定一个验证器类，这里对应的是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);  
    }  
}

以上验证器类实现了ConstraintValidator接口，并在该接口的isValid( )方法中完成了具体的参数验证逻辑。须要注意的是，实现接口时须要指定泛型，第一个参数表示验证注解类型（NotEmpty），第二个参数表示须要验证的参数类型（String）。

而后，咱们须要在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是不支持跨域访问的，也就是说，先后端两个应用必须在同一个域名下才能访问。这是很是严重的技术障碍，必定须要找到解决方案。

4.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对象中，代码以下：

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中读取相关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的方法：

<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>

完成以上过程便可实现AJAX跨域功能了，但彷佛还存在另一个问题，因为REST是无状态的，后端应用发布的REST API可在用户未登陆的状况下被任意调用，这显然是不安全的，如何解决这个问题呢？咱们须要为REST请求提供安全机制。

4.6 提供安全机制

解决REST安全调用问题，能够作得很复杂，也能够作得特简单，可按照如下过程提供REST安全机制：

  1. 当用户登陆成功后，在服务端生成一个token，并将其放入内存中（可放入JVM或Redis中），同时将该token返回到客户端。
  2. 在客户端中将返回的token写入cookie中，而且每次请求时都将token随请求头一块儿发送到服务端。
  3. 提供一个AOP切面，用于拦截全部的Controller方法，在切面中判断token的有效性。
  4. 当登出时，只需清理掉cookie中的token便可，服务端token可设置过时时间，使其自行移除。

首先，咱们须要定义一个用于管理token的接口，包括建立token与检查token有效性的功能。代码以下：

public interface TokenManager {  
  
    String createToken(String username);  
  
    boolean checkToken(String token);  
} 

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

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提供一个实现类，将token存储到Redis中，并利用Redis与生俱来的特性，作到token的分布式一致性。

而后，咱们能够基于Spring AOP写一个切面类，用于拦截Controller类的方法，并从请求头中获取token，最后对token有效性进行判断。代码以下：

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 {  
        // 从切点上获取目标方法  
        MethodSignature methodSignature = (MethodSignature) pjp.getSignature();  
        Method method = methodSignature.getMethod();  
        // 若目标方法忽略了安全性检查，则直接调用目标方法  
        if (method.isAnnotationPresent(IgnoreSecurity.class)) {  
            return pjp.proceed();  
        }  
        // 从 request header 中获取当前 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);  
        }  
        // 调用目标方法  
        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响应头，配置以下：

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

总结

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

                                                                  （责编/ 钱曙光，关注架构和算法领域，qianshg@csdn.net）

联系我们 沪ICP备2021010478号-7