substringメソッド

広告

substringメソッドは文字列の中の指定された範囲の部分文字列を返します。 

substring(start[, end])

文字列の中から開始位置から終了位置までの部分文字列を取り出し新しい文字
列として返します。

パラメータ:
  start  開始インデックス
  end  終了インデックス
戻り値:
  指定された範囲の部分文字列

対象の文字列の開始インデックスの位置にある文字から終了インデックスの位置にある文字の前の文字までの部分文字列を新しい文字列として返します。

"Thank you"という文字列を例に考えてみます。文字列は9個の文字が含まれており各文字に対するインデックスは次の通りです。 

T   0
h   1
a   2
n   3
k   4
    5
y   6
o   7
u   8

この時、substringメソッドを使用すると次のような部分文字列を取得できます。 

substring(0, 1) --> "T"
substring(0, 2) --> "Th"
substring(0, 3) --> "Tha"
substring(0, 4) --> "Than"
substring(0, 5) --> "Thank"
substring(3, 7) --> "nk y"

substringメソッドの2番目の引数を省略した場合、開始インデックスの文字から最後の文字までの部分文字列を返します。

先ほどの文字列を対象とした場合、substringメソッドによって次のような部分文字列を取得できます。 

substring(0) --> "Thank you"
substring(6) --> "you"

substringメソッドでは1番目の引数が2番目の引数よりも大きい場合には、値を入れ替えます。 

substring(5, 0) --> "Thank"
substring(7, 3) --> "nk y"

なおsubstringメソッドでは引数に負の値を指定することはできませんので注意して下さい。(指定した場合、環境にもよるかもしれませんが負の値は0が指定されたものとして処理されます)。

注意して頂きたいのは対象となる文字列またはStringクラスのオブジェクトそのものを変化させるのではなく、新しく部分文字列を作成して返すという点です。substringメソッドを呼び出しても対象のオブジェクトそのものは変化しません。

sliceメソッドとsubstringメソッドはほぼ同じ働きをしますが、sliceメソッドはインデックスに負の値を指定することができます。またsubstringメソッドの場合は1番目の引数が2番目の引数よりも大きくても自動的に値を入れ替えて処理します。
サンプルコード

では簡単なサンプルで試してみます。 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta http-equiv="Content-Script-Type" content="text/javascript">
<title>JavaScript テスト</title>
</head>
<body>

<script type="text/javascript" src="./js/script7_1.js">
</script>

</body>
</html>

function print(str){
  document.write(str + "<br />");
}

document.write("<p>");

var str_obj = new String("Thank you");

print(str_obj);

print("substring(0, 1) --> " + str_obj.substring(0, 1));
print("substring(0, 2) --> " + str_obj.substring(0, 2));
print("substring(0, 5) --> " + str_obj.substring(0, 5));
print("substring(3, 7) --> " + str_obj.substring(3, 7));
print("substring(0) --> " + str_obj.substring(0));
print("substring(6) --> " + str_obj.substring(6));
print("substring(5, 0) --> " + str_obj.substring(5, 0));

document.write("</p>");

上記を実際にブラウザ見てみると次のように表示されます。

p7-1

( Written by Tatsuo Ikura )