MongoDB在企業(yè)級(jí)項(xiàng)目中一般用于存儲(chǔ)文檔信息、圖片資源等，MongoDB的內(nèi)容完全是以 JSON字符串的形式進(jìn)行存儲(chǔ)的，所以我們?cè)讷@取數(shù)據(jù)時(shí)通過簡(jiǎn)單的 反序列化就可以完成與項(xiàng)目?jī)?nèi)的實(shí)體類轉(zhuǎn)換，不過這個(gè)過程是自動(dòng)的，不需要我們手動(dòng)進(jìn)行反序列化處理。

免費(fèi)教程專題

恒宇少年在博客整理三套免費(fèi)學(xué)習(xí)教程專題，由于文章偏多特意添加了閱讀指南，新文章以及之前的文章都會(huì)在專題內(nèi)陸續(xù)填充，希望可以幫助大家解惑更多知識(shí)點(diǎn)。

• SpringBoot基礎(chǔ)教程專題
• SpringCloud基礎(chǔ)教程專題
• ApiBoot基礎(chǔ)教程專題

本章目標(biāo)

完成簡(jiǎn)單的SpringBoot與MongoDB的自動(dòng)化整合，讓我們像是使用spring-data-jpa的形式來完成MongoDB的數(shù)據(jù)操作。

為你推薦

1. 第四十七章：SpringBoot2.0新特性 - Quartz自動(dòng)化配置集成
2. 第四十八章：SpringBoot2.0新特性 - RabbitMQ信任package設(shè)置
3. 第四十九章：SpringBoot2.0新特性 - 你get到WebMvcConfigurer兩種配置方式了嗎？
4. 第五十章：SpringBoot2.0新特性 - 豈止至今最簡(jiǎn)單redis緩存集成

SpringBoot 企業(yè)級(jí)核心技術(shù)學(xué)習(xí)專題

準(zhǔn)備MongDB

我們使用MongoDB官方提供的安裝方式進(jìn)行安裝，下面是對(duì)應(yīng)系統(tǒng)的官方安裝文檔：

1. Linux下安裝MongoDB
2. Windows下安裝MongoDB
3. OSX下安裝MongoDB

創(chuàng)建用戶

我們需要?jiǎng)?chuàng)建一個(gè)用戶，用于本章的使用，如果你是OSX系統(tǒng)，只需要打開終端輸入mongo命令就可以進(jìn)入MongoDB的管理界面。

1. 創(chuàng)建數(shù)據(jù)庫
使用 use test; 命令可以創(chuàng)建一個(gè)名為`test`的數(shù)據(jù)庫
2. 創(chuàng)建數(shù)據(jù)庫所有者角色的用戶
db.createUser(
   {
     user: "test",
     pwd: "123456",
     roles: [ { role: "dbOwner", db: "test" } ]
   }
);

用戶創(chuàng)建完成后就可以進(jìn)行本章的編碼了，環(huán)境有了之后我們接下來需要進(jìn)行環(huán)境的連接進(jìn)行操作數(shù)據(jù)。

構(gòu)建項(xiàng)目

我們使用IDEA創(chuàng)建一個(gè)新的SpringBoot項(xiàng)目，在pom.xml配置文件內(nèi)添加我們本章所需要的依賴，如下所示：

<dependencies>
        <!--mongodb依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>
        <!--lombok依賴-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--fastjson依賴-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.44</version>
        </dependency>
        <!--測(cè)試依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

根據(jù)mongodb的依賴我們可以看到Spring家族式的設(shè)計(jì)，把所有操作數(shù)據(jù)的依賴都進(jìn)行歸類到spring-boot-starter-data-xxx下，我們比較常用到的如：spring-boot-starter-data-jpa、spring-boot-starter-data-redis等。

MongoRepository

spring-boot-starter-data-mongodb確實(shí)采用了跟spring-boot-starter-data-jpa同樣的方式來完成接口代理類的生成，并且提供了一些常用的單個(gè)對(duì)象操作的公共方法，MongoRepository接口作用與JPARepository一致，繼承了該接口的業(yè)務(wù)數(shù)據(jù)接口就可以提供一個(gè)被Spring IOC托管的代理實(shí)現(xiàn)類，這樣我們?cè)谧⑷?code>業(yè)務(wù)數(shù)據(jù)接口時(shí)就會(huì)完成代理實(shí)現(xiàn)類的注入。
廢話不多說了，下面我們直接來創(chuàng)建一個(gè)名為CustomerRepository的數(shù)據(jù)接口，該接口繼承MongoRepository<T,PK>，如下所示：

/**
 * 客戶數(shù)據(jù)接口
 * 繼承自MongoRepository接口
 *
 * @author：于起宇 <br/>
 * ===============================
 * Created with IDEA.
 * Date：2018/3/28
 * Time：下午7:41
 * 簡(jiǎn)書：http://www.lxweimin.com/u/092df3f77bca
 * ================================
 */
public interface CustomerRepository extends MongoRepository<Customer, String> {
}

MongoRepository <T,PK>同樣也是采用了兩個(gè)泛型參數(shù)，
T：實(shí)體類類型。
PK：T實(shí)體類內(nèi)的主鍵類型，如：String。

自定義實(shí)體類

我們?cè)?code>CustomerRepository接口內(nèi)使用了Customer實(shí)體類作為泛型參數(shù)，下面我們簡(jiǎn)單創(chuàng)建Customer實(shí)體類，內(nèi)容如下所示：

@Data
public class Customer implements Serializable {
    /**
     * 客戶編號(hào)
     */
    @Id
    public String id;
    /**
     * 客戶名稱
     */
    public String firstName;
    /**
     * 客戶姓氏
     */
    public String lastName;

    public Customer(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }
}

同樣我們需要通過@Id注解進(jìn)行設(shè)置主鍵，不過這個(gè)主鍵的值是MongoDB自動(dòng)生成的，生成的主鍵值是具有唯一性的。

添加配置

代碼已經(jīng)準(zhǔn)備好了，我們只需要添加MongoDB的一些配置信息就大功告成了，下面我們需要在application.yml配置文件內(nèi)添加如下配置：

spring:
  application:
    name: spring-boot-mongodb
  data:
    mongodb:
      uri: mongodb://localhost/test
      username: test
      password: 123456

在上面配置的uri內(nèi)的test即為數(shù)據(jù)庫的名稱，username配置我們自定義的用戶名稱，password配置為自定義用戶設(shè)置的密碼。

上面我們的代碼已經(jīng)全部編寫完成，接下來我們需要進(jìn)行測(cè)試，來查看我們的CustomerRepository是否已經(jīng)生效.

測(cè)試

我們使用CommandLineRunner接口進(jìn)行簡(jiǎn)單的項(xiàng)目運(yùn)行后就執(zhí)行Customer文檔內(nèi)的數(shù)據(jù)操作，修改Chapter51Application入口類，添加CommandLineRunner接口的實(shí)現(xiàn)，如下所示：

/**
 * 程序入口類
 * @author yuqiyu
 */
@SpringBootApplication
public class Chapter51Application implements CommandLineRunner {
    /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(Chapter51Application.class);
    /**
     * 客戶數(shù)據(jù)接口注入
     */
    @Autowired
    private CustomerRepository repository;

    public static void main(String[] args) {
        SpringApplication.run(Chapter51Application.class, args);
        logger.info("【【【【【SpringBoot整合Mongodb啟動(dòng)完成.】】】】】");
    }

    @Override
    public void run(String... args) {
        // 刪除全部
        repository.deleteAll();
        // 添加一條數(shù)據(jù)
        repository.save(new Customer("于", "起宇"));
        // 查詢?nèi)?        logger.info(JSON.toJSONString(repository.findAll()));
    }
}

在run方法內(nèi)

1. 刪除了Customer文檔內(nèi)的全部?jī)?nèi)容
2. 執(zhí)行了保存數(shù)據(jù)的操作
3. 查詢出本次保存的數(shù)據(jù)內(nèi)容

下面我們來運(yùn)行下程序查看控制臺(tái)的效果，如下所示：

[{"firstName":"于","id":"5ad4be1cab73ac0bdc23bd9a","lastName":"起宇"}]
【【【【【SpringBoot整合Mongodb啟動(dòng)完成.】】】】】

已經(jīng)可以正常的輸出了MongoDB我們添加到文檔內(nèi)的數(shù)據(jù)，在上面說到了id這個(gè)字段的特殊性，這是個(gè)分布式唯一性的字段值，是一個(gè)短板的md5格式的字符串。

修改默認(rèn)掃描路徑

如果你不打算使用SpringBoot默認(rèn)的掃描路徑（SpringBoot默認(rèn)掃描XxxApplication類的同級(jí)以及所有子級(jí)的package）可以通過@EnableMongoRepositories注解配置basePackages屬性完成自定義的MongoDB的MongoRepository實(shí)現(xiàn)類的掃描，如下所示：

@SpringBootApplication
@EnableMongoRepositories(basePackages = "com.hengyu.chapter51")
public class Chapter51Application implements CommandLineRunner { }

總結(jié)

本章簡(jiǎn)單的講解了SpringBoot集成MongoDB，它與JPA有著同樣的數(shù)據(jù)操作方式，數(shù)據(jù)接口通過繼承MongoRepository就可以讓我們可以使用與JPA相同的方法進(jìn)行操作MongoDB文檔內(nèi)的數(shù)據(jù)，從而減少了學(xué)習(xí)的成本。

本章源碼已經(jīng)上傳到碼云：
SpringBoot配套源碼地址：https://gitee.com/hengboy/spring-boot-chapter
SpringCloud配套源碼地址：https://gitee.com/hengboy/spring-cloud-chapter

作者個(gè)人 博客
使用開源框架 ApiBoot 助你成為Api接口服務(wù)架構(gòu)師