クリーンアーキテクチャとは何ですか? Nodeで実装するにはどうすればいいでしょうか？

クリーン アーキテクチャとは何ですか?この記事では、クリーン アーキテクチャについて説明し、Node.js を使用してクリーン アーキテクチャを実装する方法について説明します。

クリーン アーキテクチャ

クリーン アーキテクチャは、Robert C. Martin によって提案された、システムを層に分割して目的を達成するソフトウェア アーキテクチャ パターンです。関心事の分離により、システムの理解、維持、拡張が容易になります。このアーキテクチャでは、システムが内部から外部に向かって、エンティティ層、ユースケース層、プレゼンテーション層、インフラストラクチャ (リポジトリ、フレームワークなど) の 4 つのレベルに分割されます。

この記事では、Node.js を使用してクリーン アーキテクチャを実装する方法を紹介し、アーキテクチャの主要な概念を示すサンプル コードをいくつか提供します。

次に、TypeScript プロジェクトの例 (github.com/lulusir/cle…) を使用します。プロジェクトは Monorepo 構造を使用し、Rush.js を使用して管理されます。サーバー フォルダーには、core、koa、nestjs-app という 3 つのサブプロジェクトが含まれています。Core はコア ビジネス ロジックであり、koa は基礎となるフレームワーク Web プロジェクトとして koa prisma を使用し、nestjs-app は基礎となるフレームワークとして nestjs typeorm を使用します。 。目的は、同じビジネス ロジックが異なるフレームワークをどのように橋渡しできるかを示すことです。 [関連チュートリアルの推奨事項: nodejs ビデオ チュートリアル 、プログラミング教育 ]

このプロジェクトでは、エンティティ レイヤーにはエンティティ オブジェクトと関連するビジネス ルールとロジックが含まれており、ケース層にはシステムのユースケースとビジネスロジックが含まれます。リポジトリ層はデータの保存と取得を担当し、プレゼンテーション層は外部に公開される http インターフェイスです。

プロジェクト機能:

投稿公開・閲覧機能の実現

• ユーザー作成・クエリ

• #投稿の公開、編集、クエリ、削除

#プロジェクト構造

#

├── server
│   ├── core // 核心业务逻辑
│   │   └── src
│   │       ├── domain
│   │       ├── repository
│   │       └── useCase
│   ├── koa
│   │   └── src
│   │       ├── post
│   │       └── user
│   └── nestjs-app
│       ├── src
│           ├── post
│           │   ├── dto
│           │   └── entities
│           └── user
│               └── entities
└── web

#コア: コアはコア ビジネス ロジックのコードです。

• ドメイン: ビジネス固有のモデルなどのエンティティ関連コードを格納します。
  ユース ケース: 格納します。ビジネス ロジック関連コード ビジネス ロジックの処理、データ検証、リポジトリの呼び出しなどのコード。
  • リポジトリ: 外部ストレージ システムのストレージおよび関連インターフェイス
  #koa/nestjs-app: core の実際のコンシューマー
• core のインターフェイスに基づいて特定のルーターとリポジトリを実装します
  プロジェクトの特徴

DDD とクリーン アーキテクチャのアイデアを使用して、ビジネス ロジックをフレームワークの実装から分離します。

モノリポジトリ プロジェクト構造を使用して、複数の関連プロジェクトの管理を容易にします。

• 簡単にすぐに始められるように、複数のサンプル アプリケーションが提供されています。
• TypeScript に基づいており、コードの可読性と保守性が向上しています。
コアには、コア ビジネス ロジック コードがあります。このレベルには、ドメイン、リポジトリ インターフェイス、およびユースケースが含まれます。ドメインには、特定のビジネス モデルなどのエンティティに関連するコードが含まれています。リポジトリには、外部ストレージ システムへの関連インターフェイスが含まれています。ユースケースには、ビジネス ロジックの処理、データ検証、リポジトリの呼び出しなど、ビジネス ロジックに関連するコードが含まれています。
koa/nestjs-app レベルでは、コア レベルに実際のコンシューマーがいます。これらは、コア層によって提供されるインターフェイスに基づいて特定のルーターとリポジトリを実装します。 クリーン アーキテクチャを使用する主な利点の 1 つは、ビジネス ロジックを技術的な実装から分離できることです。これは、コアのビジネス ロジックを変更せずに、さまざまなフレームワークやライブラリを簡単に切り替えることができることを意味します。この例では、同じコア ビジネス ロジックを維持しながら、koa とnesjs-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 プロジェクトの例ここにあります。パス内にあります (

github.com/lulusir/cle…

コードはここには投稿しません

最後に

実際のプロジェクトでは、コア ビジネス ロジックを別のウェアハウス (つまりコア) に配置しないことに注意してください。これは、別の環境でパフォーマンスを実証するためだけです。フレームワーク 同じビジネス ロジックを使用する

ビジネス ロジックをフレームワークから切り離すことにより、コア ビジネス ロジックを変更せずに、異なるフレームワークやライブラリを簡単に切り替えることができます。スケーラブルで保守可能なアプリケーションを構築したい場合は、クリーン アーキテクチャを検討する価値があります。

他のフレームワークに接続する方法をデモしたい場合は、コメント領域に

プロジェクト アドレス (github.com/lulusir/cle...#) を入力してください。 ## 良いアイデアだと思います。星を付けていただけます。ありがとうございます。

ノード関連の詳細については、

nodejs チュートリアルをご覧ください。!

以上がクリーンアーキテクチャとは何ですか? Nodeで実装するにはどうすればいいでしょうか？の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。