拦截器的使用

穿越：从0开始，构建前后端分离应用

拦截器的作用

拦截器是web项目不可或缺的组成部分，一般使用拦截器实现以下功能

1、登录session验证

　　防止浏览器端绕过登录，直接进入到应用

　　或者session超时后，返回到登录页面

2、记录系统日志

　　一个完善的应用系统，应该具备监控功能，通过完善的系统日志记录系统运行过程中都经历了什么，当发生错误的时候及时通知管理人员，将损失降到最低。同时通过系统日志的监控，也能监控每次访问的响应时长，作为性能调优的参考

3、对请求进行前置或后置的操作

　　比如对于服务端返回的异常信息，可以通过拦截器统一的进行后处理，使其格式统一

拦截器的实现方式

有两种方式

1、基于Spring AOP 的切面方式

2、基于Servlet规范的拦截器

 

实战

下面分享一下拦截器，在我的项目中是如何使用的。

我分别用基于Spring AOP的拦截器实现了登录验证及系统日志

使用基于Servlet规范的拦截器实现了跨域请求

基于Spring AOP的拦截器-登录验证

实现过程

1、pom中添加依赖

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.1</version>
</dependency>

2、开启Spring对@AspectJ的支持

在spring-mybatis.xml配置文件中，加入下面的内容

<!--开启Spring对@AspectJ的支持-->

<aop:aspectj-autoproxy/>

当然，要先在xml文件头部加上aop的命名空间（红色字体部分）

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
       http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd"> 

3、新建拦截器类 LoginInterceptor
4、在类上添加注解
     @Component ：将类的实例纳入到Spring 容器中管理
     @Aspect ：声明是基于@ASpectJ的注解实现
5、新建通知方法
    当应用中的方法处于切点表达式声明的范围内的时候，通知将被执行
6、使用@Around、@Before、@After来生命通知的类型是环绕通知、前置通知、后置通知
7、定义切点表达式

具体实现

package com.wt.common.security.interceptor;

import com.wt.common.core.annotations.IgnoreAuth;
import com.wt.common.core.result.HttpResultEntity;
import com.wt.common.core.result.HttpResultHandle;
import com.wt.common.core.utils.ServletNativeObjectUtil;
import com.wt.common.security.handler.HttpSessionHandler;
import com.wt.common.security.model.SysUser;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

/**
 * @ProjectName: syInfo
 * @Package: com.wt.common.core.interceptor
 * @Description:
 * @Author: lichking2017@aliyun.com
 * @CreateDate: 2018/5/16 上午8:20
 * @Version: v1.0
 */

@Component
@Order(1)
@Aspect
public class LoginInterceptor {
//    Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);

    @Around("@within(org.springframework.web.bind.annotation.RestController)")
    public HttpResultEntity loginCheck(ProceedingJoinPoint pjp) throws Throwable {
        HttpServletRequest request = ServletNativeObjectUtil.getRequest();
        SysUser loginUser = (SysUser) request.getSession().getAttribute(HttpSessionHandler.Items.LOGINUSER.name());

        final MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
        final Method method = methodSignature.getMethod();
        boolean ignoreAuth = method.isAnnotationPresent(IgnoreAuth.class);

        if ((null == loginUser)&&!ignoreAuth) {
            return new HttpResultEntity(HttpResultHandle.HttpResultEnum.NOTLOG);
        }
        return (HttpResultEntity) pjp.proceed();
    }
}

一些说明

在上述过程中需要理解一下的有以下两点
1、切点表达式
@within(org.springframework.web.bind.annotation.RestController)
它的意思代表了，通知的范围是只要有类添加了@RestController的注解，那么类中的方法，只要被调用，都会执行相应的通知
2、为什么这么配置呢？
为什么这么配置：因为我的项目是基于SpringMVC框架的，并且使用的请求都是基于Restful规范的。所以所有的Action都会配置@RestController这个注解，也就是说，所有的后台请求，
3、上述配置要完成的功能是什么？
如果用户没有登录，那么请求就会被打回，并在页面上给与用户提示
4、对于@Around环绕通知的执行过程是什么样的？
正常流：浏览器发起请求-》通知被执行-》在通知的内部，根据业务逻辑判断，该请求是否合法，也就是前置的一些处理，如果合法调用pjp.proceed()方法-》进入controller的方法执行，执行完成后-》返回到通知内部，继续执行pjp.proceed()后面的代码-》返回客户端
异常流：浏览器发起请求-》通知被执行-》在通知的内部，根据业务逻辑判断，该请求是否合法，也就是前置的一些处理，如果不合法，直接return-》浏览器显示处理结果

关于@AspectJ的相关知识就不再这里介绍了，感兴趣的朋友可以查看：@Aspect注解教程

基于Spring AOP的拦截器-系统日志

具体实现

package com.wt.common.security.interceptor;


import com.google.gson.Gson;
import com.wt.common.core.exception.BaseErrorException;
import com.wt.common.core.exception.BaseLogicException;
import com.wt.common.core.result.HttpResultEntity;
import com.wt.common.core.result.HttpResultHandle;
import com.wt.common.core.utils.ServletNativeObjectUtil;
import com.wt.common.security.handler.HttpSessionHandler;
import com.wt.common.security.model.SysUser;
import com.wt.common.security.model.SyslogPerformance;
import com.wt.common.security.service.SyslogPerformanceService;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

/**
 * @ProjectName: syInfo
 * @Package: com.wt.common.core.interceptor
 * @Description:
 * @Author: lichking2017@aliyun.com
 * @CreateDate: 2018/5/16 下午4:14
 * @Version: v1.0
 */

@Component
@Aspect
@Order(2)
public class LogInterceptor {

    Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);

    @Autowired
    private SyslogPerformanceService syslogPerformanceService;


    @Around("@within(org.springframework.web.bind.annotation.RestController)")
    public HttpResultEntity logRecord(ProceedingJoinPoint pjp) {
        Gson gson = new Gson();
        HttpServletRequest request = ServletNativeObjectUtil.getRequest();
        SyslogPerformance syslogPerformance = this.setLog(request);
        syslogPerformance.setParameters(gson.toJson(pjp.getArgs()));

        long startTime = System.currentTimeMillis(), endTime = 0, consume = 0;

        String requestInfo = String.format("⭐️{User-Agent:[%s],Protocol:[%s],Remote Addr:[%s],Method:[%s],uri:[%s],Cookie:[%s],operator:[%s],parameters:[%s]}⭐️",
                request.getHeader("User-Agent"), request.getProtocol(), request.getRemoteAddr(),
                request.getMethod(), request.getRequestURI(), request.getHeader("Cookie"),
                "ceshi",
                gson.toJson(pjp.getArgs()));
        try {
            HttpResultEntity result = (HttpResultEntity) pjp.proceed();
            endTime = System.currentTimeMillis();
            logger.info(requestInfo);
            return result;
        } catch (Throwable throwable) {
            endTime = System.currentTimeMillis();
            if (throwable instanceof BaseLogicException) {
                String errorMessage = ((BaseLogicException) throwable).getExceptionBody().getMessage();
                String errorCode = ((BaseLogicException) throwable).getExceptionBody().getMessage();
                logger.error(StringUtils.join(requestInfo, errorMessage), throwable);
                return HttpResultHandle.getErrorResult(errorCode, errorMessage);
            }
            if (throwable instanceof BaseErrorException) {
                logger.error(StringUtils.join(requestInfo, throwable.getMessage()), throwable);
                return HttpResultHandle.getErrorResult();
            }

            logger.error(StringUtils.join(requestInfo, throwable.getMessage()), throwable);
            return HttpResultHandle.getErrorResult();

        } finally {
            consume = endTime - startTime;
            syslogPerformance.setTimeConsuming(String.valueOf(consume));
            syslogPerformanceService.save(syslogPerformance);
        }
    }

    private SyslogPerformance setLog(HttpServletRequest request) {
        SysUser currentUser = (SysUser) request.getSession().getAttribute(HttpSessionHandler.Items.LOGINUSER.name());
        SyslogPerformance syslogPerformance = new SyslogPerformance();
        syslogPerformance
                .setRemoteHost(request.getRemoteHost())
                .setRemotePort(request.getRemotePort())
                .setRequestType(request.getMethod())
                .setRequestURI(request.getRequestURI());
        if(currentUser!=null){
            syslogPerformance.setOperatorId(currentUser.getUserId()).setOperatorName(currentUser.getUserName());
        }
        return syslogPerformance;
    }
}

一些说明

1、如果后台的请求执行正常，那么放行并记录日志

2、如果出现错误，同一处理结果，并返回结果到浏览器

3、无论处理过程是否异常，都会记录到数据库表当中

效果

1、功能如下图，每当一次请求被执行，在日志表中都会进行记录，包括时长，及时间。可以再扩展一下，加上操作人

基于Servlet规范的拦截器-跨域请求

实现过程

1、新建拦截器类CrossDomainInterceptor，并继承自HandlerInterceptor

2、对拦截器进行配置，在spring配置文件中，添加下面的内容

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/index.html"/>
            <bean class="com.wt.common.core.interceptor.CrossDomainInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

</beans>

3、重写以下方法

    preHandle：在请求调用之前调用

    postHandle：在请求执行完成，且返回视图渲染之前调用

    afterCompletion：在请求执行完成，并且完成视图渲染之后执行

具体实现

package com.wt.common.core.interceptor;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @ProjectName: syInfo
 * @Package: com.wt.common.core.interceptor
 * @Description:
 * @Author: lichking2017@aliyun.com
 * @CreateDate: 2018/5/15 下午11:21
 * @Version: v1.0
 */
@Order(1)
public class CrossDomainInterceptor implements HandlerInterceptor {
    Logger logger = LoggerFactory.getLogger(CrossDomainInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setHeader("Access-Control-Allow-Headers", "X-Requested-With, accept, content-type, xxxx");
        response.setHeader("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, PATCH");
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        return true;
    }
}

一些说明

1、这个比较简单，没什么太多说的地方，注意方法的返回值即可，根据项目的业务逻辑，如果请求通行，那么就return true，否则返回false。
2、如果有多个拦截器，执行顺序会按照拦截器在spring配置文件中声明的先后顺序执行，执行过程如下
    如果有A、B两个拦截器，A声明在先，B声明在后，执行顺序为
    A.preHandle-》B.preHandle-》B.postHandle-》A.postHandle