Comment définir les en-têtes de cache dans Spring MVC ?

Question

Dans un contrôleur Spring MVC basé sur des annotations, quelle est la meilleure façon de définir les en-têtes de cache pour un chemin spécifique ?

Answer 1

Je viens de rencontrer le même problème, et j'ai trouvé une bonne solution déjà fournie par le framework. Le site org.springframework.web.servlet.mvc.WebContentInterceptor vous permet de définir un comportement de mise en cache par défaut, plus des surcharges spécifiques au chemin (avec le même comportement de path-matcher utilisé ailleurs). Les étapes pour moi ont été les suivantes :

1. Assurez-vous que mon instance de org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter n'a pas la propriété "cacheSeconds" définie.

2. Ajouter une instance de 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>

Après ces changements, les réponses sous /foo incluaient des en-têtes pour décourager la mise en cache, les réponses sous /cache/me incluaient des en-têtes pour encourager la mise en cache, et les réponses sous /cache/agnostic n'incluaient aucun en-tête lié à la mise en cache.

---

Si vous utilisez une configuration purement 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);
  }
}

Voir aussi : http://docs.spring.io/spring-security/site/docs/current/reference/html/headers.html

Answer 2

La réponse est très simple :

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

Le code ci-dessus montre exactement ce que vous voulez obtenir. Vous devez faire deux choses. Ajouter "final HttpServletResponse response" comme paramètre. Et ensuite mettre le header Cache-Control à no-cache.

Answer 3

org.springframework.web.servlet.support.WebContentGenerator qui est la classe de base de tous les contrôleurs de Spring, comporte un certain nombre de méthodes traitant des en-têtes de cache :

/* 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);

Ils peuvent être invoqués dans votre contrôleur avant la génération du contenu ou spécifiés comme propriétés du bean dans le contexte de Spring.

Answer 4

En commençant par Printemps 4.2 vous pouvez le faire :

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 est un constructeur avec de nombreuses options de configuration, voir JavaDoc

Answer 5

Vous pouvez utiliser un intercepteur Handler et utiliser la méthode postHandle qu'il fournit :

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) 

il suffit alors d'ajouter un en-tête comme suit dans la méthode :

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