WEB 应用通常会引入 Session用来在服务端和客户端之间保存一系列动作/消息的状态比如网上购物维护 user 登录信息直到 user 退出在 user 登录后Session 周期里有很多 action 都需要从 Session 中得到 user再验证身份权限或者进行其他的操作这其中就会涉及到程序去访问 Session属性的问题在java中Servlet 规范提供了 HttpSession对象来满足这种需求开发人员可以从 HttpServletRquest对象得到 HttpSession再从HttpSession中得到状态信息
还是回到购物车的例子假设在 controller 某个方法（本文简称为action）中我们要从HttpSession中取到user对象如果基于Servlet标准的代码会是这样的
Java代码
public void doGet(HttpServletRequest req HttpServletResponse resp) throws ServletException IOException {
User user = (User)reqgetSession()getAttribute(currentUser);
//
}
这样的代码在传统的Servlet程序中是很常见的因为使用了 Servlet API从而对 Servlet API产生依赖这样如果我们要测试 action我们就必须针对 HttpServletRequestHttpServletResponse 和 HttpSession类提供 mock 或者 stub 实现当然现在已经有很多开源的 Servlet 测试框架帮助我们减轻这个痛苦包括 Spring 就自带了对了这些类的 stub 实现但那还是太冗繁琐碎了那有没有比较好的办法来让我们的 controller 更 POJO让我们的 action 脱离 Servlet API 依赖更有益于测试和复用呢？我们来看看在 Spring 中访问 Session 属性的几种解决方案并将在本博的后续文章继续探究解决方案选择背后的深层含义
（一）通过方法参数传入HttpServletRequest对象或者HttpSession对象
笔者的前一篇文章已经简单介绍了Spring的annotation使得 controller 摆脱了 Servlet API 对方法参数的限制这里就不赘述了有兴趣的同学可以参考<a >这里</a>Spring对annotationed的 action 的参数提供自动绑定支持的参数类型包括 Servlet API 里面的 Request/Response/HttpSession（包含RequestResponse在Servlet API 中声明的具体子类）于是开发人员可以通过在 action 参数中声明 Request 对象或者 HttpSession 对象来让容器注入相应的对象
action 的代码如下
Java代码
@RequestMapping
public void hello(HttpSession session){
User user = (User)sessiongetAttribute(currentUser);
//
}
优点
程序中直接得到底层的 Request/HttpSession 对象直接使用 Servlet API 规范中定义的方法操作这些对象中的属性直接而简单
action 需要访问哪些具体的 Session 属性是由自己控制的真正精确到 Session 中的每个特定属性
不足
程序对 Servlet API 产生依赖虽然 controller 类已经不需要从 HttpServlet 继承但仍需要 Servlet API 才能完成编译运行乃至测试
暴露了底层 Servlet API暴露了很多并不需要的底层方法和类开发人员容易滥用这些 API
（二）通过定制拦截器（Interceptor）在controller类级别注入需要的User对象
Interceptor 是 Spring 提供的扩展点之一SpringMVC 会在 handle 某个 request 前后调用在配置中定义的 Interceptor 完成一些切面的工作比如验证用户权限处理分发等类似于 AOP那么我们可以提取这样一个横切点在 SpringMVC 调用 action 前在 Interceptor 的 preHandle 方法中给 controller 注入 User 成员变量使之具有当前登录的 User 对象
此外还需要给这些特定 controller 声明一类 interface比如 IUserAware这样开发人员就可以只针对这些需要注入 User 对象的 controller 进行注入增强
IUserAware 的代码
Java代码
public interface IUserAware {
public void setUser();
}
controller 的代码
Java代码
@Controller
public GreetingController implements IUserAware {
private User user;
public void setUser(User user){
thisuser = user;
}
@RequestMapping
public void hello(){
//usersayHello();
}
//
}
Interceptor 的代码
Java代码
public class UserInjectInterceptor extends HandlerInterceptorAdapter {
@Override
public boolean preHandle(HttpServletRequest httpServletRequest HttpServletResponse httpServletResponse Object handler) throws Exception {
if (handlerisAssignableFrom(IUserAware)){
User user = (User)()getAttribute(currentUser);
IUserAware userAware = (IUserAware) handler;
userAwaresetUser(user);
}
return superpreHandle(httpServletRequest httpServletResponse handler);
}
//
}
为了让 SpringMVC 能调用开发人员定义的 Interceptor我们还需要在 SpringMVC 配置文件中声明该 Interceptor比如
Xml代码
<bean class=orgspringframeworkwebservletmvcannotationDefaultAnnotationHandlerMapping>
<property name=interceptors>
<list>
<ref bean=userInjectInterceptor/><! userInjectInterceptor bean 的声明省略>
</list>
</property>
</bean>
优点
对 Servlet API 的访问被移到了自 SpringMVC API 扩展的 Interceptorcontroller 不需要关心 User 如何得到
开发人员可以通过随时添加或移除 Interceptor 来完成对不同参数在某一类型 controller 上的注入
controller 的 User 对象通过外界注入测试时开发人员可以很容易地注入自己想要的 User 对象
controller 类去掉了对 Servlet API 的依赖更 POJO 和通用
controller 类是通过对 interface 的声明来辅助完成注入的并不存在任何继承依赖
不足
SpringMVC 对 controller 默认是按照单例（singleton）处理的在 controller 类中添加一个成员变量可能会引起多线程的安全问题
因为 User 对象是定义为 controller 的成员变量而且是通过 setter 注入进来在测试时需要很小心地保证对controller 注入了 User 对象否则有可能我们拿到的就不一定是一个好公民（Good Citizen）
其实一言而蔽之这些不足之所以出现是因为我们把某个 action 级别需要的 User 对象上提到 controller 级别破坏了 the convention of stateless for controller classes而 setter 方式的注入又带来了一些隐含的繁琐和不足当然我们可以通过把 controller 声明为prototype来绕过 stateless 的约定也可以保证每次 new 一个 controller 的同时给其注入一个 User 对象但是我们有没有更简单更 OO 的方式来实现呢？答案是有的
（三）通过方法参数处理类（MethodArgumentResolver）在方法级别注入User对象
正如前面所看到的SpringMVC 提供了不少扩展点给开发人员扩展让开发人员可以按需索取plugin 上自定义的类或 handler那么在 controller 类的层次上SpringMVC 提供了 Interceptor 扩展在 action 上有没有提供相应的 handler 呢？如果我们能够对 action 实现注入出现的种种不足了
通过查阅 SpringMVC API 文档SpringMVC 其实也为 action 级别提供了方法参数注入的 Resolver 扩展允许开发人员给 HandlerMapper 类 set 自定义的 MethodArgumentResolver
action 的代码如下
Java代码
@RequestMapping
public void hello(User user){
//usersayHello()
}
Resolver 的代码如下
Java代码
public class UserArgumentResolver implements WebArgumentResolver {
public Object resolveArgument(MethodParameter methodParameter NativeWebRequest webRequest) throws Exception {
if (methodParametergetParameterType()equals(Userclass)) {
return webRequestgetAttribute(currentUser RequestAttributesSCOPE_SESSION);
}
return UNRESOLVED;
}
}
配置文件的相关配置如下
Xml代码
<bean class=orgspringframeworkwebservletmvcannotationOwnAnnotationMethodHandlerAdapter>
<property name=customArgumentResolver>
<ref bean=userArgumentResolver/><! userArgumentResolver bean 的定义省略 >
</property>
</bean>
优点
具备第二种方案的所有优点
真正做到了按需分配只在真正需要对象的位置注入具体的对象减少其他地方对该对象的依赖
其他人能很容易地从 action 的参数列表得知 action 所需要的依赖API 更清晰易懂
对于很多 action 需要的某一类参数可以在唯一的设置点用很方便一致的方式进行注入
不足
对象依赖注入是针对所有 action 注入粒度还是较粗不能做到具体 action 访问具体的 Session 属性
（四）通过 SpringMVC 的 SessionAttributes Annotation 关联 User 属性
SpringMVC 文档提到了 @SessionAttributes annotation和 @ModelAttribute 配合使用可以往 Session 中存或者从 Session 中取指定属性名的具体对象文档里说
引用
The typelevel @SessionAttributes annotation declares session attributes used by a specific handler This will typically list the names of model attributes which should be transparently stored in the session or some conversational storage serving as formbacking beans between subsequent requests
很明显@SessionAttributes 是用来在 controller 内部共享 model 属性的从文档自带的例子来看标注成 @SessionAttributes 属性的对象会一直保留在 Session 或者其他会话存储中直到 SessionStatus 被显式 setComplete()那这个 annotation 对我们有什么帮助呢？
答案就是我们可以在需要访问 Session 属性的 controller 上加上 @SessionAttributes然后在 action 需要的 User 参数上加上 @ModelAttribute并保证两者的属性名称一致SpringMVC 就会自动将 @SessionAttributes 定义的属性注入到 ModelMap 对象在 setup action 的参数列表时去 ModelMap 中取到这样的对象再添加到参数列表只要我们不去调用 SessionStatus 的 setComplete() 方法这个对象就会一直保留在 Session 中从而实现 Session 信息的共享
controller的代码如下
Java代码
@Controller
@SessionAttributes(currentUser)
public class GreetingController{
@RequestMapping
public void hello(@ModelAttribute(currentUser) User user){
//usersayHello()
}
//
}
使用这种方案还需要在 SpringMVC 配置文件中在定义 ViewResolver 时加上 p:allowSessionOverride=true这样如果你对 User 对象做了修改就会在渲染 View 的同时覆写 Session 中的相关属性
优点
具备第二种方案的所有优点
使用 Annotation 声明对 Session 特定属性的存取每个 action 只需要声明自己想要的 Session 属性
其他人能很容易地从 action 的参数列表得知 action 所需要的依赖API 更清晰易懂
不足
对于相同属性的 Session 对象需要在每个 action 上定义
这种方案并不是 SpringMVC 的初衷因此有可能会引起一些争议
纵观这四类方法我们可以看出我们对 Session 属性的访问控制设置是从所有 Servlet到某一类型的 controller 的成员变量到所有 action 的某一类型参数再到具体 action 的具体对象每种方案都有各自的优点和不足第一种方案虽然精确但可惜引入了对 Servlet API 的依赖不利于 controller 的测试和逻辑复用第二三种方案虽然解决了对 Servlet API 的依赖也分别在 controller 和 action 级别上提供了对 Session 属性的访问但注入粒度在一定程度上还是不够细要想对具体属性进行访问可能会比较繁琐不过这在另一方面也提供了简便而统一的方法来对一系列相同类型的参数进行注入第四种方案通过使用 Annotation不仅摆脱了 Servlet API 的依赖而且在 action 级别上提供了对 Session 具体属性的访问控制但是这种访问有可能会粒度过细需要在很多不同 action 上声明相同的 annotation而且毕竟这种用法并不是 SpringMVC 的初衷和推荐的可能会带来一些争议
本文演示了 Spring 访问 Session 属性的几种不同解决方案并分析了各自的优点和不足本文并不打算对这些解决方案评出对错只是试图列出在选择方案时的思维过程以及选择标准每种方案都能满足某一类上下文的需求在特定的开发环境和团队中都可能会是最优的选择但是笔者还是发现整个过程中一些平常容易忽视的 OOP 的准则或者原则在发挥着效应鑒于本文篇幅已经较长就留到后续文章中继续探讨解决方案选择背后的深层含义
