InversifyJS 基础示例项目教程

InversifyJS 基础示例项目教程

inversify-basic-exampleA basic example that showcases how to setup InversifyJS项目地址:https://gitcode.com/gh_mirrors/in/inversify-basic-example

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

inversify-basic-example/
├── src/
│   ├── entities/
│   │   └── battle/
│   │       └── epic_battle.ts
│   ├── interfaces/
│   ├── constants/
│   ├── main.ts
├── .gitignore
├── .travis.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── ISSUE_TEMPLATE.md
├── LICENSE
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── gulpfile.js
├── package.json
├── tsconfig.json
├── tslint.json
└── uml.png

• src/: 包含项目的源代码。
  • entities/: 包含实体类文件，如 epic_battle.ts。
  • interfaces/: 包含接口定义文件。
  • constants/: 包含常量定义文件。
  • main.ts: 项目的入口文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• ISSUE_TEMPLATE.md: 问题模板文件。
• LICENSE: 项目许可证。
• PULL_REQUEST_TEMPLATE.md: 拉取请求模板文件。
• README.md: 项目说明文件。
• gulpfile.js: Gulp 构建脚本文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TSLint 配置文件。
• uml.png: UML 图文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。该文件是整个应用程序的入口点，负责初始化依赖注入容器并运行主要的业务逻辑。

// src/main.ts
import 'reflect-metadata';
import { Container } from 'inversify';
import { TYPES } from './constants/types';
import { Ninja } from './entities/ninja';
import { Katana } from './entities/katana';
import { Shuriken } from './entities/shuriken';
import { Warrior } from './interfaces/warrior';
import { Weapon } from './interfaces/weapon';
import { ThrowableWeapon } from './interfaces/throwable_weapon';

const container = new Container();
container.bind<Warrior>(TYPES.Warrior).to(Ninja);
container.bind<Weapon>(TYPES.Weapon).to(Katana);
container.bind<ThrowableWeapon>(TYPES.ThrowableWeapon).to(Shuriken);

const ninja = container.get<Warrior>(TYPES.Warrior);

console.log(ninja.fight());
console.log(ninja.sneak());

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "inversify-basic-example",
  "version": "1.0.0",
  "description": "A basic example that showcases how to setup InversifyJS",
  "main": "dist/main.js",
  "scripts": {
    "build": "gulp",
    "start": "node dist/main.js"
  },
  "dependencies": {
    "inversify": "^5.0.1",
    "reflect-metadata": "^0.1.13"
  },
  "devDependencies": {
    "gulp": "^4.0.2",
    "gulp-typescript": "^6.0.0-alpha.1",
    "typescript": "^4.0.2"
  },
  "keywords": [
    "inversifyjs",
    "dependency",
    "injection",
    "di",
    "javascript",
    "typescript"
  ],
  "author": "Remo H. Jansen <remo.jansen@wolksoftware.com> (http://www.remojansen.com)",
  "license": "MIT"
}

`

inversify-basic-exampleA basic example that showcases how to setup InversifyJS项目地址:https://gitcode.com/gh_mirrors/in/inversify-basic-example