Flutter元数据提取插件metadata_extract的使用

metadata_extract 是一个用于从网页中提取元数据的 Dart 库。它支持提取 OpenGraph、Meta、Twitter Cards 和结构化数据（Json-LD）。

使用

提取给定URL的元数据

你可以使用 extract() 函数从指定的 URL 中提取元数据。

import 'package:metadata_extract/metadata_extract.dart';

main() async {
  var data = extract("https://flutter.dev/"); // 使用 extract() 函数从 URL 获取数据

  print(data.title); // 输出: Flutter - Beautiful native apps in record time
  print(data.description); // 输出: Flutter is Google's UI toolkit for crafting beautiful...
  print(data.image); // 输出: https://flutter.dev/images/flutter-logo-sharing.png

  var dataAsMap = data.toMap(); // 将元数据对象转换为 Map
}

手动解析

从文档中获取聚合元数据

此方法优先处理 Open Graph 数据，其次是 Twitter Card、JSON-LD，最后退回到 HTML 元数据。

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

void main() async {
  // 发起请求
  var response = await http.get('https://flutter.dev');

  // 将响应转换为文档。提供了实用函数 `responseToDocument` 或者可以使用自己的解码器/解析器。
  var document = responseToDocument(response);

  // 获取元数据
  var data = MetadataParser.parse(document);
  print(data);
}

获取 Open Graph 元数据

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

void main() async {
  // 发起请求
  var response = await http.get('https://flutter.dev');

  // 将响应转换为文档。提供了实用函数 `responseToDocument` 或者可以使用自己的解码器/解析器。
  var document = responseToDocument(response);

  // 获取 Open Graph 元数据
  var data = MetadataParser.OpenGraph(document);
  print(data);
}

获取 HTML 元数据

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

void main() async {
  // 发起请求
  var response = await http.get('https://flutter.dev');

  // 将响应转换为文档。提供了实用函数 `responseToDocument` 或者可以使用自己的解码器/解析器。
  var document = responseToDocument(response);

  // 获取 HTML 元数据
  var data = MetadataParser.HtmlMeta(document);
  print(data);
}

获取结构化数据（Json-LD）

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

void main() async {
  // 发起请求
  var response = await http.get('https://flutter.dev');

  // 将响应转换为文档。提供了实用函数 `responseToDocument` 或者可以使用自己的解码器/解析器。
  var document = responseToDocument(response);

  // 获取 Json-LD 结构化数据
  var data = MetadataParser.JsonLdSchema(document);
  print(data);
}

获取 Twitter Cards 元数据

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

void main() async {
  // 发起请求
  var response = await http.get('https://www.epicurious.com/expert-advice/best-soy-sauce-chefs-pick-article');

  // 将响应转换为文档。提供了实用函数 `responseToDocument` 或者可以使用自己的解码器/解析器。
  var document = responseToDocument(response);

  // 获取 Twitter Cards 元数据
  var data = MetadataParser.TwitterCard(document);
  print(data);
}

示例代码

以下是完整的示例代码：

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

class Examples {
  static Future<void> basicExtract() async {
    var data = await extract('https://flutter.dev'); // 返回一个 Metadata 对象
    print(data); // 输出 Metadata 的字符串表示形式
    print(data!.title); // 输出 Metadata 的标题
    print(data.toMap()); // 将元数据对象转换为 Map
    print(data.toJson()); // 将元数据对象转换为 JSON
  }

  static Future<void> parseDocument() async {
    var url = 'https://flutter.dev';
    var response = await http.get(Uri.parse(url));
    var document = responseToDocument(response);

    var data = MetadataParser.parse(document);
    print(data);

    // 只获取 Open Graph 元数据
    var og = MetadataParser.openGraph(document);
    print(og);

    var hm = MetadataParser.htmlMeta(document);
    print(hm);

    var js = MetadataParser.jsonLdSchema(document);
    print(js);

    var twitter = MetadataParser.twitterCard(document);
    print(twitter);
  }
}

void main() async {
  await Examples.basicExtract();
  await Examples.parseDocument();
}