SpringBoot 整合 MongoDB 超详细（一）-阿里云开发者社区

一、介绍

在前面的文章中，我们详细的介绍了 MongoDB 的配置和使用，如果你对 MongoDB 还不是很了解，也没关系，在 MongoDB 中有三个比较重要的名词：数据库、集合、文档！

数据库（Database）：和关系型数据库一样，每个数据库中有自己的用户权限，不同的项目组可以使用不同的数据库
集合（Collection）：集合指的是文档组（类似于 Mysql 中的表的概念），里面可以存储许多文档
文档（Document）：文档是 MongoDB 中最基本的数据单元，由键值对组成，类似于 JSON 格式，可以存储不同字段，字段的值可以包括其他文档、数组和文档数组

搞懂这三个名词，基本就可以上手了，今天我们以 Java 语言为例，详细的介绍 Java 客户端改如何操作 MongoDB ！

话不多说，直接开撸！

二、Java 客户端

2.1、MongoDB 连接

Java 连接 MongoDB 服务器，与我们常用的连接关系型数据库方式类似！

标准 URI 连接语法：

mongodb://username:password@host1:port1,host2:port2,...,hostN:portN/database?options

参数说明：

mongodb://：这是固定的格式，必须要指定
username:password@：可选项，如果设置，在连接数据库服务器之后，驱动都会尝试登录这个数据库
host1:port1：主机IP和端口号，必须指定至少一个host。如果要连接复制集，请指定多个主机地址
/database：如果指定了username:password@，连接时会验证并登录指定数据库。若不指定，默认打开 test 数据库
?options：连接可选项，例如connectTimeoutMS=5000ms，表示连接等待时间最长 5 秒

例如，无密码连接 MongoDB

mongodb://127.0.0.1:27017

使用用户名test，密码test登录 MongoDB 的test_db数据库

mongodb://test:test@127.0.0.1:27017/test_db

无密码连接指定三台服务器 (端口 27017, 27018, 和27019)

mongodb://127.0.0.1:27017,127.0.0.1:27018,127.0.0.1:27019

2.2、添加依赖包

和关系型数据库操作一样，在 Java 程序中如果要使用 MongoDB，先要添加对应的 MongoDB JDBC 驱动器，然后才能继续操作！

在选择的版本号的时候，注意需要和服务器中的安装版本匹配，具体的版本号选择可以从如下地址中获取到最新的版本：mongo-java-driver

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>mongo-java-driver</artifactId>
    <version>3.12.7</version>
</dependency>

2.3、连接数据库

连接数据库的 Java 代码如下：

private static MongoClient mongoClient;
static {
    try {
        //连接到MongoDB服务 如果是远程连接可以替换“localhost”为服务器所在IP地址
        mongoClient = MongoClients.create("mongodb://test:test@127.0.0.1:27017/test_db");
        System.out.println("Connect to database successfully");
    } catch (Exception e) {
        System.err.println( e.getClass().getName() + ": " + e.getMessage() );
    }
}

上文中采用的是用户名和密码方式登录数据库，因为数据库已经开启了权限验证，因此需要通过用户名和密码才能登录。

2.4、创建集合

com.mongodb.client包里面都帮我们集成好了大部分常用的 api，我们可以通过MongoDatabase类中的createCollection()方法来创建集合。

创建一个tb_role集合，代码片段如下：

/**
 * 创建集合
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    mongoDatabase.createCollection("tb_role");
    System.out.println("集合创建成功");
}

如果想删除集合，操作也很简单！

/**
 * 删除集合
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    mongoDatabase.getCollection("tb_role").drop();
    System.out.println("集合 tb_role 删除成功");
}

2.5、创建文档

我们可以通过MongoCollection类中的insertMany()方法来插入一个文档。

向tb_role集合中插入文档，代码片段如下：

/**
 * 插入文档
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    //获取集合
    MongoCollection<Document> collection = mongoDatabase.getCollection("tb_role");
    //向集合中插入文档
    Document document = new Document("name", "管理员").
            append("code", "manager").
            append("sort", 100);
    List<Document> documents = new ArrayList<>();
    documents.add(document);
    collection.insertMany(documents);
    System.out.println("文档插入成功");
}

2.6、更新文档

我们可以通过MongoCollection类中的updateMany()方法来更新集合中的文档。

更新tb_role集合中的指定文档信息，代码片段如下：

/**
 * 更新文档
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    //获取集合
    MongoCollection<Document> collection = mongoDatabase.getCollection("tb_role");
    //更新文档
    collection.updateMany(Filters.eq("code", "manager"), new Document("$set",new Document("name","经理")));
    //遍历所有文档
    FindIterable<Document> findIterable = collection.find();
    MongoCursor<Document> mongoCursor = findIterable.iterator();
    while(mongoCursor.hasNext()){
        System.out.println(mongoCursor.next());
    }
}

上文操作类似于 SQL语句中的update tb_role set name = '经理' where code = 'manager'！

2.7、删除文档

我们可以通过MongoCollection类中的deleteOne()或者deleteMany方法来删除集合中的文档。

删除tb_role集合中的指定文档信息，代码片段如下：

/**
 * 删除文档
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    //获取集合
    MongoCollection<Document> collection = mongoDatabase.getCollection("tb_role");
    //删除符合条件的第一个文档
    collection.deleteOne(Filters.eq("code", "manager"));
    //删除所有符合条件的文档
    collection.deleteMany (Filters.eq("code", "manager"));
    //遍历所有文档
    FindIterable<Document> findIterable = collection.find();
    MongoCursor<Document> mongoCursor = findIterable.iterator();
    while(mongoCursor.hasNext()){
        System.out.println(mongoCursor.next());
    }
}

在这里需要注意一下，在删除的时候，官方推荐尽可能先查询一下这个数据是否存在，如果存在，然后在执行删除操作，可以调用findOneAndDelete()方法进行删除！

2.8、查询文档

MongoCollection类中提供了非常丰富的检索文档的方法，例如，我们可以通过find()方法来获取集合中的所有文档。

检索tb_role集合中的文档信息，代码片段如下：

/**
 * 查询文档
 * @param args
 */
public static void main(String[] args) {
    // 连接到数据库
    MongoDatabase mongoDatabase = mongoClient.getDatabase("test_db");
    System.out.println("Connect to database successfully");
    //获取集合
    MongoCollection<Document> collection = mongoDatabase.getCollection("tb_role");
    //遍历所有文档
    FindIterable<Document> findIterable = collection.find();
    MongoCursor<Document> mongoCursor = findIterable.iterator();
    while(mongoCursor.hasNext()){
        System.out.println(mongoCursor.next());
    }
    //查询当前集合所有文档数量
    long count = collection.countDocuments();
    System.out.println("当前文档数量:" + count);
    //带条件遍历文档
    FindIterable<Document> documentFindIterable = collection.find(Filters.eq("code", "manager"));
    MongoCursor<Document> documentMongoCursor = documentFindIterable.iterator();
    while(documentMongoCursor.hasNext()){
        System.out.println(documentMongoCursor.next());
    }
}

三、SpringBoot 整合 MongoDB

采用 SpringBoot 来对接 MongoDB，可以说极其简单，下面就以常用的几个操作为例来介绍，过程如下！

3.1、创建 SpringBoot 工程，添加 MongoDB 依赖包

<!-- 引入springboot -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.0.RELEASE</version>
</parent>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

3.2、添加配置文件

在application.properties文件中添加mongodb配置

#配置数据库连接地址
spring.data.mongodb.uri=mongodb://test123:test123@127.0.0.1:27017/test_db

3.3、创建实体类

创建用于示例中测试的实体类Person。

其中注解@Document(collection="persons")用于指定当前文档属于集合persons。

注解@Id表示当前id字段属于主键类型。

/**
 * 使用@Document注解指定集合名称
 */
@Document(collection="persons")
public class Person implements Serializable {
    private static final long serialVersionUID = -3258839839160856613L;
 /**
     * 使用@Id注解指定MongoDB中的 _id 主键
     */
    @Id
    private Long id;
    private String userName;
    private String passWord;
    private Integer age;
    private Date createTime;
    //...get/set
    @Override
    public String toString() {
        return "Person{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                ", age=" + age +
                ", createTime=" + createTime +
                '}';
    }
}

3.4、操作 MongoDB

Springboot 操作 MongoDB 有两种方式。

第一种方式是采用 Springboot 官方推荐的 JPA 方式，这种操作方式，使用简单但是灵活性比较差。
第二种方式是采用 Spring Data MongoDB 封装的 MongoDB 官方 Java 驱动 MongoTemplate 对 MongoDB 进行操作，这种方式非常灵活，能满足绝大部分需求。

本文将采用第二种方式进行介绍！

SpringBoot 整合 MongoDB 超详细（一）