web-dev-qa-db-ja.com

Spring MVCでキャッシュヘッダーをどのように設定しますか？

アノテーションベースのSpring MVCコントローラーでは、特定のパスにキャッシュヘッダーを設定する好ましい方法は何ですか？

javaspringcachingspring-mvc
60
D. Wroblewski

org.springframework.web.servlet.support.WebContentGenerator 、これはすべてのSpringコントローラーの基本クラスであり、キャッシュヘッダーを処理するメソッドがかなりあります。

/* Set whether to use the HTTP 1.1 cache-control header. Default is "true".
 * <p>Note: Cache headers will only get applied if caching is enabled
 * (or explicitly prevented) for the current request. */
public final void setUseCacheControlHeader();

/* Return whether the HTTP 1.1 cache-control header is used. */
public final boolean isUseCacheControlHeader();

/* Set whether to use the HTTP 1.1 cache-control header value "no-store"
 * when preventing caching. Default is "true". */
public final void setUseCacheControlNoStore(boolean useCacheControlNoStore);

/* Cache content for the given number of seconds. Default is -1,
 * indicating no generation of cache-related headers.
 * Only if this is set to 0 (no cache) or a positive value (cache for
 * this many seconds) will this class generate cache headers.
 * The headers can be overwritten by subclasses, before content is generated. */
public final void setCacheSeconds(int seconds);

これらは、コンテンツ生成の前にコントローラー内で呼び出すか、SpringコンテキストでBeanプロパティとして指定できます。

19
ChssPly76

私はちょうど同じ問題に遭遇し、フレームワークによってすでに提供されている良い解決策を見つけました。 org.springframework.web.servlet.mvc.WebContentInterceptorクラスを使用すると、デフォルトのキャッシュ動作に加えて、パス固有のオーバーライドを定義できます（他の場所で使用されるのと同じパスマッチャーの動作）。私の手順は次のとおりです。

  1. org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapterのインスタンスに「cacheSeconds」プロパティが設定されていないことを確認します。

  2. WebContentInterceptorのインスタンスを追加します。

    <mvc:interceptors>
...
<bean class="org.springframework.web.servlet.mvc.WebContentInterceptor" p:cacheSeconds="0" p:alwaysUseFullPath="true" >
    <property name="cacheMappings">
        <props>
            <!-- cache for one month -->
            <prop key="/cache/me/**">2592000</prop>
            <!-- don't set cache headers -->
            <prop key="/cache/agnostic/**">-1</prop>
        </props>
    </property>
</bean>
...
</mvc:interceptors>

これらの変更後、/ fooの下の応答にはキャッシュを抑止するヘッダーが含まれ、/ cache/meの下の応答にはキャッシュを促進するヘッダーが含まれ、/ cache/agnosticの下の応答にはキャッシュ関連ヘッダーが含まれませんでした。

純粋なJava設定を使用する場合：

@EnableWebMvc
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
  /* Time, in seconds, to have the browser cache static resources (one week). */
  private static final int BROWSER_CACHE_CONTROL = 604800;

  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry
     .addResourceHandler("/images/**")
     .addResourceLocations("/images/")
     .setCachePeriod(BROWSER_CACHE_CONTROL);
  }
}

参照： http://docs.spring.io/spring-security/site/docs/current/reference/html/headers.html

66
Eric R. Rath

答えは非常に簡単です。

@Controller
public class EmployeeController {

    @RequestMapping(value = "/find/employer/{employerId}", method = RequestMethod.GET)
    public List getEmployees(@PathVariable("employerId") Long employerId, final HttpServletResponse response) {
        response.setHeader("Cache-Control", "no-cache");
        return employeeService.findEmployeesForEmployer(employerId);
    }

}
30
goroncy

Spring 4.2 から始めて、これを行うことができます：

import org.springframework.http.CacheControl;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import Java.util.concurrent.TimeUnit;

@RestController
public class CachingController {
    @RequestMapping(method = RequestMethod.GET, path = "/cachedapi")
    public ResponseEntity<MyDto> getPermissions() {

        MyDto body = new MyDto();

        return ResponseEntity.ok()
            .cacheControl(CacheControl.maxAge(20, TimeUnit.SECONDS))
            .body(body);
    }
}

CacheControlオブジェクトは、多くの構成オプションを持つビルダーです。 JavaDoc を参照してください

16
Gian Marco Gherardi

ハンドラーインターセプターを使用し、それによって提供されるpostHandleメソッドを使用できます。

http://static.springsource.org/spring/docs/2.0.x/api/org/springframework/web/servlet/HandlerInterceptor.html

postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)

次に、メソッドに次のようにヘッダーを追加します。

response.setHeader("Cache-Control", "no-cache");
10
Jon

これに注釈を定義することができます：@CacheControl(isPublic = true, maxAge = 300, sMaxAge = 300)、そしてこの注釈をSpring MVCインターセプターでHTTPヘッダーにレンダリングします。またはそれを動的に行う：

int age = calculateLeftTiming();
String cacheControlValue = CacheControlHeader.newBuilder()
      .setCacheType(CacheType.PUBLIC)
      .setMaxAge(age)
      .setsMaxAge(age).build().stringValue();
if (StringUtils.isNotBlank(cacheControlValue)) {
    response.addHeader("Cache-Control", cacheControlValue);
}

意味はここにあります： 优雅的Builder模式

ところで：Spring MVCには、キャッシュ制御（Google WebContentInterceptorまたはCacheControlHandlerInterceptorまたはCacheControl）のサポートが組み込まれていることがわかりました。

4
arganzheng

私はこれが本当に古いものであることを知っていますが、グーグルの人はこれが役立つかもしれません：

@Override
protected void addInterceptors(InterceptorRegistry registry) {

    WebContentInterceptor interceptor = new WebContentInterceptor();

    Properties mappings = new Properties();
    mappings.put("/", "2592000");
    mappings.put("/admin", "-1");
    interceptor.setCacheMappings(mappings);

    registry.addInterceptor(interceptor);
}
3
realcnbs

コントローラーで、応答ヘッダーを直接設定できます。

response.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
response.setHeader("Pragma", "no-cache");
response.setDateHeader("Expires", 0);
2
hakunami

WebContentInterceptorが最も簡単な方法であることがわかりました。

@Override
public void addInterceptors(InterceptorRegistry registry)
{
    WebContentInterceptor interceptor = new WebContentInterceptor();
    interceptor.addCacheMapping(CacheControl.noCache(), "/users", "admin");
    registry.addInterceptor(interceptor);
}
1
Liang Zhou

AnnotationMethodHandlerAdapterを拡張して、カスタムキャッシュコントロールアノテーションを探し、それに応じてhttpヘッダーを設定できます。

1
user281581