在前端开发中,我们常常需要从 URL 中抓取页面的元数据,例如标题、描述、图像等等,并在网站中显示。这通常需要用到 Open Graph 协议,而 npm 包 ogs 就是一个方便实现这一目标的工具。在本文中,我们将介绍 ogs 的使用方法,给您提供详细的使用指南。
什么是 OGS?
ogs 是一个 Node.js 模块,它可以从一个 URL 中解析出 Open Graph 元数据。Open Graph 是一个由 Facebook 定义的元数据协议,使得网站可以自定义它们的内容在社交媒体中的展现方式。
使用 ogs 可以省去手动从 HTML 中解析元数据的麻烦,我们只需要提供需要抓取的 URL 地址,ogs 就会自动解析出 meta 标签及其属性,然后返回一个高度格式化和可用的 JSON 对象。
如何安装 OGS
ogs 可以通过 npm 安装,只需要在命令行中输入以下命令:
npm install ogs
然后它就会被安装到你的项目中。
如何使用 OGS
ogs 的使用方法非常简单,首先我们需要在代码中 require 进来这个包:
var ogs = require('ogs');
然后我们使用 ogs(url, callback)方法,将需要解析的网址作为第一个参数,将回调函数作为第二个参数,并在回调函数中处理解析出来的结果。
var ogs = require('ogs'); var url = "https://www.baidu.com" ogs(url, function(error, results) { console.log(results) });
这个例子中,我们会从百度的首页抓取元数据并打印出来。在结果中,我们可以看到类似于下面的东西:
-- -------------------- ---- ------- - ---- ------------------------ ------ ---------- -------- ----- ----------- ------------------------ ------- - --- - ------ ------------------------ ------------ ----- -------- ------------ -------- ----------------------------------------- ------------- ----------- -- -------- - ------ ------------------------ ------------ ----- -------- ------------ -------- ----------------------------------------- ------------- ----------- - - -
这个 JSON 对象包含了从网页中抽取出来的 Open Graph 和 Twitter 元数据。
我们可以通过如下简单的方式提取出元数据:
results.result.og.title results.result.og.description results.result.og.image
深入了解 OGS 所提供的方法
除了使用上述的最简单的方式,ogs 还提供了一些其它的方法,用于获取更完整和可定制的结果:
- ogs(options, callback): 支持传递选项,在设定属性之后可以获取更全面和可配置的结果;
- ogs.url(url, callback): 当只提供 URL 时,它会返回所有可用元数据;
- ogs.html(html, callback): 当只提供 HTML 时,它会解析所有 meta 标签并返回元数据;
- ogs.resetCache(): 重置所有的缓存;
总结
任何一项技术都需要不断的学习和探索。ogs 可以让我们从页面中轻易地拿到元数据,它方便了前端开发人员的开发工作。在本文中,我们学习了如何安装和使用 ogs,并详细介绍了 ogs 所提供的各种方法。希望这篇文章能够对你有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055bbf81e8991b448d9586