feat: register-and-login

QuarkGluonPlasma · QuarkGluonPlasma · commit 96161578dc79 · 2023-06-13T10:05:55.000+08:00
diff --git a/README.md b/README.md
@@ -58,4 +58,5 @@
 
 [jwt、session](./jwt-and-session)
 
+[typeorm + jwt + ValidationPipe 实现登录注册](./login-and-register)
 
diff --git a/login-and-register/.eslintrc.js b/login-and-register/.eslintrc.js
@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};
diff --git a/login-and-register/.gitignore b/login-and-register/.gitignore
@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
diff --git a/login-and-register/.prettierrc b/login-and-register/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
diff --git a/login-and-register/README.md b/login-and-register/README.md
@@ -0,0 +1,8 @@
+# login、register
+
+
+npm install
+
+修改数据库连接信息
+
+npm  run start:dev
diff --git a/login-and-register/nest-cli.json b/login-and-register/nest-cli.json
@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}
diff --git a/login-and-register/package.json b/login-and-register/package.json
@@ -0,0 +1,76 @@
+{
+  "name": "login-and-register",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/jwt": "^10.0.3",
+    "@nestjs/mapped-types": "*",
+    "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/typeorm": "^9.0.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "mysql2": "^3.3.4",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.2.0",
+    "typeorm": "^0.3.16"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.0.0",
+    "@nestjs/schematics": "^9.0.0",
+    "@nestjs/testing": "^9.0.0",
+    "@types/express": "^4.17.13",
+    "@types/jest": "29.5.0",
+    "@types/node": "18.15.11",
+    "@types/supertest": "^2.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "29.5.0",
+    "prettier": "^2.3.2",
+    "source-map-support": "^0.5.20",
+    "supertest": "^6.1.3",
+    "ts-jest": "29.0.5",
+    "ts-loader": "^9.2.3",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "^4.7.4"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}
diff --git a/login-and-register/src/app.controller.spec.ts b/login-and-register/src/app.controller.spec.ts
@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});
diff --git a/login-and-register/src/app.controller.ts b/login-and-register/src/app.controller.ts
@@ -0,0 +1,25 @@
+import { Controller, Get, UseGuards } from '@nestjs/common';
+import { AppService } from './app.service';
+import { LoginGuard } from './login.guard';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get('aaa')
+  @UseGuards(LoginGuard)
+  aaa() {
+    return 'aaa';
+  }
+
+  @Get('bbb')
+  @UseGuards(LoginGuard)
+  bbb() {
+    return 'bbb';
+  }
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}
diff --git a/login-and-register/src/app.module.ts b/login-and-register/src/app.module.ts
@@ -0,0 +1,40 @@
+import { Module } from '@nestjs/common';
+import { JwtModule } from '@nestjs/jwt';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { User } from './user/entities/user.entity';
+import { UserModule } from './user/user.module';
+
+@Module({
+  imports: [ 
+    TypeOrmModule.forRoot({
+      type: "mysql",
+      host: "localhost",
+      port: 3306,
+      username: "root",
+      password: "guang",
+      database: "login_test",
+      synchronize: true,
+      logging: true,
+      entities: [User],
+      poolSize: 10,
+      connectorPackage: 'mysql2',
+      extra: {
+          authPlugin: 'sha256_password',
+      }
+    }), 
+    JwtModule.register({
+      global: true,
+      secret: 'guang',
+      signOptions: {
+        expiresIn: '7d'
+      }
+    }),
+    UserModule,
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
+
diff --git a/login-and-register/src/app.service.ts b/login-and-register/src/app.service.ts
@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
diff --git a/login-and-register/src/login.guard.ts b/login-and-register/src/login.guard.ts
@@ -0,0 +1,34 @@
+import { JwtService } from '@nestjs/jwt';
+import { CanActivate, ExecutionContext, Inject, Injectable, UnauthorizedException } from '@nestjs/common';
+import { Request } from 'express';
+import { Observable } from 'rxjs';
+
+@Injectable()
+export class LoginGuard implements CanActivate {
+  @Inject(JwtService)
+  private jwtService: JwtService;
+
+  canActivate(
+    context: ExecutionContext,
+  ): boolean | Promise<boolean> | Observable<boolean> {
+    const request: Request = context.switchToHttp().getRequest();
+
+    const authorization = request.header('authorization') || '';
+
+    const bearer = authorization.split(' ');
+    
+    if(!bearer || bearer.length < 2) {
+      throw new UnauthorizedException('登录 token 错误');
+    }
+
+    const token = bearer[1];
+
+    try {
+      const info = this.jwtService.verify(token);
+      (request as any).user = info.user;
+      return true;
+    } catch(e) {
+      throw new UnauthorizedException('登录 token 失效，请重新登录');
+    }
+  }
+}
diff --git a/login-and-register/src/main.ts b/login-and-register/src/main.ts
@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(3000);
+}
+bootstrap();
diff --git a/login-and-register/src/user/dto/create-user.dto.ts b/login-and-register/src/user/dto/create-user.dto.ts
@@ -0,0 +1 @@
+export class CreateUserDto {}
diff --git a/login-and-register/src/user/dto/login.dto.ts b/login-and-register/src/user/dto/login.dto.ts
@@ -0,0 +1,6 @@
+import { PartialType } from "@nestjs/mapped-types";
+import { RegisterDto } from "./register.dto";
+
+export class LoginDto extends PartialType(RegisterDto){
+
+}
diff --git a/login-and-register/src/user/dto/register.dto.ts b/login-and-register/src/user/dto/register.dto.ts
@@ -0,0 +1,16 @@
+import { IsNotEmpty, IsString, Length, Matches } from "class-validator";
+
+export class RegisterDto {
+    @IsString()
+    @IsNotEmpty()
+    @Length(6, 30)
+    @Matches(/^[a-zA-Z0-9#$%_-]+$/, {
+        message: '用户名只能是字母、数字或者 #、$、%、_、- 这些字符'
+    })
+    username: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @Length(6, 30)
+    password: string;
+}
diff --git a/login-and-register/src/user/dto/update-user.dto.ts b/login-and-register/src/user/dto/update-user.dto.ts
@@ -0,0 +1,4 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { CreateUserDto } from './create-user.dto';
+
+export class UpdateUserDto extends PartialType(CreateUserDto) {}
diff --git a/login-and-register/src/user/entities/user.entity.ts b/login-and-register/src/user/entities/user.entity.ts
@@ -0,0 +1,30 @@
+import { Column, CreateDateColumn, Entity, PrimaryGeneratedColumn, UpdateDateColumn } from "typeorm";
+
+@Entity()
+export class User {
+
+    @PrimaryGeneratedColumn()
+    id: number;
+
+    @Column({
+        length: 50,
+        comment: '用户名'
+    })
+    username: string;
+
+    @Column({
+        length:50,
+        comment: '密码'
+    })
+    password: string;
+
+    @CreateDateColumn({
+        comment: '创建时间'
+    })
+    createTime: Date;
+
+    @UpdateDateColumn({
+        comment: '更新时间'
+    })
+    updateTime: Date;
+}
diff --git a/login-and-register/src/user/user.controller.spec.ts b/login-and-register/src/user/user.controller.spec.ts
@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { UserController } from './user.controller';
+import { UserService } from './user.service';
+
+describe('UserController', () => {
+  let controller: UserController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [UserController],
+      providers: [UserService],
+    }).compile();
+
+    controller = module.get<UserController>(UserController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});
diff --git a/login-and-register/src/user/user.controller.ts b/login-and-register/src/user/user.controller.ts
diff --git a/login-and-register/src/user/user.module.ts b/login-and-register/src/user/user.module.ts
diff --git a/login-and-register/src/user/user.service.spec.ts b/login-and-register/src/user/user.service.spec.ts
diff --git a/login-and-register/src/user/user.service.ts b/login-and-register/src/user/user.service.ts
diff --git a/login-and-register/test/app.e2e-spec.ts b/login-and-register/test/app.e2e-spec.ts
diff --git a/login-and-register/test/jest-e2e.json b/login-and-register/test/jest-e2e.json
diff --git a/login-and-register/tsconfig.build.json b/login-and-register/tsconfig.build.json
diff --git a/login-and-register/tsconfig.json b/login-and-register/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -58,4 +58,5 @@`
`58`	`58`
`59`	`59`	`[jwt、session](./jwt-and-session)`
`60`	`60`
	`61`	`+[typeorm + jwt + ValidationPipe 实现登录注册](./login-and-register)`
`61`	`62`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "singleQuote": true,
 +  "trailingComma": "all"
 +}