Java道｜文字列を追加できるStringBufferの使い方

Java道｜文字列を追加できるStringBufferの使い方

文字列は、読むだけでなく組み立てることもできる。
StringBufferを使えば、言葉を後ろへつなぎ足しながら、ひとつの文章を作れるようになる。

Javaで文字列を扱うとき、まずよく使うのは String クラスです。

String クラスを使うと、文字数を調べたり、指定位置の文字を取り出したり、文字列の中から文字を探したりできます。これまで学んできた length()、charAt()、indexOf()、toUpperCase()、toLowerCase() なども、String クラスの便利なメソッドでした。

ただし、String には大切な特徴があります。

それは、一度作った文字列の中身を直接変更できないという点です。

たとえば、ある文字列の後ろに別の文字列を追加したいときや、途中に文字を差し込みたいとき、一部を別の文字に置き換えたいときがあります。こうした「あとから文字列を編集したい」場面では、String だけだと少し扱いにくく感じることがあります。

そこで役立つのが、StringBuffer クラスです。

StringBuffer は、作ったあとで中身を変えながら扱える文字列用のクラスです。文字列の後ろに追加したり、途中に差し込んだり、一部を置き換えたり、削除したりできます。

鬼滅の刃でたとえると、String は「完成済みの任務巻物」です。一度書かれた内容を直接書き換えるというより、必要なら新しい写しを作るイメージです。
一方、StringBuffer は「追記できる任務巻物」です。任務の途中で、新しい情報を後ろに書き足したり、必要に応じて内容を編集したりできます。

この違いを理解すると、文字列をただ表示するだけでなく、少しずつ組み立てていく処理が書きやすくなります。

StringクラスとStringBufferクラスの違い

まずは、String と StringBuffer の違いを整理しましょう。

どちらも文字列を扱うためのクラスですが、性質が違います。

String は、固定された文字列を扱うのが得意です。

たとえば、隊士の名前、合言葉、表示メッセージのように、すでに決まっている文字列を扱うときに便利です。

一方で、StringBuffer は、あとから文字を追加したり、内容を変えたりしながら文字列を作りたいときに便利です。

たとえば、最初に「任務」と書いておき、あとから「開始」「完了」「報告済み」などを順番に追加していくような場面です。

鬼滅の刃でたとえると、String は清書された巻物です。
StringBuffer は、任務の進行に合わせて追記できる作戦記録帳です。

なぜStringBufferが必要なのか

文字列を扱うプログラムでは、あとから内容を変えたい場面がよくあります。

たとえば、次のような処理です。

String でも文字列の連結はできます。
ただ、文字列を何度も追加したり、途中を編集したりする処理では、StringBuffer を使うと「中身を編集している」という意図が分かりやすくなります。

鬼滅の刃でたとえると、任務の巻物に情報がどんどん追加されていく場面です。

最初は「藤の森」とだけ書かれていた巻物に、あとから「へ向かう」「夜明け前に集合」「合図を確認」と追記していくような流れです。

このように、文字列を少しずつ組み立てたり、あとから直したりしたいときに、StringBuffer が役立ちます。

StringBufferオブジェクトを作る

StringBuffer を使うには、まず StringBuffer オブジェクトを作ります。

基本の形は次のようになります。

StringBuffer sb = new StringBuffer("こんにちは");

このコードでは、こんにちは という文字列をもとにして、StringBuffer 型のオブジェクト sb を作っています。

String では、次のように文字列リテラルで簡単に作ることが多かったです。

String str = "こんにちは";

一方、StringBuffer はオブジェクトとして作るため、new StringBuffer(...) の形を使います。

鬼滅の刃でたとえると、StringBuffer sb = new StringBuffer("こんにちは"); は、こんにちは と最初に書かれた追記可能な巻物を1つ用意するようなものです。

この sb に対して、あとから append() などのメソッドを使って文字列を追加していきます。

append()メソッドで文字列を追加する

StringBuffer で最初に覚えたいメソッドが append() です。

append() は、現在の文字列の末尾に、新しい文字や文字列を追加するメソッドです。

基本の形は次のようになります。

sb.append("追加したい文字列");

たとえば、sb の中身が おはよう のときに、ございます を追加すると、結果は おはようございます になります。

append() は「末尾に追加する」と覚えると分かりやすいです。

鬼滅の刃でたとえると、巻物の最後に新しい任務文を追記する技です。
すでに書かれている内容の後ろに、次の言葉を自然につなぎ足します。

StringBuffer と append() の動きを確認する

実際のプログラムで、StringBuffer と append() の動きを確認してみましょう。

ファイル名：Sample4.java

import java.io.*;

class Sample4
{
    public static void main(String[] args) throws IOException
    {
        // キーボード入力の準備をする
        BufferedReader br =
            new BufferedReader(new InputStreamReader(System.in));

        // 元になる文字列を入力してもらう
        System.out.println("最初の任務文を入力してください。");
        String str1 = br.readLine();

        // 追加する文字列を入力してもらう
        System.out.println("続けて追加する任務文を入力してください。");
        String str2 = br.readLine();

        // StringBufferオブジェクトを作成する
        StringBuffer sb = new StringBuffer(str1);

        // 文字列を追加する
        sb.append(str2);

        // 結果を表示する
        System.out.println("つなげた結果は「" + sb + "」です。");
    }
}

このプログラムでは、まず最初の文字列を入力します。
そのあとで、追加したい文字列を入力します。

そして、StringBuffer を作り、append() を使って2つ目の文字列を後ろにつなげています。

たとえば、次のように入力したとします。

最初の任務文を入力してください。
おはよう
続けて追加する任務文を入力してください。
ございます

表示結果は次のようになります。

つなげた結果は「おはようございます」です。

鬼滅の刃でたとえると、最初の巻物に おはよう と書き、その後ろへ ございます を追記して、ひとつの文として完成させている流れです。

プログラムの流れを順番に見る

Sample4.java の処理を順番に整理すると、次のようになります。

ここで大切なのは、append() が sb の内容を変化させているという点です。

StringBuffer sb = new StringBuffer(str1);
sb.append(str2);

最初に sb は str1 の内容を持っています。
そのあと、append(str2) によって、sb の後ろに str2 が追加されます。

鬼滅の刃でたとえると、最初の任務巻物を作り、その巻物の末尾へ追加の任務文を書き足しているイメージです。

append()は同じStringBufferの内容を変えていく

append() のポイントは、StringBuffer オブジェクトの中身を変えていくところです。

String のメソッドでは、変換結果として新しい String が返されるという考え方がよく出てきました。

たとえば、toUpperCase() は元の文字列を直接変えるのではなく、新しい文字列を返しました。

一方、StringBuffer の append() は、sb の中に文字列を追加して、sb 自体の内容を変化させます。

たとえば、次のように続けて append() を呼ぶこともできます。

StringBuffer sb = new StringBuffer("全集中");
sb.append("の");
sb.append("呼吸");

この場合、最終的な内容は 全集中の呼吸 になります。

鬼滅の刃でたとえると、巻物に 全集中 と書き、後ろに の、さらに 呼吸 と追記して、ひとつの言葉を完成させるようなものです。

Stringは変更できない、StringBufferは変更できる

ここは特に大切なところです。

String と StringBuffer は、どちらも文字列に関係するクラスですが、文字列の扱い方が違います。

String は、作ったあとに中身そのものを直接変えるものではありません。
文字列を変換したいときは、新しい文字列を受け取る形になります。

StringBuffer は、同じオブジェクトの中身を変えていけます。
そのため、文字列を少しずつ追加したり、編集したりする処理に向いています。

鬼滅の刃でたとえると、String は完成した報告書です。
StringBuffer は任務中に追記していく作戦記録帳です。

どちらが優れているというより、使いどころが違います。

図：append()で文字列を後ろへ追加する

↓クリックすると拡大表示されます。

この図が示していること

この図では、StringBuffer の append() によって、元の文字列 おはよう の後ろに ございます が追加される流れを表しています。

左側の巻物には、最初に おはよう と書かれています。
中央の sb.append("ございます") によって、文字列の末尾に ございます が追加されます。
右側では、結果として おはようございます という1つの文字列になっています。

ここから分かるのは、append() は文字列の途中ではなく、末尾に内容を追加するメソッドだということです。
また、StringBuffer は追記できる巻物のように、同じオブジェクトの内容を変えながら文字列を組み立てられることも分かります。

StringBufferクラスの主なメソッド

StringBuffer には、append() 以外にも、文字列編集に便利なメソッドが用意されています。

この表を見ると、StringBuffer が文字列編集の道具箱のようなクラスだと分かります。

append() はその中でも、最初に覚えやすく、よく使う基本メソッドです。

append()以外の活用イメージ

StringBuffer は、append() だけのクラスではありません。

文字列を編集したい場面に合わせて、さまざまなメソッドを使えます。

鬼滅の刃でたとえると、StringBuffer は任務巻物の編集道具です。

後ろに追記する。
途中に差し込む。
不要な文字を消す。
一部を書き換える。
順序を逆にする。

こうした編集作業を、ひとつのクラスで扱えるようになります。

toString()が必要になる場面

StringBuffer で編集した内容を、最後に String 型として扱いたいことがあります。

そのようなときに使うのが toString() です。

String result = sb.toString();

このコードでは、StringBuffer の中身を String 型の文字列として取り出し、result に入れています。

画面表示では、次のように sb をそのまま使っても、内容が文字列として表示されます。

System.out.println("つなげた結果は「" + sb + "」です。");

ただし、String 型の変数に入れたいときや、String を受け取るメソッドに渡したいときは、toString() を使うと分かりやすいです。

鬼滅の刃でたとえると、StringBuffer は追記・編集できる作戦記録帳です。
toString() は、その編集済みの記録帳を、完成した清書の巻物として取り出すようなものです。

図：StringBufferは編集してからStringにできる

↓クリックすると拡大表示されます。

この図が示していること

この図では、StringBuffer を使って文字列を編集し、最後に toString() で String 型として取り出す流れを表しています。

最初に new StringBuffer("全集中") で、編集できる文字列を用意します。
そこに append("の")、append("呼吸") を使って、全集中の呼吸 という文字列を組み立てます。

そのあと、sb.toString() を使うことで、編集済みの内容を String 型として取り出せます。

ここから分かるのは、文字列を編集しながら作る段階では StringBuffer が便利で、完成した文字列として扱いたい段階では toString() を使うとよいということです。

実務や学習でどう役立つのか

StringBuffer は、文字列を少しずつ組み立てたいときに役立ちます。

鬼滅の刃でたとえると、任務の進行に合わせて報告書を追記していくような場面です。

最初に任務名を書きます。
次に集合場所を追加します。
さらに合図や注意事項を書き足します。
最後に完成した報告文として取り出します。

このように、文字列を一度に完成させるのではなく、順番に作っていく処理で StringBuffer は便利です。

StringBufferを使うときの注意点

StringBuffer を使うときは、次の点を意識しておくと分かりやすいです。

特に大切なのは、String と StringBuffer を混同しないことです。

String は、固定された文字列を扱う基本クラスです。
StringBuffer は、編集しながら文字列を作るためのクラスです。

また、append() は「後ろに追加する」メソッドです。
途中に入れたい場合は insert() を使います。

鬼滅の刃でたとえると、append() は巻物の最後に書き足す技です。
途中へ差し込みたい場合は、別の技である insert() を使う、というイメージです。

StringBufferを理解すると文字列処理が広がる

StringBuffer を理解すると、文字列は「ただ表示するもの」ではなく、「あとから組み立てたり編集したりできるもの」として見えてきます。

String で文字列を調べる。
StringBuffer で文字列を追加・編集する。
必要に応じて toString() で String に戻す。

この流れが分かると、文字列処理の幅が広がります。

鬼滅の刃でたとえると、String は完成した巻物を読む技です。
StringBuffer は巻物を作りながら追記していく技です。

文字列を調べる力に、文字列を組み立てる力が加わると、Javaで表現できる処理はぐっと広がります。

append() は、その入口になるとても分かりやすいメソッドです。
まずは「StringBuffer は編集できる文字列」「append() は末尾に追加する」と押さえておくと、この先の insert()、replace()、deleteCharAt() などの理解にもつながります。