Como usar CXF, JAX-RS e HTTP Caching

Question

o Cxf A documentação menciona o cache como HTTP avançado:

O CXF JAXRS fornece suporte para vários recursos HTTP avançados, manipulando os cabeçalhos IF-Match, If-Modified-Sur e ETAGS. O objeto de contexto de solicitação JAXRS pode ser usado para verificar as pré -condições. Vary, CacheControl, cookies e cozinheiros também são suportados.

Estou realmente interessado em usar (ou pelo menos explorar) esses recursos. No entanto, embora o "suporte" pareça realmente interessante, não é particularmente útil na implementação de tais recursos. Alguma ajuda ou indicadores sobre como usar se modificou, uma vez, cachecontrol ou etags?

Answer 1

Na verdade, a resposta não é específica para o CXF - é puro 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();
}

Answer 2

Com o próximo Jax-Rs 2.0, será possível aplicar declarativamente o controle de cache, conforme explicado em http://jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0/

Você já pode testar isso pelo menos com Jersey. Não tenho certeza sobre CXF e Restasy.

Answer 3

A CXF não implementa a filtragem dinâmica, conforme explicado aqui: http://www.jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0

E se você usar para retornar diretamente seus próprios objetos e não a resposta do CXF, é difícil adicionar um cabeçalho de controle de cache.

Encontro uma maneira elegante usando uma anotação personalizada e criando um interceptor CXF que leu esta anotação e adiciona o cabeçalho.

Então, primeiro, crie uma anotação de CacheControl

@Target(ElementType.METHOD )
@Retention(RetentionPolicy.RUNTIME)
public @interface CacheControl {
    String value() default "no-cache";
}

Em seguida, adicione esta anotação ao seu método de operação CXF (interface ou implementação em que ele funciona se você usar uma interface)

@CacheControl("max-age=600")
public Person getPerson(String name) {
    return personService.getPerson(name);
}

Em seguida, crie um interceptor de CacheControl que lide com a anotação e adicione o cabeçalho à sua resposta.

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()));
    }
}

Por fim, configure o CXF para usar seu interceptador, você pode encontrar todas as informações necessárias aqui: http://cxf.apache.org/docs/intercepts.html

Espero que ajude.

Loïc