Comment utiliser CXF, JAX-RS et Caching HTTP

Question

Le CXF la documentation mentionne la mise en cache comme Avancé HTTP :

  

CXF JAXRS prend en charge un certain nombre de fonctionnalités HTTP avancées par la manipulation If-Match, If-Modified-Since et en-têtes ETAG. JAXRS objet demande de contexte peut être utilisé pour vérifier les conditions. Vary, CacheControl, cookies et Set-cookies sont également pris en charge.

Je suis vraiment intéressé à utiliser (ou au moins explorer) ces caractéristiques. Cependant, alors que « apporte un soutien » sonne vraiment intéressant, il est particulièrement utile pour la mise en œuvre de telles caractéristiques. Toute aide ou des pointeurs sur la façon d'utiliser If-Modified-Since, CacheControl ou ETags?

Answer 1

En fait, la réponse est non spécifique à CXF - il est pur 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

Avec les prochains JAX-RS 2.0, il sera possible d'appliquer Cache-Control déclarative, comme expliqué dans http://jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0/

Vous pouvez déjà tester ce au moins avec Jersey. Pas sûr CXF et RESTEasy cependant.

Answer 3

CXF ne met en oeuvre le filtrage dynamique comme expliqué ici: http://www.jalg.net/2012/09/declarative-cache-control-with-jax-rs-2-0

Et si vous utilisez pour retourner directement vos propres objets et non CXF réponse, il est difficile d'ajouter un en-tête de contrôle du cache.

Je trouve une manière élégante à l'aide d'une annotation personnalisée et la création d'un Interceptor CXF qui a lu cette annotation et ajoutez l'en-tête.

Alors d'abord, créer une annotation CacheControl

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

Ensuite, ajoutez cette annotation à votre mode de fonctionnement CXF (interface ou la mise en œuvre, il fonctionne aussi bien sur si vous utilisez une interface)

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

Ensuite, créez un intercepteur CacheControl qui traitera l'annotation et ajoutez l'en-tête de votre réponse.

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

Enfin configurer CXF d'utiliser votre intercepteur, vous pouvez trouver toutes les informations nécessaires ici: http: //cxf.apache.org/docs/interceptors.html

Je espère que ça vous aidera.

Loïc