@aamazon/ vinyl-di (英语)
基于构造的依赖性注射,并经过编译时间检查的依赖性 图表。 由亚马逊·维尼尔内部使用,但单独使用.
安装
npm install @amazon/vinyl-di
依赖性注射
Amazon Vinyl使用最常见的依赖性注射形式 依赖建筑师.
类构造器有一个 deps 参数描述所需的依赖关系.
举个例子.
/**
* Dependencies for {@link RequesterImpl}
*/
export type RequesterImplDeps = {
readonly networkState: NetworkState
readonly fetch: Fetch
readonly networkMetricsController: NetworkMetricsController
}
export class RequesterImpl {
constructor(protected readonly deps: RequesterImplDeps) {}
// ...
}
const requester = new Requester({
networkState: new NetworkStateImpl(),
fetch: new FetchImpl(),
})
依赖性注射有两个步骤: 制造一个容器 利用工厂建造 执行.
创建依赖工厂记录时, 密钥匹配依赖
属性,而值是产生依赖性的函数。 工厂
函数可接受一个单一的参数,表示需要依赖
执行。 将记录包装在呼叫中 validateFactories 是一个
编译- 仅限时间检查, 以确保依赖图是健全的 。 也就是说,
没有循环依赖,缺少依赖性,或不兼容的类型.
示例
import { validateFactories } from '@amazon/vinyl-di'
class A {}
type BDependencies = {
readonly a: A
}
class B {
constructor(deps: BDependencies) {}
}
type CDependencies = {
readonly a: A
readonly b: B
}
class C {
constructor(deps: CDependencies) {}
}
const factories = validateFactories({
a: () => new A(),
b: (deps: BDependencies) => new B(deps),
c: (deps: CDependencies) => new C(deps),
} as const)
这些工厂将被用于创建执行. 使用 createContainer 改为
创建可处理的容器,并为对象提供获取器
懒散地从所提供的工厂中建造安装.
import { createContainer } from '@amazon/vinyl-di'
import { createDisposer } from '@amazon/vinyl-util'
const { add, dispose } = createDisposer()
const deps = add(createContainer(factories)).dependencies
deps.a // A {}
deps.b // B {}
deps.c // C {}
外部依赖
有时需要将已有实例注入依赖性容器
不转让所有权。 使用 externalDependencies 外包装
处置容器时不应处置的依赖性.
import {
externalDependencies,
validateFactories,
createContainer,
} from '@amazon/vinyl-di'
// External services managed elsewhere
const logger = new Logger()
const options = { port: 8080, host: 'localhost' }
const factories = validateFactories({
// These won't be disposed by the container
...externalDependencies({ logger, options }),
// This will be disposed by the container [if Server implements Disposable]
server: (deps: {
readonly options: ServerOptions
readonly logger: Logger
}) => new Server(deps.options, deps.logger),
})
const container = createContainer(factories)
// Use dependencies normally
container.dependencies.server.start()
// Only server.dispose() is called, logger and options are left alone
container.dispose()
作为一般准则,在确定提供依赖时,接口 请求应是所需最低API,处置应是 创造者的责任.
许可证
阿帕奇 - 2.0