https://github.com/foo4u/spring-mvc-cache-control

Spring MVC Cache Control is an extension to Spring MVC that aims to simplify implementing HTTP/1.1 Cache-Control headers for annotated MVC controllers.
https://github.com/foo4u/spring-mvc-cache-control

Last synced: about 2 months ago
JSON representation

Spring MVC Cache Control is an extension to Spring MVC that aims to simplify implementing HTTP/1.1 Cache-Control headers for annotated MVC controllers.

• Host: GitHub
• URL: https://github.com/foo4u/spring-mvc-cache-control
• Owner: foo4u
• License: apache-2.0
• Created: 2012-04-25T01:40:48.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-12-19T20:56:16.000Z (about 6 years ago)
• Last Synced: 2023-10-31T20:08:22.423Z (about 1 year ago)
• Language: Java
• Homepage:
• Size: 203 KB
• Stars: 77
• Watchers: 11
• Forks: 27
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spring MVC Cache Control

[![Maven Central][central-badge]][central] ![Build Status][status]

Spring MVC Cache Control is an extension to [Spring MVC][spring_mvc] that aims to simplify implementing HTTP/1.1 Cache-Control headers for annotated MVC controllers.

## Usage

### Add Spring MVC Cache Control to Your Project.

#### Maven Projects

``` 

    net.rossillo.mvc.cache

    spring-mvc-cache-control

    1.1.1-RELEASE

    compile

```

#### Gradle Projects

```

compile 'net.rossillo.mvc.cache:spring-mvc-cache-control:1.1.1-RELEASE'

```

### Configuration

Simply include `net.rossillo.spring.web.mvc.CacheControlHandlerInterceptor` in your Spring MVC configuration.

#### XML Web Application Context

```

    

```

_For XML contexts, this usually defaults to `${appName}-servlet.xml`_

#### Java Web Application Context

```

@Configuration

public class WebMvcConfig extends WebMvcConfigurerAdapter implements WebMvcConfigurer

{

    @Override

    public void addInterceptors(InterceptorRegistry registry)

    {

        registry.addInterceptor(new CacheControlHandlerInterceptor());

    }

}

```

### Annotate Your Controllers

Use the `@CacheControl` annotation on either (or both) type level `@Controller`s or method level `@RequestMapping`s. The handler interceptor will read the annotations and generate HTTP/1.1 compliant cache-control headers. For example:

```

@Controller

public final class DemoController {

	/**

	 * Public home page, cacheable for 5 minutes.

	 */

	@CacheControl(maxAge = 300)

	@RequestMapping({"/", "/home.do"})

	public String handleHomePageRequest(Model model) {

		...

	}

}

```

See our [spring-mvc-cache-control-demo][demo] project for full details.

## Building from Source

1. Clone the repository from GitHub:

		$ git clone git://github.com/foo4u/spring-mvc-cache-control

2. Navigate into the cloned repository directory:

		$ cd spring-mvc-cache-control

3. The project uses [Gradle][gradle] to build:

		$ ./gradlew build

## IDE Integration

### IntelliJ IDEA

IDEA 13+ natively support Gralde projects. Simply choose to import an existing project and select

the build.gradle file. Tick the checkbox to use the Gradle wrapper.

### Eclipse

To generate Eclipse metadata (.classpath and .project files), use the following Gradle task:

	$ ./gradlew eclipse

Once complete, you may then import the projects into Eclipse as usual:

	File -> Import -> Existing projects into workspace

## JavaDoc

Use the following Gradle task to build the JavaDoc

	$ ./gradlew javadoc

	

_Note: The result will be available in 'spring-mvc-cache-control/build/docs/javadoc'._

	

## Contributing

Contributions are always welcome. Fork the repository, create a topic branch and send a pull request.

[spring_mvc]: http://static.springsource.org/spring/docs/current/spring-framework-reference/html/mvc.html

[gradle]: http://gradle.org/

[demo]: https://github.com/foo4u/spring-mvc-cache-control/blob/master/spring-mvc-cache-control-demo/src/main/java/net/rossillo/spring/web/mvc/demo/DemoController.java

[status]: https://circleci.com/gh/foo4u/spring-mvc-cache-control.png?circle-token=2671c269c8ab085fb58617d58167ffe45bc70aac

[central]: https://maven-badges.herokuapp.com/maven-central/net.rossillo.mvc.cache/spring-mvc-cache-control

[central-badge]: https://maven-badges.herokuapp.com/maven-central/net.rossillo.mvc.cache/spring-mvc-cache-control/badge.svg