ngxtension 依赖注入进阶：createInjectable 与 assertInjector 最佳实践

ngxtension 依赖注入进阶：createInjectable 与 assertInjector 最佳实践

【免费下载链接】ngxtension-platformUtilities for Angular项目地址: https://gitcode.com/gh_mirrors/ng/ngxtension-platform

在 Angular 开发中，依赖注入是核心机制之一，而 ngxtension-platform 提供的createInjectable和assertInjector工具则进一步简化了依赖注入的高级用法。本文将深入探讨这两个工具的工作原理、使用场景和最佳实践，帮助开发者构建更健壮、更灵活的 Angular 应用。

为什么需要依赖注入增强工具？

Angular 的依赖注入系统虽然强大，但在处理复杂场景时仍有优化空间：

• 传统服务创建需要手动定义类并添加@Injectable()装饰器，步骤繁琐
• 注入上下文验证需要额外代码确保服务在正确的注入上下文中使用
• 服务作用域管理缺乏简洁的 API 来控制服务的提供范围

ngxtension-platform 的createInjectable和assertInjector正是为解决这些问题而生，它们通过函数式 API 简化了服务创建和注入验证流程。

createInjectable：简化服务创建的函数式 API

createInjectable提供了一种声明式创建注入服务的方式，无需手动定义类。

基本用法

import { createInjectable } from 'ngxtension/create-injectable'; const UserService = createInjectable(() => ({ getUser: () => ({ id: 1, name: 'John Doe' }), updateUser: (user: any) => console.log('Updating user', user) }));

这段代码会自动生成一个带有@Injectable()装饰器的类，等价于传统的 Angular 服务定义。

作用域控制

通过providedIn选项可以轻松控制服务作用域：

// 根注入器 const GlobalService = createInjectable(() => ({}), { providedIn: 'root' }); // 平台级注入器 const PlatformService = createInjectable(() => ({}), { providedIn: 'platform' }); // 非根注入器（需手动在模块/组件中提供） const ScopedService = createInjectable(() => ({}), { providedIn: 'scoped' });

实现原理

查看源码 libs/ngxtension/create-injectable/src/create-injectable.ts 可知，createInjectable本质上是一个高阶函数，它：

1. 创建一个匿名类并应用@Injectable()装饰器
2. 在构造函数中执行传入的工厂函数
3. 将工厂函数返回对象的属性通过Object.defineProperty代理到类实例
4. 根据工厂函数名称生成有意义的类名，便于调试

assertInjector：确保注入上下文的安全保障

assertInjector是 AngularassertInInjectionContext的增强版，提供了更灵活的注入上下文验证和管理。

核心功能

• 验证当前是否存在注入上下文
• 接受自定义注入器并返回有效的注入器实例
• 支持在指定注入上下文中执行函数

典型应用场景

在自定义注入函数中确保注入上下文：

import { assertInjector } from 'ngxtension/assert-injector'; import { Injector } from '@angular/core'; function injectCustomService(injector?: Injector) { // 确保注入上下文有效并获取注入器 injector = assertInjector(injectCustomService, injector); // 在注入上下文中执行代码 return injector.get(CustomService); }

带执行函数的用法

更简洁的方式是直接传入执行函数：

function getConfigValue(key: string, injector?: Injector) { return assertInjector( getConfigValue, injector, () => inject(ConfigService).get(key) ); }

实现原理

从 libs/ngxtension/assert-injector/src/assert-injector.ts 源码可以看到，assertInjector主要做了三件事：

1. 如果没有提供注入器，调用assertInInjectionContext验证当前上下文
2. 获取有效的注入器（提供的注入器或当前上下文的注入器）
3. 如果提供了执行函数，使用runInInjectionContext在注入上下文中执行

最佳实践与常见模式

1. 结合使用 createInjectable 和 assertInjector

创建需要依赖其他服务的服务时，可以这样组合使用：

import { createInjectable } from 'ngxtension/create-injectable'; import { assertInjector } from 'ngxtension/assert-injector'; import { HttpClient } from '@angular/common/http'; const DataService = createInjectable(() => { const http = assertInjector(DataService, undefined, () => inject(HttpClient)); return { fetchData: () => http.get('/api/data'), saveData: (data: any) => http.post('/api/data', data) }; });

2. 创建可复用的注入函数

利用assertInjector创建可在任意地方安全使用的注入函数：

// 定义 export function injectLogger(injector?: Injector) { return assertInjector(injectLogger, injector, () => { const logger = inject(LoggerService); const user = inject(UserService); return { log: (message: string) => logger.log(`[${user.name}] ${message}`) }; }); } // 使用 @Component({ ... }) export class MyComponent { private logger = injectLogger(); ngOnInit() { this.logger.log('Component initialized'); } }

3. 管理服务作用域

对于需要在特定功能模块中共享的服务，使用scoped作用域：

// 服务定义 const FeatureService = createInjectable(() => ({ // 功能模块特定逻辑 }), { providedIn: 'scoped' }); // 模块中提供 @NgModule({ providers: [FeatureService] }) export class FeatureModule { }

常见问题与解决方案

问题：在非注入上下文中使用注入函数

解决方案：使用assertInjector并显式提供注入器

// 错误方式 function outsideComponent() { // 会抛出错误，因为不在注入上下文中 const service = inject(MyService); } // 正确方式 function outsideComponent(injector: Injector) { const service = assertInjector(outsideComponent, injector, () => inject(MyService)); }

问题：服务实例共享与隔离

解决方案：合理选择providedIn选项控制服务作用域

• root：应用级单例
• platform：跨应用单例（适用于微前端）
• scoped：模块/组件级作用域，需手动提供

总结

ngxtension-platform 的createInjectable和assertInjector为 Angular 依赖注入提供了强大的增强功能：

• createInjectable以函数式方式简化服务创建，减少样板代码
• assertInjector确保注入上下文安全，提供灵活的注入器管理
• 两者结合使用可以构建更简洁、更健壮的依赖注入代码

通过这些工具，开发者可以更专注于业务逻辑，同时确保依赖注入的最佳实践得以遵循。要了解更多细节，可以查阅官方源码实现：

• createInjectable 源码
• assertInjector 源码

掌握这些工具将帮助你在 Angular 应用开发中更好地利用依赖注入特性，构建可维护性和可扩展性更强的应用。

【免费下载链接】ngxtension-platformUtilities for Angular项目地址: https://gitcode.com/gh_mirrors/ng/ngxtension-platform