Flutter MongoDB连接池插件 mongo_pool 的使用

简介

mongo_pool 是一个用于Flutter应用的MongoDB连接池插件。它基于 mongo_dart 包，提供了动态扩展和维护连接池的功能。

新特性 (1.4.0版本)

• 动态扩展和维护连接池
  • 当面对高需求时，连接池可以动态扩展。在指定时间内未使用的连接将自动移除，并且当连接未在该时间段内被重用时，池大小将减少到指定的最小值。

特性

• 动态扩展和维护连接池。
• 连接池大小配置
• 自动连接池扩展
• 实例化后可以从池中访问连接
• 连接生命周期配置
• 连接泄露检测

开始使用

使用这个包，您的应用程序将在运行时打开您指定数量的数据库连接。您可以随时打开、关闭或更改这些链接的数量。

使用方法

通过 mongo_pool 包，您可以使用 MongoDbPoolService 类来创建一个连接池。

首先，需要创建一个 MongoDbPoolService 实例。然后调用 open() 方法打开连接池。如果要关闭连接池，可以调用 close() 方法。

MongoDbPoolService 类有一个 getInstance() 方法，可以用来获取连接池的实例，从而在项目中的任何地方访问连接池。

示例代码

以下是一个简单的使用示例：

import 'package:mongo_pool/mongo_pool.dart';

Future<void> main() async {
  /// 创建一个包含5个连接的连接池
  final MongoDbPoolService poolService = MongoDbPoolService(
    const MongoPoolConfiguration(
      /// [maxLifetimeMilliseconds] 是连接池中连接的最大生命周期。
      /// 当面临高需求时，连接池可以动态扩展。在指定时间内未使用的连接将自动移除，
      /// 并且当连接（poolSize）在该时间段内未被重用时，池大小将减少到指定的最小值。
      maxLifetimeMilliseconds: 180000,

      /// [leakDetectionThreshold] 是连接泄露检测的阈值。
      /// 如果连接在指定时间内未释放，则认为是泄露。
      /// 如果没有设置值，则不会工作。建议设置一个值。
      leakDetectionThreshold: 10000,
      uriString: 'mongodb://localhost:27017/my_database',

      /// [poolSize] 是连接池中的最小连接数。
      poolSize: 2,
      secure: false,
      tlsAllowInvalidCertificates: false,
      tlsCAFile: 'path/to/ca/file',
      tlsCertificateKeyFile: 'path/to/certificate/key/file',
      tlsCertificateKeyFilePassword: 'password',
    ),
  );

  /// 打开连接池
  await initialize(poolService);

  /// 从连接池中获取一个连接
  final Db connection = await poolService.acquire();

  // 数据库操作
  final DbCollection collection = connection.collection('my_collection');
  final List<Map<String, dynamic>> result = await collection.find().toList();
  print(result);
  
  // 释放连接以便其他操作使用
  poolService.release(connection);

  // 关闭连接池
  await poolService.close();
}

Future<void> initialize(MongoDbPoolService service) async {
  try {
    await service.initialize();
  } on Exception catch (e) {
    /// 处理异常
    print(e);
  }
}

class OtherClass {
  OtherClass();

  Future<void> initialize() async {
    /// 获取连接池实例
    final MongoDbPoolService poolService = MongoDbPoolService.getInstance();
    final Db connection = await poolService.acquire();
    
    // 数据库操作
    final DbCollection collection = connection.collection('my_collection');
    final List<Map<String, dynamic>> result = await collection.find().toList();
    print(result);
    
    // 释放连接以便其他操作使用
    poolService.release(connection);
    
    // 关闭连接池
    await poolService.close();
  }
}

测试

要运行测试，您需要在本地机器上运行一个MongoDB实例。您可以使用以下命令通过Docker启动MongoDB实例：

docker run -d -p 27017:27017 --name mongo mongo

解决的问题

• ✅ 解决了Mongodb srv连接问题
• ✅ 修复了当没有剩余连接时无法创建新连接的bug
• ✅ 修复了使用SSL/TLS无法连接到MongoDB的问题

在项目中使用

可以通过以下命令添加依赖到您的项目：

dependencies:
  mongo_pool: ^1.4.0