实际上,答案并不特定于CXF - 它是纯JAX-RS:
// IPersonService.java
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
@GET
@Path("/person/{id}")
Response getPerson(@PathParam("id") String id, @Context Request request);
// PersonServiceImpl.java
import javax.ws.rs.core.CacheControl;
import javax.ws.rs.core.EntityTag;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.ResponseBuilder;
public Response getPerson(String name, Request request) {
Person person = _dao.getPerson(name);
if (person == null) {
return Response.noContent().build();
}
EntityTag eTag = new EntityTag(person.getUUID() + "-" + person.getVersion());
CacheControl cc = new CacheControl();
cc.setMaxAge(600);
ResponseBuilder builder = request.evaluatePreconditions(person.getUpdated(), eTag);
if (builder == null) {
builder = Response.ok(person);
}
return builder.cacheControl(cc).lastModified(person.getUpdated()).build();
}
随着即将到来的JAX-RS 2.0,可以按照http://jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0/中所解释的方式声明性地应用Cache-Control。
至少在Jersey中,您已经可以进行测试。不确定CXF和RESTEasy是否支持。
CXF没有像这里所解释的那样实现动态过滤:http://www.jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0
如果您使用自己的对象直接返回而不是CXF响应,那么很难添加缓存控制头。
我通过使用自定义注释并创建一个CXF拦截器来读取此注释并添加标头,找到了一种优雅的方法。
因此,首先创建一个CacheControl注释。
@Target(ElementType.METHOD )
@Retention(RetentionPolicy.RUNTIME)
public @interface CacheControl {
String value() default "no-cache";
}
然后,将此注释添加到您的CXF操作方法中(如果使用接口,则适用于接口或实现)
@CacheControl("max-age=600")
public Person getPerson(String name) {
return personService.getPerson(name);
}
然后创建一个CacheControl拦截器来处理注释并将标头添加到响应中。
public class CacheInterceptor extends AbstractOutDatabindingInterceptor{
public CacheInterceptor() {
super(Phase.MARSHAL);
}
@Override
public void handleMessage(Message outMessage) throws Fault {
//search for a CacheControl annotation on the operation
OperationResourceInfo resourceInfo = outMessage.getExchange().get(OperationResourceInfo.class);
CacheControl cacheControl = null;
for (Annotation annot : resourceInfo.getOutAnnotations()) {
if(annot instanceof CacheControl) {
cacheControl = (CacheControl) annot;
break;
}
}
//fast path for no cache control
if(cacheControl == null) {
return;
}
//search for existing headers or create new ones
Map<String, List<String>> headers = (Map<String, List<String>>) outMessage.get(Message.PROTOCOL_HEADERS);
if (headers == null) {
headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
outMessage.put(Message.PROTOCOL_HEADERS, headers);
}
//add Cache-Control header
headers.put("Cache-Control", Collections.singletonList(cacheControl.value()));
}
}
最后配置 CXF 使用您的拦截器,您可以在此处找到所有所需信息:http://cxf.apache.org/docs/interceptors.html
希望能够帮助到您。
Loïc