原创声明:本文为作者(幻好)原创,可用做学习参考转载,但需注明出处。禁止未经允许用于商业等途径,否则后果自负!
前言概述
在 Java 的日常代码开发中,最常见也是肯定会考虑的问题就是**对象的判空,**如:if (null != object)
。随着代码的复杂度越来越高,就会有越来越多堆积的判空,使得代码的可读性降低。而且实际场景只判空 null 是远远不够的,可能会有空的字符或空格严格上来说也为空,如果都加到条件判断上,会显得特别臃肿。
本文主要通过以上常见的场景出发,并推荐相应的解决方法,帮助我们提升代码质量。
对象的判空
对象为空的来源
对于大多少经验不多的程序员,通常会为了遍历在复杂的业务方法中,返回 null
作为方法的失败回调情况。但是以 null
作为最终结果进行返回,增加了后续判空的代码复杂度,同时如果存在多种失败的情况,后续追踪问题的原因时,排查成本也会增加。所以不要为了今日的方便,造成以后的不便,对于不同的情况一定要做对应的处理,有时候返回异常都比返回 null
更好。不推荐示例:
public object getResult() {
if (...) {
return null;
} else if (...) {
return null;
} else {
...
}
}
处理可能为空的对象
在开发中会遇到需要需要判空的场景,有的空有意义,有的是无意义的。判断处理上也需要对症下药,同时代码也需要简洁直白。
我们可以使用 JDK 中的 assert 进行处理,但是满足的场景也非常有限,我们可以借助一些工具类(如:org.apache.commons),更全面对于控制的判断。
Apache Commons
Apache Commons 是 Apache 团队对于JDK原有的API进行增强,并提供了一系列常用的工具,帮助开发者能够更简单的使用判空,让代码更加直观简洁。
以最常见的字符串的判空为例,来看看最常见的判空方法,字符串通常使用工具类 org.apache.commons.lang3.StringUtils
进行操作。
以 org.apache.commons 3.2+版本中的方法为例
isEmpty()
StringUtils.isEmpty()
方法用来判断字符串是否为空 ("")
或 null
,但是如果是字符串是空格,并不会判断为空。实例如下:
StringUtils.isEmpty(null); // true
StringUtils.isEmpty(""); // true
StringUtils.isEmpty(" "); // false
StringUtils.isEmpty("str"); // false
StringUtils.isEmpty(" str "); // false
源码解析:
// 检查 null 和 ""
public static boolean isEmpty(CharSequence cs) {
return cs == null || cs.length() == 0;
}
isNotEmpty()
StringUtils.isNotEmpty()
方法是 isEmpty()
方法的否定。
源码解析:
public static boolean isNotEmpty(CharSequence cs) {
return !StringUtils.isEmpty(cs);
}
isAnyEmpty()
StringUtils.isBlank()
方法检查多个字符串中是否有一个为空 ("") 或 null,示例如下:
StringUtils.isAnyEmpty((String) null) // true
StringUtils.isAnyEmpty((String[]) null) // false
StringUtils.isAnyEmpty(null, "foo") // true
StringUtils.isAnyEmpty("", "bar") // true
StringUtils.isAnyEmpty("bob", "") // true
StringUtils.isAnyEmpty(" bob ", null) // true
StringUtils.isAnyEmpty(" ", "bar") // false
StringUtils.isAnyEmpty("foo", "bar") // false
StringUtils.isAnyEmpty(new String[]{}) // false
StringUtils.isAnyEmpty(new String[]{""}) // true
源码解析:
public static boolean isAnyEmpty(final CharSequence... css) {
if (ArrayUtils.isEmpty(css)) {
return false;
}
// 遍历每个字符串进行检查判空
for (final CharSequence cs : css) {
if (isEmpty(cs)) {
return true;
}
}
return false;
}
isNoneEmpty()
StringUtils.isNoneEmpty()
方法是 isAnyEmpty()
方法的否定。
源码解析:
public static boolean isNoneEmpty(final CharSequence... css) {
return !isAnyEmpty(css);
}
isBlank()
StringUtils.isBlank()
方法检查字符串是否为空格、空 ("") 或 null,相对于 isEmpty()
方法增加了空格的判断。示例如下:
StringUtils.isBlank(null); // true
StringUtils.isBlank(""); // true
StringUtils.isBlank(" "); // true
StringUtils.isBlank("str"); // false
StringUtils.isBlank(" str "); // false
源码解析:
public static boolean isBlank(CharSequence cs) {
int strLen;
// 检查 null 和 ""
if (cs == null || (strLen = cs.length()) == 0) {
return true;
}
// 检查空格
for (int i = 0; i < strLen; i++) {
if (Character.isWhitespace(cs.charAt(i)) == false) {
return false;
}
}
return true;
}
isNotBlank()
StringUtils.isNotBlank()
方法是 isBlank()
方法的否定。
源码解析:
public static boolean isNotBlank(CharSequence cs) {
return !StringUtils.isBlank(cs);
}
小结
以上介绍的是工具类 org.apache.commons.lang3.StringUtils
的常用判空方法,它还有其他很多方法等待大家发掘,能帮助我们解决日常开发中大量常见的问题。
函数方法 | 功能说明 |
---|---|
IsEmpty/IsBlank | 检查字符串是否包含文本 |
Trim/Strip | 删除前导和尾随空格 |
Equals/Compare | 以 null 安全的方式比较两个字符串 |
startsWith | 检查字符串是否以 null 安全方式以前缀开头 |
endsWith | 检查字符串是否以空安全方式以后缀结尾 |
IndexOf/LastIndexOf/Contains | 空安全索引检查 |
IndexOfAny/LastIndexOfAny/IndexOfAnyBut/LastIndexOfAnyBut | 任何一组字符串的索引 |
ContainsOnly/ContainsNone/ContainsAny | 检查字符串是否仅/无/这些字符中的任何一个 |
Substring/Left/Right/Mid | 空安全子字符串提取 |
SubstringBefore/SubstringAfter/SubstringBetween | 相对于其他字符串的子字符串提取 |
Split/Join | 将字符串拆分为子字符串数组,反之亦然 |
Remove/Delete | 删除字符串的一部分 |
Replace/Overlay | 搜索字符串并用另一个字符串替换一个字符串 |
Chomp/Chop | 删除字符串的最后一部分 |
AppendIfMissing | 如果不存在,则将后缀附加到字符串的末尾 |
PrependIfMissing | 如果不存在,则在字符串的开头添加前缀 |
LeftPad/RightPad/Center/Repeat | 填充字符串 |
UpperCase/LowCase/SwapCase/Capitalize/Uncapitalize | 更改字符串的大小写 |
CountMatches | 计算一个字符串在另一个字符串中出现的次数 |
IsAlpha/IsNumeric/IsWhitespace/IsAsciiPrintable | 检查字符串中的字符 |
DefaultString | 防止空输入字符串 |
Rotate | 旋转(循环移位)一个字符串 |
Reverse/ReverseDelimited | 反转字符串 |
Abbreviate | 使用省略号或其他给定字符串缩写字符串 |
Difference | 比较字符串并报告它们的差异 |
LevenshteinDistance | 将一个字符串更改为另一个字符串所需的更改次数 |
除了字符串外,对于集合的检验,也可以使用工具类 org.apache.commons.collections4.CollectionUtils
,感兴趣的可以去研究 。
参考官方API:https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html
https://commons.apache.org/proper/commons-collections/
总结
本文主要以开发中实际遇到的经验之谈展开,讨论了空值的判断注意事项,提升我们的开发思维和技巧,希望能够同为开发者的你有所帮助。