どうも鶏です。WordPressをつかっていると出力されたHTMLタグをちょこっと改変したい時ってありますよね？
たとえば特定の文字列にリンクをつけたいとか。
WordPressの「wp_list_categories」で特定のカテゴリーの投稿数が1,000件以上など、カンマ付きの投稿数をa要素内に含めるにはこうやる
WordPressの「wp_list_categories」で特定のカテゴリーの投稿数が1,000件以上など、カンマ付きの投稿数をa要素内に含めるにはこうやる
「これって正規表現は必要なのかな？」って感じのことをつぶやいたら捕捉されたので、この記事が生まれました。
文字列置換の方法待ち https://t.co/ObrATClHIM
— bouya Imamura (@s56bouya) 2015, 7月 13こういう何かの文字列を置換する時にまず気をつけないといけないことがあります。それは「正規表現を使う必要があるかどうか考えること」。
正規表現で置換するのはとても便利で、条件に当てはまったものだけを置換できます。でも欠点があります。実行速度が遅いんです。とても遅い。すごく遅い。
単純に置換するのと比べると、だいたい2倍とか4倍とかそれくらいには遅い。｢坊やだからさ･･･｣のセリフで有名なシャアさんが操るザクも、正規表現をつかえばただのザクに成り下がる。
1回2回の正規表現での置換なら1/100秒程度の差くらいしかないかもしれません。
しかし文字列のサイズや回数が増えると倍々に膨れ上がり、それを何度も繰り返すことで0.5秒だとか1秒だとか3秒だとか処理が遅くなっていきます。
冒頭にあげた記事では、特定の文字列を正規表現で置換しています。
|
1 |
$categories = preg_replace('/\<\/a\> \((.*)\)/', ' <span class="count">($1)</span></a>', $categories ); |
WordPressのwp_list_categories関数で返ってきたHTMLタグを正規表現で置換するわけです。
|
1 2 3 4 5 6 7 8 |
<li class="cat-item cat-item-1"><a href="http://example.com/category/a/">カテゴリーA</a> (3,075) </li> <li class="cat-item cat-item-2"><a href="http://example.com/category/b/">カテゴリーB</a> (369) </li> <li class="cat-item cat-item-3"><a href="http://example.com/category/c/">カテゴリーC</a> </li> <li class="cat-item cat-item-4"><a href="http://example.com/category/d/">カテゴリーD</a> (11) </li> |
この文字列がこう変わる。
|
1 2 3 4 5 6 7 8 |
<li class="cat-item cat-item-1"><a href="http://example.com/category/a/">カテゴリーA <span class="count">(3,075)</span></a> </li> <li class="cat-item cat-item-2"><a href="http://example.com/category/b/">カテゴリーB <span class="count">(369)</span></a> </li> <li class="cat-item cat-item-3"><a href="http://example.com/category/c/">カテゴリーC</a> </li> <li class="cat-item cat-item-4"><a href="http://example.com/category/d/">カテゴリーD <span class="count">(11)</span></a> </li> |
ちょっと入れ替わっただけなので、正規表現をつかわなくてもできそうですよね。マッチ棒パズルみたいなものです。
正規表現を使わないでやってみる
ここでこうする。
|
1 2 |
$str3 = str_replace(array('</a> (', ') </li>'), array(' <span class="count">', '</span></a></li>'), $str); |
※標準の出力には、)の後ろに改行があるのでマッチさせるために改行を入れてます。
速度を確かめよう
果たして赤い彗星は遅くなるのだろうか？速度を確かめてみた。
今回は以下の3つのサンプルを比較する。
サンプル
サンプルA(正規表現で置換)
|
1 |
$categories = preg_replace('/\<\/a\> \((.*)\)/', ' <span class="count">($1)</span></a>', $categories ); |
サンプルB(文字列置換)
|
1 2 3 |
$categories = str_replace(array('</a> (', ') </li>'), array(' <span class="count">(', ')</span></a> </li>'), $categories); |
サンプルC(文字列置換2回)
配列を使わずstr_replaceを2回実行する。
|
1 2 3 4 |
$categories = str_replace('</a> (', ' <span class="count">(', $categories); $categories = str_replace(') </li>', ')</span></a> </li>', $categories ); |
検証方法
検証はカテゴリーが50個あるブログを仮定して行う。記事数はランダムでカテゴリーの1/3が記事を1,000件以上もつ大きなブログである。
実行してみた
実際に各コードを実行して、どれくらいの速度で実行されるか出力してみた。
実行結果まとめ
| サンプルA | サンプルB | サンプルC | |
|---|---|---|---|
| 平均速度(秒) | 0.052506104 | 0.022947021 | 0.021905762 |
| 最大速度(秒) | 0.116210938 | 0.036132813 | 0.052978516 |
| 最小速度(秒) | 0.047851563 | 0.021728516 | 0.020751953 |
カテゴリーが200個になるとより差が広がる。
| サンプルA | サンプルB | サンプルC | |
|---|---|---|---|
| 平均速度(秒) | 0.189856445 | 0.088239746 | 0.085999756 |
| 最大速度(秒) | 0.373046875 | 0.114990234 | 0.119873047 |
| 最小速度(秒) | 0.181884766 | 0.086669922 | 0.083984375 |
お分かりいただけただろうか。2倍程度の差が発生している。
分析
3つのサンプルでは、preg_replaceよりもstr_replace、そしてstr_replaceを配列をつかって1回実行するよりも、文字列を指定して2回実行した方が早いという結果になった。
カテゴリー数が50個を超えてもコンマ数秒しか差がでないが、カテゴリーの一覧が呼び出されるたびにこれだけの差が生じる。サイドバーとフッターの二箇所に表示させてるブログも多いはず。表示させる箇所の数によって倍々になっていくのでコンマ何秒の差でも侮ってはいけない。
ただし1つの条件下の速度ばかり追い求めても別の条件下では遅くなる可能性もある。
たとえばカテゴリーの一覧に記事数が表示されない場合は「置換する」という動作そのものがいらなくなる。この時は「置換しない」ことで表示速度を大きく改善できるはず。
サンプルBを改造して、置換対象の文字列が存在するか検証すれば、条件から外れた場合のムダな置換による遅延を抑えることができる(サンプルB’)。検証のための配列のループとstrpos関数は実行速度がとても早いため、サンプルBと大きく変わることはない。
サンプルB’
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// 検索する文字列 $search = array('</a> (', ') </li>'); // 置換する文字列 $replace = array(' <span class="count">(', ')</span></a> </li>'); foreach ($search as $k => $v) { // 検索する文字列が含まれているか検証 if (strpos($categories, $search[$k]) === false) { // 含まれていなければ配列から削除 unset($search[$k], $replace[$k]); } } if($search) { // 配列があれば置換を実行 $categories = str_replace($search, $replace , $categories); } |
置換対象のある時(カテゴリー200件)
| サンプルB | サンプルC | サンプルB’ | |
|---|---|---|---|
| 平均速度(秒) | 0.085987061 | 0.085662842 | 0.089227539 |
| 最大速度(秒) | 0.115966797 | 0.108886719 | 0.127929688 |
| 最小速度(秒) | 0.083740234 | 0.083740234 | 0.087890625 |
置換対象のない時(カテゴリー200件)
| サンプルB | サンプルC | サンプルB’ | |
|---|---|---|---|
| 平均速度(秒) | 0.035809326 | 0.035501221 | 0.02234082 |
| 最大速度(秒) | 0.059814453 | 0.055175781 | 0.040039063 |
| 最小速度(秒) | 0.034667969 | 0.033691406 | 0.020751953 |
所感
文字列が短いとそれほど大きな差はでませんが、いつか何KB、何MBのテキストを置換する時のためにこういうコードを書くクセをつけておきたいですね。
この記事の検証は適当なローカルのテスト環境（専有サーバー）で検証したため、実行速度の遅くなるレンタルサーバーではもっと大きな差がでてくる可能性も高い。
WordPressの場合、テンプレート内にある正規表現を見直せばブログの表示速度が秒単位で改善されるかもしれません。ぜひ確かめてみてください。
でも、安心してください。どれだけ表示が遅くなってHTMLやエラーコードすら吐いてないようにみえても、ちょっと時間を置いて見てみればちゃんと吐いてますよ。
付録
テストコード置いときます。間違ってたらごめんなさい(´・ω・｀)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
$str = ''; for($i = 0;$i < 50;++$i) { $r = rand(1,3); if($r%3 === 1) { $n = ' (' . number_format(rand(1000,9999)) . ')'; } elseif($r%3 === 2) { $n = ''; } else { $n = ' (' . number_format(rand(1,999)) . ')'; } $str .= <<<EOF <li class="cat-item cat-item-{$i}"><a href="http://example.com/category/%e6%9c%aa%e5%88%86%e9%a1%9e/">未分類</a>{$n} </li> EOF; } echo '<textarea style="width:100%;height:8em;font-size:10px;">' . htmlspecialchars($str) . '</textarea>'; echo '<h1>preg_replace</h1>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">'; for($i = 0;$i < 1000;++$i) { $s1 = microtime(true); $str1 = preg_replace('/\<\/a\> \((.*)\)/', ' <span class="count">($1)</span></a>', $str); $e1 = microtime(true); echo ($e1 * 1000) - ($s1 * 1000) . "\n"; } echo '</textarea>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">' . htmlspecialchars($str1) . '</textarea>'; echo '<h1>str_replace(置換×2)</h1>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">'; for($i = 0;$i < 1000;++$i) { $s2 = microtime(true); $str2 = str_replace('</a> (', ' <span class="count">(', $str); $str2 = str_replace(') </li>', ')</span></a> </li>', $str2); $e2 = microtime(true); echo ($e2 * 1000) - ($s2 * 1000) . "\n"; } echo '</textarea>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">' . htmlspecialchars($str2) . '</textarea>'; echo '<h1>str_replace(array)</h1>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">'; for($i = 0;$i < 1000;++$i) { $s3 = microtime(true); $str3 = str_replace(array('</a> (', ') </li>'), array(' <span class="count">(', ')</span></a> </li>'), $str); $e3 = microtime(true); echo ($e3 * 1000) - ($s3 * 1000) . "\n"; } echo '</textarea>'; echo '<textarea style="width:100%;height:8em;font-size:10px;">' . htmlspecialchars($str3) . '</textarea>'; |
何か一言あれば！！
質問とかツッコミとかお気軽にコメントしてください。がんばって返します。