一、问题由来
在实际开发的时候,我们经常会碰到这么一个困难:一个集合容器里面有很多重复的对象,里面的对象没有主键,但是根据业务的需求,实际上我们需要根据条件筛选出没有重复的对象。
比较暴力的方法,就是根据业务需求,通过两层循环来进行判断,没有重复的元素就加入到新集合中,新集合中已经有的元素就跳过。
操作例子如下,创建一个实体对象PenBean
,代码如下:
/** * 笔实体 */ public class PenBean { /**类型*/ private String type; /**颜色*/ private String color; //... 省略 setter 和 getter public PenBean(String type, String color) { this.type = type; this.color = color; } @Override public String toString() { return "PenBean{" + "type='" + type + '\'' + ", color='" + color + '\'' + '}'; } }
测试 demo,如下:
public static void main(String[] args) { //添加信息,PenBean中没有主键 List<PenBean> penBeanList = new ArrayList<PenBean>(); penBeanList.add(new PenBean("铅笔","black")); penBeanList.add(new PenBean("铅笔","white")); penBeanList.add(new PenBean("铅笔","black")); penBeanList.add(new PenBean("中性笔","white")); penBeanList.add(new PenBean("中性笔","white")); //新数据 List<PenBean> newPenBeanList = new ArrayList<PenBean>(); //传统重复判断 for (PenBean penBean : penBeanList) { if(newPenBeanList.isEmpty()){ newPenBeanList.add(penBean); }else{ boolean isSame = false; for (PenBean newPenBean : newPenBeanList) { //依靠type、color来判断,是否有重复元素 //如果新集合包含元素,直接跳过 if(penBean.getType().equals(newPenBean.getType()) && penBean.getColor().equals(newPenBean.getColor())){ isSame = true; break; } } if(!isSame){ newPenBeanList.add(penBean); } } } //输出结果 System.out.println("=========新数据======"); for (PenBean penBean : newPenBeanList) { System.out.println(penBean.toString()); } }
输出结果:
=========新数据====== PenBean{type='铅笔', color='black'} PenBean{type='铅笔', color='white'} PenBean{type='中性笔', color='white'}
一般处理数组类型的对象时,可以通过这种方法来对数组元素进行去重操作,以筛选出没有包含重复元素的数组。
那有没有更加简洁的写法呢?
答案肯定是有的,List
中的contains()
方法就是!
二、利用list中contains方法去重
在使用contains()
之前,必须要对PenBean
类重写equals()
方法,为什么要这么做?等会会详细解释!
我们先在PenBean
类中重写equals()
方法,内容如下:
@Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; PenBean penBean = (PenBean) o; //当type、color 内容都相等的时候,才返回true return Objects.equals(type, penBean.type) && Objects.equals(color, penBean.color); }
修改测试 demo,如下:
public static void main(String[] args) { //添加信息 List<PenBean> penBeanList = new ArrayList<PenBean>(); penBeanList.add(new PenBean("铅笔","black")); penBeanList.add(new PenBean("铅笔","white")); penBeanList.add(new PenBean("铅笔","black")); penBeanList.add(new PenBean("中性笔","white")); penBeanList.add(new PenBean("中性笔","white")); //新数据 List<PenBean> newPenBeanList = new ArrayList<PenBean>(); //使用contain判断,是否有相同的元素 for (PenBean penBean : penBeanList) { if(!newPenBeanList.contains(penBean)){ newPenBeanList.add(penBean); } } //输出结果 System.out.println("=========新数据======"); for (PenBean penBean : newPenBeanList) { System.out.println(penBean.toString()); } }
输出结果如下:
=========新数据====== PenBean{type='铅笔', color='black'} PenBean{type='铅笔', color='white'} PenBean{type='中性笔', color='white'}
如果PenBean
对象不重写equals()
,contains()
方法的都是false
!新数据与源数据是一样的,并不能达到我们想要除去重复元素的目的
那么contains()
是怎么做到,判断一个集合里面有相同的元素呢?
我们打开ArrayList
中contains()
方法,源码如下:
public boolean contains(Object o) { return indexOf(o) >= 0; }
找到indexOf(o)
方法,继续往下看,源码如下:
public int indexOf(Object o) { if (o == null) { for (int i = 0; i < size; i++) if (elementData[i]==null) return i; } else { for (int i = 0; i < size; i++) //对象通过 equals 方法,判断是否相同 if (o.equals(elementData[i])) return i; } return -1; }
此时,非常清晰了,如果传入的对象是null
,for循环判断数组中的元素是否有null
,如果有就返回下标;如果传入的对象不是null
,通过对象的equals()
方法,for循环判断是否有相同的元素,如果有就返回下标!
如果是数组返回的下标,肯定是大于0,否则返回-1!
这就是为什么在List
中使用contains()
方法,对象需要重写equals()
方法的原因!