トレノキャンプ

Java

2022.01.19

JavaのcompareToメソッドの使い方！日付や文字列、数値を比較する方法

2023.11.18

1．JavaのcompareToメソッドとは？
2．compareToメソッドの基本
3．compareToメソッドの使い方
4．compareToメソッドを使う際の注意点

実際の業務の中でプログラミングをしていると、「どちらの値が大きいか」を比較する場面がたびたび登場します。

数値であれば大小比較で問題ありませんが、日付や文字列の比較はどうすればよいのか悩む方も多いでしょう。

今回は、Javaのオブジェクト同士を大小比較するための方法を紹介します。

1．JavaのcompareToメソッドとは？

Javaでは、大小比較を行うために「compareTo」というメソッドが用意されています。

compareToを活用することで、大小判定を容易に行うことが可能です。

2．compareToメソッドの基本

ここでは、compareToの基本的な使い方を紹介していきます。

①compareToメソッドの構文

compareToは、比較する対象のインスタンスを引数とし、以下のような構文を用いて実行します。

int 比較結果 = 比較する基準のインスタンス.compareTo(比較対象のインスタンス);

②戻り値の値で大小を比較する

compareToはint型の値を返すため、その値を用いて大小を判定します。

例として、整数型のラッパークラスであるIntegerをもとに考えてみましょう。

public class Main {
    public static void main(String[] args) {
        Integer a = Integer.valueOf(12);
        Integer b = Integer.valueOf(15);
        Integer c = Integer.valueOf(12);

        // a(12) と b(15) の比較
        System.out.println(a.compareTo(b));
        // a(12) と c(12) の比較
        System.out.println(a.compareTo(c));
        // b(15) と c(12) の比較
        System.out.println(b.compareTo(c));
    }
}

実行すると、以下のように出力されます。

-1
0
1

このように、大小関係に応じて-1, 0, 1のいずれかを返します。

値に応じた説明は以下の通りです。

値	説明
0	メソッドの引数と同値
-1	メソッドの引数より小さい
1	メソッドの引数より大きい

戻り値の大小の覚え方

compareToは、同じ場合を0とし、大小関係がある場合はマイナスの値かプラスの値かを返します。

このとき、マイナスの場合はどちらが大きいんだ？と考えてしまうこともあるでしょう。

そんな時は、引き算を考えてみましょう。

Integer a = 12;
Integer b = 15;

// a(12) と b(15) の比較
a.compareTo(b)

このとき、aは12、bは15ですので、

12 - 15 = -3

となり、計算結果のマイナスと同じく、マイナスの値がcompareToで返却されます。

左の値と右の値を引き算として考えることでプラスかマイナスかが判断できるので、悩んだ際は「引き算」を思い出してみてください。

3．compareToメソッドの使い方

compareToメソッドの使い方は、実はクラスによって若干異なります。

ここでは、クラスごとのcompareToの使い方を学習していきましょう。

①String型（文字列）を比較する

文字列を構成する文字には、それぞれ「文字コード」が割り振られています。たとえば「a」は「0x41」、「b」は「0x42」といった値が割り振られているのです。

文字列を比較する場合、この文字コードを用いて値の比較を行います。

String str1 = "a";
String str2 = "c";
System.out.println(str1.compareTo(str2));

これを実行すると以下のように出力されます。

-2

文字列比較の場合、この文字コードの値で引き算した結果が返却されます。

同じ文字列であれば0となりますが、違う文字列であれば-1または1が返却されるとは限らないことに注意しましょう。

大文字と小文字は区別されるので注意

大文字のaと小文字のAは違うコードであるため、違う文字列として扱われます。

もし同じ文字として比較したい場合には「compareToIgnoreCase」を使いましょう。

String str1 = "abc";
String str2 = "ABC";
System.out.println(str1.compareTo(str2));
System.out.println(str1.compareToIgnoreCase(str2));
32
0

compareToは32を返却していますが、compareToIgnoreCaseは0を返却しています。

文字列を比較するときには、

・大文字は小文字よりも値が小さい

・大文字小文字を区別しない場合にはcompareToIgnoreCaseを使う

この2点を覚えておくとよいでしょう。

数字の比較に注意

また、文字列を比較するときに気をつけなければならないのが「数字の比較」です。

String num1 = "120";
String num2 = "90";

System.out.println(num1.compareTo(num2));

一見、120と90を比較しているのでプラスの値を返却すると予想されますが、実行結果は以下のようになります。

-8

これは1文字目の「1」と「9」で比較してしまい、9の方が大きいため、このような現象が発生します。

文字列の大小比較は先頭文字から比較をはじめるため、桁のあっていない数字を比較したい場合には注意しましょう。

②Date型（日付）を比較する

特に業務系のアプリケーション開発において、大小比較の使用頻度がもっとも高いのがDate型です。

日付を用いた期間のチェックや、基準日の判定、過去日付の指定といったさまざまな判定式で日付の比較を行います。

Date型も、CompareToを使用することで日付の前後関係を計算できます。

import java.util.Calendar;
import java.util.Date;

public class Main {

    public static void main(String[] args) {

        Calendar calendar = Calendar.getInstance();

        // 2020/11/1
        calendar.set(2020, 10, 1);
        Date day1 = calendar.getTime();

        // 2020/11/31
        calendar.set(2020, 10, 31);
        Date day2 = calendar.getTime();

        // 2020/11/1
        calendar.set(2020, 10, 1);
        Date day3 = calendar.getTime();

        // 2020/11/1 と 2020/11/31 を比較
        System.out.println(day1.compareTo(day2));
        // 2020/11/1 と 2020/11/1 を比較
        System.out.println(day1.compareTo(day3));
        // 2020/11/31 と 2020/11/1 を比較
        System.out.println(day2.compareTo(day3));
    }
}

これを実行すると、以下のように出力されます。

-1
0
1

ただし、日付の場合にはafterまたはbeforeメソッドでも比較ができます。
例として、消費税率の基準日と比較する処理を考えてみましょう。

Calendar calendar = Calendar.getInstance();

// 消費税率10%の基準日
calendar.set(2019, 10, 1, 0, 0, 0);
Date baseDir = calendar.getTime();

Date now = new Date();

if(now.after(baseDir)) {
    System.out.println("現在の消費税は10%です");
}

消費税率10%が適用された2019/10/1以降に実行していれば、「現在の消費税は10%です」と出力されます。

compareToを使うよりも、afterやbeforeを使った方が直感的に読みやすいですね。前後のどちらかを判定するだけであれば、compareToではなくafterまたはbeforeを使うとよいでしょう。

③BigDecimalの値を比較する

BigDecimalクラスでは、intやlongの値を超える大きな数字を扱います。

銀行や証券、クレジットといったお金を扱うシステム開発において利用することの多いクラスです。

import java.math.BigDecimal;

public class Main {

    public static void main(String[] args) {
        BigDecimal val1 = new BigDecimal("10.0");
        BigDecimal val2 = new BigDecimal("12");
        BigDecimal val3 = new BigDecimal("10");

        // 10.0 と 12を比較
        System.out.println(val1.compareTo(val2));
        // 10.0 と 10を比較
        System.out.println(val1.compareTo(val3));
        // 12 と 10 を比較
        System.out.println(val2.compareTo(val3));
    }
}

これを実行すると、以下のようになります。

-1
0
1

BigDecimalは少し特殊なクラスですが、compareToを用いた比較は数値と同じように実行できます。

④ラッパークラスを比較する

前述の通り、IntegerやLong、Doubleといったラッパークラスは、compareToを利用して比較することが可能です。

public class Main {

    public static void main(String[] args) {

        Double num1 = Double.valueOf(13.0);
        Double num2 = Double.valueOf(15.0);
        Double num3 = Double.valueOf("13");

        System.out.println(num1.compareTo(num2));
        System.out.println(num1.compareTo(num3));
        System.out.println(num2.compareTo(num3));
    }
}

これを実行すると、以下のようになります。

-1
0
1

⑤プリミティブ型を比較する

プリミティブ型はクラスではないため、compareToをはじめとするクラスメソッドは利用できません。

そのため、compareToを使って比較したい場合には、対応するラッパークラスのcompareメソッドを用いて比較します。

public class Main {
    public static void main(String[] args) {

        int num1 = 10;
        int num2 = 15;
        int num3 = 10;

        System.out.println(Integer.compare(num1, num2));
        System.out.println(Integer.compare(num1, num3));
        System.out.println(Integer.compare(num2, num3));
    }
}

もちろん、以下のようにラッパークラスに変換することで他のクラスと同様に比較できます。

Integer num1 = Integer.valueOf(10);
Integer num2 = Integer.valueOf(15);
Integer num3 = Integer.valueOf(10);

System.out.println(num1.compareTo(num2));
System.out.println(num1.compareTo(num3));
System.out.println(num2.compareTo(num3));

どちらで実行した場合でも、同じ実行結果になります。

-1
0
1

どちらの方法を使っても問題ありませんが、変換する手間を考慮すると、ラッパークラスのcompareメソッドを利用した方が楽に比較できます。

4．compareToメソッドを使う際の注意点

大小比較に便利に使えるcompareToメソッドですが、利用するにあたっては次のことに注意しましょう。

①nullとの比較ができない

compareToを使う場合、どちらかがnullであった時点で正常に比較できません。

たとえば、以下のようなコードを書いた場合、どちらのcompareToもエラーとなります。

String nonNullValue = "比較対象";
String nullValue = null;

// 右辺がnull
int result1 = nonNullValue.compareTo(nullValue1);

// 左辺がnull
int result2 = nullValue.compareTo(nonNullValue);