4年前 (2015-12-11) 铁匠  java
文章评分 0 次,平均分 0.0

由于其功能性和灵活性,ArrayList是 Java 集合框架中使用最为普遍的集合类之一。ArrayList 是一种 List 实现,它的内部用一个动态数组来存储元素,因此 ArrayList 能够在添加和移除元素的时候进行动态的扩展和缩减。你可能已经使用过 ArrayList,因此我将略过基础部分。如果你对 ArrayList 还不熟悉,你可以参考它的 API 文档,可以很容易理解在 ArrayList 上执行基本的操作。

在这篇文章中,我将讨论ArrayList中一种极其重要的操作,你很有可能需要在企业应用开发中实现它。它就是ArrayList元素的排序。

排序字符串对象的 ArrayList

考虑一个 ArrayList 存储着以字符串形式存在的国名(country name),为了对这个 ArrayList 进行排序,你需要调用 Collections.sort()方法,传递由国名构成的 ArrayList 对象。这种方法将按照自然顺序(按字母升序)对元素(国名)进行排序。让我们为此来写一段代码。

SortArrayListAscendingDescending.java

  1. package guru.springframework.blog.sortarraylist.ascendingdescending;
  2. import java.util.ArrayList;
  3. import java.util.Collections;
  4. public class SortArrayListAscendingDescending {
  5. private ArrayList arrayList;
  6. public SortArrayListAscendingDescending(ArrayList arrayList) {
  7. this.arrayList = arrayList;
  8. }
  9. public ArrayList getArrayList() {
  10. return this.arrayList;
  11. }
  12. public ArrayList sortAscending() {
  13. Collections.sort(this.arrayList);
  14. return this.arrayList;
  15. }
  16. public ArrayList sortDescending() {
  17. Collections.sort(this.arrayList, Collections.reverseOrder());
  18. return this.arrayList;
  19. }
  20. }

在上面的类中,我们在构造器中初始化了一个 ArrayList 对象。在 sortAscending()方法中,我们调用了 Collections.sort()方法,并传递这个初始化的 ArrayList对象为参数,返回排序后的 ArrayList。在 sortDescending()方法中,我们调用重载的 Collections.sort()方法让其按照降序对元素排序,这个版本的 Collections.sort()接收ArrayList对象作为第一个参数,一个由 Collections.reverseOrder()方法返回的 Comparator 对象作为第二个参数。我们将会在稍后讲解 Comparator。为了测试排序功能,我们将写一段测试代码。

SortArrayListAscendingDescendingTest.java

  1. package guru.springframework.blog.sortarraylist.ascendingdescending;
  2. import org.junit.Test;
  3. import java.util.ArrayList;
  4. import static org.junit.Assert.*;
  5. public class SortArrayListAscendingDescendingTest {
  6. <a href="http://www.jobbole.com/members/madao">@Test</a>
  7. public void testSortAscendingDescending() throws Exception {
  8. ArrayList countryList = new ArrayList&lt;&gt;();
  9. countryList.add("France");
  10. countryList.add("USA");
  11. countryList.add("India");
  12. countryList.add("Spain");
  13. countryList.add("England");
  14. SortArrayListAscendingDescending sortArrayList = new SortArrayListAscendingDescending(countryList);
  15. ArrayList unsortedArrayList = sortArrayList.getArrayList();
  16. System.out.println("Unsorted ArrayList: " + unsortedArrayList);
  17. ArrayList sortedArrayListAscending = sortArrayList.sortAscending();
  18. System.out.println("Sorted ArrayList in Ascending Order : " + sortedArrayListAscending);
  19. ArrayList sortedArrayListDescending = sortArrayList.sortDescending();
  20. System.out.println("Sorted ArrayList in Descending Order: " + sortedArrayListDescending);
  21. }
  22. }

在上面的测试代码中,我们创建一个 ArrayList 对象,并添加了 5 个字符串对象代表 5 个国家的名字。然后我们调用 getArrayList()、sortAscending()和 sortDescending()方法,并打印这些方法返回的 ArrayList 对象。

输出如下:

  1. -------------------------------------------------------
  2. T E S T S
  3. -------------------------------------------------------
  4. Running guru.springframework.blog.sortarraylist.ascendingdescending.SortArrayListAscendingDescendingTest
  5. Unsorted ArrayList: [France, USA, India, Spain, England]
  6. Sorted ArrayList in Ascending Order : [England, France, India, Spain, USA]
  7. Sorted ArrayList in Descending Order: [USA, Spain, India, France, England]
  8. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.001 sec - in guru.springframework.blog.sortarraylis

到目前为止,所要排序的 ArrayList 元素都是非常简单的,我们仅仅只是调用 Collections.sort()方法并传递了需要排序的 ArrayList 对象作为参数。但是更多的是你会遇到一些复杂的情景下对 ArrayList 进行排序。

Collections.sort() 方法对 ArrayList 的元素或者任何其他 List 的实现提供的可比较的元素进行排序,这意味着这些元素的类需要实现 java.lang 包中的 Comparable 接口。正如 String 类实现了 Comparable 接口,我们就可以对由国名构成的 ArrayList 排序。有些其他的标准 Java 类实现了 Comparable 接口,包括原始的包装类,例如 Integer、Short、Double、Float、Boolean、BigInteger、BigDecimal、File 和 Date 类都实现了 Comparable 接口。

使用Comparable排序ArrayList

Comparable 是带有单一 compareTo()方法的接口。一个实现了 Comparable 接口的类对象可以与其它同类型的对象进行比较,实现 Comparable 接口的类需要重写 compareTo()方法,这个方法接收一个同类型的对象,并实现这个对象和传递给方法的另一个对象比较的逻辑。compareTo()方法返回Int 类型的比较结果,分别代表下面的含义:

  • 正值表示当前对象比传递给 comPareTO()的对象大
  • 负值表示当前对象比传递给 comPareTO()的对象小
  • 零表示两个对象相等

让我们来举一个例子,JobCandidate 类的对象保存在 ArrayList 中并准备对其进行排序。JobCandidate 类有三个成员变量:字符串类型的姓名和性别、整型的年龄。我们想要对保存在 ArrayList 中的 JobCandidate 对象按照年龄进行排序。因此我们要让 JobCandidate 类实现 Comparable 接口并重写 compareTo()方法。

JobCandidate类的代码如下:

JobCandidate.java

  1. package guru.springframework.blog.sortarraylist.comparable;
  2. public class JobCandidate implements Comparable {
  3. private String name;
  4. private String gender;
  5. private int age;
  6. public JobCandidate(String name, String gender, int age) {
  7. this.name = name;
  8. this.gender = gender;
  9. this.age = age;
  10. }
  11. public String getName() {
  12. return name;
  13. }
  14. public String getGender() {
  15. return gender;
  16. }
  17. public int getAge() {
  18. return age;
  19. }
  20. @Override
  21. public int compareTo(JobCandidate candidate) {
  22. return (this.getAge() < candidate.getAge() ? -1 :
  23. (this.getAge() == candidate.getAge() ? 0 : 1));
  24. }
  25. @Override
  26. public String toString() {
  27. return " Name: " + this.name + ", Gender: " + this.gender + ", age:" + this.age;
  28. }
  29. }

在上面 JobCandidate 类被重写的 compareTo()方法中,我们实现了基于年龄的比较逻辑。我见过很多程序员将(this.getAge() – candidate.getAge())作为返回的比较结果。尽管使用这种 return 语句看上去似乎很吸引人,并且也不会对我们的例子造成影响,我的建议是远离这种语句。想象一下,比较整数值,其中有一个或者两个都是负数的结果。这会导致 一些错误,让你的程序行为不定,而且更重要的是,这样的错误是很细微的,尤其是在大型的企业应用中很难检测出来。下面我们将写一个辅助类,为委托方对包含了 JobCandidate 元素的 ArrayList 对象进行排序。

JobCandidateSorter.java

  1. package guru.springframework.blog.sortarraylist.comparable;
  2. import java.util.ArrayList;
  3. import java.util.Collections;
  4. public class JobCandidateSorter {
  5. ArrayList jobCandidate = new ArrayList<>();
  6. public JobCandidateSorter(ArrayList jobCandidate) {
  7. this.jobCandidate = jobCandidate;
  8. }
  9. public ArrayList getSortedJobCandidateByAge() {
  10. Collections.sort(jobCandidate);
  11. return jobCandidate;
  12. }
  13. }

在 JobCandidateSorter 类中,我们初始化了一个 ArrayList 对象,委托方将通过构造函数实例化 JobCandidateSorter 。然后我们编写了 getSortedJobCandidateByAge()方法,在这个方法中,我们调用 Collections.sort()并传递已经初始化了的 ArrayList 为参数,最后返回排序后的 ArrayList。

接下来,我们写一个测试类来测试一下我们的代码。

JobCandidateSorterTest.java

  1. package guru.springframework.blog.sortarraylist.comparable;
  2. import org.junit.Test;
  3. import java.lang.reflect.Array;
  4. import java.util.ArrayList;
  5. import static org.junit.Assert.*;
  6. public class JobCandidateSorterTest {
  7. <a href="http://www.jobbole.com/members/madao">@Test</a>
  8. public void testGetSortedJobCandidateByAge() throws Exception {
  9. JobCandidate jobCandidate1 = new JobCandidate("Mark Smith""Male"26);
  10. JobCandidate jobCandidate2 = new JobCandidate("Sandy Hunt""Female"23);
  11. JobCandidate jobCandidate3 = new JobCandidate("Betty Clark""Female"20);
  12. JobCandidate jobCandidate4 = new JobCandidate("Andrew Styne""Male"24);
  13. ArrayList jobCandidateList = new ArrayList&lt;&gt;();
  14. jobCandidateList.add(jobCandidate1);
  15. jobCandidateList.add(jobCandidate2);
  16. jobCandidateList.add(jobCandidate3);
  17. jobCandidateList.add(jobCandidate4);
  18. JobCandidateSorter jobCandidateSorter = new JobCandidateSorter(jobCandidateList);
  19. ArrayList sortedJobCandidate = jobCandidateSorter.getSortedJobCandidateByAge();
  20. System.out.println("-----Sorted JobCandidate by age: Ascending-----");
  21. for (JobCandidate jobCandidate : sortedJobCandidate) {
  22. System.out.println(jobCandidate);
  23. }
  24. }
  25. }

在上面的测试类中,我们创建了四个 JobCandidate 对象并把它们添加到 ArrayList,然后传递这个 ArrayList 到构造函数来实例化 JobCandidateSorter 类。最后,我们调用 JobCandidateSorter 类的 getSortedJobCandidateByAge()方法,并打印这个方法返回的排序后的 ArrayList。测试的输出结果如下:

  1. -------------------------------------------------------
  2. T E S T S
  3. -------------------------------------------------------
  4. Running guru.springframework.blog.sortarraylist.comparable.JobCandidateSorterTest
  5. -----Sorted JobCandidate by age: Ascending-----
  6. Name: Betty Clark, Gender: Female, age:20
  7. Name: Sandy Hunt, Gender: Female, age:23
  8. Name: Andrew Styne, Gender: Male, age:24
  9. Name: Mark Smith, Gender: Male, age:26
  10. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.003 sec
  11. - in guru.springframework.blog.sortarraylist.comparable.JobCandidateSorterTest

使用 Comparable 对 ArrayList 排序是一种常用的方法。但是你必须知道有某些限制。你想要排序的对象的类必须实现 Comparable 并覆写 compareTo()方法。这基本上意味着你将只能基于一个成员变量来比较对象(我们例子中的年龄字段)。如果要求你按照姓名和年龄来对 JobCandidate 对象进行排序怎么办? Comparable 就不是解决的方法了。另外,比较逻辑是需要进行比较的对象的类的一部分,它消除了比较逻辑可复用性的可能。Java 通过使用在 java.util 包下提供的Comparator接口解决了上述的比较需求。

使用 Comparator 排序 ArrayList

Comparator 接口与Comparable 接口相似也提供了一个单一的比较方法叫作 compare()。然而,与 Comparable的 compareTo()方法不同的是,这个 compare()接受两个同类型的不同对象进行比较。

我们将用 Comparator 对我们之前使用过的相同 JobCandidate 类对象进行排序。我们将通过实现 Comparatoras 匿名内部类,允许对 JobCandidate 对象按照年龄和姓名进行排序。

下面是使用了 Comparator 的 JobCandidate 类代码

JobCandidate.java

  1. package guru.springframework.blog.sortarraylist.comparator;
  2. import java.util.Comparator;
  3. public class JobCandidate {
  4. private String name;
  5. private String gender;
  6. private int age;
  7. public JobCandidate(String name, String gender, int age) {
  8. this.name = name;
  9. this.gender = gender;
  10. this.age = age;
  11. }
  12. public String getName() {
  13. return name;
  14. }
  15. public String getGender() {
  16. return gender;
  17. }
  18. public int getAge() {
  19. return age;
  20. }
  21. public static Comparator ageComparator = new Comparator() {
  22. @Override
  23. public int compare(JobCandidate jc1, JobCandidate jc2) {
  24. return (jc2.getAge() < jc1.getAge() ? -1 :
  25. (jc2.getAge() == jc1.getAge() ? 0 : 1));
  26. }
  27. };
  28. public static Comparator nameComparator = new Comparator() {
  29. @Override
  30. public int compare(JobCandidate jc1, JobCandidate jc2) {
  31. return (int) (jc1.getName().compareTo(jc2.getName()));
  32. }
  33. };
  34. @Override
  35. public String toString() {
  36. return " Name: " + this.name + ", Gender: " + this.gender + ", age:" + this.age;
  37. }
  38. }

在上面的类中,从 29 行到 35 行,我们写了一个匿名类并实现了 compare()方法,按照年龄的降序对 JobCandidate 对象进行排序。从37行到42行,我们又写了一个匿名类并实现了 compare() 方法,按照姓名的升序对 JobCandidate进行排序。现在我们写一个类,为委托方对 ArrayList 的元素进行排序。

JobCandidateSorter.java

  1. package guru.springframework.blog.sortarraylist.comparator;
  2. import java.util.ArrayList;
  3. import java.util.Collections;
  4. public class JobCandidateSorter {
  5. ArrayList jobCandidate = new ArrayList<>();
  6. public JobCandidateSorter(ArrayList jobCandidate) {
  7. this.jobCandidate = jobCandidate;
  8. }
  9. public ArrayList getSortedJobCandidateByAge() {
  10. Collections.sort(jobCandidate, JobCandidate.ageComparator);
  11. return jobCandidate;
  12. }
  13. public ArrayList getSortedJobCandidateByName() {
  14. Collections.sort(jobCandidate, JobCandidate.nameComparator);
  15. return jobCandidate;
  16. }
  17. }

在上面的类中,我们写了 getSortedJobCandidateByAge()方法,在这个方法内部我们调用了 Collections.sort()的重载版本,这个版本传递要被排序的 ArrayList 对象和比较年龄的 Comparator 对象。在 getSortedJobCandidateByName()方法内部,我们又调用了 Collections.sort()的另一个重载版本,这个版本传递要被排序的 ArrayList 对象和比较姓名的 Comparator 对象。

让我们写一个测试类来测试我们的代码。

JobCandidateSorterTest.java

  1. package guru.springframework.blog.sortarraylist.comparator;
  2. import guru.springframework.blog.sortarraylist.comparator.JobCandidate;
  3. import guru.springframework.blog.sortarraylist.comparator.JobCandidateSorter;
  4. import org.junit.Before;
  5. import org.junit.Test;
  6. import java.util.ArrayList;
  7. import static org.junit.Assert.*;
  8. public class JobCandidateSorterTest {
  9. JobCandidateSorter jobCandidateSorter;
  10. @Before
  11. public void setUp() throws Exception {
  12. JobCandidate jobCandidate1 = new JobCandidate("Mark Smith""Male"26);
  13. JobCandidate jobCandidate2 = new JobCandidate("Sandy Hunt""Female"23);
  14. JobCandidate jobCandidate3 = new JobCandidate("Betty Clark""Female"20);
  15. JobCandidate jobCandidate4 = new JobCandidate("Andrew Styne""Male"24);
  16. ArrayList jobCandidateList = new ArrayList&lt;&gt;();
  17. jobCandidateList.add(jobCandidate1);
  18. jobCandidateList.add(jobCandidate2);
  19. jobCandidateList.add(jobCandidate3);
  20. jobCandidateList.add(jobCandidate4);
  21. jobCandidateSorter = new JobCandidateSorter(jobCandidateList);
  22. }
  23. <a href="http://www.jobbole.com/members/madao">@Test</a>
  24. public void testGetSortedJobCandidateByAge() throws Exception {
  25. System.out.println("-----Sorted JobCandidate by age: Descending-----");
  26. ArrayList sortedJobCandidate = jobCandidateSorter.getSortedJobCandidateByAge();
  27. for (JobCandidate jobCandidate : sortedJobCandidate) {
  28. System.out.println(jobCandidate);
  29. }
  30. }
  31. <a href="http://www.jobbole.com/members/madao">@Test</a>
  32. public void testGetSortedJobCandidateByName() throws Exception {
  33. System.out.println("-----Sorted JobCandidate by name: Ascending-----");
  34. ArrayList sortedJobCandidate = jobCandidateSorter.getSortedJobCandidateByName();
  35. for (JobCandidate jobCandidate : sortedJobCandidate) {
  36. System.out.println(jobCandidate);
  37. }
  38. }
  39. }

在测试类中我们向 ArrayList 中添加若干 JobCandidate 对象,并使用 Before 注释在测试单元的 setup()方法中创建了一个 JobCandidateSorter 对象。如果你是一个 Junit 新手,可以参考我以前的文章包括 Junit 注释(Junit 单元测试系列)。 在 testGetSortedJobCandidateByAge()测试方法中我们调用了 getSortedJobCandidateByAge()方法,并打印了该方法返回的排序后的 ArrayList。在 testGetSortedJobCandidateByName()测试方法中我们调用了getSortedJobCandidateByName() 方法并同样打印该方法返回的 ArrayList。测试的输出如下:

  1. -------------------------------------------------------
  2. T E S T S
  3. -------------------------------------------------------
  4. Running guru.springframework.blog.sortarraylist.comparator.JobCandidateSorterTest
  5. -----Sorted JobCandidate by name: Ascending-----
  6. Name: Andrew Styne, Gender: Male, age:24
  7. Name: Betty Clark, Gender: Female, age:20
  8. Name: Mark Smith, Gender: Male, age:26
  9. Name: Sandy Hunt, Gender: Female, age:23
  10. -----Sorted JobCandidate by age: Descending-----
  11. Name: Mark Smith, Gender: Male, age:26
  12. Name: Andrew Styne, Gender: Male, age:24
  13. Name: Sandy Hunt, Gender: Female, age:23
  14. Name: Betty Clark, Gender: Female, age:20
  15. Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.023 sec
  16. - in guru.springframework.blog.sortarraylist.comparator.JobCandidateSorterTest

总结

在本文中我们看到了 ArrayList 排序的不同方法。一种是使用 Comparable 另一种是使用 Comparator。方法的选择一直是造成程序员们困惑的原因之一。你最应该记住的就是一个 Comparable 对象可以说“我可以自己与另外一个对象比较”而一个 Comparator 对象可以说“我可以比较两个不同的对象”。你不能说一个接口比另一个要好。选择的接口取决于你需要实现的功能。

  
 

除特别注明外,本站所有文章均为铁匠运维网原创,转载请注明出处来自http://www.tiejiang.org/4169.html

关于

发表评论

暂无评论

切换注册

登录

忘记密码 ?

您也可以使用第三方帐号快捷登录

切换登录

注册

扫一扫二维码分享