Flutter元数据获取插件 metadata_fetch_plus 的使用

metadata_fetch_plus 是一个用于从网页中提取元数据的Dart库。它支持OpenGraph、Meta、Twitter Cards和结构化数据（Json-LD）。本文将介绍如何使用这个插件来提取网页的元数据。

元数据结构

以下是元数据的基本结构：

Metadata:
  - title
  - description
  - image
  - url

使用方法

从给定URL提取元数据

以下是一个简单的示例，展示如何使用 MetadataFetch.extract() 函数从给定的URL中提取元数据。

import 'package:metadata_fetch_plus/metadata_fetch_plus.dart';

void main() async {
  final myURL = 'https://flutter.dev';

  // 使用 `MetadataFetch.extract()` 函数从URL中提取数据
  var data = await MetadataFetch.extract(myURL);

  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
  print(data.url); // 输出：https://flutter.dev/

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

手动解析

获取聚合的元数据

该方法优先考虑Open Graph数据，其次是Twitter Card，JSON-LD，最后是HTML元数据。

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

void main() async {
  final myURL = 'https://flutter.dev';

  // 发起HTTP请求
  var response = await http.get(Uri.parse(myURL));

  // 将响应转换为Document
  var document = MetadataFetch.responseToDocument(response);

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

手动指定使用的元数据解析器

你可以手动选择要使用的元数据解析器。

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

void main() async {
  final myURL = 'https://flutter.dev';

  // 发起HTTP请求
  var response = await http.get(Uri.parse(myURL));

  // 将响应转换为Document
  var document = MetadataFetch.responseToDocument(response);

  // 获取OpenGraph元数据
  var ogData = MetadataParser.OpenGraph(document);
  print(ogData);

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

  // 获取结构化数据
  var structuredData = MetadataParser.JsonLdSchema(document);
  print(structuredData);

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

提供备用URL以进行手动解析

如果解析器无法从文档中提取URL，你可以提供一个备用URL。这个URL会添加到最终的 Metadata 结构中，并用于解析相对路径的图片。

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

void main() async {
  final myURL = 'https://flutter.dev';

  // 发起HTTP请求
  var response = await http.get(Uri.parse(myURL));

  // 将响应转换为Document
  var document = MetadataFetch.responseToDocument(response);

  // 获取聚合的元数据，并提供备用URL
  var data = MetadataParser.parse(document, url: myURL);
  print(data);
}

示例Demo

下面是一个完整的示例，展示了如何从URL中提取元数据并将其转换为Map或JSON格式。

import 'package:metadata_fetch_plus/metadata_fetch_plus.dart';

void main() async {
  var data = await MetadataFetch.extract('https://flutter.dev'); // 返回一个Metadata对象
  print(data); // 输出Metadata.toString()
  print(data?.title); // 输出Metadata.title
  print(data?.toMap()); // 将Metadata对象转换为Map
  print(data?.toJson()); // 将Metadata对象转换为JSON
}