SpringMVC源码解析 - HandlerAdapter - @SessionAttributes注解处理
使用SpringMVC开发时,可以使用@SessionAttributes注解缓存信息.这样业务开发时,就不需要一次次手动操作session保存,读数据.
@Controller
@RequestMapping("telephones")
@SessionAttributes(value={"name","degree"},types={Double.class})
public class AttributeController {
// ...
}
SpringMVC实际处理时这部分时,主要涉及3个概念:
@SessionAttributes注解定义
注解信息初始化与容器SessionAttributesHanlder
session操作类SessionAttributeStore,虽然叫做store其实叫utils更贴切
SessionAttributesHanlder在初始化时扫描类里的方法,找出@SessionAttributes注解,并解析,然后直接保存到attributeNames和attributeTypes中,再更新knownAttributeNames.
保存的话,也可以在后期storeAttributes和isHandlerSessionAttribute进行.
在读取,清除时,都是以knownAttributeNames为索引,然后委托SessionAttributeStore处理.
SessionAttributeStore具体的session操作是委托WebRequest处理的,他主要是封装了一个属性前缀.
具体分析目录:
1. 各类定义科普:@SessionAttributes,SessionAttributesHandler,SessionAttributeStore
2. session属性的保存
3. session属性的读取
4. session属性的清除
1. 各类定义科普
1.1 先看@SessionAttributes注解的定义吧,这边就两种配置方式,一种是value定义属性的name,一种是types定义属性的类型,如Date
package org.springframework.web.bind.annotation; @Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface SessionAttributes { String[] value() default {};
Class[] types() default {};
}
1.2 SessionAttributesHandler
其实有点容器的味道,这个可以从attributeNames和attributeTypes属性可以看出.
同时也维护着对应属性的保存,读取与清除,这个看看构造发方法,retrieveAttributes,cleanupAttributes api就很清楚
当然具体对session的操作,是通过SessionAttributeStore处理的.
其中knownAttributeNames使用了ConcurrentHashMap,说明这边是线程安全的.
package org.springframework.web.method.annotation; public class SessionAttributesHandler {
// 属性名称,对应注解的value
private final Set<String> attributeNames = new HashSet<String>();
// 属性的数据类型,对应注解的types
private final Set<Class<?>> attributeTypes = new HashSet<Class<?>>();
// 缓存配置的attribute,包括根据类型扫描得到的属性,这样清除的时候,可以直接以这个为索引操作
// using a ConcurrentHashMap as a Set
private final Map<String, Boolean> knownAttributeNames = new ConcurrentHashMap<String, Boolean>(4);
// 具体操作session的utils,个人感觉名字起的有点古怪
private final SessionAttributeStore sessionAttributeStore; /**
* 实例化的时候,直接解析注解
*/
public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) {
Assert.notNull(sessionAttributeStore, "SessionAttributeStore may not be null.");
this.sessionAttributeStore = sessionAttributeStore; 22 SessionAttributes annotation = AnnotationUtils.findAnnotation(handlerType, SessionAttributes.class);
if (annotation != null) {
24 this.attributeNames.addAll(Arrays.asList(annotation.value()));
25 this.attributeTypes.addAll(Arrays.<Class<?>>asList(annotation.types()));
} for (String attributeName : this.attributeNames) {
29 this.knownAttributeNames.put(attributeName, Boolean.TRUE);
}
} public boolean hasSessionAttributes() {
return ((this.attributeNames.size() > 0) || (this.attributeTypes.size() > 0));
} /**
* 判断是否支持的同时直接缓存attributeName
*/
public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) {
if (this.attributeNames.contains(attributeName) || this.attributeTypes.contains(attributeType)) {
this.knownAttributeNames.put(attributeName, Boolean.TRUE);
return true;
}
else {
return false;
}
}
// 保存
public void storeAttributes(WebRequest request, Map<String, ?> attributes) {}
// 读取
public Map<String, Object> retrieveAttributes(WebRequest request) {}
Object retrieveAttribute(WebRequest request, String attributeName) {}
// 清除
public void cleanupAttributes(WebRequest request) {} }
1.3 SessionAttributeStore用于session中属性的操作
这边定义了一个接口,并提供默认实现.
接口很简单,直接定义了保存,读取,清除的接口
默认实现DefaultSessionAttributeStore,在实现接口的基础上,添加了一个前缀的概念用于区分,并委托WebRequest处理
SessionAttributeStore接口定义
package org.springframework.web.bind.support;
public interface SessionAttributeStore {
void storeAttribute(WebRequest request, String attributeName, Object attributeValue);
Object retrieveAttribute(WebRequest request, String attributeName);
void cleanupAttribute(WebRequest request, String attributeName); }
DefaultSessionAttributeStore其实主要是一个attributeNamePrefix的定义,并封装属性名称getAttributeNameInSession,其他的都是直接委托
package org.springframework.web.bind.support;
public class DefaultSessionAttributeStore implements SessionAttributeStore {
// 属性名称前缀
private String attributeNamePrefix = "";
// 封装属性名称
protected String getAttributeNameInSession(WebRequest request, String attributeName) {
return this.attributeNamePrefix + attributeName;
}
// ...
}
2. session属性的保存
保存可以分为两类操作,一个是实际保存属性,一个是标记是否已经处理.
实际保存的属性是:Set<String> attributeNames和Set<Class<?>> attributeTypes,在保存时,可以使用构造方法和storeAttributes.
标记是否已经处理是Map<String, Boolean> knownAttributeNames,保存时使用构造方法或者isHandlerSessionAttribute.storeAttributes在保存是也会调用isHandlerSessionAttribute.
knownAttributeNames在读取,清除时,都是作为索引使用的,特别是使用types进行注解时,没有这个做索引还真不方便.
package org.springframework.web.method.annotation; public class SessionAttributesHandler {
/**
* 实例化的时候,直接解析注解
*/
public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) {
Assert.notNull(sessionAttributeStore, "SessionAttributeStore may not be null.");
this.sessionAttributeStore = sessionAttributeStore; SessionAttributes annotation = AnnotationUtils.findAnnotation(handlerType, SessionAttributes.class);
if (annotation != null) {
13 this.attributeNames.addAll(Arrays.asList(annotation.value()));
14 this.attributeTypes.addAll(Arrays.<Class<?>>asList(annotation.types()));
} for (String attributeName : this.attributeNames) {
this.knownAttributeNames.put(attributeName, Boolean.TRUE);
}
} public boolean hasSessionAttributes() {
return ((this.attributeNames.size() > 0) || (this.attributeTypes.size() > 0));
} /**
* 判断是否支持的同时直接缓存attributeName
*/
public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) {
30 if (this.attributeNames.contains(attributeName) || this.attributeTypes.contains(attributeType)) {
31 this.knownAttributeNames.put(attributeName, Boolean.TRUE);
return true;
}
else {
return false;
}
}
/**
* Store a subset of the given attributes in the session. Attributes not
* declared as session attributes via {@code @SessionAttributes} are ignored.
* @param request the current request
* @param attributes candidate attributes for session storage
*/
public void storeAttributes(WebRequest request, Map<String, ?> attributes) {
for (String name : attributes.keySet()) {
Object value = attributes.get(name);
Class<?> attrType = (value != null) ? value.getClass() : null; if (isHandlerSessionAttribute(name, attrType)) {
this.sessionAttributeStore.storeAttribute(request, name, value);
}
}
} }
package org.springframework.web.bind.support;
public class DefaultSessionAttributeStore implements SessionAttributeStore {
public void storeAttribute(WebRequest request, String attributeName, Object attributeValue) {
String storeAttributeName = getAttributeNameInSession(request, attributeName);
5 request.setAttribute(storeAttributeName, attributeValue, WebRequest.SCOPE_SESSION);
}
// ...
}
3. session属性的读取
可以根据WebRequest读取对应的属性.
具体的处理逻辑:
迭代knownAttributeNames
委托sessionAttributeStore处理
而sessionAttributeStore是通过WebRequest.SCOPE_SESSION,委托WebRequest处理的
同时过滤出null的属性
这么描述逻辑感觉老是委托委托有那么点烦,但人Spring的确每层都封装了一个概念.
// SessionAttributesHandler
public Map<String, Object> retrieveAttributes(WebRequest request) {
Map<String, Object> attributes = new HashMap<String, Object>();
for (String name : this.knownAttributeNames.keySet()) {
Object value = this.sessionAttributeStore.retrieveAttribute(request, name);
if (value != null) {
attributes.put(name, value);
}
}
return attributes;
}
// DefaultSessionAttributeStore
public Object retrieveAttribute(WebRequest request, String attributeName) {
String storeAttributeName = getAttributeNameInSession(request, attributeName);
return request.getAttribute(storeAttributeName, WebRequest.SCOPE_SESSION);
}
4. session属性的清除
只有SessionStatus.setComplete后才会清除属性.
清楚属性的逻辑根据保存差不多,就不解释,直接看代码吧
// SessionAttributesHandler
public void cleanupAttributes(WebRequest request) {
for (String attributeName : this.knownAttributeNames.keySet()) {
this.sessionAttributeStore.cleanupAttribute(request, attributeName);
}
}
// DefaultSessionAttributeStore
public void cleanupAttribute(WebRequest request, String attributeName) {
String storeAttributeName = getAttributeNameInSession(request, attributeName);
request.removeAttribute(storeAttributeName, WebRequest.SCOPE_SESSION);
}
SpringMVC源码解析 - HandlerAdapter - @SessionAttributes注解处理的更多相关文章
- SpringMVC源码解析- HandlerAdapter - ModelFactory(转)
ModelFactory主要是两个职责: 1. 初始化model 2. 处理器执行后将modle中相应参数设置到SessionAttributes中 我们来看看具体的处理逻辑(直接充当分析目录): 1 ...
- SpringMVC源码解析- HandlerAdapter - ModelFactory
ModelFactory主要是两个职责: 1. 初始化model 2. 处理器执行后将modle中相应参数设置到SessionAttributes中 我们来看看具体的处理逻辑(直接充当分析目录): 1 ...
- SpringMVC源码解析- HandlerAdapter初始化
HandlerAdapter初始化时,主要是进行注解解析器初始化注册;返回值处理类初始化;全局注解@ControllerAdvice内容读取并缓存. 目录: 注解解析器初始化注册:@ModelAttr ...
- SpringMVC源码解析 - HandlerAdapter - HandlerMethodArgumentResolver
HandlerMethodArgumentResolver主要负责执行handler前参数准备工作. 看个例子,红色部分的id初始化,填充值就是它干的活: @RequestMapping(value ...
- springMVC源码解析--ViewResolver视图解析器执行(三)
之前两篇博客springMVC源码分析--ViewResolver视图解析器(一)和springMVC源码解析--ViewResolverComposite视图解析器集合(二)中我们已经简单介绍了一些 ...
- SpringMVC源码情操陶冶-AnnotationDrivenBeanDefinitionParser注解解析器
mvc:annotation-driven节点的解析器,是springmvc的核心解析器 官方注释 Open Declaration org.springframework.web.servlet.c ...
- SpringMVC源码解析
一:springmvc运行过程: 1. dispatcherServlet 通过 HandlerMapping 找到controller2. controller经过后台逻辑处理得到结果集modela ...
- 深入了解SpringMVC源码解析
Spring MVC源码解析 Spring MVC的使用原理其实是通过配置一个Servlet来接管所有的请求,所有的请求由这个Servlet来进行分发处理. 我们可以从web.xml里面看出这一点 & ...
- springMVC源码分析--HandlerAdapter(一)
HandlerAdapter的功能实际就是执行我们的具体的Controller.Servlet或者HttpRequestHandler中的方法. 类结构如下:
随机推荐
- js中caller和callee属性详解
一.caller属性返回一个对函数的引用,该函数调用了当前函数.functionName.callerfunctionName 对象是所执行函数的名称.说明对于函数来说,caller 属性只有在函数执 ...
- UOJ 55 【WC2014】紫荆花之恋——点分治+平衡树
题目:http://uoj.ac/problem/55 点分治.在点分树上每个点上用 splay 维护管辖的点的情况.做几次就重构点分树.TLE.只能过 20 分. #include<cstdi ...
- 使用C++生成1-33中的6个随机数,无重复
生成1-33中的6个随机数,无重复 ------------------------------------------------------------------------ 方法1.每生成 ...
- Bootstrap-Other:v2 教程
ylbtech-Bootstrap-Other:v2 教程 1.返回顶部 1. Bootstrap v2 教程 Bootstrap,来自 Twitter,是基于 HTML.CSS.JAVASCRIPT ...
- 利用spring的CommonsMultipartResolver上传文件
1.CommonsMultipartResolver是spring里面提供的一个上传方式,效率我不知道,但是加入spring容器管理还是很不错的. 2.先看依赖包pom.xml <project ...
- Docker系列05:docker镜像制作 &Docker file
1 什么是Dockerfile? Dockerfile是一个包含用于组合映像的命令的文本文档.可以使用在命令行中调用任何命令. Docker通过读取Dockerfile中的指令自动生成映像. dock ...
- IO在block级别的过程分析
btt User Guide在百度找了3天没找到,bing也不行,结果google第一页第5个结果就是. 可恶的GFW http://www.fis.unipr.it/doc/blktrace-1.0 ...
- 接口自动化(六)--使用QQ邮箱发送邮件
接口测试执行完发送一个邮件,这里使用QQ邮箱发送,先要拿到QQ邮箱授权码,方法自行百度 # coding=utf-8 import smtplib from email.mime.text impor ...
- Ubuntu无法sudo提权,报当前用户不在sudoers文件中错误
Ubuntu安装后默认root不能登陆系统,密码也是随机生成,其他用户使用root权限,可以使用sudo提权,前提是该用户在/etc/sudoers配置列表中. 但是有时用户名从/etc/sudoer ...
- Java匿名内部类的学习
新建一个抽象类或者接口,抽象类中只要有一个抽象方法就是抽象类,接口的定义是:里面的方法全部都是抽象方法,接口和抽象类不能直接实例化,需要子类来实现 /* 匿名内部类: 1.匿名内部类其实就是内部类的简 ...