spring mvc 方法注解拦截器

应用场景,在方法级别对本次调用进行鉴权,如api接口中有个用户惟一标示accessToken,对于有accessToken的每次请求能够在方法加一个拦截器,得到本次请求的用户,存放到request或者session域。java

python中,以前在python flask中能够使用装饰器来对方法进行预处理,进行权限处理python

先看一个实例,使用@access_required拦截:web

@api.route('/post_apply')
@access_required
def apply():
    """
     活动报名
    """
    print '报名者是:'+g.user
    return jsonify(response_data)

实现很简单:spring

# 验证access_token并保存当前用户到g中
def access_required(f):
    @wraps(f)
    def decorated_func(*args, **kwargs):
        access_token = request.values.get('access_token')
        if access_token == None:
            return error_msg('500', 'access_token required')
        if access_token == "":
            return error_msg('500', 'access_token can not empty')
        if is_access_token(access_token) == False:
            return error_msg('500', 'invalid_access_token')
        return f(*args, **kwargs)
    return decorated_func


java中,自定义注解拦截器来实现,在须要的拦截的方法上面加上一个注解@AccessRequiredjson

spring mvc Controller中的使用实例flask

/**
	 * 注解拦截器方法
	 * @return
	 */
	@RequestMapping(value="/urlinter",method=RequestMethod.GET)
	@AccessRequired
	public @ResponseBody String urlInterceptorTest() {
		return "经过拦截器:user"+request.getAttribute("currUser");
	}

如何实现以上实例呢?api

定义一个注解:session

import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AccessRequired {
	
}

搞一个拦截器:mvc

/**
 * 拦截url中的access_token
 * @author Nob
 * 
 */
public class UserAccessApiInterceptor extends HandlerInterceptorAdapter {

	public boolean preHandle(HttpServletRequest request,
			HttpServletResponse response, Object handler) throws Exception {

		HandlerMethod handlerMethod = (HandlerMethod) handler;
		Method method = handlerMethod.getMethod();
		AccessRequired annotation = method.getAnnotation(AccessRequired.class);
		if (annotation != null) {
		   System.out.println("你遇到了:@AccessRequired");
		   String accessToken = request.getParameter("access_token");
			/**
			 * Do something
			 */
		    response.getWriter().write("没有经过拦截,accessToken的值为:" + accessToken);
		}
		// 没有注解经过拦截
		return true;
	}
}

在spring mvc配置文件中:app

<!-- 拦截器 -->
	<mvc:interceptors>
		<mvc:interceptor>
			<!-- 对全部的请求拦截使用/** ,对某个模块下的请求拦截使用:/myPath/* -->
			<mvc:mapping path="/api/**" />
			<ref bean="userAccessInterceptor" />
		</mvc:interceptor>
	</mvc:interceptors>

	<bean id="userAccessInterceptor"
		class="com.banmacoffee.web.interceptor.UserAccessApiInterceptor">
	</bean>

注意问题:

    若是你使用了<mvc:resources mapping="/resources/**" location="/resources/" />来配置静态资源,那么配置如上拦截器的时候就要使用使用了全局拦截/**,不然会拦截静态资源抛出ResourceHttpRequestHandler cannot be cast to HandlerMethod异常

办法一:加上拦截路径前缀

<mvc:mapping path="/path/**" />

<!-- 这里使用一个path前置,如api,不然会拦截静态资源 -->

办法二:在自定义拦截器中使用instanceof 过滤ResourceHttpRequestHandler 类型

大功告成,你能够在拦截器里随心所欲,而且把它加载任何你想的Controller 请求的方法上