不要使用全局变量, ThreadLocal也不行

不要使用全局变量的道理大家都懂,基本上在大家学习编程过程中很早就会被教育到,但是有时候我们也会禁不住诱惑用到一些似非实是的全局变量,只不过这些全局变量会穿上马甲,让你不会一下看穿它的巨大危害,这里就讲一下我们的故事。

初上贼船

我们的系统是一个插件化的体系,开发同学在开发一种新的插件的时候可以通过自定义PluginHook对插件生命周期中插入一些自定义的逻辑,而在PluginHook里面会需要知道当前用户是谁? 是谁在操作数据? 因此我们搞了一个CurrentUserFilter , 里面的逻辑会把当前用户设置到一个叫做 UserHolder类的 ThreadLocal变量里面去,伪代码如下:

    // ===== 这里的代码只是为了说明问题的伪代码,只是真实实现的粗略模仿 =====
    // CurrentUserFilter.java
    protected void doneFilterInternal(HttpServletRequest request, HttpServletResponse response,
                                      FilterChain filterChain)
            throws ServletException, IOException {
        try {
            UserHolder.setCurrentUser(getLoginUserFromSession(request));
            filterChain.doFilter(request, response);
        } finally {
            UserHolder.clearCurrentUser();
        }
    }

    // UserHolder.java
    private static final ThreadLocal<User> userThreadLocal = new ThreadLocal<>();

    public static User getCurrentUser() {
        return userThreadLocal.get();
    }

    public static void setCurrentUser(User user) {
        userThreadLocal.set(user);
    }

    public static void clearCurrentUser(User user) {
        userThreadLocal.set(null);
    }

这里的 UserHolder 里面的 userThreadLocal 粗看起来不是全局变量,它只在当前线程、当前请求生命周期内有效,因为 CurrentUserFilter 在请求结束的时候会调用UserHolder.clearCurrentUser()把这个状态清除掉。

而且带来的便利性很大: 开发同学在PluginHook里面就可以通过UserHolder.getCurrentUser() 拿到当前用户了, 而不用把当前用户从上传到下。只要大家不要到处滥用UserHolder, 应该没有问题。UserHolder加入之后为了防止大家滥用,我们也没有大肆宣传这个东西。

但是鲁迅先生曾经说过:

你担心大家会滥用的代码,大家(包括你自己)一定会滥用。

                                              -- 鲁迅。

我们很快发现这个类还是很快占领了我们很多代码模块。

这条记录是谁修改的?

首先我们发现我们很多表里面记录最后操作者的字段都是NULL,

user_table
  |- id
  |- name
  |- createor_id
  |- modifier_id -- 这个字段是NULL

而原因很简单,是开发更新数据的时候忘记设置了,要确保每个地方都设置好最后操作者也确实是个很繁琐的事情。咦,我们不是有UserHolder么? 我们可以在DAO的update方法里面自动设置呀,而且就不用代码把当前用户一层层传到DAO层了,好,用上。

public void updateUser(User user) {
    // 其它业务逻辑
    balabala

    // 自动设置当前用户
    user.setModifierId(UserHolder.getCurrentUser().getId());
}

这样底层DAO就依赖上这个全局变量。

让UserHolder可以跨线程生效

在一些代码里面我们UserHolder.getUser()拿不到用户信息,

然后我们发现我们表里面有些记录的modifier_id还是NULL, 仔细查过之后发现这些记录是由异步线程写入数据库的,而这些异步线程里面没有人去设置这个User ThreadLocal, 那么自然就拿不到了。于是我们又写了一段很厉害的代码在线程切换之前把这个UserUtils.getUser()传播过去,并且在这个线程退出的时候把用户信息清除掉。

// ===== Again: 这里的代码只是为了说明问题的伪代码,只是真实实现的粗略模仿 =====

// 把当前用户拿出来传给新线程
Thread thread = new AsyncThread(UserHolder.getCurrentUser());
class AsyncThread {
    private User currentUser;
    public void run() {
        try {
            // 在真正业务代码开始之后设置这个新线程的User
            UserHolder.setCurrentUser(currentUser);
            // 下面是业务代码
        } finally {
            // 把User清理掉
            UserHolder.clearCurrentUser();
        }
    }
}

很棒,我们的 UserHolder 开始跨线程了。。

OpenAPI: 来自非浏览器的请求

再后来我们要暴露OpenAPI给其他系统调用了,我们发现从OpenAPI调用的请求会出错,原因跟上面的原因类似,因为底层的DAO代码又拿不到当前用户了。当然拿不到了,因为OpenAPI的请求不是来自用户的请求,不会进入我们的 CurrentUserFilter , 自然也就不会设置这个当前用户了。但是经过上面两节的改造,我们的代码已经深深依赖上了这个UserHolder.getCurrentUser(), 难道每次调用OpenAPI之前我们手动设置一下UserHolder么? 情况已经有点失控了,我们仿佛上了一条贼船。

为了避免问题进一步扩大,我们决定把这个UserHolder彻底干掉,所有需要用到当前用户的地方都手动把参数传下去,这样虽然代码看起来有点繁琐,有点累赘,但是不用担心全局变量的设置问题了。

总结

全局变量不能用,当全局变量穿上马甲比如ThreadLocal之类的,也要能识破它,拒绝它。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,539评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,911评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,337评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,723评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,795评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,762评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,742评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,508评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,954评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,247评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,404评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,104评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,736评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,352评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,557评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,371评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,292评论 2 352

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,621评论 18 399
  • 嗨,大家好 我们准备出一系列经管类的图书,主要是针对中小型企业的经营管理学,正在招募书书籍的作者。 如果你在管理上...
    雷大壮阅读 196评论 0 0
  • 狼群_0b56阅读 713评论 0 50