Подтвердить что ты не робот

Джерси: Управление кешем по умолчанию в no-cache

При написании веб-службы RESTful возникают проблемы, если я разрешаю кэширование на моем клиенте (в настоящее время это толстый клиент .NET). По умолчанию Джерси не отправляет какой-либо заголовок для управления кешем, поэтому клиент кэширует большинство страниц автоматически (что кажется правильным поведением).

Я бы хотел, чтобы по умолчанию Джерси отправил кеш-контроль "no-cache", а затем в частности ответы отменили контроль кеша.

Есть ли способ сделать это с Джерси?

Я обнаружил, что RESTeasy имеет возможность использовать аннотацию @NoCache, чтобы указать настройку для всего класса, но я не нашел ничего подобного с Джерси.

4b9b3361

ОТВЕТЫ

Ответ 1

Это легко с Джерси с помощью ResourceFilterFactory - вы можете создать любую пользовательскую аннотацию, которую вы присоединяете к своим методам, чтобы установить параметры управления кешем. ResourceFilterFactories вызывается для каждого обнаруженного метода ресурсов, когда приложение инициализируется - в вашем ResourceFilterFactory вы можете проверить, есть ли у метода ваша аннотация @CacheControlHeader (или что вы хотите назвать) - если нет, просто возвращайте фильтр ответов, который добавляет "no-cache" "директива для ответа, в противном случае она должна использовать настройки из аннотации. Вот пример того, как это сделать:

public class CacheFilterFactory implements ResourceFilterFactory {
    private static final List<ResourceFilter> NO_CACHE_FILTER = Collections.<ResourceFilter>singletonList(new CacheResponseFilter("no-cache"));

    @Override
    public List<ResourceFilter> create(AbstractMethod am) {
        CacheControlHeader cch = am.getAnnotation(CacheControlHeader.class);
        if (cch == null) {
            return NO_CACHE_FILTER;
        } else {
            return Collections.<ResourceFilter>singletonList(new CacheResponseFilter(cch.value()));
        }
    }

    private static class CacheResponseFilter implements ResourceFilter, ContainerResponseFilter {
        private final String headerValue;

        CacheResponseFilter(String headerValue) {
            this.headerValue = headerValue;
        }

        @Override
        public ContainerRequestFilter getRequestFilter() {
            return null;
        }

        @Override
        public ContainerResponseFilter getResponseFilter() {
            return this;
        }

        @Override
        public ContainerResponse filter(ContainerRequest request, ContainerResponse response) {
            // attache Cache Control header to each response based on the annotation value
            response.getHttpHeaders().putSingle(HttpHeaders.CACHE_CONTROL, headerValue);
            return response;
        }
    }
}

Аннотация может выглядеть так:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CacheControlHeader {
    String value();
}

ResourceFilterFactory может быть зарегистрирован в вашем приложении, добавив следующий параметр init для определения сервлета Джерси в web.xml:

<init-param>
    <param-name>com.sun.jersey.spi.container.ResourceFilters</param-name>
    <param-value>package.name.CacheFilterFactory</param-value>
</init-param>

Ответ 2

На основе решения @martin-matula я создал две аннотации кэш-памяти. Один @NoCache без кэширования вообще и один @CacheMaxAge для конкретного кэширования. CacheMaxAge принимает два аргумента, поэтому вам не нужно самостоятельно вычислять секунды:

@GET
@CacheMaxAge(time = 10, unit = TimeUnit.MINUTES)
@Path("/awesome")
public String returnSomethingAwesome() {
    ...
}

В ResourceFilter теперь есть этот метод создания, который по умолчанию не мешает (поэтому другие механизмы кэширования продолжают работать):

@Override
public List<ResourceFilter> create(AbstractMethod am) {
    if (am.isAnnotationPresent(CacheMaxAge.class)) {
        CacheMaxAge maxAge = am.getAnnotation(CacheMaxAge.class);
        return newCacheFilter("max-age: " + maxAge.unit().toSeconds(maxAge.time()));
    } else if (am.isAnnotationPresent(NoCache.class)) {
        return newCacheFilter("no-cache");
    } else {
        return Collections.emptyList();
    }
}

private List<ResourceFilter> newCacheFilter(String content) {
    return Collections
            .<ResourceFilter> singletonList(new CacheResponseFilter(content));
}

Вы можете увидеть полное решение в своем блоге.

Спасибо за решение Martin!

Ответ 3

@Решение martin-matula не работает с JAX-RS 2.0/Jersey 2.x, поскольку ResourceFilterFactory и ResourceFilter были удалены. Решение можно адаптировать к JAX-RS 2.0 следующим образом.

Аннотация:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CacheControlHeader {
  String value();
}

DynamicFeature:

@Provider
public class CacheFilterFactory implements DynamicFeature {

  private static final CacheResponseFilter NO_CACHE_FILTER = 
          new CacheResponseFilter("no-cache");

  @Override
  public void configure(ResourceInfo resourceInfo, 
                        FeatureContext featureContext) {

    CacheControlHeader cch = resourceInfo.getResourceMethod()
            .getAnnotation(CacheControlHeader.class);
    if (cch == null) {
      featureContext.register(NO_CACHE_FILTER);
    } else {
      featureContext.register(new CacheResponseFilter(cch.value()));
    }
  }

  private static class CacheResponseFilter implements ContainerResponseFilter {
    private final String headerValue;

    CacheResponseFilter(String headerValue) {
      this.headerValue = headerValue;
    }

    @Override
    public void filter(ContainerRequestContext containerRequestContext,
                       ContainerResponseContext containerResponseContext) {
      // attache Cache Control header to each response
      // based on the annotation value                     
      containerResponseContext
              .getHeaders()
              .putSingle(HttpHeaders.CACHE_CONTROL, headerValue);
    }

  }
}

CacheFilterFactory необходимо зарегистрировать в Джерси. Я делаю это с помощью Dropwizard - using environment.jersey(). Register() - но в автономных системах я понимаю, что это можно сделать, например, разрешив Джерси сканировать ваши классы для аннотаций @Provider, указав следующее в вашем web.xml

<servlet>
    <servlet-name>my.package.MyApplication</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>

    <!-- Register resources and providers under my.package. -->
    <init-param>
        <param-name>jersey.config.server.provider.packages</param-name>
        <param-value>my.package</param-value>
    </init-param>
</servlet>

Подробнее о регистрации компонентов см. этот пост.