Category: Spring

Spring2.5 访问 Session 属性的四种策略

WEB 应用通常会引入 Session,用来在服务端和客户端之间保存一系列动作/消息的状态,比如网上购物维护 user 登录信息直到 user 退出。在 user 登录后,Session 周期里有很多 action 都需要从 Session 中得到 user,再验证身份权限,或者进行其他的操作。这其中就会涉及到程序去访问 Session属性的问题。在java中,Servlet 规范提供了 HttpSession对象来满足这种需求。开发人员可以从 HttpServletRquest对象得到 HttpSession,再从HttpSession中得到状态信息。

还是回到购物车的例子,假设在 controller 某个方法(本文简称为action)中我们要从HttpSession中取到user对象。如果基于Servlet,标准的代码会是这样的:

public void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
 User user 
= (User)req.getSession().getAttribute(currentUser);
 
//
}

这样的代码在传统的Servlet程序中是很常见的:因为使用了 Servlet API,从而对 Servlet API产生依赖。这样如果我们要测试 action,我们就必须针对 HttpServletRequest、HttpServletResponse 和 HttpSession类提供 mock 或者 stub 实现。当然现在已经有很多开源的 Servlet 测试框架帮助我们减轻这个痛苦,包括 Spring 就自带了对了这些类的 stub 实现,但那还是太冗繁琐碎了。那有没有比较好的办法来让我们的 controller 更 POJO,让我们的 action 脱离 Servlet API 依赖,更有益于测试和复用呢?我们来看看在 Spring2.5 中访问 Session 属性的几种策略,并将在本博的后续文章继续探究解决方案选择后面的深层含义。

(一)通过方法参数传入HttpServletRequest对象或者HttpSession对象
笔者的前一篇文章已经简单介绍了Spring2.5的annotation使得 controller 摆脱了 Servlet API 对方法参数的限制,这里就不赘述了。有兴趣的同学可以参考这里。Spring对annotationed的 action 的参数提供自动绑定支持的参数类型包括 Servlet API 里面的 Request/Response/HttpSession(包含Request、Response在Servlet API 中声明的具体子类)。于是开发人员可以通过在 action 参数中声明 Request 对象或者 HttpSession 对象,来让容器注入相应的对象。

action 的代码如下:

@RequestMapping
public void hello(HttpSession session){
 User user 
= (User)session.getAttribute(currentUser);
 
//
}

优点:
1. 程序中直接得到底层的 Request/HttpSession 对象,直接使用 Servlet API 规范中定义的方法操作这些对象中的属性,直接而简单。
2. action 需要访问哪些具体的 Session 属性,是由自己控制的,真正精确到 Session 中的每个特定属性。
不足:
1. 程序对 Servlet API 产生依赖。虽然 controller 类已经不需要从 HttpServlet 继承,但仍需要 Servlet API 才能完成编译运行,乃至测试。
2. 暴露了底层 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 的代码:

public interface IUserAware {
 
public void setUser();
}

controller 的代码:

@Controller
public GreetingController implements IUserAware {
 
private User user;
 
public void setUser(User user){
  
this.user = user;
 }

 
 @RequestMapping
 
public void hello(){
  
//user.sayHello();
 }

 
//
}

Interceptor 的代码:

public class UserInjectInterceptor extends HandlerInterceptorAdapter {
 @Override
    
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object handler) throws Exception {
        
if (handler.isAssignableFrom(IUserAware)){
         User user 
= (User)httpServletRequest.getSession().getAttribute(currentUser);
         IUserAware userAware 
= (IUserAware) handler;
         userAware.setUser(user);
        }

        
return super.preHandle(httpServletRequest, httpServletResponse, handler);
    }

    
//
}

为了让 SpringMVC 能调用我们定义的 Interceptor,我们还需要在 SpringMVC 配置文件中声明该 Interceptor,比如:

<bean class=”org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping”>
    
<property name=”interceptors”>
        
<list>
            
<ref bean=”userInjectInterceptor”/><!– userInjectInterceptor bean 的声明省略–>
        
</list>
    
</property>
</bean>

优点:
1. 对 Servlet API 的访问被移到了自 SpringMVC API 扩展的 Interceptor,controller 不需要关心 User 如何得到。
2. 开发人员可以通过随时添加或移除 Interceptor 来完成对不同参数在某一类型 controller 上的注入。
3. controller 的 User 对象通过外界注入,测试时开发人员可以很容易地注入自己想要的 User 对象。
4. controller 类去掉了对 Servlet API 的依赖,更 POJO 和通用。
5. controller 类是通过对 interface 的声明来辅助完成注入的,并不存在任何继承依赖。
不足:
1. SpringMVC 对 controller 默认是按照单例(singleton)处理的,在 controller 类中添加一个成员变量,可能会引起多线程的安全问题。
2. 因为 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 的代码如下:

@RequestMapping
public void hello(User user){
 
//user.sayHello()
}

Resolver 的代码如下:

public class UserArgumentResolver implements WebArgumentResolver {

    
public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception {
        
if (methodParameter.getParameterType().equals(User.class)) {
            
return webRequest.getAttribute(currentUser, RequestAttributes.SCOPE_SESSION);
        }

        
return UNRESOLVED;
    }

}


配置文件的相关配置如下:

<bean class=”org.springframework.web.servlet.mvc.annotation.OwnAnnotationMethodHandlerAdapter”>
    
<property name=”customArgumentResolver”>
        
<ref bean=”userArgumentResolver”/><!– userArgumentResolver bean 的定义省略 –>
    
</property>
</bean>

优点:
1. 具备第二种方案的所有优点
2. 真正做到了按需分配,只在真正需要对象的位置注入具体的对象,减少其他地方对该对象的依赖。
3. 其他人能很容易地从 action 的参数列表得知 action 所需要的依赖,API 更清晰易懂。
4. 对于很多 action 需要的某一类参数,可以在唯一的设置点用很方便一致的方式进行注入。
不足:
1. 对象依赖注入是针对所有 action, 注入粒度还是较粗。不能做到具体 action 访问具体的 Session 属性

(四)通过 SpringMVC 的 SessionAttributes Annotation 关联 User 属性
SpringMVC 文档提到了 @SessionAttributes annotation,和 @ModelAttribute 配合使用可以往 Session 中存或者从 Session 中取指定属性名的具体对象。文档里说;

The type-level @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 form-backing 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的代码如下:

@Controller
@SessionAttributes(
currentUser)
public class GreetingController{
 @RequestMapping
 
public void hello(@ModelAttribute(currentUser) User user){
  
//user.sayHello()
 }

 
//
}

使用这种方案,还需要在 SpringMVC 配置文件的 ViewResolver 定义处,加上 p:allowSessionOverride=”true”,这样如果你对 User 对象做了修改,SpringMVC 就会在渲染 View 的同时覆写 Session 中的相关属性。

优点:
1. 具备第二种方案的所有优点
2. 使用 Annotation 声明对 Session 特定属性的存取,每个 action 只需要声明自己想要的 Session 属性。
3. 其他人能很容易地从 action 的参数列表得知 action 所需要的依赖,API 更清晰易懂。
不足:
1. 对于相同属性的 Session 对象,需要在每个 action 上定义。
2. 这种方案并不是 SpringMVC 的初衷,因此有可能会引起一些争议。

纵观这四类方法,我们可以看出我们对 Session 属性的访问控制设置,是从所有 Servlet,到某一类型的 controller 的成员变量,到所有 action 的某一类型参数,再到具体 action 的具体对象。每种方案都有各自的优点和不足:第一种方案虽然精确,但可惜引入了对 Servlet API 的依赖,不利于 controller 的测试和逻辑复用。第二、三种方案虽然解决了对 Servlet API 的依赖,也分别在 controller 和 action 级别上提供了对 Session 属性的访问,但注入粒度在一定程度上还是不够细,要想对具体属性进行访问可能会比较繁琐。不过,这在另一方面也提供了简便而统一的方法来对一系列相同类型的参数进行注入。第四种方案通过使用 Annotation,不仅摆脱了 Servlet API 的依赖,而且在 action 级别上提供了对 Session 具体属性的访问控制。但是这种访问有可能会粒度过细,需要在很多不同 action 上声明相同的 annotation。而且,毕竟这种用法并不是 SpringMVC 的初衷和推荐的,可能会带来一些争议。

本文演示了 Spring2.5 访问 Session 属性的几种不同解决方案,并分析了各自的优点和不足。本文并不打算对这些解决方案评出对错,只是试图列出在选择方案时的思维过程以及选择标准。每种方案都能满足某一类上下文的需求,在特定的开发环境和团队中都可能会是最优的选择。但是笔者还是发现,整个过程中,一些平常容易忽视的 OOP 的准则或者原则在发挥着效应,鉴于本文篇幅已经较长,就留到后续文章中继续探讨解决方案选择背后的深层含义,敬请期待。

利用 Spring2.5 和 Reflection 简化测试中的mock

spring2.5最大的特色就是全面使用annotation代替xml配置,包括IOC Container、springMVC和 TestContext测试框架等,给我们开发带来了极大的便利。springMVC的新特性在这篇文章里面已经有了比较详尽的介绍,而对于spring的新TestContext测试框架,大家也可以从这里得到详细的例子说明,有兴趣的可以去仔细阅读,本文不再赘述。总而言之,通过spring2.5提供的 annotation,我们可以让我们的类——包括controller,Test等职责特殊的类——更 POJO 化,更易于测试,也提高了 TestCase的开发效率。

在开发过程中,我们通常需要mock特定的对象来测试预期行为,或者使用stub对象来提高单元测试效率。最常见的例子就是在多层webapp中,在controller类的测试方法里mock或 stub底层dao类的方法,从而减轻单元测试时数据库操作的开销,加快单元测试速率。至于Reflection,已不是java的新概念了,各样框架基本上都有使用Reflection来增强Runtime的动态性。而java5里Reflection效率的提升和annotation的引入,更是极大地提高java语言的动态性,让开发人员得到更多Runtime的灵活性。本文将演示如何使用spring2.5和Reflection简化测试中的 mock,使用的JUnit框架是JUnit4.4,mock框架是Easymock2.4。

让我们先看看最原始的使用mock对象的测试(假设基于jdk5进行开发,使用了包括static import,varargs等新特性):

import static org.easymock.EasyMock.*;

public void HelloworldTest extends AbstractSingleSpringContextTests {
    
private Foo foo = createMock(Foo.class);
    
private Bar bar = createMock(Bar.class);
    
private Helloworld helloworld;
    
    @Before
    
public void before() {
        reset(foo, bar);
        helloworld 
= new Helloworld(foo, bar);
    }
    
    @After
    
public void after() {
        verify(foo, bar);
    }
    
    @Test
    
public void shouldSayHello() {
        
//set expectations about foo/bar
        replay(foo, bar);
        
        helloworld.sayHello();
        
//assert verification
    }
    
    
//
}

可以看到,因为使用了 Spring 老版本的 TestContext,上面的代码至少有两个方面是需要加强的:
1. 需要大量的 mock 对象创建操作,与真正的 Test Case 无关的繁琐代码,而且还引入了对Spring Context Test 类的继承依赖
2. 针对不同的 Test 类,因为用到不同的 mock 对象,每次都需要显式去指明 reset/replay/verify 用到的 mock 对象

针对上面的两个问题,我们有相应的解决方案来改进:
1. 使用spring来替我们创建mock对象,由spring IOC Container在runtime注入需要的mock对象
2. 提供更通用的rest/replay/verify机制来验证mock对象,而不是每个 Test 类都需要单独处理

1. 每个mock对象都需要手工创建么?答案当然是否定的,我们有FactoryBean。通过在配置文件中指定bean的定义,让spring来替我们创建mock对象。如下是针对Foo类的定义:

<bean id=”mockFoo” class=”org.easymock.EasyMock” factory-method=”createMock”>
    
<constructor-arg index=”0″ value=”Foo”/>
</bean>

< /constructor-arg>与此同时,Spring TestContext框架提供了 @ContextConfiguration annotation 允许开发人员手工指定 Spring 配置文件所在的位置。这样,开发过程中,如果开发人员遵循比较好的配置文件组织结构,可以维护一套只用于测试的对象关系配置,里面只维护测试用到的 mock 对象,以及测试中用到的对 mock 对象有依赖关系的对象。在产品代码中则使用另一套配置文件,配置真实的业务对象。

JUnit4.4 之后,Test 类上可以通过 @RunWith 注解指定测试用例的 TestRunner ,Spring TestContext框架提供了扩展于 org.junit.internal.runners.JUnit4ClassRunner 的 SpringJUnit4ClassRunner,它负责总装 Spring TestContext 测试框架并将其统一到 JUnit 4.4 框架中。这样,你可以把 Test 类上的关于 Spring Test 类的继承关系去掉,并且使用 JUnit4 之后引入的 annotation 去掉其他任何 JUnit3.8 需要的约定和方法继承,让 Test 类更加 POJO。

Test 类也是“纯正” 的 java 对象,自然也可以通过 Spring 来管理依赖关系:在 Test 类的成员变量上加上 @Autowired 声明,使用 SpringJUnit4ClassRunner 运行 Test Case。Spring 会很聪明地帮助我们摆平 Test 依赖的对象,然后再运行已经“合法”的 Test Case,只要你在用于测试的配置文件里面定义了完整的依赖关系,一如其他正常对象。

<bean id=”Helloword” class=”Helloworld” autowire=”byType”/>


这样,经过上面三点变化,例子代码变成了这样:


import static org.easymock.EasyMock.*;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(
test-context.xml)
public void HelloworldTest {
    @Autowired
    
private Foo foo;
    
    @Autowired
    
private Bar bar;
    
    @Autowired
    
private Helloworld helloworld;
    
    @Before
    
public void before() {
        reset(foo, bar);
    }
    
    @After
    
public void after() {
        verify(foo, bar);
    }
    
    @Test
    
public void shouldSayHello() {
        
//set expectations about foo/bar
        replay(foo, bar);
        
        helloworld.sayHello();
        
//assert verification
    }
    
    
//
}

2. 现在看上去是不是好多了?嗯,对象间的依赖关系和mock对象的创建都由 Spring 来替我们维护,再也不用费心了。不过,reset/verify 是不是还是看上去那么舒服?我们观察一下,通常为了简化对 mock 对象的验证,我们对 Test 类中使用到的 mock 对象都是一起reset/replay /verify,要是能有resetAll()/replayAll()/verifyAll()方法就好了,也省得不同的 Test 类写一大串对不同的 Mock 对象验证的方法。OK,这时候我们就要借助 Reflection 来完成这项任务了:通过 Reflection 得到 Test 类中所有加上 @Autowired 声明的成员变量,验证它们是不是由代理或者字节码增强,从而得到该 Test 类的所有由 Spring 创建的 mock 对象,进行 reset/replay/verify。

根据这个思路,我们引入这样一个 mock 测试的Helper类:

import static org.easymock.EasyMock.*;

final class MockTestHelper {

    public static void resetAll(Object testObject) {
        reset(getDeclaredMockedFields(testObject));
    }

    public static void verifyAll(Object testObject) {
        verify(getDeclaredMockedFields(testObject));
    }

    public static void replayAll(Object testObject) {
        replay(getDeclaredMockedFields(testObject));
    }

    private static Object[] getDeclaredMockedFields(Object testObject) {
        Field[] declaredFields 
= testObject.getClass().getDeclaredFields();
        List declaredMockedFields 
= new ArrayList();
        
for (Field field : declaredFields) {
            
if (field.isAnnotationPresent(Autowired.class)) {
                
boolean isAccessible = field.isAccessible();
                
try {
                    field.setAccessible(
true);
                    Object value 
= field.get(testObject);
                    
if (isClassProxy(value.getClass())) {
                        declaredMockedFields.add(value);
                    }
                } 
catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
                
finally {
                    field.setAccessible(isAccessible);
                }
            }
        }
        
return declaredMockedFields.toArray();
    }

    private static boolean isClassProxy(Class clazz) {
        String className 
= clazz.getName();
        
return className.contains($Proxy|| className.contains($$EnhancerByCGLIB$$);
    }

}

好了,有了这么一个 Helper 类,写 mock 对象的Test 类就简单了许多。还是以上面的例子为例,经过这么一重构,变成如下:

这样看起来就好多了,以后不管在 Test 类里面添加多少个 Test 类需要的 mock 对象,我们都不需要再修改对 mock 对象的验证了,Helper类会自动帮我们完成所有的工作。
综上所述,使用Spring2.5里面引入的 Test Cntext 和 annotations 的确帮助我们减轻了大量的测试代码量,而且让我们的 Test 类更加POJO,更易于让人理解其职责,成为对 feature 的 specification。而 Reflection的小技巧,则能很方便的改进原来代码中不够动态的地方,进一步简化代码量和维护难度。当然我们可以看到,即使这样,代码里面还是有不少resetAll/replayAll/verifyAll的地方,作为 mock 框架带来的一些约束,我们没有办法来省略。这里推荐一种新的 mock 框架—— mockito,是有我的外国同事开发的,它不仅把mock、stub、spy等double的概念区分更清楚,而且让我们的 mock 测试更易写,更易读。

更多敬请期待本博的其他文章。

References:
Spring 2.5:Spring MVC中的新特性:http://www.infoq.com/cn/articles/spring-2.5-ii-spring-mvc
使用 Spring 2.5 TestContext 测试框架:https://www.ibm.com/developerworks/cn/java/j-lo-spring25-test/
mockito project homepage:http://code.google.com/p/mockito/