目錄

• Clean Architecture
• 項目功能：
• 項目結(jié)構(gòu)
• 項目特點
• 代碼實現(xiàn)
• 定義實體層
• 定義存儲接口
• 定義用例層
• koa項目
• 在koa項目中實現(xiàn)存儲層接口
• 在koa項目中實現(xiàn)HTTP路由（表現(xiàn)層）
• nest-js項目
• 最后

Clean Architecture

Clean Architecture 是 Robert C. Martin 提出的一種軟件架構(gòu)模式，目的是為了將系統(tǒng)分層，實現(xiàn)關(guān)注點分離，使系統(tǒng)更易于理解、維護和擴展。該體系結(jié)構(gòu)將系統(tǒng)分為四個層級，從內(nèi)到外分別是：實體層、用例層、表現(xiàn)層、基礎(chǔ)設(shè)施（存儲庫，框架等）。

在本文中，我們將介紹如何使用 Node.js 實現(xiàn) Clean Architecture，并提供一些示例代碼來演示該架構(gòu)的關(guān)鍵概念。

接下來我們將使用 TypeScript 項目示例（github.com/lulusir/cle… ）。該項目采用了 Monorepo 結(jié)構(gòu)，使用 Rush.js 進行管理。在 server 文件夾中包含了三個子項目，分別為 core、koa 和 nestjs-app，其中 core 為核心業(yè)務(wù)邏輯，koa是使用koa+prisma的為底層框架web項目，nestjs-app是使用nestjs + typeorm為底層框架的項目。目的是演示相同的業(yè)務(wù)邏輯如何橋接不同的框架。

在這個項目中，實體層包含實體對象和相關(guān)的業(yè)務(wù)規(guī)則和邏輯，用例層包含系統(tǒng)的用例和業(yè)務(wù)邏輯，存儲庫層負責保存和檢索數(shù)據(jù)，表示層則是暴露給外部的http接口。

項目功能：

實現(xiàn)一個帖子發(fā)布，瀏覽功能

• 用戶創(chuàng)建，查詢
• 帖子的發(fā)布，編輯，查詢，刪除

項目結(jié)構(gòu)

├── server│   ├── core // 核心業(yè)務(wù)邏輯│   │   └── src│   │       ├── domain│   │       ├── repository│   │       └── useCase│   ├── koa│   │   └── src│   │       ├── post│   │       └── user│   └── nestjs-app│       ├── src│   ├── post│   │   ├── dto│   │   └── entities│   └── user│       └── entities└── web

core：core為核心業(yè)務(wù)邏輯的代碼

• Domain: 存放實體相關(guān)的代碼，如業(yè)務(wù)具體的 model 等
• Use Cases: 存放業(yè)務(wù)邏輯相關(guān)的代碼，如處理業(yè)務(wù)邏輯、數(shù)據(jù)驗證、調(diào)用 Repository 等
• Repository: 存放和外部存儲系統(tǒng)的相關(guān)接口

koa/nestjs-app: core的實際消費者

• 根據(jù)core的接口實現(xiàn)具體的Router，Repository

項目特點

• 使用 DDD 和 Clean Architecture 的思想，將業(yè)務(wù)邏輯與框架實現(xiàn)分離。
• 使用 monorepo 項目結(jié)構(gòu)，方便管理多個相關(guān)的項目。
• 提供了多個示例應(yīng)用程序，方便快速上手。
• 基于 TypeScript，提高代碼可讀性和可維護性。

在core中，我們有核心的業(yè)務(wù)邏輯代碼。此級別包含域、存儲庫接口和用例。域包含與實體相關(guān)的代碼，例如特定的業(yè)務(wù)模型。存儲庫包含與外部存儲系統(tǒng)的相關(guān)接口。用例包含與業(yè)務(wù)邏輯相關(guān)的代碼，例如處理業(yè)務(wù)邏輯、數(shù)據(jù)驗證和調(diào)用存儲庫。

在koa/nestjs-app層面，我們有核心層面的實際消費者。它們根據(jù)核心層提供的接口實現(xiàn)特定的路由器和存儲庫。 使用 Clean Architecture 的主要優(yōu)點之一是它將業(yè)務(wù)邏輯與技術(shù)實現(xiàn)分開。這意味著您可以輕松地在不同的框架和庫之間切換，而無需更改核心業(yè)務(wù)邏輯。在我們的示例中，我們可以在 koa 和 nestjs-app 之間切換，同時保持相同的核心業(yè)務(wù)邏輯。

代碼實現(xiàn)

定義實體層

// server/core/src/domain/post.tsimport { 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.tsexport 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項目中實現(xiàn)存儲層接口

// server/koa/src/user/user.repo.tsimport { 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項目中實現(xiàn)HTTP路由（表現(xiàn)層）

// server/koa/src/user/user.controller.tsimport 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 項目的示例可以在此路徑中找到 （github.com/lulusir/cle… 就不在這里貼代碼了

最后

請注意，在實際項目中，我們不會將核心業(yè)務(wù)邏輯放在單獨的倉庫中（即core），這只是為了演示在不同框架下使用相同的業(yè)務(wù)邏輯

通過將業(yè)務(wù)邏輯與框架分離，您可以輕松地在不同的框架和庫之間切換，而無需更改核心業(yè)務(wù)邏輯。如果您希望構(gòu)建可擴展且可維護的應(yīng)用程序，那么Clean Architecture 絕對值得考慮。

如果想要演示如何接入其他框架，可以在評論區(qū)提出

項目地址 （github.com/lulusir/cle… 覺得不錯的小伙伴，可以給個star，謝謝

以上就是使用Node.js實現(xiàn)Clean Architecture方法示例詳解的詳細內(nèi)容，更多關(guān)于Node.js Clean Architecture的資料請關(guān)注其它相關(guān)文章！