Tworzenie aplikacji Angular za pomocą interfejsu API usługi Azure Cosmos DB dla bazy danych MongoDB — nawiązywanie połączenia z usługą Azure Cosmos DB przy użyciu usługi Mongoose

Artykuł
06/01/2023

DOTYCZY: Mongodb

W tym wieloczęściowym samouczku pokazano, jak utworzyć aplikację Node.js za pomocą platformy Express i Angular oraz połączyć ją z kontem usługi Azure Cosmos DB skonfigurowanym przy użyciu interfejsu API usługi Azure Cosmos DB dla bazy danych MongoDB. Ten artykuł stanowi 5. część samouczka i opiera się na części 4.

W tej części samouczka zostaną wykonane następujące czynności:

Nawiązywanie połączenia z usługą Azure Cosmos DB za pomocą usługi Mongoose.
Pobierz parametry połączenia usługi Azure Cosmos DB.
Tworzenie modelu elementów hero.
Tworzenie usługi hero w celu pobrania danych elementów hero.
Uruchom aplikację lokalnie.

Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Wymagania wstępne

Przed rozpoczęciem tego samouczka wykonaj kroki przedstawione w części 4.
Ten samouczek wymaga uruchomienia interfejsu wiersza polecenia platformy Azure lokalnie. Musi być zainstalowany wiersz polecenia platformy Azure w wersji 2.0 lub nowszej. Uruchom polecenie az --version, aby dowiedzieć się, jaka wersja jest używana. Jeśli konieczna będzie instalacja interfejsu wiersza polecenia lub jego uaktualnienie, zobacz Instalowanie interfejsu wiersza polecenia platformy Azure w wersji 2.0.
Ten samouczek przedstawia instrukcje tworzenia aplikacji krok po kroku. Jeśli chcesz pobrać gotowy projekt, ukończoną aplikację znajdziesz w repozytorium angular-cosmosdb w witrynie GitHub.

Łączenie przy użyciu wtyczki Mongoose

Wtyczka Mongoose to biblioteka modelowania danych obiektu (ODM) dla bazy danych MongoDB i środowiska Node.js. Wtyczki Mongoose można użyć, aby nawiązać połączenie z kontem usługi Azure Cosmos DB. Aby zainstalować wtyczkę Mongoose i połączyć się z usługą Azure Cosmos DB, wykonaj następujące kroki:

Zainstaluj moduł npm mongoose, czyli interfejs API używany do komunikowania się z bazą danych MongoDB.
```
npm install mongoose@5.13.15 --save
```
Ważne

Usługa Azure Cosmos DB dla bazy danych MongoDB jest zgodna z wersją 5.13.15 bazy danych Mongoose. Aby uzyskać więcej informacji, zobacz dyskusję na temat problemu w repozytorium Mongoose GitHub.
W folderze server utwórz plik o nazwie mongo.js. Do tego pliku dodasz szczegóły połączenia z kontem usługi Azure Cosmos DB.
Skopiuj następujący kod do pliku mongo.js. Ten kod zapewnia następujące funkcje:
- Wymaga wtyczki Mongoose.
- Przesłania obietnicę Mongo w celu użycia podstawowej obietnicy wbudowanej w wersji ES6/ES2015 i nowszych.
- Wywołuje plik env, który umożliwia skonfigurowanie pewnych elementów w oparciu o to, czy pracujesz na etapie przygotowywania, produkcji, czy programowania. Utworzysz ten plik w następnej sekcji.
- Zawiera parametry połączenia bazy danych MongoDB, które są ustawiane w pliku env.
- Tworzy funkcję connect, która wywołuje wtyczkę Mongoose.
```
const mongoose = require('mongoose');
/**
* Set to Node.js native promises
* Per https://mongoosejs.com/docs/promises.html
*/
mongoose.Promise = global.Promise;

const env = require('./env/environment');

// eslint-disable-next-line max-len
const mongoUri = `mongodb://${env.accountName}:${env.key}@${env.accountName}.documents.azure.com:${env.port}/${env.databaseName}?ssl=true`;

function connect() {
mongoose.set('debug', true);
return mongoose.connect(mongoUri, { useMongoClient: true });
}

module.exports = {
connect,
mongoose
};
```
W okienku Eksploratora w obszarze server utwórz folder o nazwie environment. W folderze environment utwórz plik o nazwie environment.js.

Z pliku mongo.js musimy uwzględnić wartości parametrów dbName, key i cosmosPort. Skopiuj następujący kod do pliku environment.js:

// TODO: replace if yours are different
module.exports = {
  accountName: 'your-cosmosdb-account-name-goes-here',
  databaseName: 'admin', 
  key: 'your-key-goes-here',
  port: 10255
};

Pobieranie parametrów połączenia

Aby połączyć swoją aplikację z usługą Azure Cosmos DB, musisz zaktualizować ustawienia konfiguracji dla aplikacji. Wykonaj następujące kroki, aby zaktualizować ustawienia:

W witrynie Azure Portal uzyskaj numer portu, nazwę konta usługi Azure Cosmos DB i wartości klucza podstawowego dla konta usługi Azure Cosmos DB.
W pliku environment.js zmień wartość właściwości port na 10255.
```
const port = 10255;
```
W pliku environment.js zmień wartość właściwości accountName na nazwę konta usługi Azure Cosmos DB, które zostało utworzone w części 4. tego samouczka.
Pobierz klucz podstawowy konta usługi Azure Cosmos DB, używając następującego polecenia interfejsu wiersza polecenia w oknie terminala:
```
az cosmosdb list-keys --name <cosmosdb-name> -g myResourceGroup
```
<cosmosdb-name to nazwa> konta usługi Azure Cosmos DB utworzonego w części 4 samouczka.
Skopiuj klucz podstawowy do pliku environment.js jako wartość key.

Teraz Twoja aplikacja ma wszystkie informacje niezbędne do łączenia się z usługą Azure Cosmos DB.

Tworzenie modelu elementów hero

Następnie należy zdefiniować schemat danych, które mają być przechowywane w usłudze Azure Cosmos DB, definiując plik modelu. Wykonaj następujące kroki, aby utworzyć model elementów hero definiujący schemat danych:

W okienku Eksploratora w folderze server utwórz plik o nazwie hero.model.js.
Skopiuj poniższy kod do pliku hero.model.js. Ten kod zapewnia następujące funkcje:
- Wymaga wtyczki Mongoose.
- Tworzy nowy schemat z identyfikatorem, nazwą i powiedzeniem.
- Tworzy model przy użyciu schematu.
- Eksportuje model.
- Nadaje kolekcji nazwę Heroes (zamiast Heros, która jest nazwą domyślną kolekcji zgodną z regułami wtyczki Mongoose dotyczącymi nazw w liczbie mnogiej).
```
const mongoose = require('mongoose');

const Schema = mongoose.Schema;

const heroSchema = new Schema(
  {
    id: { type: Number, required: true, unique: true },
    name: String,
    saying: String
  },
  {
    collection: 'Heroes'
  }
);

const Hero = mongoose.model('Hero', heroSchema);

module.exports = Hero;
```

Tworzenie usługi hero

Po utworzeniu modelu elementów hero należy zdefiniować usługę do odczytywania danych i wykonywania operacji generowania listy, tworzenia, usuwania i aktualizacji. Wykonaj następujące kroki, aby utworzyć usługę hero, która wykonuje zapytanie o dane w usłudze Azure Cosmos DB:

W okienku Eksploratora w folderze server utwórz plik o nazwie hero.service.js.
Skopiuj poniższy kod do pliku hero.service.js. Ten kod zapewnia następujące funkcje:
- Pobiera utworzony przez Ciebie model.
- Nawiązuje połączenie z bazą danych.
- Tworzy zmienną docquery, która używa metody hero.find do definiowania zapytania zwracającego wszystkie elementy hero.
- Uruchamia zapytanie przy użyciu funkcji docquery.exec z obietnicą w celu uzyskania listy wszystkich elementów hero, gdzie stan odpowiedzi to 200.
- Wysyła z powrotem komunikat o błędzie, jeśli stan ma wartość 500.
- Pobiera elementy hero, ponieważ używane są moduły.
```
const Hero = require('./hero.model');

require('./mongo').connect();

function getHeroes() {
  const docquery = Hero.find({});
  docquery
    .exec()
    .then(heroes => {
      res.status(200).json(heroes);
    })
    .catch(error => {
      res.status(500).send(error);
      return;
    });
}

module.exports = {
  getHeroes
};
```

Konfigurowanie tras

Następnie należy skonfigurować trasy, które będą obsługiwać adresy URL dla żądań pobierania, tworzenia, odczytu i usuwania. Metody routingu określają funkcje wywołań zwrotnych (nazywane również funkcjami obsługi). Te funkcje są wywoływane, gdy aplikacja otrzymuje żądanie dotyczące określonego punktu końcowego i metody HTTP. Wykonaj następujące kroki, aby dodać usługę hero oraz zdefiniować swoje trasy:

W programie Visual Studio Code w pliku routes.js wykomentuj funkcję res.send, która wysyła dane przykładowego elementu hero. Zamiast niej dodaj wiersz wywołujący funkcję heroService.getHeroes.
```
router.get('/heroes', (req, res) => {
  heroService.getHeroes(req, res);
//  res.send(200, [
//      {"id": 10, "name": "Starlord", "saying": "oh yeah"}
//  ])
});
```
W pliku routes.js dodaj funkcję require dotyczącą usługi hero:
```
const heroService = require('./hero.service'); 
```
W pliku hero.service.js zaktualizuj w następujący sposób funkcję getHeroes, aby pobierała parametry req i res:
```
function getHeroes(req, res) {
```

Poświęćmy teraz chwilę na zapoznanie się z wcześniejszym kodem. Najpierw wchodzimy do pliku index.js, który konfiguruje serwer węzłów. Zwróć uwagę, że ten plik konfiguruje i definiuje Twoje trasy. Następnie plik routes.js komunikuje się z usługą hero i informuje ją o konieczności pobrania funkcji, takich jak getHeroes, oraz przekazania żądania i odpowiedzi. Plik hero.service.js pobiera model i nawiązuje połączenie z bazą danych Mongo. Następnie po wywołaniu wykonuje funkcję getHeroes i zwraca odpowiedź 200.

Uruchamianie aplikacji

Następnie uruchom aplikację, wykonując poniższe kroki:

W programie Visual Studio Code zapisz wszystkie zmiany. Po lewej stronie wybierz przycisk Debuguj, a następnie wybierz przycisk Rozpocznij debugowanie.
Teraz przełącz się na przeglądarkę. Otwórz Narzędzia programistyczne i kartę Sieć. Przejdź do http://localhost:3000strony , a zobaczysz naszą aplikację.

W aplikacji nie są jeszcze przechowywane żadne elementy hero. W następnej części tego samouczka dodamy funkcje umieszczania, wypychania i usuwania. Będziemy wtedy mogli dodawać, aktualizować i usuwać elementy hero z poziomu interfejsu użytkownika, używając połączeń wtyczki Mongoose z naszą bazą danych Azure Cosmos DB.

Czyszczenie zasobów

Możesz usunąć grupę zasobów, konto usługi Azure Cosmos DB oraz wszystkie powiązane zasoby, gdy nie będą już potrzebne. Aby usunąć grupę zasobów, wykonaj następujące kroki:

Przejdź do grupy zasobów, w której zostało utworzone konto usługi Azure Cosmos DB.
Wybierz pozycję Usuń grupę zasobów.
Potwierdź nazwę grupy zasobów do usunięcia i wybierz pozycję Usuń.

Następne kroki

Przejdź do części 6 samouczka, aby dodać funkcje Post, Put i Delete do aplikacji:

Część 6. Dodawanie funkcji Post, Put i Delete do aplikacji

Próbujesz zaplanować pojemność migracji do usługi Azure Cosmos DB? Do planowania pojemności można użyć informacji o istniejącym klastrze bazy danych.

Jeśli wiesz, ile rdzeni wirtualnych i serwerów znajduje się w istniejącym klastrze bazy danych, przeczytaj o szacowaniu jednostek żądań przy użyciu rdzeni wirtualnych lub procesorów wirtualnych
Jeśli znasz typowe stawki żądań dla bieżącego obciążenia bazy danych, przeczytaj o szacowaniu jednostek żądań przy użyciu planisty pojemności usługi Azure Cosmos DB