对依赖于请求上下文的方法进行单元测试

Question

我正在为包含以下行的方法编写单元测试：

String sessionId = RequestContextHolder.currentRequestAttributes().getSessionId();

我收到以下错误：

java.lang.IllegalStateException：未找到线程绑定请求：是 您指的是实际 Web 请求之外的请求属性， 或者在最初接收线程之外处理请求？如果 您实际上是在网络请求中进行操作并且仍然收到此消息 消息，您的代码可能在外部运行 DispatcherServlet/DispatcherPortlet：在本例中，使用 RequestContextListener 或 RequestContextFilter 暴露当前 请求。

原因很明显——我没有在请求上下文中运行测试。

问题是，如何在测试环境中测试包含对依赖于请求上下文的方法的调用的方法？

非常感谢。

Answer 1

假设您的类类似于：

class ClassToTest {
    public void doSomething() {
        String sessionId = RequestContextHolder.currentRequestAttributes().getSessionId();
        // Do something with sessionId
    }
}

如果您无法更改使用 RequestContextHolder 的类，那么您可以在测试代码中重写 RequestContextHolder 类。
即，您在同一个包中创建一个具有相同名称的类，并确保它在实际的 Spring 类之前加载。

package org.springframework.web.context.request;

public class RequestContextHolder {
    static RequestAttributes currentRequestAttributes() {
        return new MyRequestAttributes();
    }

    static class MyRequestAttributes implements RequestAttributes {
        public String getSessionId() {
            return "stub session id";
        }
        // Stub out the other methods.
    }
}

现在，当您的测试运行时，它们将选取您的 RequestContextHolder 类并优先使用该类（而不是 Spring 类）（假设已为此情况设置了类路径）。
这不是运行测试的特别好的方法，但如果您无法更改正在测试的类，则可能有必要。

或者，您可以将会话 ID 检索隐藏在抽象后面。例如，引入一个接口：

public interface SessionIdAccessor {
    public String getSessionId();
}

创建一个实现：

public class RequestContextHolderSessionIdAccessor implements SessionIdAccessor {
    public String getSessionId() {
        return RequestContextHolder.currentRequestAttributes().getSessionId();
    }
}

并在您的类中使用抽象：

class ClassToTest {
    SessionIdAccessor sessionIdAccessor;

    public ClassToTest(SessionIdAccessor sessionIdAccessor) {
        this.sessionIdAccessor = sessionIdAccessor;
    }

    public void doSomething() {
        String sessionId = sessionIdAccessor.getSessionId();
        // Do something with sessionId
    }
}

然后您可以为您的测试提供一个虚拟实现：

public class DummySessionIdAccessor implements SessionIdAccessor {
    public String getSessionId() {
        return "dummy session id";
    }
}

这种事情突出了将某些环境细节隐藏在抽象后面的通常最佳实践，以便您可以如果您的环境发生变化，请更换它们。
这同样适用于通过将虚拟实现替换为“真实”实现来降低测试的脆弱性。

Answer 2

如果方法包含：

String sessionId = RequestContextHolder.currentRequestAttributes().getSessionId();

是Web控制器方法，那么我建议更改方法签名，以便您/spring将请求作为单独的参数传递给该方法。

然后你可以删除麻烦部分 String RequestContextHolder.currentRequestAttributes() 并直接使用 HttpSession 。

那么在测试中使用模拟的 Session (MockHttpSession) 对象应该很容易。

@RequestMapping...
public ModelAndView(... HttpSession session) {
    String id = session.getId();
    ...
}

Answer 3

Spring-test 有一个灵活的请求模拟，称为 MockHttpServletRequest。

MockHttpServletRequest request = new MockHttpServletRequest();
RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request));

Answer 4

您可以模拟/存根 RequestAttributes对象返回你想要的，然后调用RequestContextHolder.setRequestAttributes(RequestAttributes) 在开始测试之前使用您的模拟/存根。

@Mock
private RequestAttributes attrs;

@Before
public void before() {
    MockitoAnnotations.initMocks(this);
    RequestContextHolder.setRequestAttributes(attrs);

    // do you when's on attrs
}

@Test
public void testIt() {
    // do your test...
}

Answer 5

我能够执行与此 answer 相同的操作，但没有使用 MockHttpServletRequest 类code>@Mock 注解。我猜他们很相似。只是在这里发布以供未来的访客使用。

@Mock
HttpServletRequest request;

@Before
public void setup() {
    MockitoAnnotations.initMocks(this);
    RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request));
}