Android Hilt-Dagger 实现WebSocket ServerConnection单例及多实例问题解决
单例失效原因排查与修复
触发多实例的常见问题点
按出现概率从高到低核对:
- 最普遍的新手漏项:Hilt模块的绑定注解不全
你只贴出了provide方法的代码,没有展示AppModule类的头部注解。Hilt里@Singleton标记的单例能力,必须挂载到全局应用级的SingletonComponent组件上才会生效。如果漏写两个关键注解,单例逻辑直接失效:- 模块类必须加
@Module标记 - 模块必须加
@InstallIn(SingletonComponent::class),把提供逻辑绑定到全局单例组件
很多人会错把这个provide方法放到其他作用域的模块里(比如标注了@InstallIn(ActivityComponent::class)的Activity专属模块),哪怕方法上写了@Singleton,也会因为脱离了全局作用域,被每个Activity独立生成一份ServerConnection实例,最终在Activity、Fragment的注入点拿到不同的对象。
- 模块类必须加
- 跨模块重复绑定同一类型的提供逻辑
如果你在其他Hilt模块里(哪怕是某个页面专属的模块)又写了一个返回ServerConnection类型的provide方法,Hilt会按照当前注入点所属的组件范围生成新的实例,不会统一复用全局那份单例。同组件下的重复绑定Hilt会直接编译报错,但跨组件的重复绑定不会提示,就会出现你遇到的“不同页面拿到不同实例”的现象。
修正后的模块代码参考
@Module @InstallIn(SingletonComponent::class) object AppModule { @Singleton @Provides fun provideSocketConnection(tokenDao: TokenDao): ServerConnection { // 你现有代码里查询token、拿refreshToken的逻辑完全没有传入ServerConnection,属于无效代码,可以直接删掉 return ServerConnection(URL) } }
额外提醒:你原来在provide方法里用runBlocking同步在主线程查询数据库的写法容易触发ANR,后续可以把token获取的逻辑移到WebSocket初始化的协程作用域里异步处理,避免阻塞主线程。
单例生效的验证方式
在ServerConnection的init代码块加一行日志,实例化时打印对象hash值:
init { Log.d("ServerConnection", "init instance, hash: ${hashCode()}") // 原有OkHttp、URL初始化逻辑 }
运行应用后查看日志:如果整个应用运行周期里只打印一次这行日志,就说明单例已经生效;如果多次打印,就顺着上面的模块注解、重复绑定的方向排查即可。
设计上的隐藏隐患提醒
就算单例逻辑生效,你现在写的ServerConnection类也不支持多页面同时使用:
类内部的mListener、mMessageHandler、mStatusHandler都是单变量存储,当Activity和Fragment先后调用connect()方法时,后调用的页面会直接覆盖前一个页面的监听引用,导致前一个页面收不到WebSocket的消息和状态回调。后续可以把监听存储改成弱引用列表,配套实现注册/反注册方法,避免单实例下的监听抢占问题。
内容的提问来源于stack exchange,提问作者Teo
相关产品推荐
相关产品推荐

