在JAX-RS标准中,过滤器Filter是JAX-RS API的组成部分,主要用于操作HTTP请求或响应的Headers, Methods和URI等参数。而拦截器Interceptor作为JAX-RS extension API的组成部分,主要操作HTTP请求或响应的Body中的Entity数据流,如对Entity数据流进行压缩/解压缩,JSON格式与Java对象之间的转换等。可以说,在JAX-RS标准中,拦截器Interceptor是对过滤器Filter的补充,两者各司其职。
关于的用法,详见Jersey的过滤器详解,本文聚焦在Jersey的拦截器。
1. 在JAX-RS extension API(也称为SPI)提供了2个拦截器相关的接口
- javax.ws.rs.ext.ReaderInterceptor,在读取HTTP Body之前被拦截处理
在服务端操作HTTP请求的Entity,如对HTTP请求Body中的Entity进行处理。
在客户端操作HTTP响应的Entity,如对HTTP响应Body中的Entity进行处理。
- javax.ws.rs.ext.WriterInterceptor,在写入HTTP Body之前被拦截处理
在服务端操作HTTP响应的Entity,然后将处理后的内容封装到HTTP响应的Body中。
在客户端操作HTTP请求的Entity,然后将处理后的内容封装到HTTP请求的Body中。
2. 在Jersey应用中,使拦截器Interceptor实现类生效的方式与过滤器Filter完全一致,请参考Jersey的过滤器详解。
3. 拦截器实现类示例
1)读取拦截器
@Provider
@Priority(Priorities.USER)
public class MyReader implements ReaderInterceptor {
@Override
public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
final InputStream originalInputStream = context.getInputStream();
context.setInputStream(new GZIPInputStream(originalInputStream));//解压缩
return context.proceed();
}
}
2)写入拦截器
@Provider
@Priority(Priorities.USER)
public class MyWriter implements WriterInterceptor {
@Override
public void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException {
final OutputStream outputStream = context.getOutputStream();
context.setOutputStream(new GZIPOutputStream(outputStream));//压缩
context.proceed();
}
}
4. Jersey的Entity数据流(即HTTP消息的Body)
HTTP消息的Entity数据流,可以是纯文本、XML、JSON格式的数据。
对于收到的Entity数据流,其中的数据将作为输入流传递给Jersey,Jersey的JAX-RS组件根据数据格式将其转换为Java对象,供服务端资源方法后续解析处理。
对于要发出的数据,即服务端资源方法处理后返回的Java对象,将被Jersey序列化为输出流传递给Entity,然后作为HTTP消息的Body发送出去。
在JAX-RS标准的实现中,都应该提供各种格式的数据流与Java对象之间的默认转换。但不是在JAX-RS API中,而是在JAX-RS extension API中。JAX-RS extension API(也称为SPI)提供了2个操作Entity数据流相关的接口:
- javax.ws.rs.ext.MessageBodyReader<T>,负责将Entity数据流转换为Java对象(T类型)
public boolean isReadable(Class<?> type,
Type genericType,
Annotation[] annotations, MediaType mediaType) {
return type == T.class;
}
public T readFrom(Class<T> type,
Type genericType,
Annotation[] annotations, MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException, WebApplicationException {
//将entityStream读入到T类型的对象并返回
...
}
- javax.ws.rs.ext.MessageBodyWriter<T>,负责将Java对象(T类型)转换为Entity数据流
public boolean isWriteable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType) {
return type == T.class;
}
public void writeTo(T myBean,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream)
throws IOException, WebApplicationException {
//将myBean对象写入到entityStream输出流中
...
}
参考链接:
https://jersey.github.io/documentation/latest/filters-and-interceptors.html
https://jersey.github.io/documentation/latest/message-body-workers.html