JavaScript PHP 正規表現を使用した文字列置換でが何を指しているかわからなかったので調べて簡単にまとめる

# 目的

- JavaScriptとPHPの文字列置換でどうして$1にヒットした文字列が入っているのかわからなかったので調べてみた

# 前提情報

- JavaScriptは下記の方法で確認した
    - [JavaScript 正規表現をchromeの検証モードで確認する](https://qiita.com/miriwo/items/b874f9cc27fa44451769)
- PHPは下記のサイトで確認した。
    - [https://paiza.io/ja](https://paiza.io/ja)
- 下記の内容を実装中に$1になぜヒット内容が入っているか気になった。（本来良くないことだが$1にすればヒットした内容が格納されているということを一つ覚えで実装してしまった。）
    - [Vue.js 表示文字列にURLが含まれていたときにリンク化する](https://qiita.com/miriwo/items/1c70ba9ed43595608a93)

# 確認

1. Chromeの検証モードのコンソールでで下記を実行してみる。

    ```JavaScript
    /(https?:\/\/[^\s]*)/g.exec('https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```
1. 下記の出力が得られた。

    画像

1. キー0とキー1にヒットした文字列「https://qiita.com/miriwo」が格納されている。
1. 正規表現部分を下記のように修正して実行してみる。

    ```JavaScript
    /https?:\/\/[^\s]*/g.exec('https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```
1. 下記の出力が得られた。

    ![v-html_-_Google_検索.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/306417/7fe80d0d-8a5c-0dcc-0d78-72c4dcb82b14.png)

1. キー0にのみヒットした文字列`https://qiita.com/miriwo`が格納されている。
1. どうやら$1などは正規表現部分のいくつめの括弧でマッチしたものかを表しているようである。
1. 下記のリンクの「引数としての文字列指定」の「$n」の記載にそれっぽいことが書かれている。
    - [https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/replace](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/replace)

        |パターン|挿入|
        |---|---|
        |$n|n は 100 未満の正の整数です。第一引数が RegExp オブジェクトだった場合に n 番目の括弧でキャプチャされた文字列を挿入します。1, 2, ... でインデックスされることに注意してください。|

1. $2を作り出すために意図的に下記を実行してみる。ドキュメントの記載どおりなら$2はキーとしては存在するが、検索条件を指定していないので何も値が格納されないはずである。

    ```JavaScript
    /(https?:\/\/[^\s]*)()/g.exec('https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```

1. 予想通り下記のように出力された$2はキーとして存在しているが値は格納されていない。

    ![v-html_-_Google_検索-2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/306417/0fbdafcd-ccba-978f-0bc5-e83782fe1770.png)

1. では$0は何を指しているのかを確認するために下記を実行してみた

    ```JavaScript
    /(https?)(:\/\/[^\s]*)/g.exec('https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```
1. 下記のような出力が得られた。下記の結果から$0は括弧に関係なく正規表現部分全体でヒットした文字列が格納されているものであると言える。

    ![v-html_-_Google_検索-3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/306417/cf2e6ac2-cc1e-3b4f-09c1-9981a74c17e0.png)

1. 個人のブログではあるがまとめてくださっている方がいた。「$0 は正規表現にマッチした文字列全体を表し、$1, $2, $3 は、それぞれ１番目、２番目、３番目の左括弧で囲まれた部分のパターンに一致した部分文字列を表します。」と書かれているのでおそらく自分の見解は間違えていないように思える。
    - [https://maku77.github.io/java/numstr/string-replace-all.html](https://maku77.github.io/java/numstr/string-replace-all.html)

# 付録

1. 自分がよく使うPHPでは正規表現を使った置換はどのように行われるのかが気になったので公式ドキュメントを呼んでみた。
1. PHPで正規表現を用いた文字列置換を行うときは`preg_replace()`メソッドを使用するようである。
1. 下記のように当該メソッドを使用する。

    ```php
    preg_replace(検索条件文字列, 置換後の文字列, 置換対象文字列);
    ```
1. 「検索条件文字列」は正規表現を用いて記載するものでありJavaScriptと同じようにデリミタでくくって記載する。
1. そして検索にヒットしたものが入ってくるキーも$0や$1などJavaScriptと一緒のようだった。公式ドキュメントのリンクを下記に記載し抜粋したもの載せる。（PHPのドキュメントのほうがわかりやすく書いてくれている気がした。先にこっちを読めばよかった。）
    - [https://www.php.net/manual/ja/function.preg-replace.php](https://www.php.net/manual/ja/function.preg-replace.php)

        >replacement では、 \n 形式または $n 形式で参照を指定することができます。 後者の形式の方が好ましい形式です。各参照は、n 番目のキャプチャ用サブパターンにマッチしたテキストにより置換されます。 n は 0 から 99 までとすることができ、 \0 または $0 は パターン全体にマッチするテキストを参照します。キャプチャ用サブパターンの番号 については、その左括弧が左から右に（1から）カウントされます。 string に含まれるバックスラッシュリテラルは、エスケープが必須であることに注意して下さい。
1. 試しに下記を実行してURL部分が検索にヒットするか確認してみた。

    ```php
    echo preg_replace('/(https?:\/\/[^\s]*)/', '<a href="$1">$1</a>', 'https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```
1. 下記のように出力されたので問題無く置換できているようである。

    ```terminal
    <a href="https://qiita.com/miriwo">https://qiita.com/miriwo</a> は筆者のQiitaのホームです
    ```
1. ヒットした文字列が格納されているキーがJavaScriptのものと同じであるのか確認してみる。下記を正規表現部分と置換後の文字列をいじって下記を実行してみる。

    ```php
    echo preg_replace('/(https?)(:\/\/[^\s]*)()/', '$0 - $1 - $2 - $3  ', 'https://qiita.com/miriwo は筆者のQiitaのホームです');
    ```
1. 下記のように出力された。1つ目のハイフンまでが$0であり、すべての正規表現にヒットしたのでURLがフルで表示されている。1つ目から2つ目のハイフンまでが$1であり1つ目の括弧のヒット部分が表示されている。2つ目から3つ目のハイフンまでが$2であり2つ目の括弧のヒット部分が表示されている。最後のハイフンのあとは$3であり3つ目の括弧のヒット部分が表示されるが括弧の中に何も記載されておらず何もヒットしていないので何も出力されていない。

    ```terminal
    https://qiita.com/miriwo - https - ://qiita.com/miriwo -    は筆者のQiitaのホームです
    ```

# まとめ

- JavaScriptでもPHPでも正規表現を使った文字列置換の$1とか$2とかは左から数えた正規表現の括弧の数にリンクしており、それぞれ$1には1つ目の括弧の正規表現にヒットした文字列が、$2には2つ目の括弧の正規表現にヒットした文字列が格納れている。$0だけは少し特殊で括弧に関係なくデリミタで区切られた正規表現すべてを通してヒットした文字列が格納される。