NestJS Node.js (jak to działa dla programistów)

Obsługa TypeScript

Do tworzenia NestJS wykorzystywany jest TypeScript, statycznie typowany nadzbiór języka JavaScript, który zapewnia zaawansowane autouzupełnianie, bezpieczeństwo typów oraz nowoczesne funkcje językowe. Zwiększa to łatwość utrzymania kodu i pomaga w wykrywaniu błędów podczas kompilacji. NestJS domyślnie obsługuje zarówno JavaScript, jak i TypeScript, dając programistom większą swobodę.

Architektura modułowa

NestJS zachęca do organizowania kodu w oparciu o moduły. Łatwiej jest utrzymywać, skalować i organizować kod, gdy powiązane komponenty, takie jak kontrolery, dostawcy i usługi, są zamknięte w jednym module. Moduły aplikacji mogą być wykorzystywane w innych obszarach, co sprzyja filozofii DRY (Don't Repeat Yourself).

Wstrzykiwanie zależności

Jedną z głównych funkcji NestJS, która ułatwia zarządzanie zależnościami, jest zaawansowany system wstrzykiwania zależności. Dzięki wykorzystaniu wstrzykiwania zależności zamiast ich sztywnego kodowania, NestJS tworzy luźno powiązane i testowalne komponenty. Ten styl umożliwia również tworzenie bardziej modułowego kodu i lepszy podział odpowiedzialności.

Dekoratory

W NestJS dekoratory są szeroko stosowane do tworzenia i konfigurowania klas oraz ich elementów składowych. Zastosowanie dekoratorów, takich jak @Controller(), @Get(), @Post(), @Injectable() i innych, poprawia czytelność i wyrazistość kodu, pokazując, co robi każdy element aplikacji i jak się zachowuje.

Kompatybilność z Express i Fastify

Dzięki swojej elastyczności NestJS daje programistom możliwość wyboru między Fastify a Express jako podstawowym serwerem HTTP. Podczas gdy Fastify zapewnia lepszą wydajność, Express słynie z przyjazności dla użytkownika i wydajności. Dzięki tej wszechstronności programiści mogą dostosowywać swoje aplikacje do unikalnych wymagań.

Oprogramowanie pośredniczące

Funkcje middleware'u podobne do Express są obsługiwane przez NestJS. Zanim żądania dotrą do modułów obsługi tras, mogą je przetworzyć programy pośredniczące, zapewniając funkcje takie jak parsowanie treści, uwierzytelnianie i rejestrowanie. Ułatwia to wdrażanie logiki wielokrotnego użytku do obsługi żądań.

Obsługa wyjątków

NestJS posiada rozbudowany system obsługi wyjątków, który pozwala programistom tworzyć unikalne filtry wyjątków. Filtry te mogą usprawnić zarządzanie błędami i ujednolicić reakcje w całej aplikacji poprzez wykrywanie i obsługę wyjątków w standardowy sposób.

Rury i osłony

Rury: Transformacja i walidacja danych odbywa się za pomocą rur. Można je zaimplementować na poziomie kontrolera, na poziomie obsługi trasy lub globalnie. Wbudowane są potoki walidacji i transformacji, a także można tworzyć potoki niestandardowe.

Guards: Logika autoryzacji i uwierzytelniania jest realizowana przez guards. Wykorzystują one określone reguły, takie jak weryfikacja ról lub uprawnień użytkowników, aby zdecydować, czy zatwierdzić żądanie.

Zainstaluj NestJS CLI

Najpierw zainstaluj globalnie NestJS CLI, używając Yarn lub npm.

npm install -g @nestjs/cli

npm install -g @nestjs/cli

Utwórz nowy projekt

Aby rozpocząć nowy projekt NestJS, użyj interfejsu CLI. Zmień "my-nest-app" na nazwę projektu, który chcesz.

nest new my-nest-app

nest new my-nest-app

Struktura projektu

Oto krótkie streszczenie standardowej struktury projektu:

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: Zawiera główny kontroler aplikacji.
• app.service.ts: Zawiera główną usługę aplikacji.
• app.module.ts: Moduł główny aplikacji.
• main.ts: Punkt wejścia aplikacji.

Moduł konfiguracyjny

Aby zarządzać konfiguracjami, zainstaluj pakiet @nestjs/config.

npm install @nestjs/config

npm install @nestjs/config

Dodaj moduł konfiguracyjny do pliku 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 {}

Aby uzyskać dostęp do zmiennych środowiskowych, należy skorzystać z usługi konfiguracyjnej.

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

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

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

Funkcje IronPDF

npm install @ironsoftware/ironpdf

npm install @ironsoftware/ironpdf

Utwórz usługę PDF

Aby zarządzać generowaniem plików PDF, utwórz nową usługę. Usługa ta będzie konwertować informacje HTML na pliki PDF przy użyciu IronPDF.

nest generate service pdf

nest generate service pdf

Zastosuj logikę generowania plików PDF w utworzonym pliku pdf.service.ts.

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

Utwórz kontroler PDF

Utwórz kontroler, aby udostępnić punkt końcowy do tworzenia plików PDF.

nest generate controller pdf

nest generate controller pdf

Utwórz w wynikowym pliku pdf.controller.ts punkt końcowy, który przyjmuje dane wejściowe w formacie HTML i generuje plik 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 służy do przekształcania treści HTML w bufor PDF, który jest następnie zwracany za pomocą PdfService. PdfService wykorzystuje IronPDF do renderowania HTML jako PDF. Integracja ta jest łatwo obsługiwana za pośrednictwem kontrolera NestJS. Kolejnym krokiem jest zdefiniowanie punktu końcowego POST, /generate, w celu odebrania treści HTML od klienta. Korzystając z biblioteki IronPDF, konwertujemy dostarczone dane HTML na plik PDF w ramach API.

Mówiąc dokładniej, tworzymy bufor binarny pliku PDF za pomocą pdf.saveAsBuffer() i tworzymy obiekt PDF z treści HTML za pomocą IronPdf.fromHtml(htmlContent). Następnie bufor ten jest zwracany do klienta z odpowiednim typem MIME (application/pdf). Serwer nasłuchuje na porcie 3000 i rejestruje wszelkie problemy napotkane podczas procesu tworzenia pliku PDF. W odpowiedzi klient otrzymuje kod statusu 500 w przypadku błędu. Takie rozwiązanie jest pomocne podczas tworzenia faktur, raportów lub innych dokumentów dla aplikacji internetowej, ponieważ umożliwia tworzenie dynamicznych plików PDF na podstawie treści HTML.