Spring Boot 之 整合MongoDB

整合MongoDB

1. MongoDB简介

MongoDB是一种面向文档的数据库管理系统，它是一个介于关系型数据库和非关系型数据库之间的产品，MongoDB 功能丰富，它支持一种类似JSON的BSON数据格式，既可以存储简单的数据格式，也可以存储复杂的数据类型。MongoDB最大的特点是它支持的查询语言非常强大，并且还支持对数据建立索引。总体来说，MongoDB是一款应用相当广泛的NoSQL数据库。

2. MongoDB安装

我用的是宝塔面板进行安装的,安装目录是/www/server/mongodb。

对MongoDB配置文件config.conf修改，文件内容如下:

1. dbpath=/opt/mongodb/db

2. logpath=/opt/mongodb/logs/mongodb. log

3. port=27017

4. fork=true

配置解释:

• 第1行配置表示数据存储目录。
• 第2行配置表示日志文件位置。
• 第3行配置表示启动端口。
• 第4行配置表示以守护程序的方式启动MongoDB，即允许MongoDB在后台运行。

3. MongoDB的启动和关闭

配置完成后，还是在 bin目录下，运行如下命令启动MongoDB:./mongod -f mongo.conf --bind ip all
-f表示指定配置文件的位置，–bind_ip_all则表示允许所有的远程地址连接该 MongoDB实例.MongoDB启动成功后，在 bin目录下再执行mongo命令，进入 MongoDB控制台，然后输入

./mongod -f ../config.conf --bind_ip_all

-f 表示指定配置文件的位置，–bind_ip_all 则表示允许所有的远程地址连接该MongoDB实例。MongoDB启动成功后，在 bin目录下再执行 mongo命令，进入 MongoDB控制台，然后输入

.mongo

db.version()

默认情况下，启动后连接的是 MongoDB中的test库，而关闭MongoDB的命令需要在 admin库中执行，因此关闭MongoDB需要首先切换到admin库，然后执行db.shutdownServer();命令，完整操作步骤如下:

use admin;
db.shutdownServer();
exit

服务关闭后,执行exit命令退出控制台,此时如果再执行./mongo命令就会执行失败。

4. 安全管理

默认情况下，启动的MongoDB没有登录密码，在生产环境中这是非常不安全的，但是不同于MySQL、Oracle等关系型数据库，MongoDB中每一个库都有独立的密码，在哪一个库中创建用户就要在哪一个库中验证密码。要配置密码，首先要创建一个用户,例如在admin库中创建一个用户，代码如下:

db.createUser({user:"suohechuan",pwd:"123@456",roles:[{role:"readWrite",db:"test"}]})

新创建的用户名为 suohechuan，密码是123@456，roles表示该用户具有的角色，这里的配置表示该用户对test 库具有读和写两项权限。
用户创建成功后，关闭当前实例，然后重新启动，启动命令如下:

./mongod -f ../config.conf -auth --bind_ip_all

启动成功后，再次进入控制台，然后切换到admin库中验证登录（默认连接上的库是test库)，验证成功后就可以对test库执行读写操作了,代码如下:

./mongo
db.auth("suohechuan","123@456")

如果db.auth(“suohechuan”,“123@456”)命令执行结果为1,就表示认证成功,可以执行对test 库的读写操作。

整合Spring Boot

借助于Spring Data MongoDB,Spring Boot 为 MongoDB也提供了开箱即用的自动化配置方案，具体配置步骤如下。

1. 创建Spring Boot工程

创建Spring Boot Web工程，添加MongoDB依赖，代码如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

2. 配置MongoDB

在application.properties 中配置MongoDB的连接信息,代码如下:

spring.data.mongodb.authentication-database=admin
spring.data.mongodb.database=test
spring.data.mongodb.host=170.0.0.1
spring.data.mongodb.port=27017
spring.data.mongodb.username=suohechuan
spring.data.mongodb.password=123@456

配置解释:

• 第1行配置表示验证登录信息的库。
• 第2行配置表示要连接的库，认证信息不一定要在连接的库中创建，因此这两个分开配置。
• 第3~6行配置表示MongoDB的连接地址和认证信息等。

3. 创建实体类

创建实体类Book，代码如下:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Book implements Serializable {
    private Integer id;
    private String name;
    private String author;
}

4. 创建BookDao

BookDao 的定义类似于Spring Data JPA中的Repository定义，代码如下:

@Repository
public interface BookDao extends MongoRepository<Book,Integer> {
    List<Book> findByAuthorContains (String author) ;
    Book findByNameEquals (String name) ;
}

MongoRepository中已经预定义了针对实体类的查询、添加、删除等操作。BookDao 中可以按照JPA方法命名规则定义查询方法。

5. 创建 Controller

简单起见，直接将BookDao注入 Controller进行测试:

@RestController
public class BookController {
    @Autowired
    BookDao bookDao;

    @GetMapping("/test1")
    public void test1() {
        List<Book> books = new ArrayList<>();
        Book b1 = new Book();
        b1.setId(1);
        b1.setName("朝花夕拾");
        b1.setAuthor("鲁迅");
        books.add(b1);
        Book b2 = new Book();
        b2.setId(2);
        b2.setName("呐喊");
        b2.setAuthor("鲁迅");
        books.add(b2);
        bookDao.insert(books);
        List<Book> books1 = bookDao.findByAuthorContains("鲁迅");
        System.out.println(books1);
        Book book = bookDao.findByNameEquals("朝花夕拾");
        System.out.println(book);
    }

    @Autowired
    MongoTemplate mongoTemplate;

    @GetMapping("/test2")

    public void test2() {
        List<Book> books = new ArrayList<>();
        Book b1 = new Book();
        b1.setId(3);
        b1.setName("围城");
        b1.setAuthor("钱钟书");
        books.add(b1);
        Book b2 = new Book();
        b2.setId(4);
        b2.setName("宋诗选注");
        b2.setAuthor("钱钟书");
        books.add(b2);
        mongoTemplate.insertAll(books);
        List<Book> list = mongoTemplate.findAll(Book.class);
        System.out.println(list);
        Book book = mongoTemplate.findById(3, Book.class);
        System.out.println(book);
    }
}

代码解释:

• 第19行调用MongoRepository中的insert方法插入集合中的数据。

• 第20行表示查询作者名字中包含“鲁迅”的所有书。

• 第22行表示查询书名为“朝花夕拾”的图书信息。

6. 测试 BookDao

创建好Controller 后，在浏览器中输入http:/localhost:8080/test1，控制台打印日志如图6-15所示。

[Book(id=1, name=朝花夕拾, author=鲁迅), Book(id=2, name=呐喊, author=鲁迅)]
Book(id=1, name=朝花夕拾, author=鲁迅)

7. 使用MongoTemplate

除了继承MongoRepository外，Spring Data MongoDB还提供了MongoTemplate用来方便地操作MongoDB。在 Spring Boot 中，若添加了MongoDB相关的依赖，而开发者并没有提供MongoTemplate，则默认会有一个MongoTemplate 注册到Spring 容器中，相关配置源码在MongoDataAutoConfiguration类中。因此，用户可以直接使用MongoTemplate，在 Controller中直接注入 MongoTemplate就可以使用了，添加如下代码到第5步的Controller中:

@Autowired
MongoTemplate mongoTemplate;
@GetMapping("/test2")
public void test2() {
    List<Book> books = new ArrayList<>();
    Book b1 = new Book();
    b1.setId(3);
    b1.setName("围城");
    b1.setAuthor("钱钟书");
    books.add(b1);
    Book b2 = new Book();
    b2.setId(4);
    b2.setName("宋诗选注");
    b2.setAuthor("钱钟书");
    books.add(b2);
    mongoTemplate.insertAll(books);
    List<Book> list = mongoTemplate.findAll(Book.class);
    System.out.println(list);
    Book book = mongoTemplate.findById(3, Book.class);
    System.out.println(book);
}

代码解释;

• 第1、2行表示注入Spring Boot提供的MongoTemplate。
• 第16行表示向MongoDB中插入一个集合。
• 第17行表示查询book 集合中的所有数据。第19行表示根据id查询一个文档。最后，在浏览器中输入 http:/localhost:8080/test2，控制台打印日志。

[Book(id=1, name=朝花夕拾, author=鲁迅),Book(id=2, name=呐喊, author=鲁迅), Book(id=3, name=围城, author=钱钟书), Book(id=4, name=宋诗选注, author=钱钟书)]
Book(id=3, name=围城, author=钱钟书)