awilix容器:目前网上的资料非常少,由于项目中有使用,总结了一些内容。
awilix一般和express结合使用,因此需要安装 awilix-express 依赖. 以及 awilix 依赖.
容器参数:
awilix 内部导出的一些方法:
createContainer: 创建容器,在项目启动时执行。
InjectionMode: 注入模式,awilix注入依赖的模式。
asClass: 将注入的文件作为一个类注入。即需要实例化
asFunction: 将注入的文件作为一个方法,无需实例化。
asValue:将注入的文件作为常量访问。
Lifetime:生命周期。默认单例模式(SINGLETON)
dbModels:容器的数据访问层,将数据库的模型的实例赋值。
加载类文件:
loadModules(path, options):第一个参数是文件路径的数组, 第二个参数是对传入依赖的一些配置: formatName: 'camelCase',类名导出的格式,默认驼峰式。这个意思就是说,不管文件名怎么写,最后导出时使用的类名都是驼峰式命名
resolveOptions:注入方式等
如何启动awilix项目:
以express为例,导出express实例
这里之所以能导出express,是因为在之前依赖注入的时候已经将express注入到容器中了
这里的application的作用,仅仅是启动express,即调用listen方法监听端口。
导出scopePerRequest:
app.use(scopePerRequest(container)):通过添加中间件的方式,将awilix的实例container启动。
注入对象:
awilix注入对象并没有一个默认的路径,所有需要注入的类都需要手动指定:调用loadModules()方法。
loadModules():awilix实例上的方法。接收两个参数,第一个参数是注入对象的路径字符串数组,第二个参数是object对象,用于配置注入对象.
类的自动装配:
注入类之后,如何使用这些类?只需要在构造函数的参数中声明需要使用的类名(命名格式依照之前注入时的格式配置),然后挂载在类变量上,就能在当前使用这些注入的对象了。
循环依赖:
为了解决可能出现的循环依赖的问题,一般不在constructor里面注入service类,awilix会自动扫描类中的init() 方法。所以,书写类文件的时候,一般都会默认添加一个init() 方法。并将其中注入的类添加到类的实例中,通过init方法的内部调用,避免了出现循环依赖。因此,在constructor中一般注入配置类、数据库实体类、策略工厂类、或其他第三方库提供类。init() 方法中则添加需要使用的service类。
service层和controller层:
controller层的router导出Router实例,Router使用express自带的Route构造函数。那么awilix如何知道controller目录下的文件需要以Controllers的方式注入且注册路由的呢,loadControllers
awilix会导出一个方法 loadControllers,用来识别哪些文件需要以controller的文件类型注入。
service层不需要额外表示文件类型,原则上统一将逻辑处理称为service。启动容器时,将router作为中间件注册到express。调用express的实例 listen() 方法,容器就启动了。
至此,Awilix容器的启动配置和基本特性就讲完了。