Guava中的Preconditions(前置条件判别)

Preconditions(前置条件):让办法调用的前置条件判别更简略

Guava在Preconditions 类中供给了若干前置条件判别的有用办法,咱们强烈主张在 Eclipse 中静态导入这些办法。每个办法都有三个变种:

  1. 当办法没有额定参数时,抛出的反常中不包括过错音讯,这会使得调用方很难确定产生了什么过错。因而,咱们应该在抛出反常时,为其供给一个有意义的过错音讯。

  2. 当办法有一个 Object 目标作为额定参数时,咱们能够运用该目标的 toString() 办法作为过错音讯。这样能够确保过错音讯能够包括额定参数的信息,方便调用方定位问题。

  3. 当办法有一个 String 目标作为额定参数,并且有一组恣意数量的附加 Object 目标时,咱们能够选用相似 printf 的办法来处理反常音讯。由于考虑到 GWT 的兼容性和功率,咱们只支持 %s 指示符。因而,咱们能够在过错音讯中运用 %s 来表明 String 参数,并运用 String.format() 办法将附加参数格局化为字符串,然后将其插入到过错音讯中。

综上所述,无论是否有额定参数,咱们都应该为抛出的反常供给有意义的过错音讯,以便调用方能够更好地了解和解决问题。在处理反常音讯时,咱们应该根据具体情况挑选合适的办法,以确保代码的可读性和可维护性

实际代码事例

checkArgument(i >= 0, "Argument was %s but expected nonnegative", i);
checkArgument(i < j, "Expected i < j, but %s > %s", i, j);

判别逻辑参数场景

办法声明(不包括额定参数) 描述 查看失利时抛出的反常
checkArgument(boolean) 查看 boolean 是否为 true,用来查看传递给办法的参数。 IllegalArgumentException
checkNotNull(T) 查看 value 是否为 null,该办法直接回来 value,因而能够内嵌运用 checkNotNull? NullPointerException
checkState(boolean) 用来查看目标的某些状态。 IllegalStateException
checkElementIndex(int index, int size) 查看 index 作为索引值对某个列表、字符串或数组是否有用。index>=0 && index<size IndexOutOfBoundsException
checkElementIndex(int index, int size) 查看 index 作为索引值对某个列表、字符串或数组是否有用。index>=0 && index<size IndexOutOfBoundsException
checkPositionIndex(int index, int size) 查看 index 作为方位值对某个列表、字符串或数组是否有用。index>=0 && index<=size IndexOutOfBoundsException
checkPositionIndexes(int start, int end, int size) 查看[start, end]表明的方位范围对某个列表、字符串或数组是否有用 IndexOutOfBoundsException

提示:索引值常用来查找列表、字符串或数组中的元素,如 List.get(int), String.charAt(int)
方位值和方位范围常用来截取列表、字符串或数组,如 List.subList(int,int), String.substring(int)
相比 Apache Commons 供给的相似办法,咱们把 Guava 中的 Preconditions 作为首选。

相比其他API的优势和好处

在静态导入后,Guava 办法非常清楚明晰。checkNotNull 清楚地描述做了什么,会抛出什么反常;

  • checkNotNull 直接回来查看的参数,让你能够在构造函数中坚持字段的单行赋值风格:this.field = checkNotNull(field)
  • 简略的、参数可变的 printf 风格反常信息。鉴于这个优点,JDK7 已经引进Objects.requireNonNull 的情况下,咱们仍然主张你运用checkNotNull。

在编码时,假如某个值有多重的前置条件,咱们主张你把它们放到不同的行,这样有助于在调试时定位。此外,把每个前置条件放到不同的行,也能够协助你编写明晰和有用的过错音讯。

Guava中的Preconditions(常见Object办法)

提示:可阐述编程学习办法

equals

当一个目标中的字段能够为 null 时,完成 Object.equals 办法会很痛苦,因为不得不分别对它们进行 null 查看。运用 Objects.equal 协助你履行 null 灵敏的 equals 判别,从而避免抛出 NullPointerException。例如:

Objects.equal("a", "a"); // returns true
Objects.equal(null, "a"); // returns false
Objects.equal("a", null); // returns false
Objects.equal(null, null); // returns true

留意:JDK7 引进的 Objects 类供给了一样的办法 Objects.equals。

hashCode

用目标的一切字段作散列[hash]运算应当更简略。Guava 的 Objects.hashCode(Object…)会对传入的字段序列核算出合理的、顺序灵敏的散列值。你能够运用 Objects.hashCode(field1, field2, …, fieldn)来代替手动核算散列值。

留意:JDK7 引进的 Objects 类供给了一样的办法 Objects.hash(Object…)

toString

toString办法在调试时是价值连城,但是编写 toString 办法有时候却很痛苦。运用 Objects.toStringHelper 能够轻松编写有用的 toString 办法。例如:

// Returns "ClassName{x=1}"
Objects.toStringHelper(this).add("x", 1).toString();
// Returns "MyObject{x=1}"
Objects.toStringHelper("MyObject").add("x", 1).toString();

compare/compareTo

完成一个比较器[Comparator],或许直接完成 Comparable 接口有时也伤不起。考虑一下这种情况:

class Person implements Comparable<Person> {
private String lastName;
private String firstName;
private int zipCode;
public int compareTo(Person other) {
		int cmp = lastName.compareTo(other.lastName);
		if (cmp != 0) {
			return cmp;
		}
		cmp = firstName.compareTo(other.firstName);
		if (cmp != 0) {
			return cmp;
		}
		return Integer.compare(zipCode, other.zipCode);
	}
}

这部分代码太琐碎了,因而很简单搞乱,也很难调试。咱们应该能把这种代码变得更高雅,为此,Guava 供给了ComparisonChain。

ComparisonChain

ComparisonChain 履行一种懒比较:它履行比较操作直至发现非零的结果,在那之后的比较输入将被忽略。

public int compareTo(Foo that) {
	return ComparisonChain.start()
		.compare(this.aString, that.aString)
		.compare(this.anInt, that.anInt)
		.compare(this.anEnum, that.anEnum, Ordering.natural().nullsLast())
		.result();
}

这种Fluent接口风格的可读性更高,产生过错编码的几率更小,并且能避免做不必要的作业。更多 Guava 排序器东西能够在下一节里找到。

Guava中的排序器[Ordering]

Guava 强大的”流通风格比较器” 是 Guava 流通风格比较器[Comparator]的完成,它能够用来为构建杂乱的比较器,以完成集
合排序的功用。

从完成上说,Ordering 实例就是一个特殊的 Comparator 实例。Ordering 把许多根据 Comparator 的静态办法(如 Collections.max)包装为自己的实例办法(非静态办法),并且供给了链式调用办法,来定制和增强现有的比较器。

创立排序器:常见的排序器能够由下面的静态办法创立

办法声明(不包括额定参数) 描述
natural() 对可排序类型做天然排序,如数字按巨细,日期按先后排序。
usingToString() 按目标的字符串方式做字典排序[lexicographical ordering]。
natural() 对可排序类型做天然排序,如数字按巨细,日期按先后排序。
from(Comparator) 把给定的 Comparator 转化为排序器。

完成自定义的排序器时,除了用上面的 from 办法,也能够跳过完成 Comparator,而直接继承 Ordering:

Ordering<String> byLengthOrdering = new Ordering<String>() {
	public int compare(String left, String right) {
		return Ints.compare(left.length(), right.length());
	}
};

链式调用办法:经过链式调用,能够由给定的排序器衍生出其它排序器

办法声明(不包括额定参数) 描述
reverse() 获取语义相反的排序器。
nullsFirst() 运用当时排序器,但额定把 null 值排到最前面。
nullsLast() 运用当时排序器,但额定把 null 值排到最后面。
compound(Comparator) 组成另一个比较器,以处理当时排序器中的持平情况。
lexicographical() 根据处理类型 T 的排序器,回来该类型的可迭代目标 Iterable的排序器。
onResultOf(Function) 对调集中元素调用 Function,再按回来值用当时排序器排序。

例如,你需求下面这个类的排序器。

class Foo {
	@Nullable String sortedBy;
	int notSortedBy;
}

考虑到排序器应该能处理 sortedBy 为 null 的情况,咱们能够运用下面的链式调用来组成排序器:

Ordering<Foo> ordering = Ordering.natural().nullsFirst().onResultOf(new Function<Foo, String>() {
	public String apply(Foo foo) {
		return foo.sortedBy;
	}
});

当阅览链式调用产生的排序器时,应该从后往前读。上面的例子中,排序器首先调用 apply 办法获取 sortedBy值,并把 sortedBy 为 null 的元素都放到最前面,然后把剩余的元素按 sortedBy 进行天然排序。之所以要从后往前读,是因为每次链式调用都是用后面的办法包装了前面的排序器。

注:用 compound 办法包装排序器时,就不该遵循从后往前读的原则。为了避免了解上的混乱,请不要把 compound 写在一长串链式调用的中间,你能够另起一行,在链中最先或最后调用 compound。超越一定长度的链式调用,也可能会带来阅览和了解上的难度。咱们主张按下面的代码这样,在一个链中最多运用三个办法。此外,你也能够把 Function 分离成中间目标,让链式调用更简练紧凑。

Ordering<Foo> ordering = Ordering.natural().nullsFirst().onResultOf(sortKeyFunction)

运用排序器:Guava的排序器完成有若干操作调集或元素值的办法。

办法声明(不包括额定参数) 描述
greatestOf(Iterable iterable, int k) 获取可迭代目标中最大的k个元素,相反最小:leastOf。
isOrdered(Iterable) 判别可迭代目标是否已按排序器排序:允许有排序值持平的元素,isStrictlyOrdered。
sortedCopy(Iterable) 判别可迭代目标是否已严格按排序器排序:不允许排序值持平的元素,immutableSortedCopy。
min(E, E) 回来两个参数中最小的那个。假如持平,则回来第一个参数,max(E, E)。
min(E, E, E, E…) 回来多个参数中最小的那个。假如有超越一个参数都最小,则回来第一个最小的参数,max(E, E, E, E…)
min(Iterable) 回来迭代器中最小的元素。假如可迭代目标中没有元素,则抛出 NoSuchElementException,max(Iterable), min(Iterator), max(Iterator)。

下节预告

【Java技术专题】「Guava开发攻略」手把手教你如何进行运用Guava东西箱进行开发系统实战攻略(反常处理篇)