e0d4492013
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
23 lines
1.5 KiB
Plaintext
23 lines
1.5 KiB
Plaintext
---
|
|
title: 最佳实践
|
|
---
|
|
|
|
本文档概述了当您在后端工作时应遵循的最佳实践。
|
|
|
|
## 遵循模块化方法
|
|
|
|
后端遵循模块化方法,这是使用 NestJS 的基本原则。 确保将代码分解为可重用的模块,以保持代码库的清晰和有序。
|
|
每个模块应封装特定的功能或特性,并具有明确的范围。 这种模块化方法使关注点分离更加清晰,并消除了不必要的复杂性。
|
|
|
|
## 将服务暴露以供模块使用
|
|
|
|
始终创建具有明确单一职责的服务,这有助于提高代码的可读性和可维护性。 以具有描述性且一致的方式为服务命名。
|
|
|
|
您还应该公开希望在其他模块中使用的服务。 通过 NestJS 强大的依赖注入系统,可以实现向其他模块公开服务,并促进组件间的松耦合。
|
|
|
|
## 避免使用 `any` 类型
|
|
|
|
当您将变量声明为 `any` 类型时,TypeScript 的类型检查器不会进行任何类型检查,使得可以将任何类型的值赋给该变量。 TypeScript 使用类型推断,根据值来确定变量的类型。 若声明为 `any`,TypeScript 将无法再推断其类型。 这使开发过程中难以捕捉到与类型相关的错误,导致运行时错误,使代码维护性更差,可靠性更低,且更难以被他人理解。
|
|
|
|
因此,一切都应该有一个类型。 因此,如果您创建包含名字和姓氏的新对象,应该创建一个包含名字和姓氏的接口或类型,以定义您正在操作的对象的形状。
|