NestJS Node.js（開發者的使用方法）

TypeScript 支援

NestJS 的建置使用了 TypeScript，它是 JavaScript 的靜態型別超集，提供了複雜的自動完成、型別安全性和現代語言特性。 這提高了程式碼的可維護性，並有助於在編譯過程中檢測錯誤。 NestJS 預設支援 JavaScript 和 TypeScript，為開發者提供了更大的自由度。

模組化建築

NestJS鼓勵採用模組化的程式碼組織方式。 將控制器、提供者和服務等相關元件封裝在單一模組中，可以更輕鬆地維護、擴展和組織程式碼。 該應用程式的模組可以用於其他領域，從而鼓勵 DRY（不要重複自己）理念。

依賴注入

NestJS 的一個主要特性是其完善的依賴注入系統，這使得管理相依性變得更加容易。 NestJS 透過注入依賴項而不是硬編碼依賴項，建立鬆散連結且可測試的元件。 這種設計風格也使得編寫模組化程式碼和改進關注點分離成為可能。

裝飾師

NestJS 中大量使用裝飾器來建立和設定類別及其成員。 使用諸如@Controller() 、 @Get() 、 @Post() 、 @Injectable()等裝飾器可以提高程式碼的可讀性和表達力，使應用程式的每個元件的功能和行為方式更加清晰明了。

與 Express 和 Fastify 相容

由於 NestJS 具有良好的適應性，開發者可以選擇使用 Fastify 或 Express 作為底層 HTTP 伺服器。 雖然 Fastify 效能更佳，但 Express 以其用戶友善性和高效性而聞名。 由於這種多功能性，開發者可以根據獨特的需求自訂應用程式。

中介軟體

NestJS 支援類似 Express 的中間件功能。 在請求到達路由處理程序之前，中間件可以處理它們，提供諸如正文解析、身份驗證和日誌記錄等功能。 這有助於實現可重複使用的請求處理邏輯。

例外處理

NestJS 擁有強大的異常處理系統，可讓程式設計師建立獨特的異常過濾器。 這些過濾器可以透過以標準化的方式捕獲和處理異常，從而提高應用程式的錯誤管理和回應一致性。

管道和護罩

管道：資料轉換和驗證透過管道實現。管道可以在控制器層級、路由處理程序層級或全域層級實現。 驗證和轉換管道是內建的，也可以建立自訂管道。

守衛：授權和認證的邏輯由守衛實現。 他們會使用特定的規則，例如驗證使用者角色或權限，來決定是否批准請求。

安裝 NestJS CLI

首先使用 Yarn 或 npm 全域安裝 NestJS CLI。

npm install -g @nestjs/cli

npm install -g @nestjs/cli

建立新專案

要啟動一個新的 NestJS 項目，請使用 CLI。 將"my-nest-app"變更為您想要的項目名稱。

nest new my-nest-app

nest new my-nest-app

專案結構

以下是標準項目結構的簡要概述：

src/
├── app.controller.ts
├── app.controller.spec.ts
├── app.module.ts
├── app.service.ts
├── main.ts
test/
├── app.e2e-spec.ts
└── jest-e2e.json

• app.controller.ts ：包含應用程式的主控制器。
• app.service.ts ：包含應用程式的主要服務。
• app.module.ts ：應用程式的根模組。
• main.ts ：應用程式的入口點。

配置模組

若要管理配置，請安裝@nestjs/config套件。

npm install @nestjs/config

npm install @nestjs/config

將組態模組加入app.module.ts檔中。

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // Make the module global
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

若要存取環境變量，請使用配置服務。

import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
  constructor(private configService: ConfigService) {}

  getHello(): string {
    return `Hello World!`;
  }
}

NestJS Node.js（開發者使用方法）：圖 2 - NestJS 專案輸出

IronPDF 的特點

npm install @ironsoftware/ironpdf

npm install @ironsoftware/ironpdf

建立 PDF 服務

若要管理 PDF 的生成，請建立一個新服務。該服務將使用 IronPDF 將 HTML 資訊轉換為 PDF。

nest generate service pdf

nest generate service pdf

在建立的pdf.service.ts檔案中應用 PDF 產生邏輯。

// src/pdf/pdf.service.ts
import { Injectable } from '@nestjs/common';
const IronPdf = require('@ironsoftware/ironpdf');
const document = IronPdf.PdfDocument;
var config = IronPdf.IronPdfGlobalConfig;
config.setConfig({ licenseKey: '' });

@Injectable()
export class PdfService {
  async generatePdf(htmlContent: string): Promise<Buffer> {
    const pdf = await document.fromHtml(htmlContent);
    const pdfBuffer = await pdf.saveAsBuffer();
    return pdfBuffer;
  }
}

建立 PDF 控制器

建立一個控制器，提供一個用於建立 PDF 的端點。

nest generate controller pdf

nest generate controller pdf

在產生的pdf.controller.ts檔案中建立一個端點，該端點接受 HTML 輸入並輸出 PDF。

// src/pdf/pdf.controller.ts
import { Controller, Post, Body, Res } from '@nestjs/common';
import { PdfService } from './pdf.service';
import { Response } from 'express';

@Controller('pdf')
export class PdfController {
  constructor(private readonly pdfService: PdfService) {}

  @Post('generate')
  async generatePdf(@Body('html') htmlContent: string, @Res() res: Response) {
    const pdfBuffer = await this.pdfService.generatePdf(htmlContent);
    res.set({
      'Content-Type': 'application/pdf',
      'Content-Disposition': 'attachment; filename=generated.pdf',
      'Content-Length': pdfBuffer.length,
    });
    res.end(pdfBuffer);
  }
}

IronPDF 用於將 HTML 內容轉換為 PDF 緩衝區，然後使用PdfService傳回該緩衝區。 PdfService使用 IronPDF 將 HTML 渲染成 PDF。 透過 NestJS 控制器可以輕鬆實現此整合。 下一步是定義一個 POST 端點/generate ，用於接收來自客戶端的 HTML 內容。 我們使用 IronPDF 庫，在 API 內部將提供的 HTML 資料轉換為 PDF。

更準確地說，我們使用pdf.saveAsBuffer()建立 PDF 檔案的二進位緩衝區，並使用IronPdf.fromHtml(htmlContent)從 HTML 內容建立 PDF 物件。 之後，該緩衝區將以適當的 MIME 類型（ application/pdf ）傳回給客戶端。 伺服器監聽 3000 端口，並記錄 PDF 創建過程中遇到的任何問題。 對此，客戶端會收到 500 錯誤狀態碼。 這種設定有助於為 Web 應用程式建立發票、報告或其他文檔，因為它允許從 HTML 內容建立動態 PDF。

NestJS Node.js（開發者使用指南）：圖 4 - PDF 輸出