字符串比较的经典坑：== vs equals

一、Bug 场景

在一个 Java 程序中，涉及到字符串的比较操作。开发人员在判断两个字符串是否相等时，误使用了 == 运算符，而不是 equals 方法。程序在部分情况下运行正常，但在其他情况下却出现逻辑错误，导致功能无法正确实现，给程序的稳定性和可靠性带来了隐患。

二、代码示例

字符串比较类（有缺陷）

public class StringComparison {
    public static boolean compareStrings(String str1, String str2) {
        // 错误地使用 == 进行字符串比较
        return str1 == str2; 
    }
}

测试代码

public class StringComparisonBugExample {
    public static void main(String[] args) {
        String s1 = "Hello";
        String s2 = "Hello";
        String s3 = new String("Hello");

        System.out.println("s1 == s2 使用 == 结果: " + StringComparison.compareStrings(s1, s2));
        System.out.println("s1 == s3 使用 == 结果: " + StringComparison.compareStrings(s1, s3));

        System.out.println("s1.equals(s2) 使用equals结果: " + s1.equals(s2));
        System.out.println("s1.equals(s3) 使用equals结果: " + s1.equals(s3));
    }
}

三、问题描述

1. 预期行为：无论字符串是如何创建的，只要它们的内容相同，比较结果就应该为 true。
2. 实际行为：当使用 == 运算符进行字符串比较时，s1 == s2 返回 true，因为 s1 和 s2 指向字符串常量池中的同一个对象。然而，s1 == s3 返回 false，尽管 s1 和 s3 的内容都是 "Hello"。这是因为 s3 是通过 new 关键字创建的，它在堆内存中开辟了新的空间，与 s1 指向不同的内存地址。而 == 运算符比较的是对象的内存地址，并非字符串的内容。而 equals 方法才是比较字符串内容是否相等。

四、解决方案

1. 始终使用 equals 方法：在进行字符串比较时，无论在何种情况下，都使用 equals 方法来确保比较的是字符串的内容。

public class StringComparison {
    public static boolean compareStrings(String str1, String str2) {
        // 使用equals方法进行字符串比较
        if (str1 == null) {
            return str2 == null;
        }
        return str1.equals(str2); 
    }
}

2. 考虑 null 值：在使用 equals 方法时，需要注意其中一个字符串可能为 null 的情况。上述代码中，先对 str1 是否为 null 进行判断，如果 str1 为 null，则只有当 str2 也为 null 时才返回 true。这样可以避免空指针异常。