1.业务场景
为了对用户请求进行统一的接入管理(权限认证、日志记录、请求转发等),在用户发起任何HTTP请求时,在Jersey框架中实现过统一的过滤器拦截所有用户请求。
主要需求:
- 拦截注册到Jersey容器的请求资源,做日志记录
- 拦截Jersey容器中未注册(请求不存在,报NotFound错误)的请求资源,做统一转发
2.技术原理
Jersey的过滤器包括两种,一种是请求后置过滤器(post-matching filter),用于在请求完成后进行后置处理,一种是前置过滤器(pre-matching filter),用于在处理请求之前完成某些操作。
A post-matching filter is applied only after a suitable resource method has been selected to process the request.
A pre-matching filter (annotated with @RequestMatching) is executed before the request matching process is started.
在实现时过滤器时,后置过滤器或前置过滤器均要实现ContainerRequestFilter和ContainerResponseFilter接口,但前置处理器需使用@PreMatching注解修饰。
3.代码实现
实现一个名为MyRequestFilter过滤器,拦截所有用户请求。
package org.bigdata.filter;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.PreMatching;
import javax.ws.rs.ext.Provider;
import java.io.IOException;
@Provider
@PreMatching
public class MyRequestFilter implements ContainerRequestFilter {
@Override
public void filter(ContainerRequestContext req) throws IOException {
String path = req.getUriInfo().getPath();
//记录请求信息:请求方法、路径
System.out.println(req.getMethod());
System.out.println(path);
// 根据条件进行转发
// if (path.contains("/api/v1.0/xx")) {
// req.setRequestUri(URI.create("/xx"));
// }
}
}
4.测试
写一个用于测试的资源类,注册到Jersey容器,重启应用。
@Path("/filter/test")
public class FilterTestRes {
@GET
@Path("")
@Produces(MediaType.APPLICATION_JSON)
public Response test() {
return Response.ok("{'foo':'bar'}").build();
}
}
4.1访问已注册的资源
浏览器访问http://localhost:8081/filter/test,过滤器拦截到正常的注册资源请求。
请求正常返回。
4.2 访问不存在的资源
浏览器访问http://localhost:8081/api/v1.1/app3,调试模式显示过滤器拦截到的请求如下图。
5.过滤器不生效的可能原因
5.1注解未添加
实现前置过滤器的@Provider和@PreMatching注解缺一不可。
@Provider
@PreMatching
public class MyRequestFilter implements ContainerRequestFilter{}
5.2 过滤器未注册到Jersey容器中
如果使用ResourceConfig注册,使用packages("xxx.xxx.filter"),如果使用ServletHolder进行注册,则调用sh.setInitParameter("jersey.config.server.provider.packages", "org.bigdata.filter")
5.3未重启应用
如果以上条件都具备,重启服务尝试。