Spring Boot中MongoDB的使用

MongoDB 是最早热门非关系数据库的之一，使用也比较普遍，一般会用做离线数据分析来使用，放到内网的居多。由于很多公司使用了云服务，服务器默认都开放了外网地址，导致前一阵子大批 MongoDB 因配置漏洞被攻击，数据被删，引起了人们的注意，同时也说明了很多公司生产中大量使用mongodb。

MongoDB 简介

MongoDB（来自于英文单词“Humongous”，中文含义为“庞大”）是可以应用于各种规模的企业、各个行业以及各类应用程序的开源数据库。基于分布式文件存储的数据库。由C++语言编写。旨在为 WEB 应用提供可扩展的高性能数据存储解决方案。MongoDB 是一个高性能，开源，无模式的文档型数据库，是当前 NoSql 数据库中比较热门的一种。

MongoDB 是一个介于关系数据库和非关系数据库之间的产品，是非关系数据库当中功能最丰富，最像关系数据库的。他支持的数据结构非常松散，是类似 json 的 bjson 格式，因此可以存储比较复杂的数据类型。MongoDB 最大的特点是他支持的查询语言非常强大，其语法有点类似于面向对象的查询语言，几乎可以实现类似关系数据库单表查询的绝大部分功能，而且还支持对数据建立索引。

传统的关系数据库一般由数据库（database）、表（table）、记录（record）三个层次概念组成，MongoDB是由数据库（database）、集合（collection）、文档对象（document）三个层次组成。集合 对于关系型数据库里的表，但是集合中没有列、行和关系概念，这体现了模式自由的特点。

MongoDB 中的一条记录就是一个文档，是一个数据结构，由字段和值对组成。MongoDB 文档与 JSON 对象类似。字段的值有可能包括其它文档、数组以及文档数组。MongoDB 支持 OS X、Linux 及 Windows 等操作系统，并提供了 Python，PHP，Ruby，Java及 C++ 语言的驱动程序，社区中也提供了对 Erlang 及 .NET 等平台的驱动程序。

MongoDB 的适合对大量或者无固定格式的数据进行存储，比如：日志、缓存等。对事物支持较弱，不适用复杂的多文档（多表）的级联查询。

MongoDB 的增删改查

Spring Boot 对各种流行的数据源都进行了封装，当然也包括Mongodb

pom 包配置

pom包里面添加spring-boot-starter-data-mongodb包引用

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-mongodb -->
<dependencies>
    <dependency> 
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-mongodb</artifactId>
    </dependency> 
</dependencies>

在application.properties中添加配置

spring.data.mongodb.uri=mongodb://name:pass@localhost:27017/test

spring
  data:
    mongodb:
      uri: mongodb://test:123456@localhost:27017/test

多个 IP 集群可以采用以下配置：

spring.data.mongodb.uri=mongodb://user:pwd@ip1:port1,ip2:port2/database

创建数据实体

@Getter
@Setter
@ToString
public class User implements Serializable {
    private static final long serialVersionUID = -3258839839160856613L;
    private Long id;
    private String userName;
    private String passWord;
}

创建实体的增删改查操作

public interface UserDao {
    void saveUser(User user);
    User findUserByUserName(String userName);
    long updateUser(User user);
    void deleteUserById(Long id);
}

@Component
public class UserDaoImpl implements UserDao {

    @Autowired
    private MongoTemplate mongoTemplate;

    /**
     * 创建对象
     * @param user
     */
    @Override
    public void saveUser(User user) {
        mongoTemplate.save(user);
    }

    /**
     * 根据用户名查询对象
     * @param userName
     * @return
     */
    @Override
    public User findUserByUserName(String userName) {
        Query query = new Query(Criteria.where("userName").is(userName));
        User user =  mongoTemplate.findOne(query , User.class);
        return user;
    }

    /**
     * 更新对象
     * @param user
     * @return
     */
    @Override
    public long updateUser(User user) {
        Query query = new Query(Criteria.where("id").is(user.getId()));
        Update update = new Update().set("userName", user.getUserName()).set("passWord", user.getPassWord());
        // 更新查询返回结果集的第一条
        UpdateResult result = mongoTemplate.updateFirst(query, update, User.class);
        // 更新查询返回结果集的所有
        // mongoTemplate.updateMulti(query, update, UserEntity.class);
        if (result != null)
            return result.getMatchedCount();
        else
            return 0;
    }

    /**
     * 删除对象
     * @param id
     */
    @Override
    public void deleteUserById(Long id) {
        Query query = new Query(Criteria.where("id").is(id));
        mongoTemplate.remove(query, User.class);
    }
}

单元测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class MongoTest {
    @Autowired
    private UserDao userDao;

    @Test
    public void testSaveUser() throws Exception {
        User user = new User();
        user.setId(1l);
        user.setUserName("Joe.Ye");
        user.setPassWord("123456");
        userDao.saveUser(user);
    }

    @Test
    public void findUserByUserName(){
        User user = userDao.findUserByUserName("Joe.Ye");
        System.out.println("User is " + user);
    }

    @Test
    public void updateUser(){
        User user = new User();
        user.setId(1l);
        user.setUserName("AppBlog");
        user.setPassWord("spring");
        userDao.updateUser(user);
    }

    @Test
    public void deleteUserById(){
        userDao.deleteUserById(1l);
    }
}

查看验证结果

可以使用工具 MongoVUE 工具来连接后直接图形化展示查看，也可以登录服务器用命令来查看

（1）登录 mongo

bin/mongo -host localhost -port 20000

（2）切换到 test 库

use test

（3）查询 user 集合数据

db.user.find()

根据3查询的结果来观察测试用例的执行是否正确。

到此 Spring Boot 对应 MongoDB 的增删改查功能已经全部实现

多数据源 MongoDB 的使用

接下来实现 MongoDB 多数据源的使用

多数据源 MongoDB 的使用

配置两条数据源

mongodb.primary.uri=mongodb://127.0.0.1:27017
mongodb.primary.database=primary
mongodb.secondary.uri=mongodb://127.0.0.1:27017
mongodb.secondary.database=secondary

mongodb:
  primary:
    uri: mongodb://127.0.0.1:27017
    database: primary
  secondary:
    uri: mongodb://127.0.0.1:27017
    database: secondary

配置两个库的数据源

封装读取以 Mongodb 开头的两个配置文件

@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "mongodb")
//@EnableConfigurationProperties(MongoProperties.class)
public class MultipleMongoProperties {
    private MongoProperties primary = new MongoProperties();
    private MongoProperties secondary = new MongoProperties();
}

配置不同包路径下使用不同的数据源

第一个库的封装

@Configuration
@EnableMongoRepositories(basePackages = "cn.appblog.springboot.mongo.repository.primary",
        mongoTemplateRef = PrimaryMongoConfig.MONGO_TEMPLATE)
public class PrimaryMongoConfig {
    protected static final String MONGO_TEMPLATE = "primaryMongoTemplate";
}

第二个库的封装

@Configuration
@EnableMongoRepositories(basePackages = "cn.appblog.springboot.mongo.repository.secondary",
        mongoTemplateRef = SecondaryMongoConfig.MONGO_TEMPLATE)
public class SecondaryMongoConfig {
    protected static final String MONGO_TEMPLATE = "secondaryMongoTemplate";
}

读取对应的配置信息并且构造对应的MongoTemplate

import cn.appblog.springboot.config.props.MultipleMongoProperties;
import com.mongodb.MongoClient;
import com.mongodb.MongoClientURI;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.mongo.MongoProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.SimpleMongoDbFactory;
import org.springframework.util.StringUtils;

@Configuration
public class MultipleMongoConfig {
    @Autowired
    private MultipleMongoProperties mongoProperties;

    @Primary
    @Bean(name = PrimaryMongoConfig.MONGO_TEMPLATE)
    public MongoTemplate primaryMongoTemplate() throws Exception {
        return new MongoTemplate(primaryFactory(this.mongoProperties.getPrimary()));
    }

    @Bean
    @Qualifier(SecondaryMongoConfig.MONGO_TEMPLATE)
    public MongoTemplate secondaryMongoTemplate() throws Exception {
        return new MongoTemplate(secondaryFactory(this.mongoProperties.getSecondary()));
    }

    @Bean
    @Primary
    public MongoDbFactory primaryFactory(MongoProperties mongo) throws Exception {
        if (!StringUtils.isEmpty(mongo.getUri())) {
            return new SimpleMongoDbFactory(new MongoClient(new MongoClientURI(mongo.getUri())),
                    mongo.getDatabase());
        } else {
            return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                    mongo.getDatabase());
        }
    }

    @Bean
    public MongoDbFactory secondaryFactory(MongoProperties mongo) throws Exception {
        if (!StringUtils.isEmpty(mongo.getUri())) {
            return new SimpleMongoDbFactory(new MongoClient(new MongoClientURI(mongo.getUri())),
                    mongo.getDatabase());
        } else {
            return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                    mongo.getDatabase());
        }
    }
}

两个库的配置信息已经完成。

创建两个库分别对应的对象和Repository

对应可以共用

@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class User implements Serializable {
    private static final long serialVersionUID = -3258839839160856613L;
    private Long id;
    private String userName;
    private String passWord;
}

对应的 Repository

package cn.appblog.springboot.mongo.repository.primary;

import cn.appblog.springboot.model.User;
import org.springframework.data.mongodb.repository.MongoRepository;

public interface PrimaryRepository extends MongoRepository<User, String> {
}

package cn.appblog.springboot.mongo.repository.secondary;

import cn.appblog.springboot.model.User;
import org.springframework.data.mongodb.repository.MongoRepository;

public interface SecondaryRepository extends MongoRepository<User, String> {
}

继承了 MongoRepository 会默认实现很多基本的增删改查，省了很多自己写 Repository 层的代码

单元测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class MultiMongoDBTest {
    @Autowired
    private MultipleMongoProperties mongoProperties;

    @Autowired
    private PrimaryRepository primaryRepository;

    @Autowired
    private SecondaryRepository secondaryRepository;

    @Test
    public void TestSave() {
        System.out.println("************************************************************");
        System.out.println("测试开始");
        System.out.println("************************************************************");

        this.primaryRepository.save(new User(1l, "中国", "123456"));
        this.secondaryRepository.save(new User(2l, "美国", "123456"));

        List<User> primaries = this.primaryRepository.findAll();
        for (User primary : primaries) {
            System.out.println(primary.toString());
        }

        List<User> secondaries = this.secondaryRepository.findAll();
        for (User secondary : secondaries) {
            System.out.println(secondary.toString());
        }

        System.out.println("************************************************************");
        System.out.println("测试完成");
        System.out.println("************************************************************");
    }

    @Test
    public void testUri() {
        System.out.print("Primary Uri: " + mongoProperties.getPrimary().getUri());
        System.out.print("Secondary Uri: " + mongoProperties.getSecondary().getUri());
    }
}

测试输出：

************************************************************
测试开始
************************************************************
Opened connection [connectionId{localValue:3, serverValue:18}] to 127.0.0.1:27017
Opened connection [connectionId{localValue:4, serverValue:19}] to 127.0.0.1:27017
User(id=1, userName=中国, passWord=123456)
User(id=2, userName=美国, passWord=123456)
************************************************************
测试完成
************************************************************

测试验证：

> use primary
switched to db primary
> db.user.find()
{ "_id" : NumberLong(1), "userName" : "中国", "passWord" : "123456", "_class" : "cn.appblog.springboot.model.User" }
> use secondary
switched to db secondary
> db.user.find()
{ "_id" : NumberLong(2), "userName" : "美国", "passWord" : "123456", "_class" : "cn.appblog.springboot.model.User" }

到此，MongoDB 多数据源的使用已经完成。