在Spring Boot中使用MongoDB的示例

x33g5p2x  于2022-10-04 转载在 Spring  
字(5.0k)|赞(0)|评价(0)|浏览(365)

在这篇文章中,我们将学习如何使用Spring Boot Data连接到MongoDB**。我们将使用MongoDBRepository接口来简化数据的存储管理。

开始使用MongoDB

MongoDB是一个非关系型、面向文档的DBMS。也被称为NoSQL类型的数据库,MongoDB不同于传统的RDBMS结构,而是采用具有动态模式的JSON风格的文档(MongoDB使用BSON格式),使某些类型的应用程序的数据集成更加容易和快速。

开始使用MongoDB的最简单方法是启动可用的Docker镜像。

由于我们将从我们的Spring Boot应用程序中使用它,我们将导出端口27017来与数据库通信。

docker run --name mydb --rm -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=root -e MONGO_INITDB_ROOT_PASSWORD=password -v mdb-data:/data/db mongo

另外,注意我们已经将环境变量MONGO_INITDB_ROOT_USERNAMEMONGO_INITDB_ROOT_PASSWORD设置为根用户名和密码。

接下来,我们将使用根用户连接到MongoDB,这样我们就可以为我们的Spring Boot应用程序添加一些用户。

docker exec -it mydb bash

你现在是在容器中。用Root凭证启动mongo命令行工具。

mongo --username root --password password

我们将在 "admin "数据库中存储我们的应用程序用户,因此切换到 "admin "数据库。

use admin

最后,创建用户 "myuser",密码为 "mypassword"。

db.createUser({ user: "myuser" , pwd: "mypassword", roles: ["userAdminAnyDatabase", "dbAdminAnyDatabase", "readWriteAnyDatabase"]})

检查上述命令是否成功完成。

Successfully added user: {
  "user" : "myuser",
  "roles" : [
    "userAdminAnyDatabase",
    "dbAdminAnyDatabase",
    "readWriteAnyDatabase"
  ]
}

太好了!你的MongoDB已经准备好了。你的MongoDB现在已经准备好了。让我们来建立我们的Spring Boot应用程序,它使用MongoDB作为存储。

###设置Spring Boot应用程序

如果你正在开发一个简单的Web应用程序,你所需要的只是两个依赖项。在CLI中执行。

spring init -dweb,data-mongodb mongodb-demo

另一方面,如果你喜欢使用Spring Boot Initializr,,则使用以下依赖项。

以下依赖关系现在在你的pom.xml中。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

在我们开始编码之前,我们将在application.properties中添加MongoDB的连接设置。你可以使用URI或离散的属性,如本例。

spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=myuser
spring.data.mongodb.password=mypassword
spring.data.mongodb.database=customer
spring.data.mongodb.port=27017
spring.data.mongodb.host=localhost

有了这些配置,Spring Boot应用程序将用上述凭证连接到本地的MongoDB实例。如果你有一个没有启用授权的本地实例,你可以直接删除前三行的配置。

对Spring Boot模型进行编码

首先,我们将定义我们应用程序的模型。在你的项目中添加以下客户类。

package com.example.mongodbdemo;

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document
public class Customer {
  @Id
  private int customerId;
  private String name;
  private String surname;

  public int getCustomerId() {
    return customerId;
  }

  public void setCustomerId(int customerId) {
    this.customerId = customerId;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getSurname() {
    return surname;
  }

  public void setSurname(String surname) {
    this.surname = surname;
  }

}
MongoDB @Document注解

请注意,我们使用注解**@Document**来为我们的Model设置集合名称。如果该集合不存在,MongoDB将创建它。

编写MongoDB存储库以访问我们的数据

接下来,我们需要编写持久层的代码来存储和检索MongoDB文档。主要有两个选项可以做到这一点。

MongoTemplate - 该接口提供了一套与MongoDB交互的丰富功能,并作为Spring的MongoDB支持的中心类。这需要更多的编码,但对自定义MongoDB查询提供了更精细的控制。
MongoRepository - 该接口提供了所有必要的方法,让你创建一个CRUD应用程序。它还支持自定义派生查询方法。

首先让我们看看如何使用MongoRepository接口。因此,在你的项目中添加以下CustomerRepository接口。

package com.example.mongodbdemo;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CustomerRepository extends MongoRepository<Customer, Integer> {}

定义Spring Boot控制器

接下来,让我们编写控制器类的代码,它将管理我们应用程序的REST端点。

package com.example.mongodbdemo;

import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

public class CustomerController {
  @Autowired
  private CustomerRepository repository;

  @PostMapping 
  public String saveCustomer(@RequestBody Customer customer){
    repository.save(customer);

    return "Added Successfully";
  }

  @GetMapping 
  public List<Customer> getCustomers() {

    return repository.findAll();
  }

  @DeleteMapping("/delete/{id}")
  public String deleteCustomer(@PathVariable int id){
    repository.deleteById(id);

    return "Deleted Successfully";
  }
}

在CustomerController类中,我们添加了一个**@PostMapping方法来存储一个客户。然后,我们包含了一个@GetMapping方法来返回所有的客户。最后,还有一个@DeleteMapping**,让你通过ID删除一个客户。

正如你所看到的,除了定义存储库接口和自动连接依赖关系,我们不需要写一行代码来访问数据库。

测试应用程序

最后,你可以测试你的Spring Boot应用程序。

mvn install spring-boot:run

验证你的Java驱动是否连接到MongoDB实例。

接下来,让我们使用curl工具添加一个客户。

$ curl -X POST http://localhost:8080/add -H 'Content-Type: application/json' -d '{"id":"0","name":"Francesco","surname":"Marchioni"}'
Added Successfully

如果你在MongoDB上的shell仍然处于激活状态,你可以检查 "customer "DB的集合列表。

> use customer
switched to db customer
> db.customer.find()
{ "_id" : 0, "name" : "Francesco", "surname" : "Marchioni", "_class" : "com.example.mongodbdemo.Customer" }

此外,你可以使用下面的curl来列出客户DB中的可用文档。

$ curl http://localhost:8080/list
[{"customerId":0,"name":"Francesco","surname":"Marchioni"}]

最后,用下面的REST命令删除该客户。

curl -X DELETE http://localhost:8080/delete/0
Deleted Successfully

现在,运行客户对象的列表将返回一个空数组。

源代码

本文的源代码在这里可以找到:https://github.com/fmarchioni/masterspringboot/tree/master/nosql/mongodb-demo

相关文章