NestJS Node.js (Wie es für Entwickler funktioniert)

TypeScript Unterstützung

TypeScript, ein statisch typisiertes Superset von JavaScript, das fortschrittliche Autovervollständigung, Typsicherheit und moderne Sprachfunktionen bietet, wird beim Aufbau von NestJS verwendet. Dies erhöht die Wartbarkeit des Codes und hilft bei der Erkennung von Fehlern während der Kompilierung. NestJS unterstützt standardmäßig sowohl JavaScript als auch TypeScript, was den Entwicklern mehr Freiheit gibt.

Modulare Architektur

NestJS fördert die Codeorganisation auf Modularbasis. Es ist einfacher, Code zu warten, skalieren und zu organisieren, wenn verwandte Komponenten wie Controller, Anbieter und Dienste in einem einzigen Modul gekapselt sind. Die Module der Anwendung können in anderen Bereichen verwendet werden, was die DRY-Philosophie (Don't Repeat Yourself) fördert.

Dependency Injection

Eines der Hauptmerkmale von NestJS, das die Verwaltung von Abhängigkeiten erleichtert, ist ein ausgeklügeltes System zur Dependency Injection. Durch die Verwendung von Dependency Injection anstelle von Hardcoding erstellt NestJS lose gekoppelte und testbare Komponenten. Dieser Stil ermöglicht auch modulareren Code und verbesserte Trennung von Anliegen.

Dekoratoren

Dekoratoren werden intensiv in NestJS genutzt, um Klassen und ihre Mitglieder zu erstellen und zu konfigurieren. Der Einsatz von Dekoratoren wie @Controller(), @Get(), @Post(), @Injectable() und anderen verbessert die Lesbarkeit und Ausdruckskraft des Codes, indem er sichtbar macht, was jede Komponente der Anwendung tut und wie sie sich verhält.

Kompatibilität mit Express und Fastify

Dank seiner Anpassungsfähigkeit gibt NestJS den Entwicklern die Möglichkeit, entweder Fastify oder Express als zugrunde liegenden HTTP-Server zu verwenden. Während Fastify bessere Leistung bietet, ist Express für seine Benutzerfreundlichkeit und Effizienz bekannt. Dank dieser Vielseitigkeit können Entwickler ihre Apps an einzigartige Anforderungen anpassen.

Middleware

NestJS unterstützt Middleware-Funktionalitäten ähnlich wie Express. Middleware kann Anfragen abfangen, bevor sie die Routen-Handler erreichen, und so Funktionen wie Parsing des Anfragekörpers, Authentifizierung und Protokollierung bereitstellen. Dies erleichtert die Implementierung wiederverwendbarer Logik zur Anfragebearbeitung.

Fehlerbehandlung

NestJS verfügt über ein robustes System zur Ausnahmebehandlung, das es Programmierern ermöglicht, benutzerdefinierte Ausnahmefilter zu erstellen. Diese Filter können die Fehlerverwaltung und Antwortkonsistenz in der gesamten Anwendung verbessern, indem sie Ausnahmen auf standardisierte Weise abfangen und behandeln.

Pipes und Guards

Pipes: Pipes werden zur Datenumwandlung und -validierung verwendet. Sie können auf Controller-, Routen-Handler-Ebene oder global implementiert werden. Es sind eingebaute Validierungs- und Transformationspipelines vorhanden, und auch benutzerdefinierte Pipes können erstellt werden.

Guards: Die Logik für Autorisierung und Authentifizierung wird von den Guards implementiert. Sie verwenden spezifische Regeln, wie z.B. die Überprüfung von Benutzerrollen oder Berechtigungen, um zu entscheiden, ob eine Anfrage zugelassen werden soll.

Installieren des NestJS CLI

Installieren Sie das NestJS CLI zuerst global, entweder mit Yarn oder npm.

npm install -g @nestjs/cli

npm install -g @nestjs/cli

Ein neues Projekt erstellen

Verwenden Sie das CLI, um ein neues NestJS-Projekt zu starten. Ändern Sie "my-nest-app" in den Namen des gewünschten Projekts.

nest new my-nest-app

nest new my-nest-app

Projektstruktur

Dies ist eine kurze Übersicht über die Standardprojektstruktur:

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: Enthält den Hauptcontroller der Anwendung.
• app.service.ts: Enthält den Hauptservice der Anwendung.
• app.module.ts: Das Hauptmodul der Anwendung.
• main.ts: Der Einstiegspunkt der Anwendung.

Konfigurationsmodul

Um Konfigurationen zu verwalten, installieren Sie das Paket @nestjs/config.

npm install @nestjs/config

npm install @nestjs/config

Fügen Sie das Konfigurationsmodul in die Datei app.module.ts ein.

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 {}

Verwenden Sie den Konfigurationsdienst, um auf Umgebungsvariablen zuzugreifen.

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

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

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

Funktionen von IronPDF

npm install @ironsoftware/ironpdf

npm install @ironsoftware/ironpdf

Erstellen eines PDF-Dienstes

Erstellen Sie einen neuen Dienst, um die Erstellung von PDFs zu verwalten. Dieser Dienst wird mithilfe von IronPDF HTML-Informationen in PDFs umwandeln.

nest generate service pdf

nest generate service pdf

Wenden Sie die Logik zur PDF-Erstellung in der Datei pdf.service.ts an.

// 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;
  }
}

Erstellen eines PDF-Controllers

Erstellen Sie einen Controller, um einen Endpunkt zur Erstellung von PDFs verfügbar zu machen.

nest generate controller pdf

nest generate controller pdf

Erzeugen Sie einen Endpunkt in der resultierenden Datei pdf.controller.ts, der HTML-Eingaben entgegennimmt und ein PDF ausgibt.

// 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 wird verwendet, um den HTML-Inhalt in einen PDF-Puffer umzuwandeln, der dann mit dem PdfService zurückgegeben wird. Der PdfService verwendet IronPDF zum Rendern von HTML als PDF. Diese Integration wird einfach über den NestJS-Controller gehandhabt. Der nächste Schritt ist die Definition eines POST-Endpunkts, /generate, um den HTML-Inhalt vom Client zu erhalten. Mithilfe der IronPDF-Bibliothek konvertieren wir die bereitgestellten HTML-Daten in ein PDF innerhalb der API.

Um genauer zu sein, erstellen wir einen binären Puffer der PDF-Datei mit pdf.saveAsBuffer() und ein PDF-Objekt aus HTML-Inhalt mit IronPdf.fromHtml(htmlContent). Dieser Puffer wird anschließend mit dem entsprechenden MIME-Typ (application/pdf) an den Client zurückgegeben. Der Server lauscht auf Port 3000 und protokolliert alle bei der PDF-Erstellung aufgetretenen Probleme. Als Antwort erhält der Client bei einem Fehler einen 500-Statuscode. Diese Konfiguration ist hilfreich beim Erstellen von Rechnungen, Berichten oder anderen Dokumenten für eine Webanwendung, da so dynamische PDFs aus HTML-Inhalten erstellt werden können.