玩转Lerna，助你轻松搭建Monorepo-git-PHP中文网

Lerna是一个设计用于管理包含多个 npm 包的存储库的工具。它简化了在单个git存储库中的多包存储库中处理依赖项、发布和发布包的过程。Lerna 对于 monorepo 特别有用，因为它可以在同一存储库中处理不同 npm 包的开发人员之间实现高效的代码共享和协作。它允许开发人员将具有多个包的项目视为单个实体，从而改进开发生命周期管理。

安装 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

现在让我们深入研究使用 Lerna 实现 Monorepo。

第1步：创建目录并初始化Lerna

导航到项目的根目录并初始化 Lerna：

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

登录后复制

上面的npxnpx命令将创建一个新的 Lerna 管理的存储库。
lerna.json：配置文件包含Lerna行为的设置，例如版本控制模式、包位置等

package.json：整个存储库的根 package.json 文件。

玩转Lerna，助你轻松搭建Monorepo

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

登录后复制

第2步：生成后端包

确保您位于项目的根文件夹中。

用于创建包的 Lerna 命令：npx lerna create #{packageName} #{directory}

这里，目录是默认的：packages命令将创建一个新的 Lerna 管理的存储库。

lerna.json🎜：配置文件包含Lerna行为的设置，例如版本控制模式、包位置等🎜🎜🎜package.json🎜：整个存储库的根 package.json 文件。🎜🎜

玩转Lerna，助你轻松搭建Monorepo 🎜

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

登录后复制

🎜第2步：生成后端包🎜🎜🎜确保您位于项目的根文件夹中。 🎜🎜🎜🎜用于创建包的 Lerna 命令：🎜npx lerna create #{packageName} #{directory}🎜🎜🎜这里，目录是默认的：🎜packages🎜

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

登录后复制

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

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

玩转Lerna，助你轻松搭建Monorepo

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

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

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

在根级别的主package.json文件中，您必须告知 Lerna services/ 目录中的软件包。修改工作区配置package.json并包含"services/*"文件中，您还必须告知 Lerna 目录中的包services/。编辑

package.json

工作区配置并添加"services/*"到其中。玩转Lerna，助你轻松搭建Monorepo 配置应类似于以下内容：

🎜🎜在根级别的主🎜package.json🎜🎜文件中，您必须告知 Lerna services/ 目录中的软件包。🎜🎜修改工作区配置🎜🎜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(&#39;bunyan&#39;);
const logger = bunyan.createLogger({
  name: &#39;my-logging-service&#39;,
  level: &#39;info&#39;,
});
module.exports = logger;

登录后复制

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

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

登录后复制

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

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

登录后复制

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

玩转Lerna，助你轻松搭建Monorepo

是时候使用 lerna 运行测试了npx lerna 运行测试 --scope="logging"

玩转Lerna，助你轻松搭建Monorepo npx lerna run test --scope="logging"

玩转Lerna，助你轻松搭建Monorepo

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

第5步：设置支付服务

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

在services/payment

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

第五步：设置支付服务

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

🎜在🎜服务/支付🎜目录内，并通过简单的功能设置支付服务。🎜🎜

将现有脚本替换为 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(&#39;logging&#39;);
const paymentService = {
  makePayment: (amount) => {
    loggingService.info(&#39;Payment processing initiated&#39;);
    // Implement payment logic here
    loggingService.info(&#39;Payment processed successfully&#39;);
    return `Payment of ${amount} processed successfully`;
  },
};
module.exports = paymentService;

登录后复制

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

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

登录后复制

是时候使用 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应该如所附图片所示

玩转Lerna，助你轻松搭建Monorepo

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

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

登录后复制

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

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

登录后复制

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

第 7 步：运行应用程序

伟大的！现在，让我们启动服务器并观察所有服务如何组合在一起并工作。
lerna run start在根文件夹中执行。这将在端口 3000 上启动服务器。打开浏览器并导航至localhost:3000/。您将观察到输出“后端服务器：正在运行！” 显示在浏览器中。
检查终端中的日志，您将遇到类似于图中所示的玩转Lerna，助你轻松搭建Monorepo。