Springboot 集成 mongodb

一、引入依赖

1.1 Maven

XML 复制代码

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

二、yml 配置文件

bash 复制代码

data:
  mongodb:
    # 基础链接参数
    # 连接的库
    database: mongodb
    # 用户名
    username: mongodb
    # 密码
    password: mongodb
    # IP和端口（host:port），例如127.0.0.1:27017。集群模式用,分隔开，例如host1:port1,host2:port2
    address: 192.168.1.1:3717,192.168.1.2:3717
    # 设置认证数据库，如果有的话
    authenticationDatabase: 
    # 客户端连接池参数
    clientName: ${spring.application.name}
    # TCP（socket）连接超时时间，毫秒
    connectionTimeoutMs: 5000
    # TCP（socket）连接闲置时间，毫秒
    maxConnectionIdleTimeMs: 60000
    # TCP（socket）连接最多可以使用多久，毫秒
    maxConnectionLifeTimeMs: 300000
    #TCP（socket）读取超时时间，毫秒
    readTimeoutMs: 15000
    #心跳检测发送频率，毫秒
    heartbeatFrequencyMs: 20000
    #线程池允许的最大连接数
    connectionsPerHost: 100
    #线程池空闲时保持的最小连接数
    minConnectionsPerHost: 20

三、MongoConfig配置类

部分可以配置可以查看源代码 AbstractMongoClientConfiguration 类

java 复制代码

@Configuration
@EnableConfigurationProperties(MongoConfig.MongoClientOptionProperties.class)
@Slf4j
public class MongoConfig {
 
    /**
     * 转换器
     * MappingMongoConverter可以自定义mongo转换器，主要自定义存取mongo数据时的一些操作，例如 mappingConverter.setTypeMapper(new
     * DefaultMongoTypeMapper(null)) 方法会将mongo数据中的_class字段去掉。
     *
     * @param factory     mongo工厂
     * @param context     上下文
     * @param beanFactory 自定义转换器
     * @return 转换器对象
     */
    @Bean
    public MappingMongoConverter mappingMongoConverter(MongoDatabaseFactory factory, MongoMappingContext context, BeanFactory beanFactory) {
        DbRefResolver dbRefResolver = new DefaultDbRefResolver(factory);
        MappingMongoConverter mappingConverter = new MappingMongoConverter(dbRefResolver, context);
        try {
            mappingConverter.setCustomConversions(beanFactory.getBean(CustomConversions.class));
        } catch (NoSuchBeanDefinitionException ignore) {
 
        }
 
        // 保存不需要 _class to 字段 mongo
        mappingConverter.setTypeMapper(new DefaultMongoTypeMapper(null));
 
        return mappingConverter;
    }
 
    @Bean
    public MongoTypeMapper defaultMongoTypeMapper() {
        return new DefaultMongoTypeMapper(null);
    }
 
    /**
     * 此Bean也是可以不显示定义的，如果我们没有显示定义生成MongoTemplate实例，
     * SpringBoot利用我们配置好的MongoDbFactory在配置类中生成一个MongoTemplate，
     * 之后我们就可以在项目代码中直接@Autowired了。因为用于生成MongoTemplate
     * 的MongoDbFactory是我们自己在MongoConfig配置类中生成的，所以我们自定义的连接池参数也就生效了。
     *
     * @param mongoDbFactory mongo工厂
     * @param converter      转换器
     * @return MongoTemplate实例
     */
    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter converter) {
        MongoTemplate mongoTemplate = new MongoTemplate(mongoDbFactory, converter);
        // 设置读从库优先
        mongoTemplate.setReadPreference(ReadPreference.secondaryPreferred());
        return mongoTemplate;
    }
 
    /**
     * 自定义mongo连接池
     *
     * @param properties 属性配置类
     * @return MongoDbFactory对象
     */
    @Bean
    public MongoDatabaseFactory mongoDbFactory(MongoClientOptionProperties properties) {
        // 创建客户端参数
        MongoClientSettings mongoClientOptions = mongoClientSettings(properties);
 
        // Mongo Client
        MongoDriverInformation info = MongoDriverInformation.builder().build();
 
        MongoClient mongoClient = new MongoClientImpl(mongoClientOptions, info);
 
        return new SimpleMongoClientDatabaseFactory(mongoClient, properties.database);
    }
 
    @Bean
    public MongoClientSettings mongoClientSettings(MongoClientOptionProperties properties) {
        // 创建认证
        MongoCredential mongoCredential = getCredential(properties);
        // 解析获取mongo服务地址
        List<ServerAddress> serverAddressList = getServerAddress(properties.getAddress());
 
        return MongoClientSettings.builder()
                //#客户端的标识，用于定位请求来源等，一般用程序名
                .applicationName(properties.clientName)
                //配置IP地址
                .applyToClusterSettings(i -> i.hosts(serverAddressList))
                //配置认证
                .credential(mongoCredential)
 
                .applyToSocketSettings(i -> i
                        //TCP（socket）读取超时时间，毫秒
                        .readTimeout(properties.readTimeoutMs, TimeUnit.MILLISECONDS)
                        //TCP（socket）连接超时时间，毫秒
                        .connectTimeout(properties.connectionTimeoutMs, TimeUnit.MILLISECONDS))
 
                .applyToConnectionPoolSettings(i -> i
                        //TCP（socket）连接闲置时间，毫秒
                        .maxConnectionIdleTime(properties.maxConnectionIdleTimeMs, TimeUnit.MILLISECONDS)
                        //TCP（socket）连接最多可以使用多久，毫秒
                        .maxConnectionLifeTime(properties.maxConnectionIdleTimeMs, TimeUnit.MILLISECONDS)
                        //当连接池无可用连接时客户端阻塞等待的最大时长，毫秒
                        .maxWaitTime(properties.maxWaitTimeMs, TimeUnit.MILLISECONDS)
                        .maxSize(properties.connectionsPerHost)
                        .minSize(properties.minConnectionsPerHost))
 
                .applyToServerSettings(i -> i
                        .heartbeatFrequency(properties.heartbeatFrequencyMs, TimeUnit.MILLISECONDS)
                        .minHeartbeatFrequency(properties.minHeartbeatFrequencyMs, TimeUnit.MILLISECONDS))
 
 
                .build();
    }
 
    /**
     * 创建认证
     *
     * @param properties 属性配置类
     * @return 认证对象
     */
    private MongoCredential getCredential(MongoClientOptionProperties properties) {
        if (!StringUtils.isEmpty(properties.getUsername()) && !StringUtils.isEmpty(properties.getPassword())) {
            // 没有专用认证数据库则取当前数据库
            String database = StringUtils.isEmpty(properties.getAuthenticationDatabase()) ?
                    properties.getDatabase() : properties.getAuthenticationDatabase();
            return MongoCredential.createCredential(properties.getUsername(), database,
                    properties.getPassword().toCharArray());
        }
        return null;
    }
 
    /**
     * 获取数据库服务地址
     *
     * @param mongoAddress 地址字符串
     * @return 服务地址数组
     */
    private List<ServerAddress> getServerAddress(String mongoAddress) {
        String[] mongoAddressArray = mongoAddress.trim().split(",");
        List<ServerAddress> serverAddressList = new ArrayList<>(4);
        for (String address : mongoAddressArray) {
            String[] hostAndPort = address.split(":");
            serverAddressList.add(new ServerAddress(hostAndPort[0], Integer.parseInt(hostAndPort[1])));
        }
        return serverAddressList;
    }
 
    @Setter
    @Getter
    @Accessors(chain = true)
    @ConfigurationProperties(prefix = "data.mongodb")
    public class MongoClientOptionProperties {
        /**
         * 基础连接参数
         */
        // 要连接的数据库
        @NotEmpty
        private String database;
        // 用户名
        private String username;
        // 密码
        private String password;
        // IP和端口（host:port），例如127.0.0.1:27017。集群模式用,分隔开，例如host1:port1,host2:port2
        //@NotEmpty
        private String address;
        // 设置认证数据库，如果有的话
        private String authenticationDatabase;
 
        /**
         * 客户端连接池参数
         */
        @NotEmpty
        private String clientName; // 客户端的标识，用于定位请求来源等，一般用程序名
        @Min(value = 1)
        private int connectionTimeoutMs; // TCP（socket）连接超时时间，毫秒
        @Min(value = 1)
        private int maxConnectionIdleTimeMs; // TCP（socket）连接闲置时间，毫秒
        @Min(value = 1)
        private int maxConnectionLifeTimeMs; // TCP（socket）连接最多可以使用多久，毫秒
        @Min(value = 1)
        private int readTimeoutMs; // TCP（socket）读取超时时间，毫秒
        @Min(value = 1)
        private int maxWaitTimeMs; // 当连接池无可用连接时客户端阻塞等待的最大时长，毫秒
        @Min(value = 2000)
        private int heartbeatFrequencyMs; // 心跳检测发送频率，毫秒
        @Min(value = 300)
        private int minHeartbeatFrequencyMs; // 最小的心跳检测发送频率，毫秒
        @Min(value = 200)
        private int heartbeatConnectionTimeoutMs; // 心跳检测连接超时时间，毫秒
        @Min(value = 200)
        private int heartbeatReadTimeoutMs; // 心跳检测读取超时时间，毫秒
        @Min(value = 1)
        private int connectionsPerHost; // 线程池允许的最大连接数
        @Min(value = 1)
        private int minConnectionsPerHost; // 线程池空闲时保持的最小连接数
        @Min(value = 1)
        // 计算允许多少个线程阻塞等待时的乘数，算法：threadsAllowedToBlockForConnectionMultiplier*maxConnectionsPerHost
        private int threadsAllowedToBlockForConnectionMultiplier;