NestJS Boilerplate 项目教程

项目介绍

NestJS Boilerplate 是一个基于 NestJS 框架的开源项目模板，旨在为开发者提供一个快速启动新项目的脚手架。该项目集成了多种常用功能和最佳实践，包括用户认证、角色管理、数据库集成等，使得开发者可以专注于业务逻辑的实现，而无需从头开始搭建项目结构。

项目快速启动

环境准备

在开始之前，请确保您的开发环境已经安装了以下工具：

• Node.js (推荐使用 LTS 版本)
• npm 或 yarn
• Git

克隆项目

首先，克隆项目到本地：

git clone https://github.com/brocoders/nestjs-boilerplate.git
cd nestjs-boilerplate

安装依赖

使用 npm 或 yarn 安装项目依赖：

npm install
# 或者
yarn install

配置环境变量

复制 .env.example 文件并重命名为 .env，然后根据您的环境配置相关变量。

启动项目

运行以下命令启动开发服务器：

npm run start:dev
# 或者
yarn start:dev

项目启动后，您可以通过 http://localhost:3000 访问应用。

应用案例和最佳实践

用户认证

NestJS Boilerplate 提供了基于 JWT 的用户认证系统。以下是一个简单的用户登录示例：

import { Controller, Post, Body } from '@nestjs/common';
import { AuthService } from './auth.service';

@Controller('auth')
export class AuthController {
  constructor(private readonly authService: AuthService) {}

  @Post('login')
  async login(@Body() loginDto: { email: string; password: string }) {
    return this.authService.login(loginDto);
  }
}

角色管理

项目还包含了角色管理功能，可以通过装饰器来限制接口的访问权限：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { RolesGuard } from './roles.guard';
import { Roles } from './roles.decorator';

@Controller('users')
@UseGuards(RolesGuard)
export class UsersController {
  @Get('admin')
  @Roles('admin')
  getAdminInfo() {
    return { message: 'This is admin info' };
  }
}

典型生态项目

NestJS Boilerplate 可以与多种生态项目集成，以下是一些典型的集成案例：

数据库集成

项目默认使用 TypeORM 作为数据库 ORM 工具，可以轻松集成 MySQL、PostgreSQL 等数据库。

缓存集成

通过集成 Redis，可以实现高效的缓存管理：

import { CacheModule, Module } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';

@Module({
  imports: [
    CacheModule.register({
      store: redisStore,
      host: 'localhost',
      port: 6379,
    }),
  ],
})
export class AppModule {}

日志管理

使用 Winston 作为日志管理工具，可以实现详细的日志记录和分析：

import { LoggerService } from '@nestjs/common';
import * as winston from 'winston';

export class CustomLogger extends LoggerService {
  private logger: winston.Logger;

  constructor() {
    super();
    this.logger = winston.createLogger({
      transports: [
        new winston.transports.Console(),
        new winston.transports.File({ filename: 'app.log' }),
      ],
    });
  }

  log(message: string) {
    this.logger.info(message);
  }

  error(message: string, trace: string) {
    this.logger.error(message, trace);
  }
}

通过以上集成，NestJS Boilerplate 可以构建出高效、可扩展的后端应用。