typescript - 为 NestJs REST API 创建 DTO、BO 和 DAO
问题描述
我想开始使用 NestJs 创建 REST API,但我不确定如何设置可扩展层通信对象。
因此,从有关如何开始的文档中,我提出了UsersController
处理 HTTP 请求和响应、UsersService
处理控制器和数据库访问器之间的逻辑以及UsersRepository
负责数据库管理的逻辑。
我使用 NestJs 提供的TypeORM 包,所以我的数据库模型是
@Entity('User')
export class UserEntity extends BaseEntity {
@PrimaryGeneratedColumn('uuid')
id: string;
@Column({ unique: true })
username: string;
@Column()
passwordHash: string;
@Column()
passwordSalt: string;
}
但是您可能知道这个模型必须映射到其他模型,反之亦然,因为您不想将密码信息发送回客户端。我将尝试用一个简单的例子来描述我的 API 流程:
控制器
首先,我有一个用于GET /users/:id
和的控制器端点POST /users
。
@Get(':id')
findById(@Param() findByIdParamsDTO: FindByIdParamsDTO): Promise<UserDTO> {
// find user by id and return it
}
@Post()
create(@Body() createUserBodyDTO: CreateUserBodyDTO): Promise<UserDTO> {
// create a new user and return it
}
我设置了DTO并想先验证请求。我使用NestJs 提供的class-validator包并创建了一个名为RequestDTOs的文件夹。通过 id 查找某些内容或通过 url 参数通过 id 删除某些内容是可重用的,因此我可以将其放入共享文件夹中以用于其他资源,如组、文档等。
export class IdParamsDTO {
@IsUUID()
id: string;
}
POST 请求是用户特定的
export class CreateUserBodyDTO {
@IsString()
@IsNotEmpty()
username: string;
@IsString()
@IsNotEmpty()
password: string;
}
现在控制器输入在执行业务逻辑之前得到验证。对于响应,我创建了一个名为ResponseDTOs的文件夹,但目前它只包含数据库用户,没有密码信息
export interface UserDTO {
id: string;
username: string;
}
服务
该服务需要来自参数和正文的捆绑信息。
public async findById(findByIdBO: FindByIdBO): Promise<UserBO> {
// ...
}
public async create(createBO: CreateBO): Promise<UserBO> {
// ...
}
GET 请求只需要 ID,但创建BO可能会更好,因为您可能希望稍后从字符串 ID 切换为整数。“按 id 查找”BO 是可重用的,我将其移至共享目录
export interface IdBO {
id: string;
}
对于用户创建,我创建了文件夹RequestBOs
export interface CreateBO {
username: string;
password: string;
}
现在对于ResponseBO,结果将是
export interface UserBO {
id: string;
username: string;
}
您会注意到这与UserDTO相同。所以其中一个似乎是多余的?
存储库
最后,我为存储库设置了DAO。我可以使用自动生成的用户存储库并处理我上面提到的数据库模型。但是我必须在我的服务业务逻辑中处理它。创建用户时,我必须在服务中执行此操作,并且只能usermodel.save
从存储库中调用该函数。
否则我可以创建RequestDAO
共享的一个..
export interface IdDAO {
id: string;
}
还有 POST DAO
export interface CreateDAO {
username: string;
password: string;
}
有了它,我可以在我的存储库中创建一个数据库用户并使用ResponseDAO映射数据库响应,但这始终是没有密码信息的整个数据库用户。似乎又产生了很大的开销。
我想知道我使用 3 个请求和 3 个响应接口的方法是否太多并且可以简化。但我想保留一个灵活的层,因为我认为这些层应该是高度独立的……另一方面,那里会有大量的模型。
提前致谢!
解决方案
我通过使用一个类来表示一个用户(内部和外部)与class-transformer
库(由 NestJs 推荐)来处理这个问题,以处理暴露用户和内部用户之间的差异,而不定义两个类。
这是使用您的用户模型的示例:
定义用户类
由于这个用户类被保存到数据库中,我通常为每个数据库对象期望拥有的所有字段创建一个基类。比方说:
export class BaseDBObject {
// this will expose the _id field as a string
// and will change the attribute name to `id`
@Expose({ name: 'id' })
@Transform(value => value && value.toString())
@IsOptional()
// tslint:disable-next-line: variable-name
_id: any;
@Exclude()
@IsOptional()
// tslint:disable-next-line: variable-name
_v: any;
toJSON() {
return classToPlain(this);
}
toString() {
return JSON.stringify(this.toJSON());
}
}
接下来,我们的用户将扩展这个基本类:
@Exclude()
export class User extends BaseDBObject {
@Expose()
username: string;
password: string;
constructor(partial: Partial<User> = {}) {
super();
Object.assign(this, partial);
}
}
class-transformer
当我们在服务器外部公开类时,我在这里使用库中的一些装饰器来更改这个内部用户(所有数据库字段都完好无损)。
@Expose
- 如果 class-default 是要排除的,将公开该属性@Exclude
- 如果 class-default 要公开,则将排除该属性@Transform
- 在“导出”时更改属性名称
这意味着在从 运行classToPlain
函数后class-transformer
,我们在给定类上定义的所有规则都将被应用。
控制器
NestJs
添加一个装饰器,以确保从控制器端点返回的类将使用该classToPlain
函数来转换对象,返回结果对象并省略所有私有字段和转换(例如更改_id
为id
)
@Get(':id')
@UseInterceptors(ClassSerializerInterceptor)
async findById(@Param('id') id: string): Promise<User> {
return await this.usersService.find(id);
}
@Post()
@UseInterceptors(ClassSerializerInterceptor)
async create(@Body() createUserBody: CreateUserBodyDTO): Promise<User> {
// create a new user from the createUserDto
const userToCreate = new User(createUserBody);
return await this.usersService.create(userToCreate);
}
服务
@Injectable()
export class UsersService {
constructor(@InjectModel('User') private readonly userModel: Model<IUser>) { }
async create(createCatDto: User): Promise<User> {
const userToCreate = new User(createCatDto);
const createdUser = await this.userModel.create(userToCreate);
if (createdUser) {
return new User(createdUser.toJSON());
}
}
async findAll(): Promise<User[]> {
const allUsers = await this.userModel.find().exec();
return allUsers.map((user) => new User(user.toJSON()));
}
async find(_id: string): Promise<User> {
const foundUser = await this.userModel.findOne({ _id }).exec();
if (foundUser) {
return new User(foundUser.toJSON());
}
}
}
因为在内部我们总是使用 User 类,所以我将从数据库返回的数据转换为 User 类实例。
我正在使用@nestjs/mongoose
,但基本上在从数据库中检索用户之后, 和 的一切都是一样mongoose
的TypeORM
。
注意事项
使用@nestjs/mongoose
,我无法避免创建IUser
接口以传递给 mongoModel
类,因为它需要扩展 mongodb 的东西Document
export interface IUser extends mongoose.Document {
username: string;
password: string;
}
获取用户时,API 将返回转换后的 JSON:
{
"id": "5e1452f93794e82db588898e",
"username": "username"
}
更新
如果您还想查看typegoose
用于消除接口的示例(基于此博客文章),请查看此处查看模型,查看此处查看基本模型
推荐阅读
- consensus - Raft 集群中的节点如何知道“多数”是什么?
- asp.net-mvc - Myprofile 查看布局
- java - Jgit比较更改返回null
- javascript - Nodejs / javaScript 操作 CSV 文件
- android - 具有延迟外键的 Android Room
- android - LiveData Room 进入后台时丢失数据
- linux - 在 gnuplot 中保存“stats”命令的输出
- linux - SED 命令无法正常运行
- database - 弹性搜索集群套接字举起手来
- angular - 即使在条件发生变化后,有条件的垫子旋转器也会继续旋转