🎖🎖🎖 基于 Nest + Ts 二次封装的【Nest-base】。对 Nest.js 进行了整理，风格化，二次封装，分层，动态配置，JWT，MySQL，MongoDB，参数校验，swagger 文档配置，让您避免繁琐的项目基础配置，更快的上手开发
- master: 使用 mysql 做的 auth 模块的验证, 同时使用mongodb做的业务
- master-mysql: 使用 mysql
- master-mongo: 使用 mongodb
yarn or npm iNODE_ENV = development
PORT = 7000
# 邮件配置
MAIL = <你的邮箱>
MAIL_AUTH_CODE = <邮箱秘钥>
# MongoDB配置
MONGO_URI = mongodb://username:password@1.1.1.3:27017/dbname
# development
$ npm run start
$ npm run start:dev
$ npm run start:prod# unit tests
$ npm run test
$ npm run test:e2e
$ npm run test:cov- 用户的注册，注销
- 授权登陆其他服务
- weare 发布订阅服务
- 根目录/config 目录：统一的配置文件
# 安装配置npm包
$ yarn add @nestjs/config
$ yarn add @hapi/joi // 验证包
$ yarn add -D @types/hapi__joi- app.module.ts 文件全局配置
imports: [
ConfigModule.forRoot({
envFilePath: '.env', // 配置文件路径，也可以配置为数组如['/config/.env1','.env']。
ignoreEnvFile: false, // 取消忽略配置文件，为true则仅读取操作系统环境变量，常用于生产环境
isGlobal: true, // 作用于全局
load: [mongoConfig, mailConfig], // 加载自定义配置项
// 配置文件.env校验
validationSchema:Joi.object({
PORT:Joi.string().default('7000'),
ENV:Joi.string()
.valid('development','production','test','provision')
.default('development')
})
}),
...
],- 使用（见数据库配置）
useFactory: (configService: ConfigService) => configService.get('MONGO_CONFIG'),
// useFactory: (configService: ConfigService) => configService.get('MONGO_CONFIG.uri'), // 内部nest g mo server用了存放所有的业务模块 功能模块不在此模块下
-
安装包
yarn add mysql @nestjs/typeorm typeorm -S
-
生成 mysql 模块并配置
nest g mo db-mysql- mysql.moudle.ts
@Module({
imports: [
ConfigModule.forRoot({
load: [mysqlConfig], // 加载自定义配置项
}),
TypeOrmModule.forRootAsync({
imports: [ConfigModule], // 数据库配置项依赖于ConfigModule，需在此引入
inject: [ConfigService],
useFactory: async (configService: ConfigService) => {
const mysqlConfig = await configService.get('MYSQL_CONFIG')
return {
...mysqlConfig,
type: 'mysql',
entities: [`${__dirname}/../**/*.entity{.ts,.js}`], // 扫描所有实体类
synchronize: true, // true 会反向同步表，如加入数据库中没有的新字段
// logging: false, // 生产模式关闭
// timezone: '+8:00', // 时区调整
};
}
}),
],
})3. 创建实体类 例：user.entity.ts
```ts
@Entity({
name: "t_user"
})
export class User extends BaseEntity {
@PrimaryGeneratedColumn({
name: 'user_id',
type: 'int',
comment: '用户ID',
})
user_id: number;
@Column({
name: 'mail',
type: 'varchar',
length: 100,
nullable: false,
comment: '邮箱号'
})
mail: string;
@Column({
name: 'password',
type: 'varchar',
length: 255,
nullable: false,
comment: '密码'
})
password: string;
@Column({
name: 'password',
type: 'varchar',
length: 255,
nullable: false,
comment: '密码盐'
})
salt: string;
@Column({
name: 'user_name',
type: 'varchar',
comment: '用户名'
})
user_name: string;
@Column({
name: 'status',
type: 'int',
nullable: false,
comment: '状态',
})
status: number;
}
-
使用一：创建用户模块，并引入该实体类 user.module.ts
@Module({ imports: [TypeOrmModule.forFeature([User])], // 引入实体类 providers: [UserService], controllers: [UserController], exports: [UserService], })
-
使用二：service 层引用该实体
constructor( @InjectRepository(User) private readonly userRepository: Repository<User>, ) { }
- 生成 database 模块
# 安装配置npm包
$ yarn add mongoose @nestjs/mongoose- 配置 database 模块 database.module.ts
imports: [
MongooseModule.forRootAsync({
imports: [ConfigModule], // 数据库配置项依赖于ConfigModule，需在此引入
inject: [ConfigService],
useFactory: (configService: ConfigService) => configService.get('MONGO'),
}),
MongooseModule.forFeature([ // 挂载实体
{ name: IdSchemaName, schema: IdSchema },
{ name: UserSchemaName, schema: UserSchema }
]),
],- 业务模块使用
- user.module.ts
// 引入
imports: [
DatabaseModule,
MongooseModule.forFeature([{ name: UserSchemaName, schema: UserSchema }]),
],- user.service.ts
// 引入
constructor(
@InjectModel(UserSchemaName) private readonly userModel: Model<UserDocument>,
private readonly idService: IdService,
) { }
private async createUserId() {
return await this.idService.createId('user', 10000);
}- 安装包
# 安装配置npm包
$ yarn add @nestjs/swagger swagger-ui-express- 生成配置文件 _swagger.ts
- 启动文件 main.ts 中 使用配置文件
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const config = app.get(ConfigService);
const { PORT, ENABLE_SWAGGER } = config.get('SERVER_CONFIG');
if (ENABLE_SWAGGER) createSwagger(app); // 文档插件
await app.listen(PORT);
}- 新建 log 模块 文件 src/log/log.module.ts
- 安装包 yarn add nest-winston winston winston-daily-rotate-file winston-mongodb
- 声明正确返回的接口 文件 src/global/interface/response.interface.ts
export interface NormalResponse {
data: any; // 数据
message: string; // 信息
code: 0; // 自定义code
url: string; // 错误的url地址
}- 增加拦截器 文件 src/interceptor/transform.interceptor.ts
- app 使用拦截器
app.useGlobalInterceptors(new TransformInterceptor());- 声明请求错误返回的接口 文件 src/global/interface/response.interface.ts
export interface ErrorResponse {
data: any; // 数据
message: string; // 信息
code: string; // 自定义code
url: string; // 错误的url地址
}- 增加过滤器 文件 src/filters/http-exception.filter.ts
- app 使用过滤器
app.useGlobalFilters(new AuthExceptionFilter(), new HttpExceptionFilter());-
安装包
yarn add class-validator yarn add class-transformer
-
创建业务全局管道
- 文件 src/server/validation.pipe.ts
-
创建验证类 dto
export class CreateUsersDto { @IsEmail() readonly u_mail: string; @IsString({ message: '验证码必须是字符' }) readonly code: string; @IsString({ message: '密码必须是字符' }) password: string; }
-
参数使用管道
@Post() async create( @Body(new ParamsValidationPipe()) createUsersInfo: CreateUsersDto ) { console.log('============= createUsersInfo', createUsersInfo); return 'ok' }
-
middleware 文件夹内配置中间件
-
app.module.ts 内的 app 类实现 NestModule 接口的 configure 方法
export class AppModule implements NestModule { configure(consumer: MiddlewareConsumer) { consumer .apply(SignMiddleware) .exclude( { path: 'api/upload-files', method: RequestMethod.POST }, 'api/test', ) // 多个过滤多个参数 .forRoutes('*') .apply(LogMiddleware) // .forRoutes('users'); .forRoutes('*'); } }
-
安装包
yarn add passport passport-jwt passport-local @nestjs/passport @nestjs/jwt -S
-
生成 AuthModule 认证模块
@Global() // 使其在其他模块可用 @Module({ imports: [ PassportModule.register({ defaultStrategy: 'jwt' }), JwtModule.register({ secret: jwtConstants.secret, signOptions: { expiresIn: '8h' }, // token 过期时效 }), UserModule, // 引入用户模块 ], providers: [AuthService, LocalStrategy, JwtStrategy], // 添加auth服务和验证器 exports: [AuthService], }) export class AuthModule {}
-
...auth/jwt.strategy.ts 文件配置和守卫的验证方法
{
constructor(
private readonly userService: UserService,
) {
super({
jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
ignoreExpiration: false,
secretOrKey: jwtConstants.secret,
});
}
/**
* 被守卫调用的验证方法
* @param payload
* @returns
*/
async validate(payload: TokenInfo): Promise<User> {
const { mail } = payload;
const userInfo: User = await this.userService.getUserInfoByMail(mail);
if (!userInfo) {
// throw new UnauthorizedException();
throw new AppHttpException(errHttpBack.err_user_had);
}
return userInfo;
}
}- auth.service.ts 几个用到的验证方法
- 生成加密密码
- 验证密码
- 生成 token
- 解析 token
https://github.com/niuwenzheng/nestjs-base 如果您觉得这个项目还不错, 可以在 Github 上面帮我点个 star, 支持一下作者 ☜(ﾟヮﾟ ☜)