spring bean中注入HttpServletRequest成员变量的思考

主题

在使用spring框架开发的时候,我们经常会碰到这种情况:

@Controller
public class SomeController {

    @RequestMapping("/test1")
    public String test1(HttpServletRequest request) {
        System.out.println(request.getQueryString());
        return "";
    }

    @RequestMapping("/test2")
    public String test2(HttpServletRequest request) {
        System.out.println(request.getQueryString());
        return "";
    }

    @RequestMapping("/test3")
    public String test3(HttpServletRequest request) {
        System.out.println(request.getQueryString());
        return "";
    }

}

即,一个@Controller或@Service中的多个方法都使用到了request这个参数,那么为了简化代码,我们会将request作为成员变量注入,改写成如下形式:

@Controller
public class SomeController {

    @Resource
    private HttpServletRequest request;

    @RequestMapping("/test1")
    public String test1() {
        System.out.println(request.getQueryString());
        return "";
    }

    @RequestMapping("/test2")
    public String test2() {
        System.out.println(request.getQueryString());
        return "";
    }

    @RequestMapping("/test3")
    public String test3() {
        System.out.println(request.getQueryString());
        return "";
    }

}

这样,我们就可以不必在每个用到request的方法的参数列表都写一遍HttpServletRequest request这个参数了。工作中也经常是这样做的。

思考

但是,仔细思考一下,我们会有这样的疑问:

  • spring中@Controller默认是单例的,其成员变量也是在bean初始化时注入好的,而HttpServletRequest这个变量对于每一次请求都是不同的,难道@Controller对每次请求都重新注入request这个成员变量?且不说这种做法不符合spring对bean管理的一般方式,即使这样做了,线程安全如何保证

实现

先上结论,上面的写法,每次都可以取到正确的request对象,并且是线程安全的。

那么,spring是如何做到的呢?

首先debug看下两种做法真实注入类的区别:

区别很明显,

作为成员变量注入的时候注入的是代理对象,是 AutowireUtils.ObjectFactoryDelegatingInvocationHandler的实例。

作为方法参数注入的就是我们一般使用的Request对象。

看下ObjectFactoryDelegatingInvocationHandler这个AutowireUtils的内部类:

     /**
     * Reflective InvocationHandler for lazy access to the current target object.
     */
    @SuppressWarnings("serial")
    private static class ObjectFactoryDelegatingInvocationHandler implements InvocationHandler, Serializable {

        private final ObjectFactory<?> objectFactory;

        public ObjectFactoryDelegatingInvocationHandler(ObjectFactory<?> objectFactory) {
            this.objectFactory = objectFactory;
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            String methodName = method.getName();
            if (methodName.equals("equals")) {
                // Only consider equal when proxies are identical.
                return (proxy == args[0]);
            }
            else if (methodName.equals("hashCode")) {
                // Use hashCode of proxy.
                return System.identityHashCode(proxy);
            }
            else if (methodName.equals("toString")) {
                return this.objectFactory.toString();
            }
            try {
                return method.invoke(this.objectFactory.getObject(), args);
            }
            catch (InvocationTargetException ex) {
                throw ex.getTargetException();
            }
        }
    }

可以看到,当代理对象的方法被调用时,除去少数几个方法,大部分的情况都是通过this.objectFactory.getObject()获取被代理对象,再调用被代理对象的相应方法


通过一步步debug,最终终于看到了熟悉的Request类,可以看到它是从requestAttributesHolder中取到的,那么requestAttributesHolder又是什么呢?

看到这里答案已经很明了了,这个RequestContextHolder的ThreadLocal成员变量就是实现的关键所在,它存放了每个线程对应的Request对象,因此在@Controller中调用作为成员变量注入的代理类的方法时,最终可以取到当前线程相对应的Request对象,并调用Request对应的方法,这样@Controller中的成员变量不需要重复注入(它一直都是最初bean初始化时注入的代理类),也避免了线程不安全的问题。


那么spring是何时将Request放入这个ThreadLocal之中的呢?

是在Springmvc的dispatcherServlet的父类FrameworkServlet里操作的:


可以看到对Servlet的doGet、dePost等各种调用,最终都通过processRequest(request, response)处理

该方法调用了initContextHolders(request, localeContext, requestAttributes);

最终看到了将Request放入ThreadLocal的操作。


总结

  1. 在bean中注入作为成员变量的HttpServletRequest时,实际注入的是spring框架生成的代理对象,是ObjectFactoryDelegatingInvocationHandler的实例。在我们调用这个成员变量的方法时,最终是调用了objectFactory的getObject()对象的对应方法,在这里objectFactory是RequestObjectFactory这个类的对象。
  2. RequestObjectFactory的getObject方法是从RequestContextHolderthreadlocal中去取值的。
  3. 请求刚进入springmvc的dispatcherServlet的时候会把request相关对象设置到RequestContextHolder的threadlocal中去.
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 224,535评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,106评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 171,668评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,863评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,874评论 6 399
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,362评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,748评论 3 428
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,717评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,249评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,280评论 3 345
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,408评论 1 354
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,020评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,727评论 3 337
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,191评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,320评论 1 275
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,946评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,473评论 2 365

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,741评论 18 139
  • 前言 本文将介绍在Spring MVC开发的web系统中,获取request对象的几种方法,并讨论其线程安全性。 ...
    jackcooper阅读 1,555评论 0 11
  • 概念: Zookeeper的服务器三种角色:Leader,Follower,Observer。Leader提供读和...
    西5d阅读 6,836评论 0 2
  • 【每天一问QQ】:QQ,妈妈问你扣出来的他们在干什么呀? QQ说:妈妈,是小星星病了,小螃蟹和小乌贼离开城堡坐飞机...
    674e09b5464a阅读 159评论 0 0
  • 文 | 徐亨福 一个在南方打工的朋友W君最近留言说,自己又报了一个微信运营培训班,每天下班后还要去听课一小时,回来...
    羿云天阅读 885评论 0 1