Flutter牛津词典查询插件oxford_dictionary的使用

Flutter 牛津词典查询插件 oxford_dictionary 的使用

Oxford Dictionary API Wrapper in Dart

该包正在开发中，并未包含所有 API 功能。欢迎贡献！

Oxford Dictionaries API 提供了一种简单的方法来访问强大的词汇数据（单词、定义、翻译、音频发音、同义词、反义词、词性等），以在您的应用和网站中使用。

为了测试包的可靠性，在 test/fixtures/{entries,lemmas}/ 文件夹中保存了 100 个请求及其相应的响应。如果您遇到任何空值错误，请在存储库的 Issues 页面上打开一个问题。

查看此项目的贡献指南。

阅读 Oxford Dictionaries 文档

开始使用

首先，克隆项目仓库：

git clone git@github.com:rIIh/oxford-dictionary.git && cd oxford-dictionary

然后安装依赖：

flutter pub get

最后运行构建脚本：

flutter pub run build_runner build

如何使用

请参阅示例文件以获取更多用例信息。

void main() async {
  final dictionary = OxfordDictionary(
    'en',
    Platform.environment['APP_ID'],
    Platform.environment['APP_KEY'],
  );

  // 查询单词定义
  final word = await dictionary.entries.search(wordString);

  // 获取短语
  final phrases = word.phrases.values
      .map((phrases) => phrases)
      .expand((phrases) => phrases)
      .toList();

  // 获取发音
  final pronunciations = word.variants.values
      .map((e) => e.map((e) => e.pronunciations))
      .expand((pronunciations) => pronunciations)
      .toList();

  // 获取词义
  final senses = word.variants.values
      .map((variants) => variants.map((variant) => variant.senses))
      .expand((senses) => senses)
      .toList();

  // 获取定义
  final definitions = senses
      .map((e) => e.map((e) => e.definitions))
      .expand((definitions) => definitions)
      .toList();

  // 获取子词义
  final subSenses = senses
      .map((e) => e.map((e) => e.subSenses))
      .expand((subSenses) => subSenses)
      .toList();
}

完整示例代码

以下是完整的示例代码，展示了如何使用插件进行查询并处理返回的数据。

import 'dart:io';

import 'package:http/http.dart' as http;
import 'package:oxford_dictionary/oxford_dictionary.dart';

void main() {
  find('programming').then((word) {});
}

Future<Word?> find(String wordString, [http.Client? client]) async {
  final dictionary = OxfordDictionary(
    'en',
    Platform.environment['APP_ID'] ?? 'test_app_id',
    Platform.environment['APP_KEY'] ?? 'test_app_key',
    client: client,
  );

  // 查询单词定义
  final word = await dictionary.entries.search(wordString).then((value) => value!);

  print(word);

  // 获取短语
  final phrases = word.phrases.values
      .map((phrases) => phrases)
      .expand((phrases) => phrases)
      .toList();

  // 获取发音
  final pronunciations = word.variants.values
      .map((e) => e.map((e) => e.pronunciations))
      .expand((pronunciations) => pronunciations)
      .toList();

  // 获取词义
  final senses = word.variants.values
      .map((variants) => variants.map((variant) => variant.senses))
      .expand((senses) => senses)
      .toList();

  // 获取定义
  final definitions = senses
      .map((e) => e.map((e) => e.definitions))
      .expand((definitions) => definitions)
      .toList();

  // 获取子词义
  final subSenses = senses
      .map((e) => e.map((e) => e.subSenses))
      .expand((subSenses) => subSenses)
      .toList();

  print([phrases, pronunciations, senses, definitions, subSenses].join('\n'));

  return word;
}

Future<Lemmas?> findLemmas(String wordString, [http.Client? client]) async {
  final dictionary = OxfordDictionary(
    'en',
    Platform.environment['APP_ID'] ?? 'test_app_id',
    Platform.environment['APP_KEY'] ?? 'test_app_key',
    client: client,
  );

  final lemmas = await dictionary.lemmas.search(wordString).then((value) => value!);

  print(lemmas);

  for (final inflection in lemmas.inflections.entries) {
    final category = inflection.key;
    final inflectionsByCategory = inflection.value;

    print("Searching words defenitions for inflections of ${wordString} for ${category.text} category");

    final wordsForCategory = await Future.wait(
      inflectionsByCategory.map((e) => find(e.text)).toList(),
    );

    print(wordsForCategory.whereType<Word>().map((e) => e.variants).join(', '));
  }

  return lemmas;
}