Spielen Sie mit Lerna, um Ihnen beim einfachen Aufbau von Monorepo zu helfen

Was ist Monorepo?

Ein Monorepo ist ein einzelnes Repository mit mehreren zugehörigen Diensten, Projekten und Komponenten, das von verschiedenen Teams zum Speichern von Code für verwandte oder nicht verwandte Projekte verwendet werden kann. Das Wort Monorepo leitet sich von Mono ab, was Single bedeutet, und Repo, was die Abkürzung für Repository ist. Vorteile von Monorepo

Hier sind einige der wichtigsten Vorteile der Verwendung von Monorepo:

• Code-Sharing: Projekte teilen Standardcode, Bibliotheken oder Dienstprogramme.
• Wiederverwendbarkeit: Komponenten müssen in verschiedenen Projekten wiederverwendet werden.
• Einfachere Codeüberprüfungen: Codeüberprüfungen sind in einem Monorepo effizienter, da Prüfer den Kontext von Änderungen zwischen verwandten Projekten leicht erkennen können, was die Codequalität verbessern und potenzielle Probleme früher erkennen kann.
• Vereinfachter CI/CD-Prozess: Das gleichzeitige Veröffentlichen mehrerer Projekte über ein einziges Repository ist jetzt noch einfacher.
• Konsistentes Abhängigkeitsmanagement: Projekte haben ähnliche oder überlappende Abhängigkeiten und Sie möchten Abhängigkeiten zentral verwalten.
• Teamzusammenarbeit: Teams, die an verwandten Projekten arbeiten, können in einem einzigen Repository effektiver zusammenarbeiten und Wissen, Erkenntnisse und Ressourcen austauschen.
• Microservices-Architektur: Beim Umgang mit einer Reihe eng verwandter Microservices kann ein einziges Repository die Codefreigabe, das Abhängigkeitsmanagement und das Testen zwischen Diensten vereinfachen.
• Versionskonsistenz: Alle Projekte können eine Standardarchitektur zur Versionskontrolle gemeinsam nutzen, was die Kommunikation und das Verständnis vereinfacht.

Bibliotheken und Tools, die speziell für die Verwaltung von Monorepos mit Node.js entwickelt wurden.

• Lerna: Ein weit verbreitetes Tool zur Verwaltung von JavaScript-Projekten mit mehreren Paketen.
• Nx: Nx konzentriert sich auf Angular, ist aber auch auf andere Frameworks anwendbar und bietet leistungsstarke Entwicklungstools für Monorepos mit Schwerpunkt auf effizienten Arbeitsabläufen, Code-Wiederverwendung und Tests.
• Yarn Workspace: Die integrierte Monorepo-Funktionalität von Yarn ermöglicht die Verwaltung mehrerer Pakete in einem einzigen Repository.
• Rush: Ein skalierbarer Monorepo-Manager, der von Microsoft für große Codebasen entwickelt wurde.
• Bolt: Ein einzelnes Repository-Verwaltungstool mit Fokus auf Leistung, das bei einigen Vorgängen schneller als Lerna sein kann.
• Monorepo Manager: Dieses Tool vereinfacht die Erstellung und Wartung von Monorepo und bietet eine benutzerfreundliche Oberfläche zum Verwalten von Paketen, Abhängigkeiten und Skripten.
• pnpm: Wie Yarn unterstützt pnpm auch Monorepo-Setups über seine Workspace-Funktion, wodurch Duplizierungen reduziert und die Speicherplatznutzung durch gemeinsame Abhängigkeiten verbessert werden.

Jedes Tool bietet spezifische Vorteile und Funktionen, sodass die Wahl von den Anforderungen und Vorlieben Ihres Projekts abhängt.

Warum Lerna?

Lerna ist ein Tool zur Verwaltung von Repositorys, die mehrere npm-Pakete enthalten. Es vereinfacht den Prozess der Handhabung von Abhängigkeiten sowie der Veröffentlichung und Freigabe von Paketen über mehrere Paket-Repositorys hinweg in einem einzigen Git-Repository. Lerna ist besonders nützlich für Monorepo, da es eine effiziente Codefreigabe und Zusammenarbeit zwischen Entwicklern ermöglicht, die an verschiedenen npm-Paketen im selben Repository arbeiten. Es ermöglicht Entwicklern, Projekte mit mehreren Paketen als eine Einheit zu behandeln und so das Entwicklungslebenszyklusmanagement zu verbessern.

Voraussetzungen vor der Installation von Lerna

• Git: Laden Sie Git herunter und installieren Sie es.
• Git Bash (Terminal) : Wenn Sie Windows verwenden, ist Git Bash in der Git-Installation enthalten Für macOS und Linux verwenden Sie bitte das Terminal Ihres Systems.
Node.js
• : Laden Sie Node.js
npm
• herunter und installieren Sie es: npm ist in Node.js enthalten, sodass npm nach der Installation von Node.js in Ihrer Terminalnutzung verfügbar ist. Überprüfen Sie, indem Sie ein Terminal öffnen und Folgendes eingeben. . npm -v

Wir erstellen ein einziges Repository, das die vom Backend-Server verwendeten Zahlungsdienste enthält. Darüber hinaus teilen sich der Backend-Server und der Zahlungsdienst den Protokollierungsdienst.

Protokollierungsdienst:
• Entwickelt für die effiziente Protokollierung verschiedener Dienste.
Zahlungsservice:
• Zuständig für die Abwicklung zahlungsbezogener Funktionen.
Backend-Server:
• Führt die Zahlungsabwicklung durch und integriert Protokollierungsdienste für einen reibungslosen Betrieb.

Lassen Sie uns nun mit der Implementierung von Monorepo mit Lerna beginnen.

Schritt 1: Verzeichnis erstellen und Lerna initialisieren

Navigieren Sie zum Stammverzeichnis Ihres Projekts und initialisieren Sie Lerna:

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

Oben npxnpx命令将创建一个新的 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}

这里，目录是默认的：packagesDer Befehl erstellt ein neues von Lerna verwaltetes Repository.

lerna.json🎜： Die Konfigurationsdatei enthält Einstellungen für das Lerna-Verhalten, wie z. B. Versionskontrollmodus, Paketspeicherort usw. 🎜🎜🎜

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

Nach dem Login kopieren

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

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

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

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

An der Wurzelpackage.jsonpackage.json文件中，您还必须告知 Lerna 目录中的包services/。编辑package.json工作区配置并添加"services/*"到其中。配置应类似于以下内容：

在根级别的主package.json文件中，您必须告知 Lerna services/ 目录中的软件包。修改工作区配置package.json并包含"services/*" Datei, müssen Sie Lerna auch das Paket im Verzeichnis mitteilen services/. Bearbeiten

package.json

Workspace-Konfiguration und add"services/*" hinein. Die Konfiguration sollte wie folgt aussehen:

🎜🎜Master auf Stammebene 🎜package.json🎜und enthält 🎜"services/*"🎜🎜. Die Konfiguration sollte so aussehen: 🎜🎜🎜🎜🎜🎜🎜🎜🎜🎜🎜🎜

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"

npx lerna run test --scope="logging"

• 日志服务实现现已就位，让我们开发支付服务。

第5步：设置支付服务

付款服务具有一个名为 的函数makePayment，它接受单个参数作为金额并利用记录器服务来记录活动。

在services/payment付款服务具有一个名为 的函数</span>在</p><code style="box-sizing: border-box; Schriftfamilie: Menlo, Monaco, Consolas, „Courier New“, Monospace; Schriftgröße: 17,1 Pixel; Polsterung: 2px 4px; Farbe: RGB(199, 37, 78); Hintergrundfarbe: rgb(249, 242, 244); border-radius: 4px;">Dienste/Zahlung🎜目录内，并通过简单的功能设置支付服务。🎜🎜

• 将现有脚本替换为 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/。您将观察到输出“后端服务器：正在运行！” 显示在浏览器中。
• 检查终端中的日志，您将遇到类似于图中所示的Spielen Sie mit Lerna, um Ihnen beim einfachen Aufbau von Monorepo zu helfen。

• Executelerna run testlerna run test，这将运行所有微服务中的所有测试，因为所有微服务test, dadurch werden alle Tests in allen Microservices ausgeführt, da alle Microservices testEs gibt Befehle im Skript.

Fazit

Das Erstellen eines Monorepo mit einem Backend-Server, einem Zahlungsdienst und einem Protokollierungsdienst unterstreicht die Vorteile eines einheitlichen Entwicklungsansatzes. Dieses Setup fördert eine effiziente Codeverwaltung und -freigabe durch die Konsolidierung verwandter Komponenten in einem einzigen Repository.

Die Integration von Protokollierungsdiensten in Zahlungsdienste und Backend-Server zeigt die Leistungsfähigkeit der Wiederverwendbarkeit von Code und konsistenter Protokollierungspraktiken über alle Dienste hinweg.

Die Einführung einer Monorepo-Architektur sorgt für eine organisierte und kollaborative Entwicklungsumgebung. Modularisierung vereinfacht die Entwicklung, verbessert die Effizienz und die langfristige Wartung. Es bietet eine solide Grundlage für komplexe Anwendungen mit transparenter Kommunikation, Wiederverwendbarkeit des Codes und effektiven Tests.

🎜

Das obige ist der detaillierte Inhalt vonSpielen Sie mit Lerna, um Ihnen beim einfachen Aufbau von Monorepo zu helfen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!