2023-04-04

首先,我们需要创建一个nestjs项目:


$ npm i -g @nestjs/cli      # 全局安装nestjs脚手架

$ nest new project-name    # 初始化一个nestjs项目

$ cd project-name          # 进入项目目录

然后,我们需要安装sqlite3依赖库:


$ npm install sqlite3 @nestjs/typeorm typeorm passport passport-local

接下来,我们需要创建一个user实体:


$ nest g class auth/user

修改auth/user.ts文件内容如下:


import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()

export class User {

  @PrimaryGeneratedColumn()

  id: number;

  @Column()

  username: string;

  @Column()

  password: string;

}

这里我们定义了一个user实体,有id、username、password三个字段,用来存储用户信息。@Entity()是typeorm的装饰器,用来标记这是一个实体类,@PrimaryGeneratedColumn()表示id字段为主键并自动递增,@Column()表示该字段为表中的列。

我们需要为nestjs添加TypeORM模块,编辑app.module.ts文件如下:


import { Module } from '@nestjs/common';

import { AppController } from './app.controller';

import { AppService } from './app.service';

import { TypeOrmModule } from '@nestjs/typeorm';

import { User } from './auth/user';

@Module({

  imports: [

    TypeOrmModule.forRoot({

      type: 'sqlite',

      database: 'db.sqlite',

      entities: [User],

      synchronize: true,

    }),

  ],

  controllers: [AppController],

  providers: [AppService],

})

export class AppModule {}

这里我们定义了一个TypeORM模块,配置了Sqlite3数据库和user实体类。注意:默认情况下,TypeORM会在应用启动时自动创建表格,synchronize: true表示开启表结构同步,即创建表结构。在生产环境下,这个选项需要关闭。因为在生产环境下,表结构的修改需要手动执行迁移。

接下来,我们需要为nestjs添加登录模块,编辑auth/auth.module.ts文件如下:


import { Module } from '@nestjs/common';

import { AuthService } from './auth.service';

import { LocalStrategy } from './local.strategy';

import { PassportModule } from '@nestjs/passport';

import { TypeOrmModule } from '@nestjs/typeorm';

import { User } from './user';

import { AuthController } from './auth.controller';

@Module({

  imports: [

    PassportModule,

    TypeOrmModule.forFeature([User]),

  ],

  providers: [AuthService, LocalStrategy],

  controllers: [AuthController],

})

export class AuthModule { }

这里我们定义了一个登录模块,包含LocalStrategy、AuthController和AuthService三个模块。

接下来,我们需要为nestjs添加LocalStrategy,编辑auth/local.strategy.ts文件如下:


import { Injectable, UnauthorizedException } from '@nestjs/common';

import { PassportStrategy } from '@nestjs/passport';

import { Strategy } from 'passport-local';

import { AuthService } from './auth.service';

@Injectable()

export class LocalStrategy extends PassportStrategy(Strategy) {

  constructor(private authService: AuthService) {

    super();

  }

  async validate(username: string, password: string): Promise<any> {

    const user = await this.authService.validateUser(username, password);

    if (!user) {

      throw new UnauthorizedException();

    }

    return user;

  }

}

这里我们定义了一个LocalStrategy,用来校验用户登录信息。PassportStrategy是nestjs一个封装的Passport策略,它的构造函数传递了一个Strategy属性,这里我们使用了本地策略(Strategy),即使用本地用户名和密码验证。

接下来,我们需要为nestjs添加AuthService,编辑auth/auth.service.ts文件如下:


import { Injectable } from '@nestjs/common';

import { UserService } from './user.service';

import { User } from './user';

@Injectable()

export class AuthService {

  constructor(private usersService: UserService) {}

  async validateUser(username: string, password: string): Promise<User> {

    const user = await this.usersService.findOne(username);

    if (user && user.password === password) {

      const { password, ...result } = user;

      return result;

    }

    return null;

  }

}

在这里,我们定义了一个AuthService,用于验证用户登录信息。根据输入的用户名和密码,查询数据库中的user信息,并校验密码是否正确。查询成功,则返回user信息,否则返回null。

最后,我们需要为nestjs添加AuthController,编辑auth/auth.controller.ts文件如下:


import { Controller, Request, Post, UseGuards } from '@nestjs/common';

import { LocalAuthGuard } from './local-auth.guard';

@Controller()

export class AuthController {

  constructor(private authService: AuthService) { }

  @UseGuards(LocalAuthGuard)

  @Post('auth/login')

  async login(@Request() req) {

    return req.user;

  }

}

在这里,我们定义了一个AuthController,该控制器使用了nestjs的AuthGuard守卫,用来拦截请求并进行用户登录认证。@Request()装饰器用于获取请求对象,@Post()装饰器用于定义post请求的路由地址。

最后,我们需要为nestjs添加LocalAuthGuard守卫,编辑auth/local-auth.guard.ts文件如下:


import { Injectable } from '@nestjs/common';

import { AuthGuard } from '@nestjs/passport';

@Injectable()

export class LocalAuthGuard extends AuthGuard('local') {}

在这里,我们定义了一个LocalAuthGuard守卫,它继承了nestjs的AuthGuard守卫,通过调用守卫类的构造函数时传递'strategy'参数,指定验证策略为本地策略。

完成后,我们就完成了nestjs的登录模块的开发。我们可以在应用中进行测试:


npm run start:dev

默认情况下,应用会在http://localhost:3000地址开启服务。在postman工具中,我们可以用post请求和username、password参数来进行登录的测试:


POST /auth/login

{

  "username": "admin",

  "password": "password"

}

如何输出token?

你可以使用JWT模块完成token的生成(https://docs.nestjs.com/security/authentication/jwt)。简单来讲,你需要进行下面步骤:

  1. 安装jsonwebtoken和@nestjs/jwt模块

npm i jsonwebtoken @nestjs/jwt

  1. 修改AuthService服务

在AuthService服务中添加生成Token的方法:


import { Injectable } from '@nestjs/common';

import { UserService } from './user.service';

import { JwtService } from '@nestjs/jwt';

import { User } from './user';

@Injectable()

export class AuthService {

  constructor(

    private usersService: UserService,

    private jwtService: JwtService

  ) {}

  async validateUser(username: string, password: string): Promise<any> {

    const user = await this.usersService.findOne(username);

    if (user && user.password === password) {

      const { password, ...result } = user;

      return result;

    }

    return null;

  }

  async login(user: User) {

    const payload = { username: user.username, sub: user.id };

    return {

      access_token: this.jwtService.sign(payload),

    };

  }

}

在这里,我们定义了一个login方法,该方法需要传递一个user对象参数。这里使用JwtService生成了一个Token,并且token包含了用户信息,用于验证。返回的access_token,就是生成的Token。

使用生成的access_token访问受保护的资源就是在headers中加入Authorization字段,值为Bearer access_token。


Authorization: Bearer access_token

  1. 注册JwtModule

app.module.ts


import { Module } from '@nestjs/common';

import { TypeOrmModule } from '@nestjs/typeorm';

import { AppController } from './app.controller';

import { AppService } from './app.service';

import { AuthModule } from './auth/auth.module';

import { User } from './auth/user';

import { UserService } from './auth/user.service';

import { JwtModule } from '@nestjs/jwt';

@Module({

  imports: [

    AuthModule,

    TypeOrmModule.forRoot({

      type: 'sqlite',

      database: 'db.sqlite',

      entities: [User],

      synchronize: true,

    }),

    JwtModule.register({

      secret: 'secretKey', // 安全秘钥

      signOptions: {expiresIn: '60s'} // 过期时间60s

    }),

  ],

  controllers: [AppController],

  providers: [AppService, UserService],

})

export class AppModule { }

在这里,我们从nestjs中引入了JwtModule,并注册了该模块。在signOptions配置中,我们指定了过期时间。

  1. 修改AuthController

AuthController


import { Controller, Request, Post, UseGuards } from '@nestjs/common';

import { LocalAuthGuard } from './local-auth.guard';

import { AuthService } from './auth.service';

@Controller()

export class AuthController {

  constructor(private authService: AuthService) { }

  @UseGuards(LocalAuthGuard)

  @Post('auth/login')

  async login(@Request() req) {

    return this.authService.login(req.user); // 修改这里

  }

}

在login方法中调用了AuthService的login方法,返回生成的token。

至此,我们就完成了jsonwebtoken和@nestjs/jwt模块的开发,可以愉快的生成Token了。

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容