以下是一个使用Midway + TypeORM搭建的简单的Node.js后端框架示例。
- 初始化项目：
$ npm init midway --type=ts
- 安装TypeORM依赖：
$ npm install typeorm pg --save
- 配置
src/config/config.default.ts添加TypeORM配置：
export default {
// ...
typeorm: {
type: 'postgres', // 数据库类型
host: 'localhost', // 数据库地址
port: 5432, // 数据库端口
username: 'your_username', // 数据库用户名
password: 'your_password', // 数据库密码
database: 'your_database', // 数据库名
synchronize: true, // 是否同步数据库结构
logging: true, // 是否打印SQL日志
entities: ['./entity/**/*.ts'], // 实体文件位置
migrations: ['./migration/**/*.ts'], // 迁移文件位置
subscribers: ['./subscriber/**/*.ts'], // 订阅器文件位置
},
// ...
};
- 创建实体（Entity）：
在src/entity目录下创建一个User.ts：
import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: number;
@Column({ length: 50 })
name: string;
@Column({ length: 50 })
email: string;
}
- 创建一个Controller和Service：
// src/controller/user.ts
import { Controller } from '@midwayjs/decorator';
import { CoolController } from '@cool-midway/core';
import { UserEntity } from '../entity/user';
@Controller('/user')
export class UserController extends CoolController {
// ...
}
// src/service/user.ts
import { Provide } from '@midwayjs/decorator';
import { InjectEntityModel } from '@midwayjs/orm';
import { Repository } from 'typeorm';
import { UserEntity } from '../entity/user';
@Provide()
export class UserService {
@InjectEntityModel(UserEntity)
userModel: Repository<UserEntity>;
async findAll(): Promise<UserEntity[]> {
return await this.userModel.find();
}
// 其他方法...
}
- 在
src/interface.ts中定义Service方法：
import { IDefinition } from '@cool-midway/core';
export default {
'user:findAll': IDefinition.Func
};
- 使用TypeORM的迁移功能创建数据库表：
$ npm run typeorm migration:run
以上代码提供了一个简单的示例，展示了如何在Midway框架中使用TypeORM。这个示例包括了实体定义、迁移运行等步骤，为开发者提供了一个完整的视角来理解如何将TypeORM集成到Node.js后端开发中。