Połączenie do usługi Azure SQL Database i wykonywania na nie zapytań przy użyciu pakietu npm Node.js i mssql

Dotyczy:Azure SQL Database

W tym przewodniku Szybki start opisano sposób łączenia aplikacji z bazą danych w usłudze Azure SQL Database i wykonywania zapytań przy użyciu Node.js i mssql. Ten przewodnik Szybki start jest zgodny z zalecanym podejściem bez hasła w celu nawiązania połączenia z bazą danych.

Połączenia bez hasła dla deweloperów

Połączenia bez hasła oferują bezpieczniejszy mechanizm uzyskiwania dostępu do zasobów platformy Azure. Następujące ogólne kroki służą do nawiązywania połączenia z usługą Azure SQL Database przy użyciu połączeń bez hasła w tym artykule:

  • Przygotuj środowisko do uwierzytelniania bez hasła.
    • W środowisku lokalnym: Używana jest tożsamość osobista. Tę tożsamość można ściągnąć ze środowiska IDE, interfejsu wiersza polecenia lub innych lokalnych narzędzi programistycznych.
    • W środowisku chmury: jest używana tożsamość zarządzana.
  • Uwierzytelnij się w środowisku przy użyciu biblioteki DefaultAzureCredential tożsamości platformy Azure, aby uzyskać zweryfikowane poświadczenia.
  • Użyj zweryfikowanego poświadczenia, aby utworzyć obiekty klienta zestawu Azure SDK na potrzeby dostępu do zasobów.

Więcej informacji na temat połączeń bez hasła można uzyskać w centrum bez hasła.

Wymagania wstępne

Konfigurowanie serwera bazy danych

Bezpieczne, bez hasła połączenia z usługą Azure SQL Database wymagają pewnych konfiguracji bazy danych. Sprawdź następujące ustawienia na serwerze logicznym na platformie Azure , aby prawidłowo nawiązać połączenie z usługą Azure SQL Database w środowiskach lokalnych i hostowanych:

  1. W przypadku lokalnych połączeń programistycznych upewnij się, że serwer logiczny jest skonfigurowany tak, aby zezwolić na nawiązywanie połączenia z adresem IP komputera lokalnego i innymi usługami platformy Azure:

    • Przejdź do strony Sieć serwera.

    • Przełącz przycisk radiowy Wybrane sieci, aby wyświetlić dodatkowe opcje konfiguracji.

    • Wybierz pozycję Dodaj adres IPv4 klienta (xx.xx.xx.xx.xx ), aby dodać regułę zapory, która umożliwi połączenia z adresu IPv4 komputera lokalnego. Alternatywnie możesz również wybrać pozycję + Dodaj regułę zapory, aby wprowadzić wybrany konkretny adres IP.

    • Upewnij się, że pole wyboru Zezwalaj usługom i zasobom platformy Azure na dostęp do tego serwera jest zaznaczone.

      Zrzut ekranu przedstawiający sposób konfigurowania reguł zapory.

      Ostrzeżenie

      Włączenie opcji Zezwalaj usługom i zasobom platformy Azure na dostęp do tego ustawienia serwera nie jest zalecaną praktyką zabezpieczeń w scenariuszach produkcyjnych. Rzeczywiste aplikacje powinny implementować bezpieczniejsze podejścia, takie jak silniejsze ograniczenia zapory lub konfiguracje sieci wirtualnej.

      Więcej informacji na temat konfiguracji zabezpieczeń bazy danych można uzyskać w następujących zasobach:

  2. Serwer musi również mieć włączone uwierzytelnianie Microsoft Entra i mieć przypisane konto administratora firmy Microsoft Entra. W przypadku lokalnych połączeń programistycznych konto administratora firmy Microsoft Entra powinno być kontem, które można również zalogować się do programu Visual Studio lub interfejsu wiersza polecenia platformy Azure lokalnie. Możesz sprawdzić, czy serwer ma włączone uwierzytelnianie firmy Microsoft Entra na stronie Identyfikator entra firmy Microsoft serwera logicznego.

    Zrzut ekranu przedstawiający sposób włączania uwierzytelniania w usłudze Microsoft Entra.

  3. Jeśli używasz osobistego konta platformy Azure, upewnij się, że masz konfigurację usługi Microsoft Entra i skonfigurowaną dla usługi Azure SQL Database w celu przypisania konta jako administratora serwera. Jeśli używasz konta firmowego, identyfikator Firmy Microsoft najprawdopodobniej zostanie już skonfigurowany.

Tworzenie projektu

Kroki opisane w tej sekcji umożliwiają utworzenie interfejsu API REST Node.js.

  1. Utwórz nowy katalog dla projektu i przejdź do niego.

  2. Zainicjuj projekt, uruchamiając następujące polecenie w terminalu:

    npm init -y
    
  3. Zainstaluj wymagane pakiety używane w przykładowym kodzie w tym artykule:

    npm install mssql swagger-ui-express yamljs
    
  4. Zainstaluj pakiet programowy używany w przykładowym kodzie w tym artykule:

    npm install --save-dev dotenv 
    
  5. Otwórz projekt w programie Visual Studio Code.

    code .
    
  6. Otwórz plik package.json i dodaj następującą właściwość i wartość po właściwości name, aby skonfigurować projekt dla modułów ESM.

    "type": "module",
    

Tworzenie kodu aplikacji Express.js

Aby utworzyć aplikację Express.js OpenAPI, utworzysz kilka plików:

Plik opis
.env.development Lokalny plik środowiska programistycznego.
index.js Główny plik aplikacji, który uruchamia aplikację Express.js na porcie 3000.
person.js Express.js /person route API plik do obsługi operacji CRUD.
openapi.js Express.js /api-docs route for OpenAPI explorer UI (Trasa narzędzia /api-docs dla interfejsu użytkownika eksploratora interfejsu użytkownika interfejsu api interfejsu użytkownika eksploratora interfejsu api). Root przekierowuje do tej trasy.
openApiSchema.yml Plik schematu openAPI 3.0 definiujący interfejs API osoby.
config.js Plik konfiguracji do odczytywania zmiennych środowiskowych i konstruowania odpowiedniego obiektu połączenia mssql.
database.js Klasa bazy danych do obsługi operacji CRUD usługi Azure SQL przy użyciu pakietu npm mssql .
./vscode/settings.json Ignoruj pliki według wzorca glob podczas wdrażania.
  1. Utwórz plik index.js i dodaj następujący kod:

    import express from 'express';
    import { config } from './config.js';
    import Database from './database.js';
    
    // Import App routes
    import person from './person.js';
    import openapi from './openapi.js';
    
    const port = process.env.PORT || 3000;
    
    const app = express();
    
    // Development only - don't do in production
    // Run this to create the table in the database
    if (process.env.NODE_ENV === 'development') {
      const database = new Database(config);
      database
        .executeQuery(
          `CREATE TABLE Person (id int NOT NULL IDENTITY, firstName varchar(255), lastName varchar(255));`
        )
        .then(() => {
          console.log('Table created');
        })
        .catch((err) => {
          // Table may already exist
          console.error(`Error creating table: ${err}`);
        });
    }
    
    // Connect App routes
    app.use('/api-docs', openapi);
    app.use('/persons', person);
    app.use('*', (_, res) => {
      res.redirect('/api-docs');
    });
    
    // Start the server
    app.listen(port, () => {
      console.log(`Server started on port ${port}`);
    });
    
  2. Utwórz plik trasy person.js i dodaj następujący kod:

    import express from 'express';
    import { config } from './config.js';
    import Database from './database.js';
    
    const router = express.Router();
    router.use(express.json());
    
    // Development only - don't do in production
    console.log(config);
    
    // Create database object
    const database = new Database(config);
    
    router.get('/', async (_, res) => {
      try {
        // Return a list of persons
        const persons = await database.readAll();
        console.log(`persons: ${JSON.stringify(persons)}`);
        res.status(200).json(persons);
      } catch (err) {
        res.status(500).json({ error: err?.message });
      }
    });
    
    router.post('/', async (req, res) => {
      try {
        // Create a person
        const person = req.body;
        console.log(`person: ${JSON.stringify(person)}`);
        const rowsAffected = await database.create(person);
        res.status(201).json({ rowsAffected });
      } catch (err) {
        res.status(500).json({ error: err?.message });
      }
    });
    
    router.get('/:id', async (req, res) => {
      try {
        // Get the person with the specified ID
        const personId = req.params.id;
        console.log(`personId: ${personId}`);
        if (personId) {
          const result = await database.read(personId);
          console.log(`persons: ${JSON.stringify(result)}`);
          res.status(200).json(result);
        } else {
          res.status(404);
        }
      } catch (err) {
        res.status(500).json({ error: err?.message });
      }
    });
    
    router.put('/:id', async (req, res) => {
      try {
        // Update the person with the specified ID
        const personId = req.params.id;
        console.log(`personId: ${personId}`);
        const person = req.body;
    
        if (personId && person) {
          delete person.id;
          console.log(`person: ${JSON.stringify(person)}`);
          const rowsAffected = await database.update(personId, person);
          res.status(200).json({ rowsAffected });
        } else {
          res.status(404);
        }
      } catch (err) {
        res.status(500).json({ error: err?.message });
      }
    });
    
    router.delete('/:id', async (req, res) => {
      try {
        // Delete the person with the specified ID
        const personId = req.params.id;
        console.log(`personId: ${personId}`);
    
        if (!personId) {
          res.status(404);
        } else {
          const rowsAffected = await database.delete(personId);
          res.status(204).json({ rowsAffected });
        }
      } catch (err) {
        res.status(500).json({ error: err?.message });
      }
    });
    
    export default router;
    
    
  3. Utwórz plik trasy openapi.js i dodaj następujący kod dla eksploratora interfejsu użytkownika interfejsu użytkownika interfejsu openAPI:

    import express from 'express';
    import { join, dirname } from 'path';
    import swaggerUi from 'swagger-ui-express';
    import yaml from 'yamljs';
    import { fileURLToPath } from 'url';
    
    const __dirname = dirname(fileURLToPath(import.meta.url));
    
    const router = express.Router();
    router.use(express.json());
    
    const pathToSpec = join(__dirname, './openApiSchema.yml');
    const openApiSpec = yaml.load(pathToSpec);
    
    router.use('/', swaggerUi.serve, swaggerUi.setup(openApiSpec));
    
    export default router;
    
  4. Utwórz plik schematu openApiSchema.yml i dodaj następujący kod YAML:

    openapi: 3.0.0
    info:
      version: 1.0.0
      title: Persons API
    paths:
      /persons:
        get:
          summary: Get all persons
          responses:
            '200':
              description: OK
              content:
                application/json:
                  schema:
                    type: array
                    items:
                      $ref: '#/components/schemas/Person'
        post:
          summary: Create a new person
          requestBody:
            required: true
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/Person'
          responses:
            '201':
              description: Created
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/Person'
      /persons/{id}:
        parameters:
          - name: id
            in: path
            required: true
            schema:
              type: integer
        get:
          summary: Get a person by ID
          responses:
            '200':
              description: OK
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/Person'
            '404':
              description: Person not found
        put:
          summary: Update a person by ID
          requestBody:
            required: true
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/Person'
          responses:
            '200':
              description: OK
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/Person'
            '404':
              description: Person not found
        delete:
          summary: Delete a person by ID
          responses:
            '204':
              description: No Content
            '404':
              description: Person not found
    components:
      schemas:
        Person:
          type: object
          properties:
            id:
              type: integer
              readOnly: true
            firstName:
              type: string
            lastName:
              type: string
    

Konfigurowanie obiektu połączenia mssql

Pakiet mssql implementuje połączenie z usługą Azure SQL Database, zapewniając ustawienie konfiguracji dla typu uwierzytelniania.

  1. W programie Visual Studio Code utwórz plik config.js i dodaj następujący kod konfiguracji mssql w celu uwierzytelnienia w usłudze Azure SQL Database.

    import * as dotenv from 'dotenv';
    dotenv.config({ path: `.env.${process.env.NODE_ENV}`, debug: true });
    
    const server = process.env.AZURE_SQL_SERVER;
    const database = process.env.AZURE_SQL_DATABASE;
    const port = parseInt(process.env.AZURE_SQL_PORT);
    const type = process.env.AZURE_SQL_AUTHENTICATIONTYPE;
    
    export const config = {
        server,
        port,
        database,
        authentication: {
            type
        },
        options: {
            encrypt: true
        }
    };
    
  2. Utwórz plik .env.development dla lokalnych zmiennych środowiskowych i dodaj następujący tekst i zaktualizuj wartości dla <YOURSERVERNAME><YOURDATABASENAME>i .

    AZURE_SQL_SERVER=<YOURSERVERNAME>.database.windows.net
    AZURE_SQL_DATABASE=<YOURDATABASENAME>
    AZURE_SQL_PORT=1433
    AZURE_SQL_AUTHENTICATIONTYPE=azure-active-directory-default
    

Uwaga

Obiekty konfiguracji bez hasła są bezpieczne do zatwierdzania kontroli źródła, ponieważ nie zawierają żadnych wpisów tajnych, takich jak nazwy użytkowników, hasła lub klucze dostępu.

  1. .vscode Utwórz folder i utwórz plik settings.json w folderze.

  2. Dodaj następujące polecenie, aby zignorować zmienne środowiskowe i zależności podczas wdrażania pliku zip.

    {
        "appService.zipIgnorePattern": ["./.env*","node_modules{,/**}"]
    }
    

Dodawanie kodu w celu nawiązania połączenia z usługą Azure SQL Database

  1. Utwórz plik database.js i dodaj następujący kod:

    import sql from 'mssql';
    
    export default class Database {
      config = {};
      poolconnection = null;
      connected = false;
    
      constructor(config) {
        this.config = config;
        console.log(`Database: config: ${JSON.stringify(config)}`);
      }
    
      async connect() {
        try {
          console.log(`Database connecting...${this.connected}`);
          if (this.connected === false) {
            this.poolconnection = await sql.connect(this.config);
            this.connected = true;
            console.log('Database connection successful');
          } else {
            console.log('Database already connected');
          }
        } catch (error) {
          console.error(`Error connecting to database: ${JSON.stringify(error)}`);
        }
      }
    
      async disconnect() {
        try {
          this.poolconnection.close();
          console.log('Database connection closed');
        } catch (error) {
          console.error(`Error closing database connection: ${error}`);
        }
      }
    
      async executeQuery(query) {
        await this.connect();
        const request = this.poolconnection.request();
        const result = await request.query(query);
    
        return result.rowsAffected[0];
      }
    
      async create(data) {
        await this.connect();
        const request = this.poolconnection.request();
    
        request.input('firstName', sql.NVarChar(255), data.firstName);
        request.input('lastName', sql.NVarChar(255), data.lastName);
    
        const result = await request.query(
          `INSERT INTO Person (firstName, lastName) VALUES (@firstName, @lastName)`
        );
    
        return result.rowsAffected[0];
      }
    
      async readAll() {
        await this.connect();
        const request = this.poolconnection.request();
        const result = await request.query(`SELECT * FROM Person`);
    
        return result.recordsets[0];
      }
    
      async read(id) {
        await this.connect();
    
        const request = this.poolconnection.request();
        const result = await request
          .input('id', sql.Int, +id)
          .query(`SELECT * FROM Person WHERE id = @id`);
    
        return result.recordset[0];
      }
    
      async update(id, data) {
        await this.connect();
    
        const request = this.poolconnection.request();
    
        request.input('id', sql.Int, +id);
        request.input('firstName', sql.NVarChar(255), data.firstName);
        request.input('lastName', sql.NVarChar(255), data.lastName);
    
        const result = await request.query(
          `UPDATE Person SET firstName=@firstName, lastName=@lastName WHERE id = @id`
        );
    
        return result.rowsAffected[0];
      }
    
      async delete(id) {
        await this.connect();
    
        const idAsNumber = Number(id);
    
        const request = this.poolconnection.request();
        const result = await request
          .input('id', sql.Int, idAsNumber)
          .query(`DELETE FROM Person WHERE id = @id`);
    
        return result.rowsAffected[0];
      }
    }
    

Lokalne przetestowanie aplikacji

Aplikacja jest gotowa do testowania lokalnie. Upewnij się, że zalogowano się do chmury platformy Azure w programie Visual Studio Code przy użyciu tego samego konta, które zostało ustawione jako administrator bazy danych.

  1. Uruchom aplikację za pomocą następującego polecenia. Aplikacja jest uruchamiana na porcie 3000.

    NODE_ENV=development node index.js
    

    Tabela Person jest tworzona w bazie danych podczas uruchamiania tej aplikacji.

  2. W przeglądarce przejdź do eksploratora interfejsu OpenAPI pod adresem http://localhost:3000.

  3. Na stronie Swagger UI rozwiń metodę POST i wybierz pozycję Wypróbuj.

  4. Zmodyfikuj przykładowy kod JSON, aby uwzględnić wartości właściwości. Właściwość ID jest ignorowana.

    Zrzut ekranu przedstawiający sposób testowania interfejsu API.

  5. Wybierz pozycję Wykonaj , aby dodać nowy rekord do bazy danych. Interfejs API zwraca pomyślną odpowiedź.

  6. Rozwiń metodę GET na stronie interfejsu użytkownika programu Swagger i wybierz pozycję Wypróbuj. Wybierz pozycję Wykonaj, a utworzona osoba zostanie zwrócona.

Wdrażanie w usłudze Azure App Service

Aplikacja jest gotowa do wdrożenia na platformie Azure. Program Visual Studio Code może utworzyć usługę aplikacja systemu Azure i wdrożyć aplikację w jednym przepływie pracy.

  1. Upewnij się, że aplikacja została zatrzymana.

  2. Zaloguj się do platformy Azure, jeśli jeszcze tego nie zrobiono, wybierając polecenie Azure: Zaloguj się do chmury platformy Azure w palecie poleceń (Ctrl + Shift + P)

  3. W oknie Eksplorator platformy Azure programu Visual Studio Code kliknij prawym przyciskiem myszy węzeł Usługi App Services i wybierz polecenie Utwórz nową aplikację internetową (zaawansowane).

  4. Użyj poniższej tabeli, aby utworzyć usługę App Service:

    Monit Wartość
    Wprowadź globalnie unikatową nazwę nowej aplikacji internetowej. Wprowadź monit, taki jak azure-sql-passwordless. Post-pend unikatowy ciąg, taki jak 123.
    Wybierz grupę zasobów dla nowych zasobów. Wybierz pozycję +Utwórz nową grupę zasobów, a następnie wybierz nazwę domyślną.
    Wybierz stos środowiska uruchomieniowego. Wybierz wersję LTS stosu Node.js.
    Wybierz system operacyjny. Wybierz pozycję Linux.
    Wybierz lokalizację nowych zasobów. Wybierz blisko siebie lokalizację.
    Wybierz plan usługi App Service dla systemu Linux. Wybierz pozycję Utwórz nowy plan usługi App Service. Następnie wybierz nazwę domyślną.
    Wybierz warstwę cenową. Wybierz pozycję Bezpłatna (F1).
    Wybierz zasób aplikacji Szczegółowe informacje dla aplikacji. Wybierz pozycję Pomiń na razie.
  5. Przed kontynuowaniem poczekaj na powiadomienie, że aplikacja została utworzona.

  6. W eksploratorze platformy Azure rozwiń węzeł App Services i kliknij prawym przyciskiem myszy nową aplikację.

  7. Wybierz pozycję Wdróż w aplikacji internetowej.

    Zrzut ekranu programu Visual Studio Code w eksploratorze platformy Azure z wyróżnioną pozycją Deploy to Web App (Wdrażanie w aplikacji internetowej).

  8. Wybierz folder główny projektu JavaScript.

  9. Po wyświetleniu wyskakującego okna podręcznego programu Visual Studio Code wybierz pozycję Wdróż.

Po zakończeniu wdrażania aplikacja nie działa poprawnie na platformie Azure. Nadal musisz skonfigurować bezpieczne połączenie między usługą App Service i bazą danych SQL, aby pobrać dane.

Połączenie usługi App Service do usługi Azure SQL Database

Aby połączyć wystąpienie usługi App Service z usługą Azure SQL Database, wymagane są następujące kroki:

  1. Utwórz tożsamość zarządzaną dla usługi App Service.
  2. Utwórz użytkownika bazy danych SQL i skojarz ją z tożsamością zarządzaną usługi App Service.
  3. Przypisz role SQL do użytkownika bazy danych, który zezwala na odczyt, zapis i potencjalnie inne uprawnienia.

Dostępnych jest wiele narzędzi do implementowania następujących kroków:

Usługa Połączenie or to narzędzie, które usprawnia uwierzytelnianie połączeń między różnymi usługami na platformie Azure. Usługa Połączenie or obsługuje obecnie łączenie usługi App Service z bazą danych Azure SQL Database za pośrednictwem interfejsu wiersza polecenia platformy az webapp connection create sql Azure przy użyciu polecenia . To pojedyncze polecenie wykonuje trzy kroki wymienione powyżej.

Tworzenie tożsamości zarządzanej przy użyciu Połączenie or usługi

Uruchom następujące polecenie w usłudze Cloud Shell w witrynie Azure Portal. Usługa Cloud Shell ma najnowszą wersję interfejsu wiersza polecenia platformy Azure. Zastąp zmienne własnymi <> wartościami.

az webapp connection create sql \
    -g <app-service-resource-group> \
    -n <app-service-name> \
    --tg <database-server-resource-group> \
    --server <database-server-name> \
    --database <database-name> \
    --system-identity

Weryfikowanie ustawień aplikacji usługi App Service

Zmiany wprowadzone przez usługę Service Połączenie or można sprawdzić w ustawieniach usługi App Service.

  1. W programie Visual Studio Code w eksploratorze platformy Azure kliknij prawym przyciskiem myszy usługę App Service i wybierz polecenie Otwórz w portalu.

  2. Przejdź do strony Tożsamość dla usługi App Service. Na karcie Przypisane przez system stan powinien być ustawiony na Włączone. Ta wartość oznacza, że tożsamość zarządzana przypisana przez system została włączona dla aplikacji.

  3. Przejdź do strony Konfiguracja usługi App Service. Na karcie Ustawienia aplikacji powinna zostać wyświetlona kilka zmiennych środowiskowych, które znajdowały się już w obiekcie konfiguracji mssql.

    • AZURE_SQL_SERVER
    • AZURE_SQL_DATABASE
    • AZURE_SQL_PORT
    • AZURE_SQL_AUTHENTICATIONTYPE

    Nie usuwaj ani nie zmieniaj nazw właściwości ani wartości.

Testowanie wdrożonej aplikacji

Przejdź do adresu URL aplikacji, aby sprawdzić, czy połączenie z usługą Azure SQL Database działa. Adres URL aplikacji można znaleźć na stronie przeglądu usługi App Service.

Osoba utworzona lokalnie powinna być wyświetlana w przeglądarce. Gratulacje! Aplikacja jest teraz połączona z usługą Azure SQL Database zarówno w środowiskach lokalnych, jak i hostowanych.

Napiwek

Jeśli podczas testowania wystąpi błąd 500 Wewnętrzny serwer, może to być spowodowane konfiguracjami sieci bazy danych. Sprawdź, czy serwer logiczny jest skonfigurowany z ustawieniami opisanymi w sekcji Konfigurowanie bazy danych .

Oczyszczanie zasobów

Po zakończeniu pracy z usługą Azure SQL Database usuń zasób, aby uniknąć niezamierzonych kosztów.

  1. Na pasku wyszukiwania w witrynie Azure Portal wyszukaj ciąg Azure SQL i wybierz pasujący wynik.

  2. Znajdź i wybierz bazę danych na liście baz danych.

  3. Na stronie Przegląd usługi Azure SQL Database wybierz pozycję Usuń.

  4. Na platformie Azure na pewno chcesz usunąć otwieraną stronę, wpisz nazwę bazy danych, aby potwierdzić, a następnie wybierz pozycję Usuń.

Przykładowy kod

Przykładowy kod dla tej aplikacji jest dostępny w witrynie GitHub.

Następne kroki