Flutter Elasticsearch服务插件pip_services4_elasticsearch的使用

Flutter Elasticsearch服务插件pip_services4_elasticsearch的使用

该模块是Pip.Services多语言微服务工具包的一部分。

ElasticSearch模块包含在ElasticSearch服务器上存储数据的日志组件。

该模块包含以下软件包：

• Build - 包含用于构建组件的工厂
• Log - 日志组件

使用

在你的项目的pubspec.yaml文件中添加以下依赖项：

dependencies:
  pip_services4_elasticsearch: ^版本号

现在你可以从命令行安装包：

flutter packages get

微服务组件应使用CompositeLogger组件进行常规日志记录。CompositeLogger将从引用中获取ElasticSearchLogger，并会将日志消息重定向到其他目标。

class MyComponent implements IConfigurable, IReferenceable {
  CompositeLogger _logger = new CompositeLogger();
  
  void configure(ConfigParams config) {
    this._logger.configure(config);
  }
  
  void setReferences(IReferences refs) {
    this._logger.setReferences(refs);
  }
  
  void myMethod(IContext? context, param1) {
    this._logger.trace(context, "Executed method mycomponent.mymethod");
    // 其他代码...
  }
}

配置包含ElasticSearch日志记录器的微服务可能如下所示：

...
{{#if ELASTICSEARCH_ENABLED}}
- descriptor: pip-services:logger:elasticsearch:default:1.0
  connection:
    uri: {{{ELASTICSEARCG_SERVICE_URI}}}
    host: {{{ELASTICSEARCH_SERVICE_HOST}}}{{#unless ELASTICSEARCH_SERVICE_HOST}}localhost{{/unless}}
    port: {{ELASTICSEARCG_SERVICE_PORT}}{{#unless ELASTICSEARCH_SERVICE_PORT}}9200{{/unless}}\ 
{{/if}}
...

开发

开发时你需要安装以下前置条件：

• Dart SDK 3
• Visual Studio Code 或其他你选择的IDE
• Docker

安装依赖项：

flutter packages get

运行自动化测试：

flutter packages run test

生成API文档：

./docgen.ps1

在提交更改之前，运行docker化的构建和测试：

./build.ps1
./test.ps1
./clear.ps1

联系方式

该库由以下人员创建和维护：

• Sergey Seroukhov
• Levichev Dmitry

文档由以下人员编写：

• Mark Makarychev
• Levichev Dmitry

完整示例Demo

以下是一个完整的示例Demo，展示了如何使用ElasticSearch日志记录器。

import 'dart:io';

import 'package:pip_services4_commons/pip_services4_commons.dart';
import 'package:pip_services4_components/pip_services4_components.dart';
import 'package:pip_services4_elasticsearch/pip_services4_elasticsearch.dart';
import 'package:pip_services4_observability/pip_services4_observability.dart';

void main() async {
  var host = Platform.environment['ELASTICSEARCH_SERVICE_HOST'] ?? 'localhost';
  var port = Platform.environment['ELASTICSEARCH_SERVICE_PORT'] ?? 9200;
  var dateFormat = 'yyyyMMdd';

  var _logger = ElasticSearchLogger();

  var config = ConfigParams.fromTuples([
    'source',
    'test',
    'index',
    'log',
    'daily',
    true,
    'date_format',
    dateFormat,
    'connection.host',
    host,
    'connection.port',
    port
  ]);
  _logger.configure(config);

  await _logger.open(null);

  _logger.setLevel(LogLevel.Trace);
  _logger.fatal(null, null, 'Fatal error message');
  _logger.error(null, null, 'Error message');
  _logger.warn(null, 'Warning message');
  _logger.info(null, 'Information message');
  _logger.debug(null, 'Debug message');
  _logger.trace(null, 'Trace message');

  try {
    // 引发异常
    throw Exception('Test error');
  } catch (err) {
    var ex = ApplicationException().wrap(err);
    _logger.fatal(Context.fromTraceId('123'), ex, 'Fatal error');
    _logger.error(Context.fromTraceId('123'), ex, 'Recoverable error');
  }

  _logger.dump();

  await _logger.close(null);
}