Flutter翻译服务插件deepl的使用

Flutter翻译服务插件deepl的使用

这是对未官方支持的库的介绍，该库可以访问DeepL API。

安装

在pubspec.yaml文件中添加以下内容：

dependencies:
  deepl: <最新版本>

或者直接运行命令：

dart pub add deepl
flutter pub add deepl

使用

首先创建一个实例并传入你的API密钥：

var deeplApi = DeepLApi.fromAuthKey('<你的API密钥>');

接下来，你可以通过命名空间来访问API。例如，翻译文本：

var translation = (await deeplApi.translations.translateText(
    options: TranslateTextRequestOptionsBuilder.simple(
      text: 'Hello',
      target: TargetLanguage.ES,
    ).build(),
  ))
      .first;
print(
    '检测到的语言: ${translation.detectedLanguage?.name}, 翻译结果: ${translation.text}');

翻译文档

要翻译文档，你需要先上传文件：

var document = await deeplApi.documents.uploadDocument(
    options: TranslateDocumentRequestOptionsBuilder(
      filename: '<你的文件名>',
      target: TargetLanguage.ES,
    ).build(),
  );

如果文档较大，你可能需要检查其翻译状态：

var status = await deeplApi.documents.status(document);
print('状态: ${status.key}');
if (status.key == TranslationStatus.translating) {
  var v = status.value as StatusTranslating;
  var r = v.estimatedSeconds;
  stdout.write('正在翻译...');
  _timedCounter(Duration(seconds: 1), r).listen((event) {
    stdout.write('\r剩余时间: ${r - event}s');
  }, onDone: () async {
    var status = await deeplApi.documents.status(document);
    if (status.key == TranslationStatus.done) {
      print('下载文档');
      await deeplApi.documents.downloadDocument(document, '<你的翻译后的文件名>');
      print('完成');
    }
  });
}

支持的端点

• ✅ 翻译文档
  • ✅ 上传文件
  • ✅ 检查文件状态
  • ✅ 下载文档
• ✅ 翻译文本
• ✅ 词汇表
• ✅ 翻译配额

示例代码

以下是完整的示例代码：

import 'dart:async';
import 'dart:convert';

import 'package:deepl/deepl.dart';
import 'package:deepl/src/models/_models.dart';
import 'dart:io';

void main(List<String> args) async {
  var deepl = await _getApi();
  var s = await deepl.languages.supportedLanguages();
  print(s.map((e) => e.name).join(','));

  var h = 'hello';
  var t = TargetLanguage.ES;
  print('将 \'$h\' 翻译为 ${t.name}:');
  var translation = (await deepl.translations.translateText(
    options: TranslateTextRequestOptionsBuilder.simple(
      text: 'Hello',
      target: TargetLanguage.ES,
    ).build(),
  ))
      .first;
  print(
      '检测到的语言: ${translation.detectedLanguage?.name}, 翻译结果: ${translation.text}');
  
  var curr = Directory.current.path;
  print('上传文档 $curr/example/gatsby.txt');
  var id = (await deepl.documents.uploadDocument(
    options: TranslateDocumentRequestOptionsBuilder(
      filename: '$curr/example/gatsby.txt',
      target: TargetLanguage.ES,
    ).build(),
  ));
  
  var status = (await deepl.documents.status(id));
  if (status.key == TranslationStatus.translating) {
    var v = status.value as StatusTranslating;
    var r = v.secondsRemaining ?? 0;
    stdout.write('正在翻译...');
    _timedCounter(Duration(seconds: 1), r).listen((event) {
      stdout.write('\r剩余时间: ${r - event}s');
    }, onDone: () async {
      var status = (await deepl.documents.status(id));
      if (status.key == TranslationStatus.done) {
        print('下载文档');
        await deepl.documents
            .downloadDocument(id, '$curr/example/gatsby_es.txt');
        print('完成');
      }
    });
  }
}

Future<DeepLApi> _getApi() async {
  var keyJson = await File('example/.apikey').readAsString();
  var keyMap = json.decode(keyJson);
  return DeepLApi.fromAuthKey(keyMap['key']);
}

Stream<int> _timedCounter(Duration interval, [int? maxCount]) {
  late StreamController<int> controller;
  Timer? timer;
  int counter = 0;

  void tick(_) {
    counter++;
    controller.add(counter); // 向流发送计数器值作为事件。
    if (counter == maxCount) {
      timer?.cancel();
      controller.close(); // 告诉流关闭并通知监听者。
    }
  }

  void startTimer() {
    timer = Timer.periodic(interval, tick);
  }

  void stopTimer() {
    timer?.cancel();
    timer = null;
  }

  controller = StreamController<int>(
      onListen: startTimer,
      onPause: stopTimer,
      onResume: startTimer,
      onCancel: stopTimer);

  return controller.stream;
}