currentRequestAttributes和getRequestAttributes获取HttpServletRequest对象

发表于 分类于 阅读次数： 本文字数： 690 阅读时长 ≈ 3 分钟

前言

Spring获取HttpServletRequest的方法有很多。
比较常用的是使用@Autowired或者直接在方法参数里面注入。

问题场景

从数据库dao层取出了url资源路径, 需要结合ContextPath进行补充。
比如访问http://localhost:8080/project/userList, 项目路径是project。
查询到以下数据

1
2
3
4
id    name       avatar_url
1     user1     /avatar1.jpg
2     user2     /avatar2.jpg
3     user3     /avatar3.jpg

如果直接将avatar_url填入<img src="/avatar1.jpg"/>中的话, 会出现404错误。
需要在前面添加项目路径ContextPath, 也就是<img src="/project/avatar1.jpg"/>才能正常访问。

尝试解决

现在的项目一般都是通过MVC完成的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@Controller
public class MyController{
    private MyService myService;
    public MyController(MyService myService){ this.myService = myService; }
    
    @RequestMapping("/userList")
    public List<Map<String, String>> userList(){
        return myService.getUserList();    
    }
}


public interface MyService{ List<Map<String, String>> getUserList(); }
@Service
public class MyServiceImpl implements MyService{
    private MyDao myDao;
    public MyServiceImpl(MyDao myDao) { this.myDao = myDao; }

    public List<Map<String, String>> getUserList() {
        // 给avatar_url添加contextPath前缀
        List<Map<String, String>> list = myDao.getUserList();
        for (Map<String, String> user : list) {
            String url = user.get("avatar_url");
            user.put("avatar_url", contextPath+url);
        }
        return list
    }
}

@Repository
class MyDao{
    public List<Map<String, String>> getUserList(){
        // 模拟从数据库取出数据
        List<Map<String, String>> list = new ArrayList<>();
        for(int i = 0; i < 3; i++){
            Map<String, String> user = new HashMap<>();
            user.put("id", String.valueOf(i));
            user.put("name", "user"+i);
            user.put("avatar_url", "/avatar"+i+".jpg");
            list.add(user);
        }
        return list;
    }
}

使用Spring自动注入

只要是实现了@Component注解(@Controller中包含@Component, 注意, 注解没有继承), Spring就可以自动为其注入HttpServletRequest。

1
2
3
4
5
6
7
8
9
10
11
@Controller
public class MyController{
    // 省略其他代码

    HttpServletRequest request1; // 1. 第一种方法
    @RequestMapping("/userList")
    // 2. 第二种方法
    public List<Map<String, String>> userList(HttpServletRequest request2){
        return myService.getUserList();    
    }
}

上面两种都可以取得线程安全的HttpServletRequest对象。

但是有个弊端。
使用HttpServletRequest对象的类必须实现@Component注解。
如果我是在工具类Utils中使用, 则必须要为Utils中的静态方法提供一个HttpServletRequest参数。
如果函数调用链足够深, 则会污染整个函数调用链, 导致每个链上的每个函数都有一个HttpServletRequest参数。

解决方案

每一个Request请求都是属于一个线程, 那么就应该可以存放在ThreadLocal对象中。
RequestContextHolder类里面就有ThreadLocal对象。
它有两个方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// org.springframework.web.context.request.RequestContextHolder
public abstract class RequestContextHolder  {
    private static final ThreadLocal<RequestAttributes> requestAttributesHolder =
            new NamedThreadLocal<RequestAttributes>("Request attributes");

    private static final ThreadLocal<RequestAttributes> inheritableRequestAttributesHolder =
            new NamedInheritableThreadLocal<RequestAttributes>("Request context");

    public static RequestAttributes getRequestAttributes() {
        RequestAttributes attributes = requestAttributesHolder.get();
        if (attributes == null) { attributes = inheritableRequestAttributesHolder.get(); }
        return attributes;
    }

    public static RequestAttributes currentRequestAttributes() throws IllegalStateException {
        // 调用getRequestAttributes()方法
        RequestAttributes attributes = getRequestAttributes();
        if (attributes == null) {
            if (jsfPresent) {
                attributes = FacesRequestAttributesFactory.getFacesRequestAttributes();
            }
            if (attributes == null) {
                throw new IllegalStateException("异常信息");
            }
        }
        return attributes;
    }

可以看到currentRequestAttributes方法调用了getRequestAttributes方法。追加了对JSF的判断。

所以我们可以直接使用currentRequestAttributes。

1
2
3
4
5
6
7
8
9
10
public abstract class RequestHelper {
    private RequestHelper() { throw new AssertionError("工具类不允许实例化"); }
    public static HttpServletRequest getRequest(){
        return ((ServletRequestAttributes) RequestContextHolder
                .currentRequestAttributes()).getRequest(); 
    }

    public static String getContextPath(){
        return getRequest().getContextPath();
    }

参考资料