練習 - 建立 .NET 應用程式和參考 SDK

  • 7 分鐘

作為建立專案應用程式的第一個步驟，您需要建立 .NET 專案。 回想一下，.NET 項目應該使用 Microsoft.Azure.Cosmos SDK 連線到您已建立的帳戶。 目前有三個主要需求：

  • 建立 .NET 專案
  • 將套件參考新增至 SDK
  • 使用用戶端類別進行連線

Illustration of icons of an Azure Cosmos DB account and .NET application.

完成此練習之後，您將擁有一個簡單的 .NET 應用程式，可成功連線到您的 API for NoSQL 帳戶，但尚未執行任何作業。

建立 .NET 主控台專案

.NET CLI 會在指定的目錄中建立和管理 .NET 專案。 在這裡，您會使用 CLI 來建立新的主控台應用程式，並將套件參考新增至 SDK。

  1. 在目前目錄中建立新的主控台應用程式。

    dotnet new console

    提示

    由於您未指定專案名稱或目錄，因此命令會在目前目錄中建立新專案，並將專案命名為符合目錄的名稱 (inventory)。

  2. 從 NuGet 將套件參考新增至 Microsoft.Azure.Cosmos SDK 的版本 3。

    dotnet add package Microsoft.Azure.Cosmos --version 3.*

  3. 建置 .NET 專案，以確保您已正確設定專案。

    dotnet build

    命令的輸出應類似此範例：

    MSBuild version 17.5.0+6f08c67f3 for .NET
  Determining projects to restore...
  All projects are up-to-date for restore.
  dotnet-env-azure-cosmos-db -> /workspaces/dotnet-env-azure-cosmos-db/bin/Debug/net7.0/dotnet-env-azure-cosmos-db.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:05.96

連線到帳戶

現在，.NET 專案應已建置，並準備好新增您自己的自訂程式碼。 您可以存取 Microsoft.Azure.Cosmos 命名空間，以及連線到 API for NoSQL 所需的所有類別。 在這裡，您會開啟 Program.cs 檔案，並實作程式碼，以使用 SDK 的用戶端類別連線到帳戶。

  1. 在程式碼編輯器內開啟 Program.cs 檔案。

  2. 從檔案中刪除所有現有的程式碼。

  3. 為下列命名空間新增 using 指示詞：

    using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;
using Microsoft.Azure.Cosmos.Linq;

  4. 建立名為 connectionString 的常數字串變數。 將變數的值設定為您稍早在本課程模組中記錄的連接字串。

    const string connectionString = "<your-azure-cosmos-db-connection-string>";

    提示

    假設 Azure Cosmos DB 帳戶的名稱是 ，而密鑰是 nybncrsna76fo-cosmos-nosql Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==，您會像下列範例一樣設定 連接字串：

    const string connectionString = "AccountEndpoint=https://nybncrsna76fo-cosmos-nosql.documents.azure.com:443/;AccountKey=Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==;";

  5. 將連接字串列印至主控台。

    Console.WriteLine($"[Connection string]:\t{connectionString}");

  6. 建立名為 serializerOptions 的 CosmosSerializationOptions 類別新執行個體。 將 PropertyNamingPolicy 屬性設定為來自 CamelCase 列舉 CamelCase 的值。

    CosmosSerializationOptions serializerOptions = new()
{
    PropertyNamingPolicy = CosmosPropertyNamingPolicy.CamelCase
};

  7. 藉由將連接字串傳入建構函式，以建立 CosmosClientBuilder 類別的新執行個體。 接下來，鏈結 WithSerializerOptions(CosmosSerializationOptions) fluent 方法，並將此方法的參數設定為 serializerOptions。 鏈結 Build() 方法以建立名為 client 類型為 CosmosClient 的執行個體。 最後，使用 using 陳述式包裝用戶端變數的建立。

    using CosmosClient client = new CosmosClientBuilder(connectionString)
    .WithSerializerOptions(serializerOptions)
    .Build();

  8. 列印訊息，指出您的用戶端已就緒。

    Console.WriteLine("[Client ready]");

  9. 儲存 Program.cs 檔案。

檢查您的工作

應用程式現在已準備好執行並連線到 Azure Cosmos DB for NoSQL。 在這裡，您會比較您的應用程式程式碼與我們的範例。 然後，您會執行程式碼來檢查您的應用程式是否如預期般運作。

  1. 在終端機中執行 .NET 應用程式

    dotnet run

  2. 觀察執行應用程式的輸出。 輸出應該會與此處範例相符。

    [Connection string]:    <your-azure-cosmos-db-connection-string>
[Client ready]

注意

如果建置或執行 .NET 應用程式會產生錯誤，請移至 [檢閱程式碼] 索引標籤，以驗證您的程式碼是否符合範例。