npm 包 lyric-dl 使用教程

介绍

在前端开发中，有些项目需要在网页上展示歌词。而有些音乐平台并不提供歌词，这时我们就需要使用第三方工具获取歌词。npm 包 lyric-dl 就是一款方便获取歌词的工具。

安装

首先，需要在本地安装 Node.js 和 npm。然后，在命令行输入以下命令进行安装：

npm install -g lyric-dl

使用

安装完成后，在命令行中输入以下命令获取指定歌曲的歌词：

lyric-dl <歌曲名> -a <歌手名>

例如，获取周杰伦的歌曲《稻香》的歌词：

lyric-dl 稻香 -a 周杰伦

执行后，歌词将会显示在命令行中。

如果你需要将歌词保存到本地文件中，可以通过以下命令：

lyric-dl <歌曲名> -a <歌手名> -s <文件名>

例如，保存周杰伦的歌曲《稻香》的歌词到本地文件 lyric.txt 中：

lyric-dl 稻香 -a 周杰伦 -s lyric.txt

执行后，歌词将会保存到 lyric.txt 文件中。

示例代码

如果你需要在网页上展示歌词，可以将获取到的歌词插入到 HTML 中的一个元素中。下面是一个使用 jQuery 实现的示例：

<div id="lyric"></div>

$.ajax({
  url: 'https://api.lyrics.ovh/v1/周杰伦/稻香',
  dataType: 'json',
  success: function(data) {
    var lyric = data.lyrics;
    $('#lyric').text(lyric);
  }
});

深入理解

lyric-dl 是基于 Node.js 的一个命令行工具。它通过调用第三方 API 获取歌曲的歌词，并将歌词返回到命令行中。在具体实现上，它通过调用 request 和 cheerio 库来发送 HTTP 请求和解析 HTML 页面，从而获取歌词信息。

除了 lyric-dl，在 npm 上还有许多获取歌词的工具，如 lyrics-fetcher、lyrics-mod 和 lyrics-finder 等。它们的实现原理都基本相同，都是通过调用第三方 API 获取歌曲的歌词信息，再将信息返回到命令行或者文件中。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cb681e8991b448da38b