首先，我們需要創建一個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）。簡單來講，你需要進行下面步驟：
- 安裝jsonwebtoken和@nestjs/jwt模塊
npm i jsonwebtoken @nestjs/jwt
- 修改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
- 注冊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配置中，我們指定了過期時間。
- 修改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了。
