Spring Boot 整合 MongoDB的示例

更新時(shí)間：2020年10月26日 14:52:32 作者：空夜

這篇文章主要介紹了Spring Boot 整合 MongoDB的示例，幫助大家更好的理解和學(xué)習(xí)spring boot框架，感興趣的朋友可以了解下

本節(jié)使用SpringBoot 2.1.9.RELEASE，示例源碼在https://github.com/laolunsi/spring-boot-examples/tree/master/06-spring-boot-mongo-demo

SpringBoot可以非常方便地引入和操作MongoDB。本節(jié)分兩部分，記錄個(gè)人學(xué)習(xí)SpringBoot使用MongoDB數(shù)據(jù)庫(kù)的一些知識(shí)。

第一部分是一個(gè)簡(jiǎn)單的springboot連接mongo的demo，測(cè)試查詢(xún)功能。

第二部分是基于mongo實(shí)現(xiàn)的增刪改查數(shù)據(jù)示例。

本節(jié)使用SpringBoot 2.1.9.RELEASE

一、A simple demo

首先來(lái)演示SpringBoot項(xiàng)目引入MongoDB，以及一個(gè)簡(jiǎn)單的findAll操作。

maven依賴(lài)：

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

環(huán)境配置：

application.yml文件中寫(xiě)入如下配置，test表示MongoDB中的test表

spring:
 data:
  mongodb:
   uri: "mongodb://localhost:27017/test"

以一個(gè)bean類(lèi)為例：

package com.example;

public class User {

  private String id;
  private String name;
  private Integer age;
  private Integer grade;

  // ... ignore getter and setter


  // override its toString method
  @Override
  public String toString() {
    return "User{" +
        "id='" + id + '\'' +
        ", name='" + name + '\'' +
        ", age=" + age +
        ", grade=" + grade +
        '}';
  }
}

在MongoDB數(shù)據(jù)庫(kù)中新建一個(gè)collection(也就是表)，名字叫user，插入幾條數(shù)據(jù)，比如：

注：這里用的可視化工具是robo 3t：http://m.fzitv.net/database/567493.html

我們這里先默認(rèn)JavaBean的字段與user表的字段名保持一致。

下面我們編寫(xiě)測(cè)試類(lèi)：

@SpringBootTest
@RunWith(SpringRunner.class)
public class MongoTest {

  @Autowired
  private MongoTemplate mongoTemplate;

  @Test
  public void test1() {
    List<User> userList = mongoTemplate.findAll(User.class);
    if (userList != null && userList.size() > 0) {
      userList.forEach(user -> {
        System.out.println(user.toString());
      });
    }
  }

}

運(yùn)行測(cè)試類(lèi)，輸出如下：

User{id='5d243534514701183f5fcab8', name='zf0', age=12, grade=1}
User{id='5d243534514701183f5fcab9', name='zf1', age=13, grade=2}
User{id='5d243534514701183f5fcaba', name='zf2', age=14, grade=3}
User{id='5d243534514701183f5fcabb', name='zf3', age=15, grade=4}
User{id='5d243534514701183f5fcabc', name='zf4', age=16, grade=5}

二、基于SpringBoot的MongoDB增刪改查操作

下面來(lái)實(shí)現(xiàn)一個(gè)基于SpringBoot的對(duì)MongoDB增刪改查操作的簡(jiǎn)單示例，依然使用上面的環(huán)境：

maven:

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

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
</dependency>

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

<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>fastjson</artifactId>
  <version>1.2.60</version>
</dependency>

yml:

server:
 port: 8866

spring:
 data:
  mongodb:
   uri: "mongodb://localhost:27017/test"

User類(lèi)：

這里我們清楚一下之前的數(shù)據(jù)，把mongo里的user表里的數(shù)據(jù)全部刪掉。

注：這里用的可視化工具admin-mongo：https://github.com/mrvautin/adminMongo

新建一個(gè)不同的user類(lèi)：

@Document("user")
public class User {

  @Id
  private String id;

  @Field("name")
  private String name;

  @Field("password")
  private String password;

  @Field("address")
  private String address;

  @Field("create_time")
  private Date createTime;

  @Field("last_update_time")
  private Date lastUpdateTime;

  // ... ignore getter and setter methods

  @Override
  public String toString() {
    return JSONObject.toJSONString(this);
  }
}

此處定義一個(gè)JsonResult類(lèi)，用于封裝接口返回?cái)?shù)據(jù)：

import com.alibaba.fastjson.JSONObject;

import java.util.HashMap;
import java.util.Map;

public class JsonResult {

  /**
   * 未登錄
   */
  public static final int NO_LOGIN = 400;

  /**
   * 登錄失敗
   */
  public static final int LOGIN_FAILED = 401;

  /**
   * TOKEN過(guò)期
   */
  public static final int TOKEN_EXPIRED = 402;

  /**
   * 無(wú)權(quán)限
   */
  public static final int NO_PERMISSION = 403;


  private Boolean success;
  private Integer code;
  private String msg;
  private Object data;

  public JsonResult(Boolean success) {
    this.success = success;
  }

  public JsonResult(Boolean success, String msg) {
    this.success = success;
    this.msg = msg;
  }

  public JsonResult(Integer code, Boolean success, String msg) {
    this.code = code;
    this.success = success;
    this.msg = msg;
  }

  public JsonResult(Boolean success, Object data) {
    this.success = success;
    this.data = data;
  }

  public JsonResult(Boolean success, Integer code, String msg, Object data) {
    this.success = success;
    this.code = code;
    this.msg = msg;
    this.data = data;
  }

  // ... ignore getter and setter methods

  public void put(String key, Object value) {
    if (data == null) {
      data = new HashMap<>();
    }
    ((Map) data).put(key, value);
  }

  public void putAll(Map<String, Object> map) {
    if (data == null) {
      data = new HashMap<>();
    }
    ((Map) data).putAll(map);
  }

  @Override
  public String toString() {
    return JSONObject.toJSONString(this);
  }
}

下面編寫(xiě)測(cè)試接口類(lèi)，實(shí)現(xiàn)用戶(hù)的新增、刪除、更新、查詢(xún)功能

UserController類(lèi)：

@RestController
@RequestMapping(value = "user")
public class UserController {

  @Autowired
  private MongoTemplate mongoTemplate;

  @GetMapping(value = "")
  public JsonResult list() {
    List<User> userList = mongoTemplate.findAll(User.class, "user");
    return new JsonResult(true, userList);
  }

  @PostMapping(value = "")
  public JsonResult add(User user) {
    String msg = verifySaveForm(user);
    if (!StringUtils.isEmpty(msg)) {
      return new JsonResult(false, msg);
    }

    if (user.getId() == null) {
      user.setCreateTime(new Date());
      user.setLastUpdateTime(new Date());
      User newUser = mongoTemplate.insert(user, "user");
      return new JsonResult(true, newUser);
    } else {
      Query query = new Query();
      query.addCriteria(Criteria.where("_id").is(user.getId()));

      Update update = new Update();
      update.set("name", user.getName());
      update.set("password", user.getPassword());
      update.set("address", user.getAddress());
      update.set("last_update_time", new Date());

      UpdateResult updateResult = mongoTemplate.updateFirst(query, update, "user");
      return new JsonResult(true, updateResult);
    }
  }

  @DeleteMapping(value = "{id}")
  public JsonResult delete(@PathVariable String id) {
    Query query = new Query();
    query.addCriteria(Criteria.where("_id").is(id));
    DeleteResult deleteResult = mongoTemplate.remove(query, User.class, "user");
    return new JsonResult(true, deleteResult);
  }

  // private methods

  private String verifySaveForm(User user) {
    if (user == null || StringUtils.isEmpty(user.getName())) {
      return "用戶(hù)名不能為空";
    } else if (user.getPassword() == null) {
      return "密碼不能為空";
    }

    return null;
  }
}

下面用postman模擬一下請(qǐng)求：

新增用戶(hù)：