實例講解Springboot整合MongoDB進行CRUD操做的兩種方式

時間 2020-04-21

標籤實例講解 springboot 整合 mongodb 進行 crud 兩種方式欄目 Spring 简体版

原文原文鏈接

1 簡介

Springboot是最簡單的使用Spring的方式，而MongoDB是最流行的NoSQL數據庫。二者在分佈式、微服務架構中使用率極高，本文將用實例介紹如何在Springboot中整合MongoDB的兩種方法：MongoRepository和MongoTemplate。java

代碼結構以下：web

2 項目準備

2.1 啓動MongoDB實例

爲了方便，使用Docker來啓動MongoDB，詳細指導文檔請參考：用Docker安裝一個MongoDB最新版玩玩，這裏再也不贅述。spring

2.2 引入相關依賴

主要的依賴爲Web和MongoDB的starter，把下面代碼加入到pom.xml中便可：mongodb

<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>複製代碼

2.3 配置數據庫鏈接信息

與配置MySQL或Oracle同樣，MongoDB也須要配置鏈接信息，配置在application.properties中以下：docker

server.port=8080

spring.data.mongodb.authentication-database=admin
spring.data.mongodb.database=testdb
spring.data.mongodb.username=user
spring.data.mongodb.password=123456
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017複製代碼

2.4 建立數據模型實體

建立User類以下：數據庫

package com.pkslow.mongo.model;

import org.springframework.data.annotation.Id;
import java.util.Date;

public class User {
    @Id
    private String userId;
    private String name;
    private Integer age;
    private Date createTime = new Date();

    public String getUserId() {
        return userId;
    }

    public void setUserId(String userId) {
        this.userId = userId;
    }

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}複製代碼

不須要在MongoDB中建立對應的Collections（表），當經過Web應用新增時會自動建立。微信

3 方式1：MongoRepository

3.1 定義數據訪問層UserRepository

使用過Spring Jpa的都清楚，Repository實際就是用於操做數據庫的類。在非關係型數據庫MongoDB的整合中，也是同樣的。Spring會幫咱們實現好對應接口的方法，開發人員連SQL都不用寫，很是省心。代碼以下：架構

package com.pkslow.mongo.dal;

import com.pkslow.mongo.model.User;
import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends MongoRepository<User, String> {
}複製代碼

注意MongoRepository後面接的泛型<User, String>第一個爲實體類，第二個爲主鍵ID。app

3.2 實現Controller

Controller比較基礎，就不講解了，經常使用的註解是必需要掌握的，直接上代碼吧：分佈式

package com.pkslow.mongo.contrlloer;

import com.pkslow.mongo.dal.UserRepository;
import com.pkslow.mongo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private final UserRepository userRepository;

    public UserController(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @GetMapping("")
    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    @GetMapping("/{userId}")
    public User getByUserId(@PathVariable String userId) {
        return userRepository.findById(userId).orElse(new User());
    }

    @PostMapping("")
    public User addNewUser(@RequestBody User user) {
        return userRepository.save(user);
    }

    @DeleteMapping("/{userId}")
    public String delete(@PathVariable String userId) {
        User user = new User();
        user.setUserId(userId);
        userRepository.deleteById(userId);
        return "deleted: " + userId;
    }

    @PutMapping("")
    public User update(@RequestBody User user) {
        return userRepository.save(user);
    }
}複製代碼

注意代碼沒有作異常狀況的判斷和處理，這裏爲了快速演示，就先無論了。

3.3 測試

用Postman測試後，每一個接口均調用成功。就不一一截圖了。

4 方式2：MongoTemplate

4.1 定義數據訪問層UserDAL

先定義接口爲：

package com.pkslow.mongo.dal;

import com.pkslow.mongo.model.User;
import java.util.List;

public interface UserDAL {
    List<User> findAll();

    User findById(String userId);

    User save(User user);

    void deleteById(String userId);
}複製代碼

而後實現該接口以下：

package com.pkslow.mongo.dal;

import com.pkslow.mongo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.stereotype.Repository;
import java.util.List;

@Repository
public class UserDALImpl implements UserDAL {

    @Autowired
    private MongoTemplate template;

    @Override
    public List<User> findAll() {
        return template.findAll(User.class);
    }

    @Override
    public User findById(String userId) {
        return template.findById(userId,User.class);
    }

    @Override
    public User save(User user) {
        return template.save(user);
    }

    @Override
    public void deleteById(String userId) {
        Query query = new Query();
        query.addCriteria(Criteria.where("userId").is(userId));
        template.remove(query, User.class);
    }
}複製代碼

4.2 實現另外一個Controller

這個Controller的代碼與以前的基本同樣，只是數據訪問類不同，代碼以下：

package com.pkslow.mongo.contrlloer;

import com.pkslow.mongo.dal.UserDAL;
import com.pkslow.mongo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/userTemplate")
public class UserTemplateController {

    @Autowired
    private final UserDAL userDAL;

    public UserTemplateController(UserDAL userDAL) {
        this.userDAL = userDAL;
    }


    @GetMapping("")
    public List<User> getAllUsers() {
        return userDAL.findAll();
    }

    @GetMapping("/{userId}")
    public User getByUserId(@PathVariable String userId) {
        return userDAL.findById(userId);
    }

    @PostMapping("")
    public User addNewUser(@RequestBody User user) {
        return userDAL.save(user);
    }

    @DeleteMapping("/{userId}")
    public String delete(@PathVariable String userId) {
        User user = new User();
        user.setUserId(userId);
        userDAL.deleteById(userId);
        return "deleted: " + userId;
    }

    @PutMapping("")
    public User update(@RequestBody User user) {
        return userDAL.save(user);
    }
}複製代碼