Cheerio を使って HTML 内の画像 URL を相対パスに変換する

HTML ソースを読み込み、その中にある img 要素の src を書き換えたいことがありました。対象は、特定のドメインから始まる画像 URL です。
ブラウザ上なら jQuery などで操作できますが、今回は Node.js で処理したい。そこで、HTML を jQuery に近い書き方で扱える Cheerio を使ってみました。
Cheerio をインストールする
npm でインストールします。
npm install cheerioHTML を読み込むには cheerio.load() を使います。返された $ を使うと、jQuery のようにセレクターで要素を取得できます。
const cheerio = require('cheerio')
const $ = cheerio.load('<p><img src="image.jpg"></p>')
const images = $('img')これで、HTML 内の img 要素を取得できました。
特定のドメインから始まる URL を書き換える
今回は、次のような URL を対象にします。
https://cashe.hogehoge.com/images/sample.jpg変換後は、ドメイン部分を取り除いた相対パスにします。
images/sample.jpgCheerio で各 img 要素を取得し、src が対象の文字列から始まる場合だけ書き換えます。
const cheerio = require('cheerio')
const source = `
<p>サンプル画像</p>
<img src="https://cashe.hogehoge.com/images/sample.jpg">
<img src="https://example.com/other.jpg">
`
// HTML 断片として読み込む
const $ = cheerio.load(source, null, false)
const prefix = 'https://cashe.hogehoge.com/'
$('img').each((_index, element) => {
const image = $(element)
const src = image.attr('src')
if (src && src.startsWith(prefix)) {
image.attr('src', src.slice(prefix.length))
}
})
const html = $.html()
console.log(html)出力は次のようになります。
<p>サンプル画像</p>
<img src="images/sample.jpg">
<img src="https://example.com/other.jpg">対象外のドメインや、src が設定されていない img 要素はそのまま残します。クエリ文字列やフラグメントがある場合も、ドメイン以降の文字列に含めて残ります。
今回は replaceWith() も調べましたが、要素を置き換えずに属性だけ変更すればよいので、each() と attr() を使う形にしました。
相対パスの基準に注意する
変換後の images/sample.jpg は、その HTML を表示するページの URL を基準に解決されます。
たとえば、ページの URL が https://example.com/news/ であれば、画像は https://example.com/news/images/sample.jpg を参照します。サイトのルートを基準にしたい場合は、先頭に / を付けた /images/sample.jpg にするなど、配置に合わせた調整が必要です。
また、このコードが書き換えるのは img の src だけです。srcset や CSS 内の画像 URL は対象にしていません。
HTML 断片として出力する
Cheerio は通常、HTML を読み込む際に <html>、<head>、<body> を補います。本文の一部だけを扱いたい場合は、load() の第3引数に false を指定すると、HTML 断片として読み込めます。
const $ = cheerio.load(source, null, false)
const html = $.html()これで、追加の <html> や <body> を付けずに出力できます。[Cheerio の読み込み方法]
以前使っていたバージョンでは、日本語が数値文字参照として出力されることがあり、decodeEntities: false を指定して対処していました。Cheerio はバージョンやパーサーによって設定方法が異なるため、現在の環境では使用しているバージョンのドキュメントと出力結果を確認しておくとよさそうです。[Cheerio のパーサー設定]




Discussion