Lerna を使って Monorepo を簡単に構築してみましょう

モノレポとは何ですか?

monorepo は、さまざまなチームが使用できる複数の関連サービス、プロジェクト、コンポーネントを含む単一の リポジトリです It 関連または無関係のプロジェクトのコードを保存します。 モノリポという言葉は、単一を意味する mono とリポジトリの略語である repo に由来しています。

Monorepo の利点

Monorepo の主な利点の一部を次に示します。モノリポジトリの使用：

• コード共有: プロジェクトは、標準コード、ライブラリ、またはユーティリティを共有します。
• 再利用性: コンポーネントは別のプロジェクトで再利用する必要があります。
• コード レビューの簡素化: モノリポジトリでは、レビュー担当者が関連プロジェクト間の変更のコンテキストを簡単に確認できるため、コード レビューがより効率的になり、コードの品質を向上させ、潜在的な可能性を検出できます。先ほどの問題。
• 簡素化された CI/CD プロセス: 単一のリポジトリを使用して複数のプロジェクトを同時に公開する方が簡単です。
• 一貫した依存関係管理: プロジェクトは類似または重複する依存関係を共有しており、依存関係を一元管理したいと考えています。
• チーム コラボレーション: 関連プロジェクトに取り組むチームは、より効果的にコラボレーションし、単一のリポジトリで知識、洞察、リソースを共有できます。
• マイクロサービス アーキテクチャ: 密接に関連した一連のマイクロサービスを扱う場合、単一のリポジトリでコード共有、依存関係管理、およびサービス間のテストを簡素化できます。
• バージョンの一貫性: すべてのプロジェクトは標準のバージョン管理アーキテクチャを共有できるため、コミュニケーションと理解が簡素化されます。

#Node.js を使用して Monorepos を管理するために特別に設計されたライブラリとツール

• Lerna##:複数のパッケージを含む JavaScript プロジェクトを管理するために広く使用されているツール。
Nx
• : Angular に焦点を当てていますが、他のフレームワークにも適用できる Nx は、効率的なワークフロー、コードの再利用、テストに重点を置いたモノリポジトリ用の強力な開発ツールを提供します。
Yarn ワークスペース
• : Yarn に組み込まれたモノリポジトリ機能を使用すると、複数のパッケージを単一のリポジトリ内で管理できます。
Rush
• : Microsoft が開発したスケーラブルなモノリポ マネージャーで、大規模なコード ベースに適しています。
Bolt
• : パフォーマンスに重点を置いた単一のリポジトリ管理ツールで、一部の操作では Lerna よりも高速な場合があります。
Monorepo Manager
• : このツールは、monorepo の作成と保守を簡素化し、パッケージ、依存関係、スクリプトを管理するための使いやすいインターフェイスを提供します。
• pnpm: Yarn と同様に、pnpm もワークスペース機能を通じてモノリポジトリ設定をサポートします。これにより、重複が削減され、共有依存関係によってディスク領域の使用率が向上します。

各ツールには特定の利点と機能があるため、選択はプロジェクトの要件と好みによって異なります。

なぜ レルナ ?

Lerna は、複数の npm パッケージを含むリポジトリを管理するために設計されたツールです。 これにより、単一の git リポジトリ内の複数のパッケージ リポジトリ間での依存関係の処理、パッケージ の公開および公開のプロセスが簡素化されます。 Lerna は、同じリポジトリ内の異なる npm パッケージを開発する開発者間での効率的なコード共有とコラボレーションを可能にするため、モノリポジトリに特に役立ちます。 開発者が複数のパッケージを含むプロジェクトを 1 つのエンティティとして扱うことができるため、開発ライフサイクル管理が向上します。

Lerna をインストールする前の前提条件

• #Git: Git をダウンロードしてインストールします
• Git Bash (ターミナル) : Windows を使用している場合、Git Bash は Git インストールに含まれています; macOS および Linux の場合は、システムのターミナルを使用します。
• Node.js: Node.js
• npm をダウンロードしてインストールします。 : npm は Node.js に含まれているため、Node.js をインストールすると、ターミナルで npm を使用できるようになります。 ターミナルを開いて入力して確認します。 npm -v。

#バックエンド サーバーで使用される支払いサービスを含む単一のリポジトリを作成しています。 さらに、バックエンド サーバーと決済サービスはログ サービスを共有します。

• ログ サービス: さまざまなサービスにわたって効率的にログを記録できるように設計されています。
• 支払いサービス: は、支払い関連機能の処理を担当します。
• バックエンド サーバー: 支払い処理を実行し、シームレスな操作のためにログ サービスを統合します。

次に、Lerna を使用した Monorepo の実装について詳しく見ていきましょう。

ステップ 1: ディレクトリの作成と Lerna の初期化

プロジェクトのルート ディレクトリに移動し、Lerna を初期化します:

mkdir monorepo # create a repo directory of the monorepo 
cd monorepo
npx lerna@latest init # initalize the repo

上記の npx コマンドは、Lerna が管理する新しいリポジトリを作成します。
lerna.json: 構成ファイルには、バージョン管理モード、パッケージの場所など、Lerna の動作の設定が含まれています。 #package.json

: リポジトリ全体のルート package.json ファイル。

git config user.name ${username}
git config user.email ${email}

ステップ 2: バックエンド パッケージの生成

現在のルート フォルダーにいることを確認してください。プロジェクト中盤。

パッケージを作成するための Lerna コマンド:

npx lerna create #{packageName} #{directory}

here 、ディレクトリはデフォルトです:

packages

npx lerna create back-end 
//or
//this will skip the questionnaire related to package
npx lerna create back-end -y

上面的命令，不带-y 会提示你各种问题，比如覆盖包名、添加描述等等。但是，这些详细信息对于本示例来说并不重要，因此请按“Enter”键。

运行后，包后端将如下所示：

步骤3：生成支付和日志服务包

再次执行相同的过程，但指定要创建的服务的目录，因为我们希望包位于该"services/"目录中。

ルート package.json ファイルで、ディレクトリ services/ にあるパッケージについて Lerna に伝える必要もあります。 ＃＃＃。 package.jsonワークスペース構成を編集し、"services/*" に追加しますそれ。 構成は次のようになります。

Main package.json##ルート レベル # ファイルを作成するには、services/ ディレクトリ内のパッケージについて Lerna に通知する必要があります。 ワークスペース構成を変更しますpackage.json を追加し、 "services/*" を含めます。 設定は次のようになります:

##

npx lerna create payment services -y
npx lerna create logging services -y

第 4 步：设置日志服务

在该目录中，通过简单的配置使用 Bunyan 库services/logging设置日志记录服务。

• 在日志服务中安装 Buyan 库，并将 Mocha 作为开发依赖项安装在根目录中，以测试所有服务。

// root folder install test dependencies
npm install mocha --save-dev 
//inside logging
cd services/logging
npm install bunyan

• 替换日志功能文件的内容services/logging/lib/logging.js

const bunyan = require('bunyan');
const logger = bunyan.createLogger({
  name: 'my-logging-service',
  level: 'info',
});
module.exports = logger;

• 日志记录测试用例（测试记录器）：
• 替换测试文件的内容services/logging/__tests__/logging.test.js

const loggingService = require('../lib/logging'); // Import the logging service
describe('Logging Service', () => {
  it('should log messages', () => {
    loggingService.info('Test log message');
  });
});

• 更新 services/logging 的 package.json 中的测试脚本。

"test": "mocha ./__tests__/logging.test.js"

• package.json 应如所附图像所示。

• lerna を使用してテストを実行しますnpx lerna run test --scope="logging"

• ##ログ サービスの実装が完了したので、支払いサービスを開発しましょう。

ステップ 5: 支払いサービスを設定する

支払いサービスには、makePayment# という関数があります。 ## は、単一のパラメーターを量として受け入れ、ロガー サービスを利用してアクティビティを記録します。

services/payment ディレクトリで、簡単な関数を使用して支払いサービスを設定します。

• 将现有脚本替换为 mocha，提供用于测试目的的代码片段。
• 要在支付服务中使用日志记录服务，请将其依赖项添加到支付服务的 package.json 中，如下所述。然后，npm i在services/payment目录中运行进行安装。

"scripts": {
    "test": "mocha ./__tests__/payment.test.js"
  },
  "dependencies": {
    "logging": "file:../logging"
  }

• package.json应该如图片所示
  
• 替换支付文件的内容。services/payment/lib/payment.js

const loggingService = require('logging');
const paymentService = {
  makePayment: (amount) => {
    loggingService.info('Payment processing initiated');
    // Implement payment logic here
    loggingService.info('Payment processed successfully');
    return `Payment of ${amount} processed successfully`;
  },
};
module.exports = paymentService;

• makePayment支付服务功能测试用例。
• 替换测试文件的内容services/payment/__tests__/payment.test.js

const chai = require('chai');
const paymentService = require('../lib/payment'); // Import the payment service
const expect = chai.expect;
describe('Payment Service', () => {
  it('should make a payment successfully', () => {
    const paymentResult = paymentService.makePayment(100);
    expect(paymentResult).to.equal('Payment of 100 processed successfully');
  });
});

• 是时候使用 lerna 运行测试了npx lerna run test --scope="payment"
• 我们已经完成了支付服务的实施。现在，让我们继续创建后端服务。

第 6 步：设置后端服务器

我们将使用基本的 GET API 配置服务器，该 API 利用记录器和支付服务。此设置将有助于付款和记录相应的活动。

• 安装 Express 服务器并实现使用这两种服务的功能。

//from root
cd packages/back-end
npm install express

• 替换日志功能文件的内容packages/back-end/lib/back-end.js
• 我们想在服务器中使用支付和日志服务，所以让我们在package.jsonof的依赖项中添加以下代码片段packages/back-end

"logging": "file:../services/logging",
"payment": "file:../services/payment"

• 替换脚本块来运行服务器并进行测试，如下所示：

"scripts": {
    "start": "node ./lib/back-end.js",
    "test": "mocha ./__tests__/back-end.test.js --exit"
}

• package.json应该如所附图片所示

• 现在，通过执行更新依赖项npm update。
• 将 的内容替换packages/back-end/lib/back-end.js为以下代码：
  • 我们将创建一个带有get / API端口的服务器3000，并使用日志记录和支付服务。

const express = require('express');
const loggingService = require('logging');
const paymentService = require('payment');
const app = express();
app.get('/', (req, res) => {
  // Use of logging service
  loggingService.info('Backend server received a request');
  
  // Use the payment service
  const paymentResult = paymentService.makePayment(100);
  loggingService.info('Payment result:', paymentResult);
  res.send('Backend Server: Running!');
});
app.listen(3000, () => {
  console.log('Backend server is running on port 3000');
});

• 安装chai-http以对目录上的 API 进行单元测试packages/back-end。
  • npm i chai-http --save-dev
• 替换测试文件的内容，我们将在其中测试 API 是否按预期工作。

const chai = require('chai');
const chaiHttp = require('chai-http');
const app = require('../lib/back-end'); // Import the Express app
// using request server as chaiHttp;
chai.use(chaiHttp);
const expect = chai.expect;
describe('Backend Server', () => {
  it('should log a request and process payment', (done) => {
    chai.request(app)
      .get('/')
      .end((err, res) => {
        expect(res).to.have.status(200);
        expect(res.text).to.equal('Backend Server: Running!');
        done();
      });
  });
});

• 恭喜！这样就完成了 monorepo 中三个微服务的简洁有效的实现。 

第 7 步：运行应用程序

• 伟大的！现在，让我们启动服务器并观察所有服务如何组合在一起并工作。
• lerna run start在根文件夹中执行。这将在端口 3000 上启动服务器。打开浏览器并导航至localhost:3000/。您将观察到输出“后端服务器：正在运行！” 显示在浏览器中。
• 检查终端中的日志，您将遇到类似于图中所示的Lerna を使って Monorepo を簡単に構築してみましょう。

• 実行 lerna run test、これにより、すべてのマイクロサービスですべてのテストが実行されます。なぜなら、すべてのマイクロサービス #testスクリプト内にコマンドがあります。

結論

バックエンド サーバー、支払いサービス、ログを作成するロギング サービスのモノリポジトリは、統合開発アプローチの利点を強調しています。 この設定では、関連コンポーネントを 1 つのリポジトリに統合することで、効率的なコード管理と共有が促進されます。

ロギング サービスを決済サービスとバックエンド サーバーに統合すると、コードの再利用性とサービス間での一貫したロギングの実践の力が実証されます。

#モノリポジトリ アーキテクチャを採用すると、組織化された共同開発環境が実現します。 モジュール化により開発が簡素化され、効率が向上し、長期的なメンテナンスが可能になります。 これは、透過的な通信、コードの再利用性、効果的なテストを備えた、複雑なアプリケーションの強固な基盤を提供します。

以上がLerna を使って Monorepo を簡単に構築してみましょうの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。