共计 3914 个字符，预计需要花费 10 分钟才能阅读完成。
我的项目地址（https://github.com/lulusir/clean-architecture）感觉不错的小伙伴，能够给个 star，谢谢
Clean Architecture
Clean Architecture 是 Robert C. Martin 提出的一种软件架构模式，目标是为了将零碎分层，实现关注点拆散，使零碎更易于了解、保护和扩大。该体系结构将零碎分为四个层级，从内到外别离是：实体层、用例层、体现层、基础设施（存储库，框架等）。
在本文中，咱们将介绍如何应用 Node.js 实现 Clean Architecture，并提供一些示例代码来演示该架构的要害概念。
接下来咱们将应用 TypeScript 我的项目示例（https://github.com/lulusir/clean-architecture）。该我的项目采纳了 Monorepo 构造，应用 Rush.js 进行治理。在 server 文件夹中蕴含了三个子项目，别离为 core、koa 和 nestjs-app，其中 core 为外围业务逻辑，koa 是应用 koa+prisma 的为底层框架 web 我的项目，nestjs-app 是应用 nestjs + typeorm 为底层框架的我的项目。目标是演示雷同的业务逻辑如何桥接不同的框架。
在这个我的项目中，实体层蕴含实体对象和相干的业务规定和逻辑，用例层蕴含零碎的用例和业务逻辑，存储库层负责保留和检索数据，表示层则是裸露给内部的 http 接口。
我的项目性能：
实现一个帖子公布，浏览性能
- 用户创立，查问
- 帖子的公布，编辑，查问，删除
我的项目构造
├── server
│ ├── core // 外围业务逻辑
│ │ └── src
│ │ ├── domain
│ │ ├── repository
│ │ └── useCase
│ ├── koa
│ │ └── src
│ │ ├── post
│ │ └── user
│ └── nestjs-app
│ ├── src
│ ├── post
│ │ ├── dto
│ │ └── entities
│ └── user
│ └── entities
└── web-
core：core 为外围业务逻辑的代码
- Domain: 寄存实体相干的代码，如业务具体的 model 等
- Use Cases: 寄存业务逻辑相干的代码，如解决业务逻辑、数据验证、调用 Repository 等
- Repository: 寄存和内部存储系统的相干接口
-
koa/nestjs-app: core 的理论消费者
- 依据 core 的接口实现具体的 Router，Repository
我的项目特点
- 应用 DDD 和 Clean Architecture 的思维，将业务逻辑与框架实现拆散。
- 应用 monorepo 我的项目构造，方便管理多个相干的我的项目。
- 提供了多个示例应用程序，不便疾速上手。
- 基于 TypeScript，进步代码可读性和可维护性。
在 core 中，咱们有外围的业务逻辑代码。此级别蕴含域、存储库接口和用例。域蕴含与实体相干的代码，例如特定的业务模型。存储库蕴含与内部存储系统的相干接口。用例蕴含与业务逻辑相干的代码，例如解决业务逻辑、数据验证和调用存储库。
在 koa/nestjs-app 层面，咱们有外围层面的理论消费者。它们依据核心层提供的接口实现特定的路由器和存储库。
应用 Clean Architecture 的次要长处之一是它将业务逻辑与技术实现离开。这意味着您能够轻松地在不同的框架和库之间切换，而无需更改外围业务逻辑。在咱们的示例中，咱们能够在 koa 和 nestjs-app 之间切换，同时放弃雷同的外围业务逻辑。
代码实现
定义实体层
// server/core/src/domain/post.ts
import {User} from "./user";
export class Post {
author: User | null = null;
content: string = "";
updateAt: Date = new Date(); // timestamp;
createdAt: Date = new Date(); // timestamp;
title: string = "";
id: number = -1;
}
// server/core/src/domain/user.ts
export class User {
name: string = ''email: string =''
id: number = -1
}定义存储接口
import {Post} from "../domain/post";
export interface IPostRepository {create(post: Post): Promise<boolean>;
find(id: number): Promise<Post>;
update(post: Post): Promise<boolean>;
delete(post: Post): Promise<boolean>;
findMany(options: { authorId: number}): Promise<Post[]>;}
...
import {User} from "../domain/user";
export interface IUserRepository {create(user: User): Promise<boolean>;
find(id: number): Promise<User>;
}定义用例层
import {User} from "../domain/user";
import {IUserRepository} from "../repository/user";
export class UCUser {constructor(public userRepo: IUserRepository) {}
find(id: number) {return this.userRepo.find(id);
}
create(name: string, email: string) {if (email.includes("@test.com")) {const user = new User();
user.email = email;
user.name = name;
return this.userRepo.create(user);
}
throw Error("Please use legal email");
}
}koa 我的项目
在 koa 我的项目中实现存储层接口
// server/koa/src/user/user.repo.ts
import {PrismaClient} from "@prisma/client";
import {IUserRepository, User} from "core";
export class UserRepository implements IUserRepository {prisma = new PrismaClient();
async create(user: User): Promise<boolean> {
const d = await this.prisma.user_orm_entity.create({
data: {
email: user.email,
name: user.name,
},
});
return !!d;
}
async find(id: number): Promise<User> {
const d = await this.prisma.user_orm_entity.findFirst({
where: {id: id,},
});
if (d) {const u = new User();
u.email = d?.email;
u.id = d?.id;
u.name = d?.name;
return u;
}
throw Error("user id" + id + "not found");
}
}在 koa 我的项目中实现 HTTP 路由（体现层）
// server/koa/src/user/user.controller.ts
import Router from "@koa/router";
import {UCUser} from "core";
import {UserRepository} from "./user.repo";
export const userRouter = new Router({prefix: "/user",});
userRouter.get("/:id", async (ctx, next) => {
try {const service = new UCUser(new UserRepository());
if (ctx.params.id) {const u = await service.find(+ctx.params.id);
ctx.response.body = JSON.stringify(u);
}
} catch (e) {ctx.throw(400, "some error on get user", e.message);
}
await next();});nest-js 我的项目
nestjs 我的项目的示例能够在此门路中找到（https://github.com/lulusir/clean-architecture/tree/main/server/nestjs-app）
就不在这里贴代码了
最初
请留神，在理论我的项目中，咱们不会将外围业务逻辑放在独自的仓库中（即 core），这只是为了演示在不同框架下应用雷同的业务逻辑
通过将业务逻辑与框架拆散，您能够轻松地在不同的框架和库之间切换，而无需更改外围业务逻辑。如果您心愿构建可扩大且可保护的应用程序，那么 Clean Architecture 相对值得思考。
如果想要演示如何接入其余框架，能够在评论区提出
我的项目地址（https://github.com/lulusir/clean-architecture）感觉不错的小伙伴，能够给个 star，谢谢