Java List Contains

介绍

在Java中，List是一种常用的数据结构，用于存储一组元素。List提供了一系列常用的方法来操作和管理元素，其中包括contains()方法。本文将详细介绍contains()方法的使用，其原理以及一些注意事项。

contains()方法概述

contains()方法是List接口的一个方法，用于判断列表中是否包含指定的元素。该方法的定义如下：

boolean contains(Object o)

contains()方法接收一个参数，即要检测是否存在的元素，返回一个boolean值，表示是否包含该元素。如果列表中包含了该元素，则返回true；否则，返回false。

使用contains()方法

下面通过一个示例代码演示如何使用contains()方法。假设我们有一个存储学生姓名的列表students，现在要判断是否包含名为”Tom”的学生。

import java.util.ArrayList;
import java.util.List;

public class Main {
    public static void main(String[] args) {
        // 创建学生姓名列表
        List<String> students = new ArrayList<>();
        students.add("Alice");
        students.add("Bob");
        students.add("Tom");
        students.add("Jerry");

        // 判断是否包含名为"Tom"的学生
        boolean containsTom = students.contains("Tom");
        System.out.println("是否包含Tom：" + containsTom);

        // 判断是否包含名为"Linda"的学生
        boolean containsLinda = students.contains("Linda");
        System.out.println("是否包含Linda：" + containsLinda);
    }
}

运行上述代码，输出为：

是否包含Tom：true
是否包含Linda：false

可以看到，通过调用List的contains()方法，我们可以轻松地判断列表是否包含指定元素。

contains()方法的实现原理

在ArrayList中，contains()方法的实现原理是遍历列表，逐个比较元素是否相等。具体来说，contains()方法通过调用equals()方法来比较每个元素与指定元素之间的相等性。

例如，在前面的示例代码中，判断是否包含名为”Tom”的学生，实际上会逐个比较列表中的元素与”Tom”之间的相等性。在这个示例中，列表中的第3个元素是”Tom”，因此contains()方法最终返回true。

需要注意的是，对于自定义的类对象，如果没有重写equals()方法，默认情况下使用的是Object类的equals()方法，该方法使用的是对象的引用相等性进行比较。如果希望自定义类对象的contains()方法按照特定的相等性准则进行判断，就需要在类中重写equals()方法。

注意事项

使用contains()方法时，需要注意以下几点：

1. 参数类型与泛型相符

在调用contains()方法时，传入的参数类型必须与列表的泛型类型相符。例如，在上述示例代码中，我们使用的是List<String>，因此传入的参数也必须是String类型。

如果参数类型与列表的泛型类型不符，编译器将会报错。例如，如果将students.contains(123)改为students.contains("123")，编译器会报错。

2. 注意引用相等性与值相等性

使用contains()方法判断元素是否存在时，要注意区分引用相等性和值相等性。对于基本数据类型（如int、double等），判断其值相等；对于对象类型（如String、自定义类等），判断其引用相等。

例如，在上述示例代码中，我们通过students.contains("Tom")来判断是否包含名为”Tom”的学生，其中的”Tom”是一个String对象。由于String对象是基于值相等性进行比较的，所以即使List中存储的是新创建的String对象，只要其值与”Tom”相等，contains()方法仍然会返回true。