Spring MVC Cookie example
In this post we will see how to access and modify http cookies of a webpage in Spring MVC framework.
Read Http Cookie in Spring MVC
Spring 3 MVC framework provides a very useful annotation @CookieValue
to
access data set within any http cookie. This annotation can be leverage to fetch the cookie value without getting into hassle of fetching cookies from http request and iterating through the list.
@CookieValue annotation can be used within Controller argument. It automatically bind the cookie value with method argument.
import
import
//.. @RequestMapping ( "/hello.html" ) public
@CookieValue ( "foo" ) //.. } |
In above code snippet we defined a controller method hello() which is mapped to URL /hello.html. Also we bind the parameter String
using
fooCookie@CookieValue
annotation.
When spring maps the request, it checks http for cookie with name “foo
”
and bind its value to String fooCookie
.
No boiler plate code to iterate though list of cookies, just one line will do it all.
One thing worth noting here is that we have not defined any default value for the String fooCookie. If Spring does not find the cookie with name “foo” in http request, it will throw an exception: java.lang.IllegalStateException:
Missing cookie value ‘foo’ of type
java.lang.IllegalStateException: at at at at at at |
In order to resolve this we must add default value to @CookieValue annotation so if Spring doesn’t find http cookie with that name, it binds the parameter with default value. Following is syntax for that:
import
import
//.. @RequestMapping ( "/hello.html" ) public
@CookieValue (value "foo" , "hello" ) //.. } |
We used value and defaultValue attribute of @CookieValue annotation. Thus if Spring doesn’t find any cookie with name ‘foo’ in http request, it binds the fooCookie parameter with value ‘hello’.
Setting Http Cookie in Spring MVC
We just saw how we can use @CookieValue annotation to auto-magically bind cookie value with a spring controller parameter.
Now let us see how to set a cookie in a Spring MVC based application. For this actually we will use HttpServletResponse class’s method addCookie(). Spring does not provide any fancy way to set http cookie because it’s already taken care by servlets HttpServletResponse
class. All you need to do it to use just one method addCookie(). Spring MVC can be used to get the response
object.
Once we have this object it’s just piece of cake.
Consider below code:
import
import
import
import
//.. @RequestMapping ( "/hello.html" ) public
response.addCookie( new
"foo" , "bar" )); //.. } //.. |
In above code we just bind HttpServletResponse object to Spring method controller and used itsaddCookie
method
to save new Cookie. That’s it. One line of code will do it. One thing worth noticing here is that you can set the cookie expire time using setMaxAge method on Cookie class.
Cookie new
"foo" , "bar" ); //bake foo.setMaxAge( 1000 ); //set response.addCookie(foo); //put |
Complete Tutorial
Now we know the concept, let us use it and create a Spring MVC based application to track page hits. We will use Cookie to track page hit counter.
For this tutorial I will be using following tools and technologies:
- Spring MVC 3.2.6.RELEASE
- Java 6
- Eclipse
- Maven 3
Following is the project structure.
Create and copy following file contents in the project structure.
Maven configuration: pom.xml
< project
= "http://maven.apache.org/POM/4.0.0"
= "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 > < modelVersion >4.0.0</ modelVersion > < groupId >net.viralpatel.spring</ groupId > < artifactId >Spring_Cookie_example</ artifactId > < packaging >war</ packaging > < version >1.0.0-SNAPSHOT</ version > < name >SpringMVCCookie</ name > < properties > < org.springframework.version >3.2.6.RELEASE</ org.springframework.version > < project.build.sourceEncoding >UTF-8</ project.build.sourceEncoding > < compileSource >1.6</ compileSource > </ properties > < dependencies > < dependency > < groupId >javax.servlet</ groupId > < artifactId >servlet-api</ artifactId > < version >2.5</ version > < scope >provided</ scope > </ dependency > <!-- < dependency > < groupId >org.springframework</ groupId > < artifactId >spring-web</ artifactId > < version >${org.springframework.version}</ version > </ dependency > < dependency > < groupId >org.springframework</ groupId > < artifactId >spring-webmvc</ artifactId > < version >${org.springframework.version}</ version > </ dependency > <!-- < dependency > < groupId >taglibs</ groupId > < artifactId >standard</ artifactId > < version >1.1.2</ version > </ dependency > < dependency > < groupId >javax.servlet</ groupId > < artifactId >jstl</ artifactId > < version >1.1.2</ version > </ dependency > </ dependencies > < build > < finalName >springcookie</ finalName > </ build > < profiles > </ profiles > </ project > |
Maven configuration is simple. We just need Spring MVC and JSTL dependency.
Deployment description: web.xml
<? xml
= "1.0"
= "UTF-8" ?> < web-app
= "http://www.w3.org/2001/XMLSchema-instance" xmlns = "http://java.sun.com/xml/ns/javaee"
= "http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation = "http://java.sun.com/xml/ns/javaee id = "WebApp_ID"
= "2.5" > < display-name >Spring display-name > < welcome-file-list > < welcome-file >hello.htm</ welcome-file > </ welcome-file-list > < servlet > < servlet-name >spring</ servlet-name > < servlet-class >org.springframework.web.servlet.DispatcherServlet</ servlet-class > < load-on-startup >1</ load-on-startup > </ servlet > < servlet-mapping > < servlet-name >spring</ servlet-name > < url-pattern >*.htm</ url-pattern > </ servlet-mapping > </ web-app > |
Web.xml is quite simple too. We just need to configure Spring’s DispatcherServlet
with *.htmurl
pattern.
Spring Configuration: spring-servlet.xml
<? xml
= "1.0"
= "UTF-8" ?> < beans
= "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:context = "http://www.springframework.org/schema/context" xmlns:mvc = "http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/context http://www.springframework.org/schema/mvc < context:annotation-config
< context:component-scan
= "net.viralpatel.spring"
< bean
= "viewResolver" class = "org.springframework.web.servlet.view.InternalResourceViewResolver" > < property
= "viewClass" value = "org.springframework.web.servlet.view.JstlView"
< property
= "prefix"
= "/WEB-INF/jsp/"
< property
= "suffix"
= ".jsp"
</ bean > </ beans > |
In spring-servlet.xml
we
just defined component scan to load @Controller classes. Also we defined a view resolver that will points to JSPs within /WEB-INF/jsp/ folder.
JSP file: hello.jsp
<%@ < html > < head > < title >Spring title > </ head > < body > < h1 >Spring h1 > Page b > b > </ body > </ html > |
This JSP displays the hit counter. It prints the counter value using tag${cookie.hitCounter.value}
.
Spring Controller: HelloController.java
package
import
import
import
import
import
@Controller public
@RequestMapping (value "/hello.htm" ) public
@CookieValue (value "hitCounter" , "0" ) HttpServletResponse // hitCounter++; // Cookie new
"hitCounter" , response.addCookie(cookie); // return
; } } |
The logic to fetch hit counter from cookie and set it back is written in HelloController. We used@CookieValue
annotation
to map hitCounter
cookie
to Long
parameter. Notice how we mapped
hitCounterjava.lang.Long
value.
Spring automatically converts String from Cookie to Long value.
Demo
Open your favorite web browser and point to below URL:
http://localhost:8080/Spring_Cookie_Example/hello.htm
Refresh page 2-3 times and see how hit counter value is incremented.
Download Source Code
Spring_Cookie_Example.zip
(8 KB)
Related Articles
- Spring
@RequestHeader Annotation example - Spring
MVC Exception Handling using @ControllerAdvice annotation - Spring
3 MVC Interceptor tutorial with example - Spring
MVC Flash Attribute tutorial with example - Change
spring-servlet.xml Filename (Spring Web Contenxt Configuration Filename) - Spring
MVC Multiple File Upload example - Spring
3 MVC: Handling Forms in Spring 3.0 MVC
Spring MVC Cookie example的更多相关文章
- spring mvc +cookie+拦截器功能 实现系统自动登陆
先看看我遇到的问题: @ResponseBody @RequestMapping("/logout") public Json logout(HttpSession session ...
- spring mvc 用cookie和拦截器实现自动登录(/免登录)
Cookie/Session机制详解:http://blog.csdn.net/fangaoxin/article/details/6952954 SpringMVC记住密码功能:http://blo ...
- Spring学习笔记之五----Spring MVC
Spring MVC通常的执行流程是:当一个Web请求被发送给Spring MVC Application,Dispatcher Servlet接收到这个请求,通过HandlerMapping找到Co ...
- Http请求中Content-Type讲解以及在Spring MVC中的应用
引言: 在Http请求中,我们每天都在使用Content-type来指定不同格式的请求信息,但是却很少有人去全面了解content-type中允许的值有多少,这里将讲解Content-Type的可用值 ...
- Spring MVC 学习总结(一)——MVC概要与环境配置
一.MVC概要 MVC是模型(Model).视图(View).控制器(Controller)的简写,是一种软件设计规范,用一种将业务逻辑.数据.显示分离的方法组织代码,MVC主要作用是降低了视图与业务 ...
- spring笔记2 spring MVC的基础知识2
2,spring MVC的注解驱动控制器,rest风格的支持 作为spring mvc的明星级别的功能,无疑是使得自己的code比较优雅的秘密武器: @RequestMapping处理用户的请求,下面 ...
- spring笔记1 spring MVC的基础知识1
1,spring MVC的流程 优秀的展现层框架-Spring MVC,它最出彩的地方是注解驱动和支持REST风格的url. 流程编号 完成的主要任务 补充 1 用户访问web页面,发送一个htt ...
- spring mvc基础配置
web.xml 配置: <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class> ...
- 使用Spring MVC 实现 国际化
使用Spring MVC 实现 国际化 博客分类: Spring 1. 版本 Spring 3.1 2. 配置 LocaleResolver LocaleResolver 是指 ...
随机推荐
- org.tigris.subversion.javahl.ClientException: Attempted to lock an already-locked dir svn: Working c
Eclipse插入svn提交出现:org.tigris.subversion.javahl.ClientException: Attempted to lock an already-locked d ...
- (记录前面算过的后面仍然会用的数减小复杂度)A - AC Me
Description Ignatius is doing his homework now. The teacher gives him some articles and asks him to ...
- 新安装的linux(linux mint 或则ubuntu)系统中安装postgresql-xc安装的包
一:./configure的时候1,gcc的处理:sudo apt-get install clang && rvm install 1.9.3 --with-gcc=clang2,缺 ...
- BZOJ 1096: [ZJOI2007]仓库建设( dp + 斜率优化 )
dp(v) = min(dp(p)+cost(p,v))+C(v) 设sum(v) = ∑pi(1≤i≤v), cnt(v) = ∑pi*xi(1≤i≤v), 则cost(p,v) = x(v)*(s ...
- USACO March. 2012
Connect the Cows Times17 水题 Landscaping Flowerpot Tractor 广搜 搜到边界就可以终止了 没什么难度 #include <stdio.h&g ...
- hibernate报错
报错二:java.lang.ExceptionInInitializerError java.lang.ExceptionInInitializerError at com.java1234.serv ...
- d3.js入门1:安装配置
D3 是当前流行的数据可视化工具,通过本文能有对 D3 有一个初步认识. 1. D3 是什么 D3 的全称是(Data-Driven Documents),顾名思义可以知道是一个被数据驱动的文档.听名 ...
- excel unixtime与北京时间互转
unixtime转北京时间,在单元格内输入:=INT((B2-70*365-19)*86400-8*3600) *.要设置一下单元格格式为y-m-d h:m:s才会正确显示 北京时间转unixti ...
- G-Sensor 校准标准
在桌面上水平平,自己的前表面. 此时Z轴应+值,和值至9.8大约,x.y轴应0值大约.它是平行于主体x轴,固定的左,提起右侧时,,x轴数值它应0开始增加.直到垂直时,+9.8大约. 为y轴.下面固定. ...
- Case of the Zeros and Ones
Time Limit:1000MS Memory Limit:262144KB 64bit IO Format:%I64d & %I64u Description Andrew ...