==, .equals(), compareTo(), and compare() (之一)

短命女 2022-08-07 05:47 198阅读 0赞

## Equality comparison: One way for primitives, Four ways for objects ##

相等比较：一种是基本，其他四种是对象的

<table> 
 <tbody> 
 <tr> 
 <th>Comparison </th> 
 <th>Primitives </th> 
 <th>Objects</th> 
 </tr> 
 <tr> 
 <td><code>a == b</code> , <code>a != b</code> </td> 
 <td>Equal values</td> 
 <td>Compares references, not values. The use of <code>==</code> with object references is generally limited to the following: 
 <ul> 
 <li>Comparing to see if a reference is null.</li> 
 <li>Comparing two enum values. This works because there is only one object for each enum constant.</li> 
 <li>You want to know if two references are to the same object </li> 
 </ul> </td> 
 </tr> 
 <tr> 
 <td><code>a.equals(b)</code> </td> 
 <td>N/A </td> 
 <td>Compares values for equality. Because this method is defined in the Object class, from which all other classes are derived, it's automatically defined for every class. However, it doesn't perform an intelligent comparison for most classes unless the class overrides it. It has been defined in a meaningful way for most Java core classes. If it's not defined for a (user) class, it behaves the same as ==. It turns out that defining <code>equals()</code> isn't trivial; in fact it's moderately hard to get it right, especially in the case of subclasses. The best treatment of the issues is in Horstmann's Core Java Vol 1 . [TODO: Add explanation and example] </td> 
 </tr> 
 <tr> 
 <td><code>a.compareTo(b)</code> </td> 
 <td>N/A </td> 
 <td>Comparable interface. Compares values and returns an int which tells if the values compare less than, equal, or greater than. If your class objects have a natural order, implement the Comparable&lt;T&gt; interface and define this method. All Java classes that have a natural ordering implement this (String, Double, BigInteger, ...). </td> 
 </tr> 
 <tr> 
 <td><code>compare(a,&nbsp;b)</code> </td> 
 <td>N/A</td> 
 <td>Comparator interface. Compares values of two objects. This is implemented as part of the Comparator&lt;T&gt; interface, and the typical use is to define one or more small utility classes that implement this, to pass to methods such as <code>sort()</code> or for use by sorting data structures such as TreeMap and TreeSet. You might want to create a Comparator object for the following. 
 <ul> 
 <li>Multiple comparisions. To provide several different ways to sort somthing. For example, you might want to sort a Person class by name, ID, age, height, ... You would define a Comparator for each of these to pass to the <code>sort()</code> method.</li> 
 <li>System class. To provide comparison methods for classes that you have no control over. For example, you could define a Comparator for Strings that compared them by length.</li> 
 <li>Strategy pattern. To implement a Strategey pattern, which is a situation where you want to represent an algorithm as an object that you can pass as a parameter, save in a data structure, etc.</li> 
 </ul> If your class objects have one natural sorting order, you may not need this. </td> 
 </tr> 
 </tbody> 
</table>

## Comparing Object references with the `==` and `!=` Operators---使用操作符 ##

## `==` 和`!=比较对象引用` ##

The two operators that can be used with object references are comparing for equality (**`==`** ) and inequality (**`!=`** ). These operators compare two values to see if they **refer to the same object** . Although this comparison is very fast, it is often not what you want.

Usually you want to know if the objects have the same *value* , and not whether two objects are a *reference* to the same object. For example,

被用来做对象引用比较的两个操作符是==和!=.这两个操作符比较值以判断他们是否引用了相同的对象。虽然这种比较很快，但他通常不是你所想要的。

通常你想知道两个对象是否拥有相同的值，而不是两个对象引用了同一个对象。例如。

if (name == "Mickey Mouse")   // Legal, but ALMOST SURELY WRONG

This is true only if `name` is a reference to the *same object* that `"Mickey Mouse"` refers to. This will be false if the String in `name` was read from input or computed (by putting strings together or taking the substring), even though `name` really does have exactly those characters in it.

Many classes (eg, `String` ) define the `equals()` method to compare the *values* of objects.

只有当name引用了同样的对象`"Mickey Mouse"所引用的时，这个才是true。假如字符串name从输入或者计算（将字符串合起来后者截取）读取的话，这个判断就是false， 即使name确实有完全相同的字符，许多类定义equals()方法比较对象的值。`

## Comparing Object values with the `equals()` Method---使用equals()方法比较对象值 ##

Use the `equals()` method to compare object values. The `equals()` method returns a boolean value. The previous example can be fixed by writing:

if (name.equals
    
    ("Mickey Mouse"))  // Compares values, not refererences.

Because the `equals()` method makes a == test first, it can be fairly fast when the objects are identical. It only compares the values if the two references are not identical.

因为equals()方法首先使用==测试，它相当的快，当对象是相同的。只有在两个引用不是相同的时候，它才比较values。

## Other comparisons - Comparable<T> interface ##

The `equals` method and `==` and `!=` operators test for equality/inequality, but do not provide a way to test for relative values. Some classes (eg, String and other classes with a natural ordering) implement the *Comparable<T>* interface, which defines a `compareTo` method. You will want to implement *Comparable<T>* in your class if you want to use it with Collections.sort() or Arrays.sort() methods.

## Defining a Comparator object ##

As described in the table above on `compare()` , you can create Comparators to sort any arbitrary way for any class. For example, the String class defines the CASE\_INSENSITIVE\_ORDER comparator.

## If you override equals, you should also override hashCode() ##

**Overriding `hashCode()`** . The `hashCode()` method of a class is used for *hashing* in library data structures such as `HashSet` and `HashMap` . If you override `equals()` , you should override `hashCode()` or your class will not work correctly in these (and some other) data structures.

## Shouldn't .equals and .compareTo produce same result? ##

The general advice is that if `a.equals(b)` is true, then `a.compareTo(b) == 0` should also be true. Curiously, `BigDecimal` violates this. Look at the Java API documentation for an explanation of the difference. This seems wrong, although their implementation has some plausibiliby.

## Other comparison methods ##

String has the specialized `equalsIgnoreCase()` and `compareToIgnoreCase()` . String also supplies the constant `String.CASE_INSENSITIVE_ORDER` Comparator.

## The === operator (Doesn't exist - yet?) ##

Comparing objects is somewhat awkward, so a === operator has been proposed. One proposal is that  
`a === b` would be the same as `((a == b) || ((a != null) && a.equals(b)))`

## Common Errors ##

**Using == instead of `equals()` with Objects**

When you want to compare objects, you need to know whether you should use `==` to see if they are the *same object* , or `equals()` to see if they may be a different object, but have the *same value* . This kind of error can be very hard to find.