GetX 依赖管理完全指南：从 Get.put 到 Bindings 与 SmartManagement 的源码级解析

前端【免费下载链接】getxOpen screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.项目地址https://gitcode.com/gh_mirrors/ge/getx点击查看免费下载导读GetX本仓库getx内置了一个简单而强大的依赖管理器Dependency Manager它允许开发者仅用一行代码即可获得与 Bloc 或 Controller 等价的类实例全程无需Provider、InheritedWidget或任何BuildContext。本文以仓库 documentation/id_ID/dependency_management.md 为骨架结合 lib/get_instance、lib/get_core/src/smart_management.dart 等源码实现完整讲解四大实例化方法Get.put/Get.lazyPut/Get.putAsync/Get.create的参数体系、Get.find的获取与释放、Bindings 路由集成机制以及 SmartManagement 的三种内存管理策略。读完本文你将掌握 GetX 依赖注入的完整实操方案并能深入理解其底层_singl哈希表与 Route 绑定清理的原理。一、认识 GetX 的依赖管理器GetX 的依赖管理器是包内一个相对独立的模块它与其他部分状态管理、路由解耦即使你的应用已经在使用其他状态管理方案无论是哪个库你也可以直接使用 GetX 的依赖注入而无需重写任何业务代码。它的核心使用方式极其简洁——把类实例放进 Get 的内存注册表中而不是在你的类内部手动实例化Controller controller Get.put(Controller());这会让该实例在应用的所有位置都可用之后你就能像使用普通类一样使用这个 controller或任何 Bloc 类。从源码看这一切的基础是 lib/get_instance/src/extension_instance.dart 中定义的静态注册表static final MapString, _InstanceBuilderFactory _singl {};所有通过Get.put()注册的实例最终都存储在这个以“类型字符串可选 tag”为 key 的_singl哈希表中Get.find()本质上就是一次哈希表查找。而Get全局单例对象定义在 lib/get_core/src/get_main.dartclass _GetImpl extends GetInterface {} final Get _GetImpl();提示如果你使用 GetX 的状态管理器建议重点关注 Bindings API它能让你将 View 与 Controller 的连接变得异常轻松。二、实例化方法四种注入方式详解以下是依赖管理提供的四种核心方法及其可配置参数。对应源码统一位于 lib/get_instance/src/extension_instance.dart建议对照阅读。2.1 Get.put() —— 最常用的即时注入Get.put()是最常见的依赖注入方式通常用于注入当前 View 的 controllerGet.putSomeClass(SomeClass()); Get.putLoginController(LoginController(), permanent: true); Get.putListItemController(ListItemController, tag: some unique string);完整的参数说明如下对应源码 extension_instance.dartGet.putS( // 必填你想要保存的类实例例如 controller 或任意类型的类。 // 注意S 表示该类型可以是任意类。 S dependency // 可选当你想要注册多个同类型类时使用。 // 因为通常你通过 Get.findController() 获取类 // 所以需要用 tag 来标记你需要的是哪一个实例。 // tag 必须唯一且类型为 String。 String tag, // 可选默认情况下Get 会在实例不再被使用后将其 dispose // 例如某个 View 的 controller 在 View 关闭后被清理 // 但如果你需要在应用其他位置继续使用它 // 例如 SharedPreferences 之类的实例就需要用到该参数。 // 默认值为 false。 bool permanent false, // 可选允许你在测试中使用抽象类时用另一个实现替换它并跟进测试。 // 默认值为 false。 bool overrideAbstract false, // 可选允许你用函数而非依赖本身来注入依赖。 // 该参数很少使用。 InstanceBuilderCallbackS builder, )从源码实现看put会以isSingleton: true、permanent: permanent调用内部方法_insert把 builder 注册进_singl然后立即执行findS()完成实例的初始化与生命周期启动S putS(S dependency, {String? tag, bool permanent false}) { _insert(isSingleton: true, name: tag, permanent: permanent, builder: (() dependency)); return findS(tag: tag); }也就是说Get.put是“创建即初始化”实例立刻进入内存。2.2 Get.lazyPut() —— 按需懒加载Get.lazyPut()让依赖进入“懒加载”模式只有当你第一次调用Get.find()时实例才会被真正创建。这对于“昂贵”的计算类非常有用也适合在 Bindings 类中集中注册多个类而无需立即实例化它们。/// ApiMock 只在有人第一次调用 Get.findApiMock 时才被实例化。 Get.lazyPutApiMock(() ApiMock()); Get.lazyPutFirebaseAuth( () { // ... 一些按需逻辑 return FirebaseAuth(); }, tag: Math.random().toString(), fenix: true ); Get.lazyPutController(() Controller());完整参数说明如下源码见 extension_instance.dartGet.lazyPutS( // 必填当你的类第一次被调用时将要执行的函数。 InstanceBuilderCallback builder, // 可选与 Get.put() 相同用于区分同类型的多个实例。 // 必须唯一且为 String。 String tag, // 可选类似于 permanent区别在于 // 实例在不被使用时会从内存删除但当再次需要时 // Get 会重新创建该实例就像 bindings API 中的 // SmartManagement.keepFactory 一样。 bool fenix false )源码中lazyPut有一个值得注意的细节——fenix的默认值并不总是falsevoid lazyPutS(InstanceBuilderCallbackS builder, {String? tag, bool? fenix, bool permanent false}) { _insert( isSingleton: true, name: tag, permanent: permanent, builder: builder, fenix: fenix ?? Get.smartManagement SmartManagement.keepFactory, ); }当全局smartManagement配置为SmartManagement.keepFactory时即使你不显式传fenix: true懒加载实例也会默认具备“凤凰重生”能力。这一点在 test/instance/get_instance_test.dart 中有对应的测试用例test(Get.lazyPut fenix test, () async { Get.lazyPutController(() Controller(), fenix: true); Get.findController().increment(); expect(Get.findController().count, 1); Get.deleteController(); expect(Get.findController().count, 0); // 删除后重新创建count 归零 Get.reset(); });2.3 Get.putAsync() —— 异步实例的注入当你需要注册一个异步创建的实例时使用Get.putAsync()Get.putAsyncSharedPreferences(() async { final prefs await SharedPreferences.getInstance(); await prefs.setInt(counter, 12345); return prefs; }); Get.putAsyncYourAsyncClass(() async await YourAsyncClass());完整参数说明如下对应类型定义见 extension_instance.dartGet.putAsyncS( // 必填用于实例化你的类的异步函数。 AsyncInstanceBuilderCallbackS builder, // 可选与 Get.put() 相同用于区分同类型的多个实例。 // 必须唯一且为 String。 String tag, // 可选与 Get.put() 相同用于让实例在整个应用中 // 保持存活keep-alive。 // 默认值为 false。 bool permanent false )注putAsync与put遵循相同的创建顺序区别仅在于前者使用异步函数构建实例两者都会将实例直接放入内存并随后通过Get.find()完成初始化。2.4 Get.create() —— 每次 find 都新建实例Get.create()稍微特殊一些。它并不返回单例而是每次调用Get.find()时都会通过 builder 函数“重新制造”一个新实例。详细差异见本文第三节「方法之间的区别」。Get.createSomeClass(() SomeClass()); Get.createLoginController(() LoginController());完整参数说明如下Get.createS( // 必填一个返回类的函数每次调用 Get.find() 时都会重新制造一个实例。 // 示例Get.createYourClass(() YourClass()) FcBuilderFuncS builder, // 可选与 Get.put() 相同用于区分同类型的多个实例。 // 当你的列表中的每一项都需要各自的 controller 时非常有用。 // 必须唯一且为 String。这里参数名是 name。 String name, // 可选与 Get.put() 相同用于让实例在应用中保持存活。 // 对于 Get.createpermanent 的默认值为 true。 bool permanent true )在当前的仓库源码中Get.create的底层实现逻辑体现在spawn方法中extension_instance.dart它以isSingleton: false、permanent: true注册void spawnS(InstanceBuilderCallbackS builder, {String? tag, bool permanent true}) { _insert(isSingleton: false, name: tag, builder: builder, permanent: permanent); }当isSingleton为false时_InstanceBuilderFactory.getDependency()会直接调用builderFunc()而不是复用缓存的dependencyextension_instance.dart这就是“每次 find 都是新实例”的底层原因。仓库测试 test/instance/get_instance_test.dart 也验证了这一点test(Get.create with abstract class test, () async { Get.spawnService(() Api()); final ct1 Get.findService(); final ct2 Get.findService(); expect(ct1 ct2, false); // 每次 find 都是新实例 Get.reset(); });另外从 lib/get_state_manager/src/simple/get_view.dart 的注释可以看到GetWidget将每个 controller 缓存到独立的Expando中因此Get.createspawn应当与GetWidget搭配使用以保证每个列表项 / 每个 Widget 都持有自己唯一的实例并能在退出时正确触发onClose。三、获取与释放实例Get.find 与 Get.delete想象一下你在很多路由之间导航需要在很靠后的路由里访问之前路由的 controller 数据。通常你需要 state manager Provider 或 Get_it 的组合——但用 Get 完全不需要你只需让 Get “找到”那个 controller不需要任何额外依赖final controller Get.findController(); // 或者 Controller controller Get.find(); // 是的这就像魔法Get 会找到你的 controller 并把它送到你所在的位置。 // 即使你有 100 万个已初始化的 controllerGet 也总能给你正确的那个。之后你就能获取之前遗留在其中的数据Text(controller.textFromApi);因为返回值是一个普通类你可以对它做任何事int count Get.findSharedPreferences().getInt(counter); print(count); // 输出12345从源码看find的核心逻辑在 extension_instance.dartS findS({String? tag}) { final key _getKey(S, tag); if (isRegisteredS(tag: tag)) { final dep _singl[key]; ... final i _initDependenciesS(name: tag); return i ?? dep.getDependency() as S; } else { throw $S not found. You need to call Get.put($S()) or Get.lazyPut(()$S()); } }值得说明的是_initDependenciesextension_instance.dart中有一个关键分支当实例是单例且smartManagement不是SmartManagement.onlyBuilder时会把该实例与当前路由关联起来reportDependencyLinkedToRoute这正是后面“路由出栈即自动清理”机制的数据来源。此外Get还提供了若干便捷 APIGet.findOrNullS()注册过则返回实例否则返回nullextension_instance.dart测试见 get_instance_test.dartGet.isRegisteredS()判断某类型或 tag是否已注册Get.replaceP()/Get.lazyReplaceP()删除父实例并用新实例替换常用于测试中替换抽象实现测试见 get_instance_test.dartGet.reloadS()/Get.reloadAll()重置实例而不注销注册。从内存中删除一个实例Get.deleteController(); // 通常你不需要手动调用因为 GetX 已经替你做了delete的实现extension_instance.dart有几个值得注意的行为若实例被标记为permanent且未传force: true则拒绝删除若实例混入了GetxServiceMixin即GetxService类型同样拒绝删除只能通过Get.reset()清理——这是 lib/get_instance/src/lifecycle.dart 中GetxService的设计意图服务一旦启动就常驻内存如 Auth 服务若注册时fenix为true删除时仅清空dependency与isInit保留 builder 以便将来重建对于实现了GetLifeCycleMixin的实例删除时会调用onDelete()内部触发onClose()释放资源。生命周期钩子定义在 lib/get_instance/src/lifecycle.dartonInit()在实例分配内存后立即调用、onReady()在onInit()之后一帧调用适合发起导航、Snackbar 或异步请求、onClose()在销毁前调用适合关闭流、Timer、TextEditingController等资源。四、方法之间的区别permanent、fenix 与四种注入语义4.1 permanent 与 fenix 的本质区别首先必须理解Get.lazyPut的fenix与其他方法的permanent之间的根本差异——它们决定了你希望如何“保存”类实例。默认行为强调GetX 默认会在实例不再被使用时将其删除。这意味着假设 Screen 1 有 controller 1Screen 2 有 controller 2当你把第一条路由从栈中移除例如使用Get.off()或Get.offNamed()时controller 1 就会失去使用状态并被删除。permanent: truecontroller 不会在页面切换时被删除——非常适合那些希望在整个应用中保持存活keep-alive的 Service。fenix用于那些你希望“切换页面时不必担心丢失”但当你需要时又期望它仍然存在的 Service。实际上controller/service/class 依然会被 dispose只是当你再次需要它时Get 会“从灰烬中”重新创建一个全新实例这正是fenix一词“凤凰”的含义。4.2 四种方法的分组与底层差异Get.put与Get.putAsync遵循相同的创建顺序区别在于后者使用异步方法。两者都会创建并初始化实例直接放入内存通过内部insert方法以permanent: false和isSingleton: true参数注册isSingleton参数仅用于区分应该使用dependency还是FcBuilderFunc。随后调用Get.find()立即初始化内存中的实例。Get.create顾名思义它“创建”你的依赖与Get.put类似它也调用内部insert来实例化但把permanent改为true、isSingleton改为false因为我们是“创建”依赖无法将其作为单例所以为false。由于permanent: true默认就拥有页面切换不丢失的优势同时Get.find()不会被直接调用而是等待在某个页面被使用时才调用。它是这样设计的可以善用permanent参数同时要知道Get.create()的目的是创建“不可共享、但也不会被 dispose”的实例——例如 ListView 中的一个按钮你希望列表拥有一个唯一的实例——因此Get.create必须与GetWidget配合使用如 get_view.dart 所述。Get.lazyPut顾名“lazy”即“懒加载过程”。实例被注册但不会直接使用它等待被调用。与其他方法相反这里不会调用insert完成实例化实例被放入内存中另一个负责“判断能否重建”的区域——我们称之为factory工厂。如果你想为将来使用准备一些东西它不会与当前正在使用的东西混淆。而fenix的“魔法”就发生在这里如果你选择保持fenix: false且smartManagement不是keepFactory那么当使用Get.find时实例会在内存中移动位置、进入这个独立的 factory 区域甚至进入公共区域以便将来再次被调用。五、Bindings将路由、状态与依赖注入完全集成Bindings 也许是这个包最大的差异点之一它提供了将路由route、状态管理器state manager与依赖管理器dependency manager完全集成的可能性。当路由从 Stack 中移除时与其相关的所有 controller、变量和实例都会从内存中清除。如果你使用了 stream 或 timer它们也会被自动关闭无需担心泄漏。自版本 2.10 起Get 完整实现了 Bindings API你不再需要使用init方法甚至不必在页面里手动声明要使用的 controller——你可以在最合适的位置启动 controller 和 service。Binding 类是一个将依赖注入与路由、状态管理“挂钩”的类它让 Get 知道当前正在显示哪个 View、对应使用哪个 controller以及如何正确地 dispose 它。此外Binding 类还让你能控制 SmartManager 的配置。你可以配置依赖是在路由从栈中移除时清理、还是在使用它的 Widget 被放置时清理、或两者都不清理。默认情况下智能依赖管理会替你工作但你完全可以按需配置。5.1 创建 Bindings 类创建一个实现Bindings的类class HomeBinding implements Bindings {}你的 IDE 会自动提示你 overridedependencies方法——点击灯泡图标、override 该方法然后放入该路由中要使用的所有类class HomeBinding implements Bindings { override void dependencies() { Get.lazyPutHomeController(() HomeController()); Get.putService(() Api()); } } class DetailsBinding implements Bindings { override void dependencies() { Get.lazyPutDetailsController(() DetailsController()); } }Bindings抽象类的定义位于 lib/get_instance/src/bindings_interface.dart目前被标记为Deprecated(Use Binding instead)。当前仓库推荐使用的是返回ListBind的Binding类定义于 lib/get_state_manager/src/simple/get_state.dart而Bind是一个提供put/lazyPut/create/spawn/find等静态方法的StatelessWidgetget_state.dart。仓库中的真实示例 example/lib/pages/home/bindings/home_binding.dart 展示了推荐写法class HomeBinding extends Binding { override ListBind dependencies() { return [ Bind.lazyPutIHomeProvider(() HomeProvider()), Bind.lazyPutIHomeRepository(() HomeRepository(provider: Get.find())), Bind.lazyPut(() HomeController(homeRepository: Get.find())), ]; } }这种写法的好处是Bind.lazyPut返回的_FactoryBind会在其 Element 被卸载时自动调用Get.delete实现与页面生命周期的自动联动参考 get_state.dart 中onClose回调的注册逻辑。然后只需告诉你的路由将使用该 binding 来建立路由管理器、依赖管理器和状态之间的连接。使用命名路由GetPagegetPages: [ GetPage( name: /, page: () HomeView(), binding: HomeBinding(), ), GetPage( name: /details, page: () DetailsView(), binding: DetailsBinding(), ), ];使用普通路由Get.to(Home(), binding: HomeBinding()); Get.to(DetailsView(), binding: DetailsBinding());从源码看GetPage除了binding还支持bindings列表与bindsBind列表参数lib/get_navigation/src/routes/get_route.dart。example_nav2 项目的路由表 example_nav2/lib/app/routes/app_pages.dart 展示了在复杂嵌套路由中使用bindings: [RootBinding(), ...]的完整案例。Binding 会在路由被调用时触发。你也可以在GetMaterialApp中设置initialBinding注入所有必需的依赖GetMaterialApp( initialBinding: SampleBind(), home: Home(), );GetMaterialApp的完整参数定义见 lib/get_navigation/src/root/get_material_app.dart其中smartManagement默认值为SmartManagement.full第 121 行。5.2 BindingsBuilder —— 免建类的快捷方式默认情况下创建 Binding 的方式是新建一个实现Bindings的类。另一种方式是使用BindingsBuilder通过一个回调函数实例化任何你想要的东西getPages: [ GetPage( name: /, page: () HomeView(), binding: BindingsBuilder(() { Get.lazyPutControllerX(() ControllerX()); Get.putService(() Api()); }), ), GetPage( name: /details, page: () DetailsView(), binding: BindingsBuilder(() { Get.lazyPutDetailsController(() DetailsController()); }), ), ];这样你可以避免为每个路由单独创建一个 Binding 类让代码更简洁。两种方式都能完美工作选择你觉得顺手的那种即可。六、SmartManagement三种内存清理策略GetX 默认会从内存中 dispose 不再使用的 controller——即使发生异常、使用该 controller 的 Widget 没有被正确 dispose也会被清理。这就是所谓的full模式。但如果你希望改变 GetX 对“类销毁”的控制方式可以通过SmartManagement类来调整行为。枚举定义于 lib/get_core/src/smart_management.dartenum SmartManagement { full, onlyBuilder, keepFactory, }6.1 如何修改配置这种配置通常不需要修改但如果你想改比如设置成onlyBuildersvoid main () { runApp( GetMaterialApp( smartManagement: SmartManagement.onlyBuilders // 在这里修改 home: Home(), ) ) }默认值SmartManagement.full定义在 lib/get_core/src/get_interface.dart即Get.smartManagement SmartManagement.full;。6.2 SmartManagement.full默认清理所有未被使用、且未被标记为permanent的类。在大多数情况下你希望保持该配置不动——如果你是 GetX 新手请不要修改它。6.3 SmartManagement.onlyBuilders使用该选项时只有以下两类 controller 会被 dispose在init:中启动的 controller通过Get.lazyPut()加载进 Binding 的 controller。如果你使用Get.put()、Get.putAsync()或其他方式SmartManagement 无权排除清理这些依赖。这与默认行为形成对比在默认行为下即使是通过Get.put实例化的 Widget 也会被移除而SmartManagement.onlyBuilders不会。源码层面的证据见 lib/get_navigation/src/router_report.dartreportRouteDispose中if (Get.smartManagement ! SmartManagement.onlyBuilder)才执行依赖清理同时_initDependenciesextension_instance.dart中只有非onlyBuilder模式才把单例实例关联到当前路由。6.4 SmartManagement.keepFactory与SmartManagement.full相同它会清理不再使用的依赖但它会保留 factory工厂意味着当你再次需要该依赖时它会重新创建。这正好呼应了前文lazyPut源码中fenix: fenix ?? Get.smartManagement SmartManagement.keepFactory的默认值逻辑——在keepFactory模式下懒加载依赖天然具备重建能力。6.5 Bindings 的幕后工作方式Bindings 会创建一个临时 factory它在你点击跳转到另一个页面时被创建并在页面切换动画结束后立即被删除。这个过程非常快甚至 analyzer静态分析器都无法记录它。当你再次回到该页面时新的 factory 会被调用——因此这比使用SmartManagement.keepFactory更值得推荐但如果你不想创建 Bindings或想把所有依赖放在同一个 Binding 中keepFactory会很有帮助。factory 对内存的消耗非常小它们不持有实例只是一些带有“类形状”的函数。这极大地节省了内存但因为这个库的目标是获得最大性能并尽可能少地使用资源Get 默认连 factory 本身也会删除。选择你觉得方便的方式即可。七、注意事项与最佳实践不要在使用多个 Bindings 时使用SmartManagement.keepFactory该模式是为“不使用 Bindings”或“只使用一个与GetMaterialApp的initialBinding关联的 Binding”而设计的。使用 Binding 是可选的如果你愿意完全可以只用Get.put()和Get.find()来管理 controller 类没有任何问题。不过如果你在使用 Service 或其他形式的抽象推荐使用 Bindings 以便更好地组织代码。善用GetxService常驻内存GetxServicelib/get_instance/src/lifecycle.dart不会被Get.delete()移除适合 Auth 之类的全局服务只有Get.reset()能清理它。GetX 与路由生命周期自动联动测试 test/navigation/dispose_dependencies_test.dart 完整验证了“路由出栈 → 依赖自动注销”的行为当从 Second 页面Get.back()返回 First 时Controller2被自动移除而Controller仍然存活再Get.back()后Controller也被移除。这说明只要配合GetMaterialApp使用内存管理几乎无需手动干预。测试中的重置单元测试的tearDown或结束时建议调用Get.reset()内部调用resetInstanceextension_instance.dart它会清空所有已注册实例及路由绑定避免用例之间相互污染。结语GetX 的依赖管理器以极低的 API 门槛Get.put/Get.lazyPut/Get.putAsync/Get.createGet.find提供了完整的依赖注入能力并通过 Bindings 与 SmartManagement 将「路由生命周期」和「内存回收」自动衔接起来。理解permanent、fenix、onlyBuilders、keepFactory这几组概念的差异就能在实战中精准控制每个依赖的存活范围。建议进一步阅读仓库源码 lib/get_instance/src/extension_instance.dart、lib/get_core/src/smart_management.dart 与测试 test/instance/get_instance_test.dart并参照 example/lib/pages/home/bindings/home_binding.dart 与 example_nav2/lib/app/routes/app_pages.dart 中的实战写法将这套依赖管理体系落地到自己的 Flutter 项目中。赞分享前端【免费下载链接】getxOpen screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.项目地址https://gitcode.com/gh_mirrors/ge/getx点击查看免费下载相关推荐GetX 依赖管理完全指南从 Get.put 到 Bindings 与 SmartManagement 的源码级解析GetX 依赖管理完全指南从 Get.put 到 Bindings 与 SmartManagement 的源码级解析 本指南基于当前仓库 documentat前端GetX 依赖注入完全指南从 Get.put、Bindings 到 SmartManagement 的源码级解析GetX 依赖注入完全指南从 Get.put、Bindings 到 SmartManagement 的源码级解析 Get 内置的依赖管理器让你可以用一行代码注前端GetX 依赖管理Dependency Management完整指南Get.put、Bindings 与 SmartManagement 源码级解析GetX 依赖管理Dependency Management完整指南Get.put、Bindings 与 SmartManagement 源码级解析 Ge前端上一篇Bytebase DiffMetadata 重构解析从 SQLService 匿名调用到 DatabaseService 的 IAM 门控 DDL 生成下一篇如何快速上手MultiQC3分钟完成多样本分析报告整合创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考