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

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

Pub Dev地址

• Pub

元数据结构

Metadata:
  - title
  - description
  - image
  - url

使用方法

通过给定URL提取元数据

以下是通过指定URL来提取页面元数据的简单示例：

import 'package:metadata_fetch/metadata_fetch.dart';

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

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

  print(data.title); // 输出标题
  print(data.description); // 输出描述
  print(data.image); // 输出图片链接
  print(data.url); // 输出页面URL

  // 将元数据转换为Map格式
  var dataAsMap = data.toMap();
  print(dataAsMap);
}

手动解析文档中的元数据

获取聚合的元数据

此方法优先从Open Graph数据中获取信息，其次是Twitter Card、JSON-LD，最后是HTML元数据。

import 'package:metadata_fetch/metadata_fetch.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/metadata_fetch.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 ogData = MetadataParser.OpenGraph(document);
  print('OpenGraph Data:');
  print(ogData);

  var htmlData = MetadataParser.HtmlMeta(document);
  print('HTML Meta Data:');
  print(htmlData);

  var structuredData = MetadataParser.JsonLdSchema(document);
  print('Structured Data:');
  print(structuredData);

  var twitterCardData = MetadataParser.TwitterCard(document);
  print('Twitter Card Data:');
  print(twitterCardData);
}

提供备用URL进行手动解析

当解析器无法从文档中提取URL时，可以通过MetadataFetch.parse()提供一个备用URL。

import 'package:metadata_fetch/metadata_fetch.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);
}

示例代码

下面是一个完整的示例程序，展示了如何使用metadata_fetch插件来提取并打印出指定网站的元数据：

import 'package:metadata_fetch/metadata_fetch.dart';

void main() async {
  try {
    var data = await MetadataFetch.extract('https://flutter.dev');
    print('Title: ${data?.title}');
    print('Description: ${data?.description}');
    print('Image: ${data?.image}');
    print('URL: ${data?.url}');
    
    // 转换为Map或JSON格式
    print('As Map: ${data?.toMap()}');
    print('As JSON: ${data?.toJson()}');
  } catch (e) {
    print('Error occurred: $e');
  }
}

致谢

本库受到open_graph_parser项目的启发，但试图更加通用。

路线图

• 增加对权重或优先级元数据的支持，允许为每个解析器分配自定义权重以提供回退优先系统。
• 改进文档。

问题、错误和功能请求

有关此项目的所有查询，请提交至issue tracker。