springMVC源码分析--@SessionAttribute用法及原理解析SessionAttributesHandler和SessionAttributeStore

最新推荐文章于 2024-11-24 23:21:28 发布
最新推荐文章于 2024-11-24 23:21:28 发布
阅读量214 收藏
点赞数
分类专栏： 开发
本文详细解析了Spring MVC框架中@SessionAttribute注解的工作原理及其应用场景，包括如何利用该注解实现跨请求的数据传递，并介绍了其内部实现机制。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

@SessionAttribute作用于处理器类上，用于在多个请求之间传递参数，类似于Session的Attribute，但不完全一样，一般来说@SessionAttribute设置的参数只用于暂时的传递，而不是长期的保存，长期保存的数据还是要放到Session中。

通过@SessionAttribute注解设置的参数有3类用法：

（1）在视图中通过request.getAttribute或session.getAttribute获取

（2）在后面请求返回的视图中通过session.getAttribute或者从model中获取

（3）自动将参数设置到后面请求所对应处理器的Model类型参数或者有@ModelAttribute注释的参数里面。

将一个参数设置到SessionAttribute中需要满足两个条件：

（1）在@SessionAttribute注解中设置了参数的名字或者类型

（2）在处理器中将参数设置到了model中。

@SessionAttribute用户后可以调用SessionStatus.setComplete来清除，这个方法只是清除SessionAttribute里的参数，而不会应用Session中的参数。

示例如下：注解@SessionAttribute中设置book、description和types={Double}，这样值会被放到@SessionAttribute中，但Redirect跳转时就可以重新获得这些数据了，接下来操作sessionStatus.setComplete()，则会清除掉所有的数据，这样再次跳转时就无法获取数据了。

  1. @Controller
  2. @RequestMapping("/book")
  3. @SessionAttributes(value ={"book","description"},types={Double.class})
  4. public class RedirectController {
  6. @RequestMapping("/index")
  7. public String index(Model model){
  8. model.addAttribute("book", "金刚经");
  9. model.addAttribute("description","不擦擦擦擦擦擦擦车");
  10. model.addAttribute("price", new Double("1000.00"));
  11. //跳转之前将数据保存到book、description和price中，因为注解@SessionAttribute中有这几个参数
  12. return "redirect:get.action";
  13. }
  15. @RequestMapping("/get")
  16. public String get(@ModelAttribute ("book") String book,ModelMap model,
  17. SessionStatus sessionStatus){
  18. //可以获得book、description和price的参数
  19. System.out.println(model.get("book")+";"+model.get("description")+";"+model.get("price"));
  20. sessionStatus.setComplete();
  21. return "redirect:complete.action";
  22. }
  24. @RequestMapping("/complete")
  25. public String complete(ModelMap modelMap){
  26. //已经被清除，无法获取book的值
  27. System.out.println(modelMap.get("book"));
  28. modelMap.addAttribute("book", "妹纸");
  29. return "sessionAttribute";
  30. }
  32. }
接下来我们分析一下@SessionAttribute的实现机制

第一步：我们首先要获取注解@SessionAttribute的值的情况，在RequestMappingHandlerAdapter中的getModelFactory中处理。

  1. protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
  2. HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
  4. //这里面对注解的@SessionAttribute的处理器做处理
  5. ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory);
  7. ........
  8. //会对@SessionAttribute操作的值进行处理
  9. modelFactory.initModel(webRequest, mavContainer, invocableMethod);
  10. ........
  12. return getModelAndView(mavContainer, modelFactory, webRequest);
  13. }
在getModelFactory中会创建@SessionAttribute的处理器SessionAttributeHandler

  2. private ModelFactory getModelFactory(HandlerMethod handlerMethod, WebDataBinderFactory binderFactory) {
  3. //创建SessionAttribute处理器
  4. SessionAttributesHandler sessionAttrHandler = getSessionAttributesHandler(handlerMethod);
  6. return new ModelFactory(attrMethods, binderFactory, sessionAttrHandler);
  7. }

getSessionAttributesHandler的操作就是获取或者初始化SessionAttributesHandler

  1. //已经获取过的SessionAttribute放到Map中，如果没有则需要初始化
  2. private SessionAttributesHandler getSessionAttributesHandler(HandlerMethod handlerMethod) {
  3. Class<?> handlerType = handlerMethod.getBeanType();
  4. SessionAttributesHandler sessionAttrHandler = this.sessionAttributesHandlerCache.get(handlerType);
  5. if (sessionAttrHandler == null) {
  6. synchronized (this.sessionAttributesHandlerCache) {
  7. sessionAttrHandler = this.sessionAttributesHandlerCache.get(handlerType);
  8. if (sessionAttrHandler == null) {
  9. //初始化sessionAttrHandler,并放到map中
  10. sessionAttrHandler = new SessionAttributesHandler(handlerType, sessionAttributeStore);
  11. this.sessionAttributesHandlerCache.put(handlerType, sessionAttrHandler);
  12. }
  13. }
  14. }
  15. return sessionAttrHandler;
  16. }

SessionAttributesHandler的构造函数中的操作如下，其实就是解析被@SessionAttribute注解的处理器，这样就完成了@SessionAttribute注解中设置的key的解析。

  1. public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) {
  2. Assert.notNull(sessionAttributeStore, "SessionAttributeStore may not be null.");
  3. this.sessionAttributeStore = sessionAttributeStore;
  4. //解析被@SessionAttribute注解的处理器
  5. SessionAttributes annotation = AnnotationUtils.findAnnotation(handlerType, SessionAttributes.class);
  6. if (annotation != null) {
  7. this.attributeNames.addAll(Arrays.asList(annotation.names()));
  8. this.attributeTypes.addAll(Arrays.asList(annotation.types()));
  9. }
  11. for (String attributeName : this.attributeNames) {
  12. this.knownAttributeNames.add(attributeName);
  13. }
  14. }

接下来我们看看springMVC对@SessionAttribute的处理操作，在ModelFactory.initModel会对@SessionAttribute的注解进行处理操作。

  1. protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
  2. HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
  4. //这里面对注解的@SessionAttribute的处理器做处理
  5. ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory);
  7. ........
  8. //会对@SessionAttribute操作的值进行处理
  9. modelFactory.initModel(webRequest, mavContainer, invocableMethod);
  10. ........
  12. return getModelAndView(mavContainer, modelFactory, webRequest);
  13. }

initModel其实做了两步操作，一是：获取上一次请求保存在SessionAttributeHandler中值，给这次请求的值用，二是将这次请求的处理结果可能会对上次的@SessionAttribute中的值进行改变的值进行保存给下一次请求使用。

  1. public void initModel(NativeWebRequest request, ModelAndViewContainer mavContainer, HandlerMethod handlerMethod)
  2. throws Exception {
  3. //获取所有的@SessionAttribute注解设置的key中值
  4. Map<String, ?> sessionAttributes = this.sessionAttributesHandler.retrieveAttributes(request);
  5. //将获取的值传递给下一个请求使用
  6. mavContainer.mergeAttributes(sessionAttributes);
  8. invokeModelAttributeMethods(request, mavContainer);
  10. //请求访问完之后将修改的值重新放到@SessionAttributeStore设置的key中
  11. for (String name : findSessionAttributeArguments(handlerMethod)) {
  12. if (!mavContainer.containsAttribute(name)) {
  13. Object value = this.sessionAttributesHandler.retrieveAttribute(request, name);
  14. if (value == null) {
  15. throw new HttpSessionRequiredException("Expected session attribute '" + name + "'");
  16. }
  17. mavContainer.addAttribute(name, value);
  18. }
  19. }
  20. }
sessionAttributesHandler.retrieveAttributes的操作是将request中值，按照注解@SessionAttribute中key取值处理，然后保存到attribute中，作为这次请求的传递值使用。

  1. public Map<String, Object> retrieveAttributes(WebRequest request) {
  2. Map<String, Object> attributes = new HashMap<String, Object>();
  3. //获取注解@SessionAttribute中设置的key
  4. for (String name : this.knownAttributeNames) {
  5. //如果设置的key有值则把它保存到attribute中，给跳转之后的请求使用
  6. Object value = this.sessionAttributeStore.retrieveAttribute(request, name);
  7. if (value != null) {
  8. attributes.put(name, value);
  9. }
  10. }
  11. return attributes;
  12. }
这样就完成了将值保存在SessionAttributeHandler中，这样下一次请求过来时依然可以从SessionAttributeHandler中获取上次的结果，完成了类似Session的实现机制，但明显感觉和Session不一样，所有的请求其值是保存在一个同一个SessionAttributeHandler中。


SessionAttributeHandler其实维持了一个Map结构来存取数据，功能主要有解析@SessionAttribute注解，get和set相关值，源码如下：

  1. public class SessionAttributesHandler {
  3. private final Set<String> attributeNames = new HashSet<String>();
  5. private final Set<Class<?>> attributeTypes = new HashSet<Class<?>>();
  7. private final Set<String> knownAttributeNames =
  8. Collections.newSetFromMap(new ConcurrentHashMap<String, Boolean>(4));
  10. private final SessionAttributeStore sessionAttributeStore;
  13. //构造函数，解析@SessionAttribute注解，将其设置额key等信息保存
  14. public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) {
  15. Assert.notNull(sessionAttributeStore, "SessionAttributeStore may not be null.");
  16. this.sessionAttributeStore = sessionAttributeStore;
  18. SessionAttributes annotation = AnnotationUtils.findAnnotation(handlerType, SessionAttributes.class);
  19. if (annotation != null) {
  20. this.attributeNames.addAll(Arrays.asList(annotation.names()));
  21. this.attributeTypes.addAll(Arrays.asList(annotation.types()));
  22. }
  24. for (String attributeName : this.attributeNames) {
  25. this.knownAttributeNames.add(attributeName);
  26. }
  27. }
  30. public boolean hasSessionAttributes() {
  31. return ((this.attributeNames.size() > 0) || (this.attributeTypes.size() > 0));
  32. }
  34. //判断类型
  35. public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) {
  36. Assert.notNull(attributeName, "Attribute name must not be null");
  37. if (this.attributeNames.contains(attributeName) || this.attributeTypes.contains(attributeType)) {
  38. this.knownAttributeNames.add(attributeName);
  39. return true;
  40. }
  41. else {
  42. return false;
  43. }
  44. }
  46. //保存
  47. public void storeAttributes(WebRequest request, Map<String, ?> attributes) {
  48. for (String name : attributes.keySet()) {
  49. Object value = attributes.get(name);
  50. Class<?> attrType = (value != null) ? value.getClass() : null;
  52. if (isHandlerSessionAttribute(name, attrType)) {
  53. this.sessionAttributeStore.storeAttribute(request, name, value);
  54. }
  55. }
  56. }
  58. //获取
  59. public Map<String, Object> retrieveAttributes(WebRequest request) {
  60. Map<String, Object> attributes = new HashMap<String, Object>();
  61. for (String name : this.knownAttributeNames) {
  62. Object value = this.sessionAttributeStore.retrieveAttribute(request, name);
  63. if (value != null) {
  64. attributes.put(name, value);
  65. }
  66. }
  67. return attributes;
  68. }
  70. //清除所有内容
  71. public void cleanupAttributes(WebRequest request) {
  72. for (String attributeName : this.knownAttributeNames) {
  73. this.sessionAttributeStore.cleanupAttribute(request, attributeName);
  74. }
  75. }
  77. //获取所有值
  78. Object retrieveAttribute(WebRequest request, String attributeName) {
  79. return this.sessionAttributeStore.retrieveAttribute(request, attributeName);
  80. }
Spring MVC 教程-@SessionAttribute详解
smart_an的专栏
08-06 1582
作者简介：大家好，我是哥，前中兴通讯、美团架构师，现某互联网公司联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬学习必须往深处挖，挖的越深，基础越扎实！本文将介绍SpringMVC中的@SessionAttribute注解。
详解SpringMVC的url-pattern配置及原理剖析
08-19
SpringMVC url-pattern 配置及原理剖析 SpringMVC 框架中的 url-pattern 配置是指在 web.xml 文件中对 DispatcherServlet 的配置，用于确定哪些 URL 请求将被 SpringMVC 框架所处理。在本文中，我们将详细介绍 ...
session.getAttribute
12-30
session.getAttribute在servlet中是一个很重要的方法。
从原理层面掌握@SessionAttributes的使用【享学Spring MVC】
架构师：通透，才能写出好代码！
08-04 4202
前言 该注解顾名思义，作用是将Model中的属性同步到session会话当中，方便在下一次请求中使用(比如重定向场景~)。 虽然说Session的概念在当下前后端完全分离的场景中已经变得不那么十分重要了，但是我仍旧强烈不建议各位扔掉这个知识点~ @SessionAttribute 这个注解只能标注在类上，用于在多个请求之间传递参数，类似于Session的Attribute。 但不完全一样：一般来说...
SpringMVC之@SessionAttributes
jamieblue1的博客
08-02 377
作用：在多个请求之间共用数据，用于在session范围内存储对象。 使用方法，@SessionAttributes只能使用在类定义上，可以在控制器类上标注一个 @SessionAttributes，配置需要在session中存放的数据范围，Spring MVC将存放在model中对应的数据暂存到HttpSession 中。 一、@SessionAttributes属性 value：用于指定存入...
Spring MVC之SessionAttributes
纳米的专栏
10-24 464
@SessionAttributes注解用在处理类上，用于在多个请求之间传递参数，一般来说该注解设置的参数只用于暂时保存，而不是长期保存。像身份验证等需要长期保存的参数还是应该保存在Session#serAttribute中。 看以下例子： @Controller @RequestMapping("/session") //条件1：在SessionAttributes设置需要传递的参数名...
SpringMVC基础：@ModelAttribute与@SessionAttribute解析
"SpringMVC基础文档讲解了@ModelAttribute和@SessionAttribute在处理HTTP请求和管理模型数据中的应用。文档详细阐述了如何利用@ModelAttribute注解在目标方法执行前操作模型数据，以及两种向模型中存入数据的方式。...
SpringMVC ---- HelloWorld ---- 代码
09-18
SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- Hello...
source-code-springMVC:SpringMVC源码查看-查看
03-24
SpringMVC是Spring框架的一部分，专门用于处理Web应用程序的请求和响应。它是基于模型-视图-控制器（MVC）设计模式的，提供了一个灵活且强大的机制来组织和构建Web应用。在这个“source-code-springMVC”项目中，...
Spring MVC中的@SessionAttributes注解
qiangzhogshou的博客
02-26 383
@SessionAttributes注解用于：将响应方法中处理请求时添加的与该注解匹配的数据添加到session中。 1、该注解只能应用在类上 2、这种添加方式在Map的put方法、Model和ModelMap的addAttribute方法或ModelAndView的addObject方法中有效。 3、@SessionAttributes值：可以通过value或names注解属性指定哪些属性放到S...
@SessionAttribute
百般回首曾经的相遇，留下的只是一缕残忆
07-14 2370
HttpSession 与 @SessionAttribute @SessionAttribute(“emailcode”) String sessionEmailCode @SessionAttribute 在使用时 session 中必须存在对应元素， 例如：@SessionAttribute(“emailcode”) String sessionEmailCode，若无"emailcode"...
sessionAttribute
不以人人的意志为转义乃天道
11-10 885
@SessionAttribute与@SessionAttributes
热门推荐
csyy140225的博客
09-07 1万+
@SessionAttributes @SessionAttributes作用于处理器类上，用于在多个请求之间传递参数，类似于Session的Attribute，但不完全一样，一般来说@SessionAttributes设置的参数只用于暂时的传递，而不是长期的保存，长期保存的数据还是要放到Session中。 通过@SessionAttributes注解设置的参数有3类用法： （1）在视图中通...
SpringMVC源码分析-HandlerAdapter(5)-SessionAttributesHandler组件分析
BraveWangDev
07-08 365
SessionAttributesHandler组件分析 SessionAttributesHandler介绍 用于处理@SessionAttributes注释的参数 具体存储工由又SessionAttributeStore完成 SessionAttributeStore并不是保存数据的容器,而是保存数据的一个工具类 保存数据的容器默认使用Session, 也可以使用其他容器,重写Sessio...
@SessionAttribute注解
xzy的博客
12-07 3977
@SessionAttribute注解的用法 @SessionAttributes注解只能使用在类的定义上，此注解源码如下图 @SessionAttributes(types={User.class, Dept.class}) 会将model中所有类型为 User和Dept的属性添加到会话中即session作用域中。 @SessionAttributes(value={“user1”, “user2”}) 会将model中属性名为user1和user2的属性添加到会话中即session作用域中。 使用@S
Spring学习笔记_48——@SessionAttribute
最新发布
LuckyLay的博客
11-24 948
注解作用于处理器类上，它允许开发者有选择地指定哪些模型属性需要存储到HTTP会话（Session）中，以便在多个请求之间共享这些数据。这通常用于需要跨多个页面或请求保持数据一致性的场景，如多步骤表单处理或向导式用户界面。注解指定属性名称就可以直接从当前Session的作用域中获取指定属性名称的值，Model：用于在控制器和视图之间传递数据。Session：用于在多个请求之间保持状态信息，数据存储在服务器端。Cookie：用于在客户端浏览器中存储少量数据，数据存储在客户端。
SpringMVC框架----SessionAttribute注解
Java硬件工程师的博客
08-14 2186
作用： 用于多次执行控制器方法间的参数共享。 属性： value：用于指定存入的属性名称 type：用于指定存入的数据类型 如果是把一个数据存到session这个域对象中，session域称为会话域。它可以经过多次请求，存数据，请数据，session都可以用。 需求：在request域对象中存入一个值，存入之后，跳转到success成功页面，在成功页面中，把request值取出来 要存入request域，我们想获得原生的servletAPI，可以在方法上直接加一个 public String testS
@SessionAttribute使用详解
weixin_30341735的博客
12-24 681
@SessionAttribute使用详解 @ModelAttribute注解作用在方法上或者方法的参数上，表示将被注解的方法的返回值或者是被注解的参数作为Model的属性加入到Model中，然后Spring框架自会将这个Model传递给ViewResolver。Model的生命周期只有一个http请求的处理过程，请求处理完后，Mod...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值