将 Spring Data 与 Azure Cosmos DB for MongoDB API 配合使用

本文演示如何使用 Spring Data 通过 Azure Cosmos DB for MongoDB 存储和检索信息的示例应用程序。

先决条件

  • Git 客户端。

创建 Azure Cosmos DB 帐户

使用 Azure 门户创建 Azure Cosmos DB 帐户

注意

可以在 Azure Cosmos DB 文档中阅读有关创建帐户的更多详细信息。

  1. 浏览到 https://portal.azure.com/ 上的 Azure 门户并登录。

  2. 依次选择“创建资源”、“数据库”和“Azure Cosmos DB”

    Azure portal, create a resource, search for Azure Cosmos DB.

  3. “选择 API”选项 屏幕上,选择 Azure Cosmos DB for MongoDB

    Azure portal, create a resource, select API option, Azure Cosmos DB for MongoDB selected.

  4. 指定下列信息:

    • 订阅:指定要使用的 Azure 订阅。
    • 资源组:指定是创建新的资源组,还是选择现有资源组。
    • 帐户名称:为 Azure Cosmos DB 帐户选择唯一名称;这将用于创建完全限定的域名,例如 wingtiptoysmongodb.documents.azure.com
    • API:指定 Azure Cosmos DB for MongoDB API 本教程。
    • 位置:指定数据库最近的地理区域。
  5. 输入上述所有信息后,单击“ 查看 + 创建”。

  6. 如果查看页面上的所有信息看起来都是正确的,则单击“创建”。

    Review your Azure Cosmos DB account settings.

检索 Azure Cosmos DB 帐户的连接字符串

  1. 浏览到 https://portal.azure.com/ 上的 Azure 门户并登录。

  2. 单击“所有资源”,然后单击你刚才创建的 Azure Cosmos DB 帐户。

  3. 单击连接字符串,并复制“主连接字符串”字段的值;稍后将使用该值配置应用程序。

    Retrieve your Azure Cosmos DB connection string.

配置示例应用程序

  1. 打开一个命令 shell 并使用 git 命令克隆示例项目,如以下示例所示:

    git clone https://github.com/spring-guides/gs-accessing-data-mongodb.git
    
  2. 在示例项目的 <project root>/complete/src/main 目录中创建一个 resources 目录,然后在 resources 目录中创建一个 application.properties 文件。

  3. 在文本编辑器中打开 application.properties 文件,在文件中添加以下行,并将示例值替换为上文中的相应值:

    spring.data.mongodb.database=wingtiptoysmongodb
    spring.data.mongodb.uri=mongodb://wingtiptoysmongodb:AbCdEfGhIjKlMnOpQrStUvWxYz==@wingtiptoysmongodb.documents.azure.com:10255/?ssl=true&replicaSet=globaldb
    

    其中:

    参数 说明
    spring.data.mongodb.database 指定本文前面的 Azure Cosmos DB 帐户的名称。
    spring.data.mongodb.uri 指定本文上文中所述的主要连接字符串
  4. 保存并关闭 application.properties 文件。

打包并测试示例应用程序

若要生成应用程序,请浏览到目录 /gs-accessing-data-mongodb/complete,其中包含 pom.xml 文件。

  1. 使用 Maven 生成示例应用程序,并将 Maven 配置为跳过测试;例如:

    mvn clean package -DskipTests
    
  2. 启动示例应用程序;例如:

    
    java -jar target/accessing-data-mongodb-complete-0.0.1-SNAPSHOT.jar
    

    你的应用程序应返回如下所示的值:

    Customers found with findAll():
    -------------------------------
    Customer[id=5c1b4ae4d0b5080ac105cc13, firstName='Alice', lastName='Smith']
    Customer[id=5c1b4ae4d0b5080ac105cc14, firstName='Bob', lastName='Smith']
    
    Customer found with findByFirstName('Alice'):
    --------------------------------
    Customer[id=5c1b4ae4d0b5080ac105cc13, firstName='Alice', lastName='Smith']
    Customers found with findByLastName('Smith'):
    --------------------------------
    Customer[id=5c1b4ae4d0b5080ac105cc13, firstName='Alice', lastName='Smith']
    Customer[id=5c1b4ae4d0b5080ac105cc14, firstName='Bob', lastName='Smith']
    

总结

在本教程中,你创建了一个示例 Java 应用程序,该应用程序使用 Spring Data 通过 Azure Cosmos DB for MongoDB 存储和检索信息。

清理资源

如果不再需要,请使用 Azure 门户删除本文中创建的资源,以避免产生意外的费用。

后续步骤

若要了解有关 Spring 和 Azure 的详细信息,请继续访问“Azure 上的 Spring”文档中心。

另请参阅

有关如何将 Azure 与 Java 配合使用的详细信息,请参阅面向 Java 开发人员的 Azure使用 Azure DevOps 和 Java