RegExp

解説

リテラル記法とコンストラクター

RegExp オブジェクトを生成するには 2 通りの方法があります。「リテラル記法」と「コンストラクター」です。

• 「リテラル記法」はパターンを 2 本のスラッシュで囲み、 2 本目のスラッシュの後にオプションでフラグが続きます。
• 「コンストラクター関数」は文字列または RegExp オブジェクトを最初の引数として取り、オプションのフラグを文字列で 2 番目の引数として取ります。

以下の 3 つの式は、同じ正規表現オブジェクトを生成します。

const re = /ab+c/i; // リテラル記法
// または
const re = new RegExp("ab+c", "i"); // 最初の引数に文字列のパターンを渡したコンストラクター
// または
const re = new RegExp(/ab+c/, "i"); // 最初の引数に正規表現リテラルを渡したコンストラクター

正規表現は使用できるようになる前に、コンパイルする必要があります。この処理によって、より効率的に照合を行うことができるようになります。この処理の詳細はドットネットのドキュメントに記載されています。

リテラル記法では、正規表現が評価されるときにコンパイルが行われます。一方、RegExp オブジェクトのコンストラクターである new RegExp('ab+c') は、実行時に正規表現をコンパイルすることになります。

動的な入力から正規表現を生成する場合には、 RegExp() コンストラクターの最初の引数として、文字列を使用してください。

コンストラクターのフラグ

new RegExp(/ab+c/, flags) という式は新しい RegExp を生成しますが、第 1 引数を元として使用し、第 2 引数で指定されたフラグとして使用して生成します。

コンストラクター関数を使用する場合は、通常の文字エスケープの規則（文字列内に特殊文字が含まれるとき、前に \ を付加する）が必須です。

例えば、以下 2 つの構文は同等です。

const re = /\w+/;
// または
const re = new RegExp("\\w+");

正規表現の特殊な扱い

いくつかの組み込みメソッドは、正規表現を特別に扱います。 x が正規表現であるかどうかを複数のステップを経て判断します。

1. x はオブジェクトでなければなりません（プリミティブではない）。
2. x[Symbol.match] が undefined でない場合、これが真値であるかどうかを調べます。
3. そうではない場合、 x[Symbol.match] が undefined であれば、 x が RegExp コンストラクターで作られたかどうかを調べます。（このステップが発生するのは稀です。 x が改ざんされていない RegExp オブジェクトであれば、 Symbol.match プロパティを持つはずだからです。）

ほとんどの場合、 Symbol.match のチェックを通ることに注意してください。これはつまり、次のようなことです。

• 実際の RegExp オブジェクトの Symbol.match プロパティの値が偽値であるが undefined ではなかった場合、（exec や [Symbol.replace]() のように他のすべてがそのままでも）、正規表現ではないかのように使用することができます。
• RegExp ではないオブジェクトが Symbol.match プロパティを持っていると、正規表現であるかのように扱われます。

この選択は [Symbol.match]() が照合に使用することを意図したプロパティであることを最もよく表しているからです。（exec も使用することができますが、シンボルのプロパティではないので、誤検出が多すぎるでしょう）。正規表現を特別扱いする場所は次のとおりです。

• String.prototype.endsWith(), startsWith(), includes() では、最初の引数が正規表現の場合は TypeError が発生します。
• String.prototype.matchAll() と replaceAll() は、最初の引数が正規表現である場合、 global フラグが [Symbol.matchAll]() または [Symbol.replace]() メソッドを呼び出す前に設定されます。
• RegExp() コンストラクターは、 pattern が（他のいくつかの条件を満たして）正規表現と判断された場合、 pattern を直接返します。 pattern が正規表現である場合、 pattern を文字列に変換するのではなく、 source と flags プロパティに問い合わせることになります。

例えば、 String.prototype.endsWith() はすべての入力値を文字列へと強制しますが、引数が正規表現の場合、この関数が文字列と照合するだけのために設計されており、正規表現を使用することは開発者の間違いと考えるため、例外を発生させます。

"foobar".endsWith({ toString: () => "bar" }); // true
"foobar".endsWith(/bar/); // TypeError: First argument to String.prototype.endsWith must not be a regular expression

このチェックを回避するには、 [Symbol.match] に undefined ではない偽値を設定してください。この場合、正規表現は String.prototype.match() には使用できませんが（[Symbol.match] がなければ match() は re.toString() で追加したスラッシュ 2 本を持つ新しい RegExp オブジェクトを構築するので）、事実上他のすべてに使用することが可能です。

const re = /bar/g;
re[Symbol.match] = false;
"/bar/g".endsWith(re); // true
re.exec("bar"); // [ 'bar', index: 0, input: 'bar', groups: undefined ]
"bar & bar".replace(re, "foo"); // 'foo & foo'

Perl 風の RegExp プロパティ

RegExp のプロパティのいくつかは長い名前と短い（Perl 風の）名前があります。どちらの名前も同じ値を参照します。（Perl は JavaScript が正規表現をモデルにしたプログラミング言語です。）非推奨の RegExp のプロパティも参照してください。

コンストラクター

RegExp()

新しい RegExp オブジェクトを生成します。

静的プロパティ

RegExp.$1, …, RegExp.$9

読み取り専用の静的プロパティで、括弧で囲まれた一致した部分文字列を格納します。

RegExp.input ($_)

静的プロパティで、正規表現が正常に一致した最後の文字列を格納します。

RegExp.lastMatch ($&)

読み取り専用の静的プロパティで、最後に一致した部分文字列を格納します。

RegExp.lastParen ($+)

読み取り専用の静的プロパティで、最後の括弧で囲まれた部分文字列の一致を格納します。

RegExp.leftContext ($`)

読み取り専用の静的プロパティで、最近一致した文字列の前の部分文字列を格納します。

RegExp.rightContext ($')

読み取り専用の静的プロパティで、最近一致した文字列以下の部分文字列を格納します。

RegExp[Symbol.species]

派生オブジェクトを生成するために使用されるコンストラクター関数です。

静的メソッド

RegExp.escape()

文字列内の潜在的な正規表現構文文字をエスケープし、リテラルパターンとして RegExp() コンストラクターで安全に使用できる新しい文字列を返します。

インスタンスプロパティ

これらのプロパティは RegExp.prototype で定義されており、すべての RegExp インスタンスで共有されます。

RegExp.prototype.constructor

このインスタンスオブジェクトを作成したコンストラクター関数。 RegExp インスタンスの場合、初期値は RegExp コンストラクターです。

RegExp.prototype.dotAll

. を改行文字に一致させるかどうかのフラグです。

RegExp.prototype.flags

RegExp オブジェクトのフラグから成る文字列です。

RegExp.prototype.global

対象文字列で一致する可能性があるすべてのものに対して正規表現を検査するか、それとも、最初に一致するものに対してのみ検査するどうかのフラグです。

RegExp.prototype.hasIndices

正規表現の結果で、キャプチャした部分文字列の先頭と末尾の位置を出力するかどうかのフラグです。

RegExp.prototype.ignoreCase

文字列を照合する際に、大文字と小文字の違いを無視するかどうかのフラグです。

RegExp.prototype.multiline

複数行に渡って文字列を検索するかどうかのフラグです。

RegExp.prototype.source

パターンのテキストです。

RegExp.prototype.sticky

検索が先頭固定 (sticky) であるかどうかのフラグです。

RegExp.prototype.unicode

Unicode 機能が有効かどうかのフラグです。

RegExp.prototype.unicodeSets

u モードへのアップグレードである v フラグが有効かどうか。

これらのプロパティは各 RegExp インスタンスの自分自身で持つプロパティです。

lastIndex

次の照合を開始する位置です。

インスタンスメソッド

RegExp.prototype.compile()

スクリプトの実行中に正規表現を (再) コンパイルします。

RegExp.prototype.exec()

文字列引数の中で一致するものを検索します。

RegExp.prototype.test()

文字列引数で一致するものがあるかどうか検査します。

RegExp.prototype.toString()

指定されたオブジェクトを表す文字列を返します。 Object.prototype.toString() メソッドを上書きします。

RegExp.prototype[Symbol.match]()

指定された文字列と照合を実行し、照合結果を返します。

RegExp.prototype[Symbol.matchAll]()

文字列で正規表現に一致するものをすべて返します。

RegExp.prototype[Symbol.replace]()

指定された文字列で一致する部分を新しい部分文字列で置き換えます。

RegExp.prototype[Symbol.search]()

指定された文字列で一致する部分を検索し、その文字列で見つかったパターンの位置を返します。

RegExp.prototype[Symbol.split]()

文字列を部分文字列に分割し、指定された文字列を配列に分割します。

例

正規表現を使用したデータ形式の変更

以下のスクリプトは、 String.prototype.replace() メソッドを使用して、 名 姓 の形式の名前で照合し、姓, 名 の形式で出力します。

スクリプトでは、置換テキスト中で $1 と $2 を使用して、それぞれ対応する正規表現パターンで一致する括弧がキャプチャした結果を指定しています。

const re = /(\w+)\s(\w+)/;
const str = "Maria Cruz";
const newStr = str.replace(re, "$2, $1");
console.log(newStr);

これは、 "Cruz, Maria" と表示します。

正規表現を使用したさまざまな行末/行の終端/改行での行の分割

既定の改行文字は、プラットフォーム (Unix、Windows など) によって異なります。この例で実行する行分割は、あらゆるプラットフォームで動作します。

const text = "Some text\nAnd some more\r\nAnd yet\nThis is the end";
const lines = text.split(/\r?\n/);
console.log(lines); // [ 'Some text', 'And some more', 'And yet', 'This is the end' ]

正規表現内のパターンの順序が重要であることに注意してください。

複数行で正規表現を使用する

デフォルトでは、. 文字は改行に一致しません。改行に一致させるには、s フラグ（dotAll モード）を使用します。

const s = "Please yes\nmake my day!";

s.match(/yes.*day/);
// null を返す

s.match(/yes.*day/s);
// Returns ["yes\nmake my day"]

sticky フラグ付きの正規表現の使用

sticky フラグは、正規表現の sticky 照合を実行することを示しており、対象文字列で RegExp.prototype.lastIndex の位置から照合を試みます。

const str = "#foo#";
const regex = /foo/y;

regex.lastIndex = 1;
regex.test(str); // true
regex.lastIndex = 5;
regex.test(str); // false (sticky フラグがあるので lastIndex から始める)
regex.lastIndex; // 0 (照合に失敗した後はリセット)

sticky フラグと global フラグの違い

sticky フラグ y を付けると、次の照合は lastIndex の位置で行われるのに対し、 global フラグ g を付けると、検索は lastIndex の位置から始められます。

const re = /\d/y;
let r;
while ((r = re.exec("123 456"))) {
  console.log(r, "AND re.lastIndex", re.lastIndex);
}

// [ '1', index: 0, input: '123 456', groups: undefined ] AND re.lastIndex 1
// [ '2', index: 1, input: '123 456', groups: undefined ] AND re.lastIndex 2
// [ '3', index: 2, input: '123 456', groups: undefined ] AND re.lastIndex 3
//   ... あとは一致しない

global フラグ g を付けると、 3 桁だけでなく、 6 桁すべてに一致します。

正規表現と Unicode 文字

上の表にもある通り、\w や \W は ASCII 基本文字にのみ一致します。具体的には a から z 、A から Z 、 0 から 9 および _ です。

キリル語やヘブライ語で使われるような非 ASCII 文字と照合するには \uHHHH 形式（HHHH の部分は 16 進表記の Unicode 値）を使ってください。

この例は、文字列全体から Unicode 文字列だけを抜き出す方法を示しています。

const text = "Образец text на русском языке";
const regex = /[\u0400-\u04ff]+/g;

const match = regex.exec(text);
console.log(match[0]); // 'Образец'
console.log(regex.lastIndex); // 7

const match2 = regex.exec(text);
console.log(match2[0]); // 'на' ('text' は出力しない)
console.log(regex.lastIndex); // 15

// 以下同様

Unicode プロパティエスケープ機能は \p{scx=Cyrl} （すべてのキリル文字に一致）または \p{L}/u （すべての言語の文字に一致）のようにより簡潔な表記ができるようにする解決策を導入しています。

URL からのサブドメイン名の抽出

const url = "http://xxx.domain.com";
console.log(/^https?:\/\/(.+?)\./.exec(url)[1]); // 'xxx'

動的な入力からの正規表現の構築

const breakfasts = ["bacon", "eggs", "oatmeal", "toast", "cereal"];
const order = "Let me get some bacon and eggs, please";

order.match(new RegExp(`\\b(${breakfasts.join("|")})\\b`, "g"));
// ['bacon', 'eggs'] を返す

仕様書

ブラウザーの互換性

Firefox 固有の注意事項

Firefox 34 より、量指定子を伴うキャプチャグループが動作を妨げている場合に、キャプチャグループに一致するテキストは空文字列ではなく undefined になりました。

// Firefox 33 以前
"x".replace(/x(.)?/g, (m, group) => {
  console.log(`group: ${JSON.stringify(group)}`);
});
// group: ""

// Firefox 34 以降
"x".replace(/x(.)?/g, (m, group) => {
  console.log(`group: ${group}`);
});
// group: undefined

ウェブの互換性のため RegExp.$N は引き続き、 undefined ではなく空文字列を返します (バグ 1053944)。

関連情報

• RegExp の新しい機能の多くのポリフィル (dotAll、sticky フラグ、名前付きキャプチャグループ、など (core-js) で利用できます。
• 正規表現ガイド
• 正規表現
• String.prototype.match()
• String.prototype.replace()
• String.prototype.split()