Power-DI 项目使用教程

Power-DI 项目使用教程

1. 项目的目录结构及介绍

Power-DI 是一个轻量级的依赖注入库。以下是项目的目录结构及其介绍：

power-di/
├── src/
│   ├── core/
│   │   ├── Injector.ts
│   │   ├── Module.ts
│   │   └── Provider.ts
│   ├── decorators/
│   │   ├── Inject.ts
│   │   ├── Injectable.ts
│   │   └── Optional.ts
│   ├── index.ts
│   └── utils/
│       └── helpers.ts
├── tests/
│   ├── core/
│   │   ├── Injector.test.ts
│   │   ├── Module.test.ts
│   │   └── Provider.test.ts
│   ├── decorators/
│   │   ├── Inject.test.ts
│   │   ├── Injectable.test.ts
│   │   └── Optional.test.ts
│   └── utils/
│       └── helpers.test.ts
├── package.json
├── tsconfig.json
└── README.md

目录结构说明

• src/: 源代码目录。
  • core/: 核心功能模块，包括依赖注入器、模块和提供者的实现。
  • decorators/: 装饰器模块，用于定义依赖注入相关的装饰器。
  • utils/: 工具函数模块。
  • index.ts: 项目入口文件。
• tests/: 测试代码目录，包含各个模块的单元测试。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。该文件主要负责导出项目的核心功能和装饰器，以便其他项目引用和使用。

// src/index.ts
export * from './core/Injector';
export * from './core/Module';
export * from './core/Provider';
export * from './decorators/Inject';
export * from './decorators/Injectable';
export * from './decorators/Optional';

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件定义了项目的依赖、脚本和其他元数据。以下是部分关键内容：

{
  "name": "power-di",
  "version": "1.0.0",
  "description": "A lightweight Dependency Injection library",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "reflect-metadata": "^0.1.13"
  },
  "devDependencies": {
    "@types/jest": "^27.0.1",
    "jest": "^27.0.6",
    "ts-jest": "^27.0.3",
    "typescript": "^4.4.3"
  }
}

tsconfig.json

tsconfig.json 文件定义了 TypeScript 编译器的配置选项。以下是部分关键内容：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

通过以上配置，可以确保项目能够正确编译和运行。