JavaでreplaceFirstメソッドを使って最初に該当した文字列を置換する方法を現役エンジニアが解説【初心者向け】

初心者向けにJavaでreplaceFirstメソッドを使って最初に該当した文字列を置換する方法について解説しています。replaceFirstは指定した条件で最初に該当した文字列を置き換えることができるメソッドです。正規表現と組み合わせた使い方について、実際の例で見てみましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

JavaでreplaceFirstメソッドを使って最初に該当した文字列を置換する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

Javaについてそもそもよく分からないという方は、Javaとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Java講座の内容をもとに作成しています。

 

田島悠介

今回は、Javaに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

replaceFirstメソッドを使って最初に該当した文字列を置換する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

replaceFirstメソッドとは

文字列を正規表現で検索し、最初にHITした1件だけ置換するためのメソッドです。

replaceFirstを利用するメリット

replaceFirstと似た機能をもつメソッドとしてreplaceAllがあります。replaceAllは全件検索して一括置換が可能ですが、詳細が不明になってしまいます。

一方で、replaceFirstは、検索してHITした1件ごとに処理が実施できるため、HIT件数をカウントできたり、if文による条件分岐を使ったより詳細なプログラミングをしながら置換処理を実行することができます。

replaceFirstを使うケース

このような場合は、replaceFirstを使うと便利です。

  • 置換件数を把握したい時
  • 1回の置換を実行する度にログ出力をしたい時

replaceFirstメソッドの使い方

replaceFirstは、Stringクラスに実装済みのメソッドとして使うことができます。replaceFirstメソッドの使い方は、以下の通りです。

String sampleStr = "ABC"
String replacedStr = sampleStr.replaceFirst("正規表現”、"置換後の文字列")

 

[PR] Javaで挫折しない学習方法を動画で公開中

最初に該当した文字列を置換する方法

テキストエディタで置換処理をする場合とほぼ同じ感覚で置換が可能です。例えば、以下のサンプルプログラムでは、最初に検索条件の「OK」にヒットした箇所を「#」に置換することができます。

public static void main(String[] args) {
  String target1 = "OK1234NG567OK89";
  String afterStr = target1.replaceFirst( "OK", "#" );
  System.out.println( "replaceFirstしました:" + afterStr );
}

実行結果

replaceFirstしました:#1234NG567OK89

上記サンプルでは「OK」という文字列を検索条件に指定しましたが、これは正規表現として扱われます。正規表現については、replaceAllの記事で解説しています。一括置換したい場合も、こちらの記事をご覧ください。

 

実際に書いてみよう

replaceFirstは最初にHITした文字列だけ置換しますが、for文で繰り返し実行することで件数をカウントしながら一括置換をすることもできます。今回は、以下の例文の余計な半角スペースを置換回数をカウントしながら一括置換するプログラムを書いてみましょう。

“Regular    Expression   is very   useful!”

サンプルプログラム

public class ReplaceFirstSample {

  public static void main(String[] args) {
    // 半角スペースが多すぎる例文(置換処理対象)
    String target = "Regular    Expression    is very    useful!" ;
    // 半角スペースが2つ以上連続している場合を検出する正規表現
    String regex = "[ ] {2,}+" ;
 
    int mutchCount = 0;
    for( int i=0 ; i < 100 ; i++ ) {
      // 半角スペースが2つ以上並んでいるケースを半角スペース1つだけに置換する
      target = target.replaceFirst( regex, " " ); // replaceFirst メソッドの実行
      mutchCount = mutchCount + 1 ;
      // 途中経過をコンソールに表示
      System.out.println( mutchCount + "回目HITしました。置換後文字列:" + target );
 
      if( !Pattern.compile(regex).matcher(target).find() ) {
        // 全て置換し終わって target が正規表現にHITしなくなったら処理終了
        break ;
      }
    }
    System.out.println( " === 処理結果 === " );
    System.out.println( " リプレイス回数: " + mutchCount + " 回" );
    System.out.println( " 置換処理後の最終的なテキストは ");
    System.out.println( target + " です。");
  }
}

実行結果

1回目HITしました。置換後文字列:Regular Expression is very useful!
2回目HITしました。置換後文字列:Regular Expression is very useful!
3回目HITしました。置換後文字列:Regular Expression is very useful!
=== 処理結果 ===
リプレイス回数: 3 回
置換処理後の最終的なテキストは
Regular Expression is very useful! です。

 

まとめ

replaceFirstメソッドを使うことで、1件の検索・置換を実行することができます。また、for文と組み合わせて使うことで件数をカウントしながらの一括置換も可能です。

 

監修してくれたメンター

寺谷文宏

WEBアプリケーションエンジニアとして数多くのプロジェクトを経験し、フロントエンドからサーバーサイドまで総合的な開発を得意としています。

TechAchademyではフロントエンド、Javaコースを担当。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

TechAcademyでは、初心者でも最短4週間で、JavaやServletの技術を使ってWebアプリケーション開発を習得できる、オンラインブートキャンプを開催しています。

 

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。