SpringBoot中使用MongoDB的連接池配置全過程

更新時間：2025年06月06日 09:00:00 作者：liuhuiteng

這篇文章主要介紹了SpringBoot中使用MongoDB的連接池配置全過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

說明

Spring Boot中通過依賴spring-boot-starter-data-mongodb，來實現(xiàn)spring-data-mongodb的自動配置。

但是默認情況下，Spring Boot 中，并沒有像使用MySQL或者Redis一樣，提供了連接池配置的功能。因此，我們需要自行重寫 MongoDbFactory，實現(xiàn)MongoDB客戶端連接的參數(shù)配置擴展。

需要說明的是，MongoDB的客戶端本身就是一個連接池，因此，我們只需要配置客戶端即可。

配置文件

為了統(tǒng)一Spring Boot的配置，我們要將重寫的配置也配置到 application.yml中，前綴為spring.data.mongodb.custom下（前綴可自己隨意配置）：

spring:
 data:
 mongodb:
 custom:
 hosts:
 - 10.0.5.1
 - 10.0.5.1
 ports:
 - 27017
 - 27018
 replica-set: mgset-3590061
 username: jancee
 password: abc123
 database: jancee
 authentication-database: admin
 connections-per-host: 20
 min-connections-per-host: 20

該配置例子中，配置了副本集，其中包含了主機10.0.5.1:27017和10.0.5.1:27018，其它配置與Spring Boot的標準配置類似，另外，connections-per-host為客戶端的連接數(shù)，in-connections-per-host為客戶端最小連接數(shù)。

將配置包裝成類

為方便調(diào)用和可讀性，將上述配置包裝成一個配置實體類，MongoConfig.java代碼如下：

package com.feidiao.jancee.fdiot.api.config.mongo;

import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.NotEmpty;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import java.util.List;

@Component
@Validated
public class MongoSettingsProperties {

    @NotBlank
    private String database;

    @NotEmpty
    private List<String> hosts;

    @NotEmpty
    private List<Integer> ports;

    private String replicaSet;
    private String username;
    private String password;
    private String authenticationDatabase;
    private Integer minConnectionsPerHost = 10;
    private Integer connectionsPerHost = 2;

    public MongoSettingsProperties() {

    }

    public String getDatabase() {
        return database;
    }

    public void setDatabase(String database) {
        this.database = database;
    }

    public List<String> getHosts() {
        return hosts;
    }

    public void setHosts(List<String> hosts) {
        this.hosts = hosts;
    }

    public List<Integer> getPorts() {
        return ports;
    }

    public void setPorts(List<Integer> ports) {
        this.ports = ports;
    }

    public String getReplicaSet() {
        return replicaSet;
    }

    public void setReplicaSet(String replicaSet) {
        this.replicaSet = replicaSet;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getAuthenticationDatabase() {
        return authenticationDatabase;
    }

    public void setAuthenticationDatabase(String authenticationDatabase) {
        this.authenticationDatabase = authenticationDatabase;
    }

    public Integer getMinConnectionsPerHost() {
        return minConnectionsPerHost;
    }

    public void setMinConnectionsPerHost(Integer minConnectionsPerHost) {
        this.minConnectionsPerHost = minConnectionsPerHost;
    }

    public Integer getConnectionsPerHost() {
        return connectionsPerHost;
    }

    public void setConnectionsPerHost(Integer connectionsPerHost) {
        this.connectionsPerHost = connectionsPerHost;
    }
}

覆蓋MongoDbFactory

接下來，就是覆蓋Spring Boot原有的MongoDbFactory Bean，新建文件MongoConfig.java，代碼如下：

import com.mongodb.MongoClient;
import com.mongodb.MongoClientOptions;
import com.mongodb.MongoCredential;
import com.mongodb.ServerAddress;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.SimpleMongoDbFactory;

import java.util.ArrayList;
import java.util.List;

@Configuration
public class MongoConfig {


    // 注入配置實體
    @Autowired
    private MongoSettingsProperties mongoSettingsProperties;
    @Bean
    @ConfigurationProperties(
            prefix = "spring.data.mongodb.custom")
    MongoSettingsProperties mongoSettingsProperties() {
        return new MongoSettingsProperties();
    }

    // 覆蓋默認的MongoDbFactory
    @Bean
    MongoDbFactory mongoDbFactory() {
        //客戶端配置（連接數(shù)、副本集群驗證）
        MongoClientOptions.Builder builder = new MongoClientOptions.Builder();
        builder.connectionsPerHost(mongoSettingsProperties.getConnectionsPerHost());
        builder.minConnectionsPerHost(mongoSettingsProperties.getMinConnectionsPerHost());
        if (mongoSettingsProperties.getReplicaSet() != null) {
            builder.requiredReplicaSetName(mongoSettingsProperties.getReplicaSet());
        }
        MongoClientOptions mongoClientOptions = builder.build();

        // MongoDB地址列表
        List<ServerAddress> serverAddresses = new ArrayList<>();
        for (String host : mongoSettingsProperties.getHosts()) {
            Integer index = mongoSettingsProperties.getHosts().indexOf(host);
            Integer port = mongoSettingsProperties.getPorts().get(index);

            ServerAddress serverAddress = new ServerAddress(host, port);
            serverAddresses.add(serverAddress);
        }
        System.out.println("serverAddresses:" + serverAddresses.toString());

        // 連接認證
        List<MongoCredential> mongoCredentialList = new ArrayList<>();
        if (mongoSettingsProperties.getUsername() != null) {
            mongoCredentialList.add(MongoCredential.createScramSha1Credential(
                    mongoSettingsProperties.getUsername(),
                    mongoSettingsProperties.getAuthenticationDatabase() != null ? mongoSettingsProperties.getAuthenticationDatabase() : mongoSettingsProperties.getDatabase(),
                    mongoSettingsProperties.getPassword().toCharArray()));
        }
        System.out.println("mongoCredentialList:" + mongoCredentialList.toString());

        //創(chuàng)建客戶端和Factory
        MongoClient mongoClient = new MongoClient(serverAddresses, mongoCredentialList, mongoClientOptions);
        MongoDbFactory mongoDbFactory = new SimpleMongoDbFactory(mongoClient, mongoSettingsProperties.getDatabase());

        return mongoDbFactory;
    }
}

在這里，實現(xiàn)了MongoDB連接時，前面配置的參數(shù)的設置，按照自己的實際情況，可以在new SimpleMongoDbFactory時，增加修改自己需要的配置參數(shù)。

至此，就完成了全部配置，運行測試即可。