JavaのStringUtilsで空白入力を確かめるイラスト。null・空文字・半角空白・全角空白を虫眼鏡で調べ、isBlankとisEmptyの使い分けを示す。

実装・エラー解決

JavaのStringUtils.isBlankとisEmptyの違い|null・空文字・空白を判定

この記事でわかること

空白だけの入力も未入力ならisBlank、nullと空文字だけならisEmpty。Apache Commons Langの7入力の結果を見て、標準String・Springの同名クラスとの違いと、依存を追加する判断まで確認します。

StringUtils.isBlank()とisEmpty()の違いは、空白だけの文字列を未入力に含めるかです。Apache Commons Langではどちらもnullを受け取れますが、Java標準のStringへ同じ感覚でメソッドを呼ぶと例外になります。

例えば、表示名は空白だけなら未入力とし、CSVの備考は空文字のときだけ既定値に替える。この2つへ同じ判定を使うと、表示名の空白を見逃したり、残すはずの備考を消したりします。この記事では、何を未入力とする仕様なのかからAPIを選び、同じ7入力をコードとテストで照合します。

実装・Main・43テストを全文で取得する

JDK 17とMaven 3.9系。Commons Lang 3.22.0を固定し、未入力判定・7入力の比較表示・標準だけの別案・比較テスト・POM・READMEを同梱します。ZIPを展開したフォルダーでmvn clean test、続けてmvn -q exec:javaを実行できます。

表示名の未入力はisBlank、空の備考の補完はisEmptyで判定する

今回の2つの仕様を先に固定します。表示名は、null・空文字・Javaが空白と判定する文字だけの値を「未入力」に分類します。備考は、nullと空文字だけを(未設定)に替え、入力されている文字列は空白も削らず残します。

まず、Java標準のStringへnullのまま呼び出すと、判定結果を得る前にNullPointerExceptionです。次は不具合を起こす2行の抜粋です。配布テストのjdkPredicatesRejectNullAndClassifyOtherInputsでも、実際にこの例外を検証しています。

String name = null;
boolean missing = name.isBlank();

Commons Langを既に使っている場合の修正例が、次のInputPolicy.javaです。これは配布ソースの全文で、表示名と備考の処理を分けています。

package info.syachiku.samples.stringutils;

import org.apache.commons.lang3.StringUtils;

public final class InputPolicy {
    private InputPolicy() { }

    public static boolean isDisplayNameMissing(String name) {
        return StringUtils.isBlank(name);
    }

    public static String memoOrDefault(String memo) {
        return StringUtils.isEmpty(memo) ? "(未設定)" : memo;
    }
}

isDisplayNameMissing(null)とisDisplayNameMissing(" ")はtrueです。一方、memoOrDefault(" ")は半角スペースを残します。備考にもisBlank()を使うと、要件では残すはずの空白だけの入力まで既定値へ置き換わります。

表示名のメソッドが答えるのは、この仕様で「未入力か」だけです。使える文字種や最大文字数まで検証したわけではなく、falseだから保存してよい名前だ、という最終的な許可判定にはしません。全角空白とNBSPの違いも、後の表で確認します。

依存関係とimportをApache Commons Langへ揃える

この記事のStringUtilsはorg.apache.commons.lang3.StringUtilsです。java.lang.Stringに含まれるクラスではないため、比較サンプルのpom.xmlには次の依存を入れています。検証した版を3.22.0に固定し、再実行時に別の版へ変わらないようにしました。

    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.22.0</version>
    </dependency>

importは、最初のInputPolicy.javaにあるimport org.apache.commons.lang3.StringUtils;です。IDEが同名クラスを提案したときは、StringUtilsという短い名前だけで決めず、パッケージまで見ます。org.springframework.util.StringUtilsを選ぶと、同じメソッドが使えるとは限りません。

既存案件では、そのプロジェクトが管理している依存と版を先に確認します。今回のサンプルのように新しく追加する方法を示すことと、実装のたびにライブラリを増やす判断は別です。Java 17だけで同じ要件を満たす例も後で示します。

配布POMには、比較テストのためJUnit 5.12.2とSpring Core 6.2.19もあります。Springはtestスコープで、MainやCommons版の実装を動かすための依存ではありません。Springアプリを起動するサンプルでもありません。

pom.xmlの全文を見る
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>info.syachiku.samples</groupId>
  <artifactId>stringutils-blank</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.22.0</version>
    </dependency>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>5.12.2</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>6.2.19</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-clean-plugin</artifactId>
        <version>3.4.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.3.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.14.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.5.6</version>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>3.6.3</version>
        <configuration>
          <mainClass>info.syachiku.samples.stringutils.Main</mainClass>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

7入力を実行すると、空文字と空白の扱いが見える

ZIPを展開し、pom.xmlがあるフォルダーで次を実行します。JDK 17とMaven 3.9系を使い、初回は依存取得のためネットワークが必要です。HTTPサーバーやDBを用意する必要はありません。

mvn clean test
mvn -q exec:java

最初のコマンドは43テスト、次はMain.javaの7入力の比較表示です。次の表はApache Commons Lang 3.22.0で実行した結果です。文字列リテラルの書き方を併記し、見た目では分かりにくい空白を区別しています。

入力StringUtils.isEmptyStringUtils.isBlank
nulltruetrue
""truetrue
" "(半角)falsetrue
"\u3000"(全角)falsetrue
"\u00A0"(NBSP)falsefalse
"\t\n"(タブ・改行)falsetrue
"Alice"falsefalse

isEmpty()はnullまたは長さ0ならtrueです。スペース1文字でも長さがあるので、半角空白・全角空白・タブと改行はfalseになります。値を削ったり、前後を取り除いてから長さを見たりする処理ではありません。

isBlank()はnull・空文字に加え、空白文字だけの値もtrueです。この版ではCharacter.isWhitespaceに沿った空白判定なので、全角空白U+3000やタブ・改行も対象になります。どちらが厳しいかだけで選ばず、空白を未入力へ含める仕様かを確認します。

MainのMEMO欄では、残した空白を\u0020・\u3000・\u00A0・\t\nのように表示します。空に見える出力を見て「消えた」と勘違いしないためです。JDK_EMPTYとJDK_BLANKのnull時のNPEは比較表示用のラベルで、Main自体は落ちません。標準メソッドの例外はテストで別に呼び出して確認しています。

Mainの実行結果7行を見る
CASE=NULL APACHE_EMPTY=true APACHE_BLANK=true JDK_EMPTY=NPE JDK_BLANK=NPE NAME_MISSING=true MEMO="(未設定)"
CASE=EMPTY APACHE_EMPTY=true APACHE_BLANK=true JDK_EMPTY=true JDK_BLANK=true NAME_MISSING=true MEMO="(未設定)"
CASE=HALF_SPACE APACHE_EMPTY=false APACHE_BLANK=true JDK_EMPTY=false JDK_BLANK=true NAME_MISSING=true MEMO="\u0020"
CASE=FULL_SPACE APACHE_EMPTY=false APACHE_BLANK=true JDK_EMPTY=false JDK_BLANK=true NAME_MISSING=true MEMO="\u3000"
CASE=NBSP APACHE_EMPTY=false APACHE_BLANK=false JDK_EMPTY=false JDK_BLANK=false NAME_MISSING=false MEMO="\u00A0"
CASE=TAB_LF APACHE_EMPTY=false APACHE_BLANK=true JDK_EMPTY=false JDK_BLANK=true NAME_MISSING=true MEMO="\t\n"
CASE=TEXT APACHE_EMPTY=false APACHE_BLANK=false JDK_EMPTY=false JDK_BLANK=false NAME_MISSING=false MEMO="Alice"
Main.javaの全文を見る
package info.syachiku.samples.stringutils;

import java.util.List;
import org.apache.commons.lang3.StringUtils;

public final class Main {
    private Main() { }

    public static void main(String[] args) {
        List<Input> inputs = List.of(
                new Input("NULL", null),
                new Input("EMPTY", ""),
                new Input("HALF_SPACE", " "),
                new Input("FULL_SPACE", "\u3000"),
                new Input("NBSP", "\u00A0"),
                new Input("TAB_LF", "\t\n"),
                new Input("TEXT", "Alice"));

        for (Input input : inputs) {
            String value = input.value();
            String jdkEmpty = value == null ? "NPE" : Boolean.toString(value.isEmpty());
            String jdkBlank = value == null ? "NPE" : Boolean.toString(value.isBlank());
            System.out.printf(
                    "CASE=%s APACHE_EMPTY=%s APACHE_BLANK=%s JDK_EMPTY=%s JDK_BLANK=%s NAME_MISSING=%s MEMO=%s%n",
                    input.label(), StringUtils.isEmpty(value), StringUtils.isBlank(value),
                    jdkEmpty, jdkBlank, InputPolicy.isDisplayNameMissing(value),
                    visible(InputPolicy.memoOrDefault(value)));
        }
    }

    private static String visible(String value) {
        if (value == null) {
            return "null";
        }
        return "\"" + value.replace("\\", "\\\\")
                .replace("\t", "\\t").replace("\n", "\\n")
                .replace(" ", "\\u0020").replace("\u3000", "\\u3000")
                .replace("\u00A0", "\\u00A0") + "\"";
    }

    private record Input(String label, String value) { }
}

NBSPはisBlankでもfalseになる

表のNBSPは、ノーブレークスペースU+00A0です。見た目は空白でも、この入力はisEmpty()・isBlank()の両方でfalseでした。空白を判定するメソッドを使ったからといって、画面上で空白に見える文字をすべて拒否できるとは限りません。

今回のisDisplayNameMissing("\u00A0")もfalseです。これは「Javaの空白判定に沿って未入力を分類する」という、今回決めた範囲の結果です。業務の仕様が「NBSPだけの表示名も受け付けない」なら、この判定だけでは足りません。拒否対象へ加える入力と期待値を先に決め、別の条件として実装します。

ここで、値を勝手にtrim()したり、見えない文字を一括削除したりして帳尻を合わせないようにします。未入力かの判定と、受け取った値を変更する正規化は別の仕様です。表示名と備考でも、同じ空白を残すかどうかの約束が違います。

Java 17なら、ライブラリを追加せず同じ要件を書ける

Java 17のString.isEmpty()とString.isBlank()は、呼び出し元の変数がnullだと使えません。先にnullを判定すれば、最初の2つの要件はJava標準だけでも書けます。次は配布したJdkOnlyInputPolicy.javaの全文です。

package info.syachiku.samples.stringutils;

public final class JdkOnlyInputPolicy {
    private JdkOnlyInputPolicy() { }

    public static boolean isDisplayNameMissing(String name) {
        return name == null || name.isBlank();
    }

    public static String memoOrDefault(String memo) {
        return memo == null || memo.isEmpty() ? "(未設定)" : memo;
    }
}

name == null || name.isBlank()は、左側がtrueなら右側を評価しません。nullのときにname.isBlank()を呼ばない順番になっています。備考も同じで、空文字だけを対象にするためisEmpty()を使います。このクラスは、外部ライブラリをクラスパスへ入れないjavacでもコンパイルできることを確認しています。

既存プロジェクトにCommons Langがなく、今回必要なのがこの2つの条件だけなら、標準の書き方は有力です。一方、既にCommons Langを使っていて、入力判定も同じAPIへ揃える方針ならStringUtilsを選べます。短く書けるという理由だけで依存を追加せず、プロジェクトの前提と読み手の分かりやすさをそろえます。

標準Stringで、空文字・全角空白・NBSP・trim()・strip()まで比較したい場合は、次の記事で結果を照合できます。このページはCommons LangのAPI選択と依存関係の判断を中心に扱っています。

関連記事JavaのisEmptyとisBlankの違い|null・空文字・空白の判定方法 標準Stringで空文字・空白・全角空白・NBSPを比較したい場合に。trimとstripの違いまで実行結果から確認できます。 記事を読む

SpringのStringUtilsではhasTextとhasLengthを使う

Springにもorg.springframework.util.StringUtilsがあります。今回固定したSpring Core 6.2.19には、isBlankという公開メソッドはありません。StringUtils.isBlankが補完されない場合は、最初にimportしたクラスを確認します。

SpringのhasText()は、空白以外の文字があればtrueです。未入力を調べるなら、戻り値を逆に読む必要があります。hasLength()は長さがあればtrueで、空白だけでも長さがあればtrueになります。ApacheのisBlank()・isEmpty()とは、trueが表す意味が逆です。

使うクラス呼出しtrueになる条件
Java標準のStringvalue.isBlank()空文字・Javaの空白だけ。nullへの呼出しは例外
ApacheのStringUtilsStringUtils.isBlank(value)null・空文字・Javaの空白だけ
SpringのStringUtilsStringUtils.hasText(value)空白以外の文字がある
SpringのStringUtilsStringUtils.hasLength(value)nullではなく長さが1以上ある

配布テストは同じ7入力でhasText()・hasLength()も実行し、Springの公開メソッドにisBlankがないことも確認しています。次はBlankSelectionTest.javaから、Spring比較のメソッドだけを抜粋したものです。全文は後のテスト欄にあります。

    @ParameterizedTest(name = "Spring: {0}")
    @MethodSource("cases")
    void springUsesPositiveTextAndLengthPredicates(Input input) {
        assertEquals(!input.blank(), org.springframework.util.StringUtils.hasText(input.value()));
        assertEquals(!input.empty(), org.springframework.util.StringUtils.hasLength(input.value()));
    }

Springが既に入っているプロジェクトでそのAPIを使う場合も、単純名のStringUtilsだけをそろえるのではなく、どのクラスを使い、trueを何の意味で読むかをレビューで説明します。空白判定だけのために、SpringがないJavaアプリへSpringを追加する必要はありません。

採用理由は、要件と既存の依存関係から説明する

判断の順番は、未入力の定義、nullの意味、既存の依存関係です。例えば表示名の未設定が入力エラーとして普通に届くなら、nullも未入力として分類する処理が必要です。内部メソッドの契約ではnullが来ないはずなら、nullを受け取ったこと自体を調べる必要があります。

StringUtils.isBlank()へ置き換えれば例外を避けられますが、それで入力経路の問題が解決したとは限りません。必須の内部データが欠落している場面で、nullを通常の未入力として黙って扱うと、呼び出し元の誤りを見落とします。画面やCSVの入力境界なのか、内部処理の契約なのかを分けます。

備考も「必須ではない」だけでは条件が足りません。空白を保存するか、既定値へ替えるかまで決めて、" "の期待結果に落とします。今回の仕様では空白を残すのでisEmpty()を選び、isBlank()へ機械的に置き換えません。

レビュー返信を、今回の要件・選択肢・採用理由・他の手段を選ばない理由へ対応させるなら、次のように書けます。実際の案件の経験談ではなく、このサンプルの判断を伝える例です。

要件:表示名はJavaの空白文字だけでも未入力、備考は空文字だけを既定値に替えます。
選択肢:Java標準でnullを先に判定する方法と、Commons LangのStringUtilsがあります。
採用理由:このプロジェクトはCommons Langを既に使う想定で、入力判定を同じAPIへ揃えます。
他手段:依存がない別案件なら標準版を選べます。備考には、空白を消してしまうisBlankを使いません。

この説明なら、後任が備考をisBlank()へ変えたとき、どの仕様を失うかも追えます。ライブラリ名を知っていることではなく、その戻り値が今回の要件に合うことを説明できる状態を目指します。

43テストで、見逃す変更と消しすぎる変更を検出する

配布テストは7入力を6つの観点で検証する42件と、Springの公開APIを確かめる1件で、合計43件です。Apacheと標準Stringの結果、表示名、備考、Java標準だけの別案、Springの結果を、入力ごとに対応させています。43種類の入力を用意した、という意味ではありません。

BlankSelectionTest.javaの全文を見る
package info.syachiku.samples.stringutils;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.util.Arrays;
import java.util.stream.Stream;
import org.apache.commons.lang3.StringUtils;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;

class BlankSelectionTest {
    private record Input(String label, String value, boolean empty, boolean blank,
                         boolean missingName, String memo) {
        @Override
        public String toString() {
            return label;
        }
    }

    static Stream<Input> cases() {
        return Stream.of(
                new Input("NULL", null, true, true, true, "(未設定)"),
                new Input("EMPTY", "", true, true, true, "(未設定)"),
                new Input("HALF_SPACE", " ", false, true, true, " "),
                new Input("FULL_SPACE", "\u3000", false, true, true, "\u3000"),
                new Input("NBSP", "\u00A0", false, false, false, "\u00A0"),
                new Input("TAB_LF", "\t\n", false, true, true, "\t\n"),
                new Input("TEXT", "Alice", false, false, false, "Alice"));
    }

    @ParameterizedTest(name = "Apache: {0}")
    @MethodSource("cases")
    void apachePredicatesFollowEmptyAndBlankRules(Input input) {
        assertEquals(input.empty(), StringUtils.isEmpty(input.value()));
        assertEquals(input.blank(), StringUtils.isBlank(input.value()));
    }

    @ParameterizedTest(name = "String: {0}")
    @MethodSource("cases")
    void jdkPredicatesRejectNullAndClassifyOtherInputs(Input input) {
        if (input.value() == null) {
            assertThrows(NullPointerException.class, () -> input.value().isEmpty());
            assertThrows(NullPointerException.class, () -> input.value().isBlank());
        } else {
            assertEquals(input.empty(), input.value().isEmpty());
            assertEquals(input.blank(), input.value().isBlank());
        }
    }

    @ParameterizedTest(name = "Name requirement: {0}")
    @MethodSource("cases")
    void displayNameMissingFollowsDeclaredBlankRequirement(Input input) {
        assertEquals(input.missingName(), InputPolicy.isDisplayNameMissing(input.value()));
    }

    @ParameterizedTest(name = "Memo requirement: {0}")
    @MethodSource("cases")
    void optionalMemoDefaultsOnlyForNullOrZeroLength(Input input) {
        assertEquals(input.memo(), InputPolicy.memoOrDefault(input.value()));
    }

    @ParameterizedTest(name = "JDK-only alternative: {0}")
    @MethodSource("cases")
    void jdkOnlyAlternativeMeetsTheSameRequirements(Input input) {
        assertEquals(input.missingName(), JdkOnlyInputPolicy.isDisplayNameMissing(input.value()));
        assertEquals(input.memo(), JdkOnlyInputPolicy.memoOrDefault(input.value()));
    }

    @ParameterizedTest(name = "Spring: {0}")
    @MethodSource("cases")
    void springUsesPositiveTextAndLengthPredicates(Input input) {
        assertEquals(!input.blank(), org.springframework.util.StringUtils.hasText(input.value()));
        assertEquals(!input.empty(), org.springframework.util.StringUtils.hasLength(input.value()));
    }

    @Test
    void springStringUtilsInThePinnedVersionHasNoIsBlankMethod() {
        assertFalse(Arrays.stream(org.springframework.util.StringUtils.class.getMethods())
                .anyMatch(method -> method.getName().equals("isBlank")));
    }
}

動作を確認するだけでなく、作業用コピーで表示名の判定をisBlank(name)からisEmpty(name)へ弱めました。すると半角空白・全角空白・タブ改行の3件が失敗します。要件では未入力なのに、未入力として検出できなくなるためです。

備考の方をisEmpty(memo)からisBlank(memo)へ替えた場合も3件が失敗します。今度は、残すはずの空白だけの備考が(未設定)へ置き換わってしまいます。同じ3入力でも、表示名と備考で失敗する理由は逆です。

ソースを戻すと43件が成功し、ZIP展開版でも43件とMainの7行が一致しました。配布しているのは復元した版です。正しく動く入力だけでなく、選び方を間違えると何が変わるかまでテストで示します。

レビュー前は、未入力の範囲とimportを確認する

  • null・空文字・空白だけの値を、項目ごとの仕様に合わせて分類したか。
  • 半角・全角・NBSPを同じ見た目だけで扱わず、期待値へ分けたか。
  • ApacheとSpringのStringUtilsを、パッケージまで確認したか。
  • 既存の依存とJava版を見て、ライブラリを増やす理由を説明できるか。
  • 未入力判定と、文字列を削る正規化・最終的な入力許可を混ぜていないか。

nullと文字列の基礎を整理したい場合に

nullへメソッドを呼ぶとなぜ例外になるか、変数とメソッド呼出しの基礎から整理したい場合は『スッキリわかるJava入門 第5版』を案内します。この記事のAPI比較を丸暗記するためではなく、入力値と処理のつながりを自分で説明する土台を補うための1冊です。

書籍「スッキリわかるJava入門 第5版」の表紙
商品画像:Amazon.co.jp
PR Java初学者向け

スッキリわかるJava入門 第5版

中山 清喬 (著), 国本 大悟 (著), 株式会社フレアリンク (監修)

変数・条件分岐から、クラスの基本まで学ぶ一冊。

豊富な図とサンプルで、変数、条件分岐、クラス、例外処理まで順番に学べます。Javaの最初の教科書を探している人向けです。

  • Javaを基礎から体系的に学びたい
  • Java 25 LTS対応の入門書を選びたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

nullを許す場所と、テストで選ぶ入力をもう少し整理したい場合に。標準Stringの比較は本文中のカード、次の2本は入力の契約と期待結果の決め方へつながります。

関連記事Javaのnullチェック入門 nullを通常の未入力として扱うか、契約違反として調べるか。入力境界と内部処理で扱いを分ける基本を確認できます。 記事を読む 関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 今回の7入力のように、仕様から期待結果を決めたい場合に。入力の分類を選び、JUnitのassertionへ対応させる手順を確認できます。 記事を読む

仕様の確認:Apache Commons LangのStringUtils、Java 17のString、Spring Core 6.2.19のStringUtils。本文の結果は配布ソースの固定版で実測しています。

isBlankかisEmptyかは、未入力の定義から選ぶ

Apache Commons LangのisEmpty()はnull・空文字、isBlank()はそれに加えてJavaの空白文字だけの値を対象にします。NBSPのように対象から外れる入力もあるので、見た目ではなく表と実行結果で判断します。

今回の表示名と備考は、どちらも未入力に関係する処理ですが、残すべき値が違います。その違いを先に決め、既に使うライブラリとJava標準の選択肢を比べれば、APIの名前だけに頼らず実装理由を説明できます。

-実装・エラー解決
-, ,