第一步:基于node创建一个Nest.js项目
-
注:不要关心注释代码,那是属于后面功能的区域。因为随着代码体量加大,功能不再明确,只需按照步骤并参考效果图,把关键代码写入即可,所以下只写关键代码,具体请看效果图。
项目地址
1 创建写接口的模块
1.1 查看快捷命令语句
nest g -h
-
name
命令名称 / alias
命令简写 / description
命令描述
1.2 创建接口模块
nest g co user_copy
nest g mo user_copy
-
执行后会生成黄色框内的三个文件(不要关注黄框外的两个文件,后面会讲。),并自动将该模块引入挂载到
app.module.ts
2 建立数据库连接并创建数据库表
有关数据库安装的文章
- 我本地的数据库是没设置任何密码等,就是下载安装后的默认配置,请根据实际需求更改以下代码
2.1 建立数据库连接 -- 只写关键代码
中文官网文档
npm install --save @nestjs/mongoose mongoose
~ /src/app.module.ts
// moogodb 数据库 https://docs.nestjs.cn/9/techniques?id=mongo
import { MongooseModule } from '@nestjs/mongoose';
@Module({
imports: [
// 连接moogodb数据库
MongooseModule.forRoot('mongodb://localhost/nest'),
],
})
2.2 创建数据库表,并引入到app.module.ts
模块,全局共享
2.2.1 找到user_copy
文件夹,创建user_copy.outside.ts
文件
~ /src/user_copy/user_copy.outside.ts
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document } from 'mongoose';
import { dateFormat } from '../utils'
// 表文件
export type CatDocument = user & Document;
@Schema()
// 定义了一个名为user的类,该类继承自Document类,表示该类的实例可以被存储到数据库中。
export class user extends Document {
// @Prop()装饰器可以接受一些参数,例如default,用于指定属性的默认值。
@Prop()
user_name: string; // 账号
@Prop()
password: string; // 密码
@Prop({default: ''}) // 年龄 默认 ''
age: string;
@Prop({default: ''}) // 性别 默认 ''
sex: string;
// default 如果不传则添加默认值
@Prop({default: dateFormat('data')}) // 创建时间 默认当前时间
date: string;
}
// 创建了一个名为userSchema的模式,该模式基于user类。
export const userSchema = SchemaFactory.createForClass(user);
~ /src/utils/index.ts
// 处理时间
export const dateFormat = (type) => {
const dt = new Date()
const y = dt.getFullYear()
const m = (dt.getMonth() + 1 + '').padStart(2, '0')
const d = (dt.getDate() + '').padStart(2, '0')
const hh = (dt.getHours() + '').padStart(2, '0')
const mm = (dt.getMinutes() + '').padStart(2, '0')
const ss = (dt.getSeconds() + '').padStart(2, '0')
if (type === 'year') {
return `${y}`
} else if (type === 'month') {
return `${y}-${m}`
} else if (type === 'data') {
return `${y}-${m}-${d}`
} else {
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
}
2.2.2 引入表到app.module.ts
文件内
~ /src/app.module.ts
// 表
import { user, userSchema } from './user_copy/user_copy.outside'
@Module({
imports: [
// 挂载user表 来源:./user_copy/user_copy.outside
MongooseModule.forFeature([{ name: user.name, schema: userSchema }]),
],
})
3 依赖注入数据库表,写接口
3.1 依赖注入数据库表
~ /src/user_copy/user_copy.controller.ts
import { InjectModel } from '@nestjs/mongoose';
@Controller('user-copy')
export class UserCopyController {
constructor(
// 依赖注入表文件,别名userModel 此表已挂载到app.module.ts文件内
@InjectModel('user') private readonly userModel,
// 依赖注入全局参数方法
// private readonly globalParamsService: GlobalParamsService,
// private readonly jwtService: JwtService
) { }
}
3.2 写新增与查询接口
3.2.1 新增接口
import { Controller, Post, Body } from '@nestjs/common';
// 请求方式:Post, 请求路径:/user-copy/add
@Post('add')
// @Body() 装饰器
async addData(@Body() body) {
// create 插入一条数据,直接将接收到的body参数插入
const data = await this.userModel.create(body)
if (data) {
return { code: 200, data: null, message: "操作成功" }
}
}
3.2.2 查询接口
import { Controller, Get, Query } from '@nestjs/common';
// 请求方式:Get, 请求路径:/user-copy/find
@Get('find')
// @Query() 装饰器
async findData(@Query() query) {
// find 查询指定数据
const data = await this.userModel.find({ user_name: query.user_name })
// 模糊查询
// $regex 是 MongoDB 查询操作符,用于指定正则表达式进行匹配。$options: 'i' 表示不区分大小写,即忽略关键字的大小写。
// const data = await this.userModel.find({ user_name: { $regex: query.user_name, $options: 'i' } })
return { code: 200, data: data, message: "操作成功" }
}
3.3 调用写好的接口 - 使用工具postman
- 根据表文件
user_copy.outside.ts
得知表里的接收参数为 user_name:string | password:string | age:string | sex:string | date:string,由于此时还未开启接口参数校验,请保证自己传参类型的正确性。