throw new IllegalArgumentException(“用户不存在!”);
}
}
- 采用Assert能使代码更优雅,更简洁。
还是上面的例子,如果采用Assert可以这样写:
public void test2(int accountId) {
Account account = accountDao.selectById(accountId);
Assert.notNull(account, “用户不存在!”);
}
如何使用Assert?
在SpringBoot中使用Assert非常简单,直接使用Assert提供的静态方法即可。
@RestController
@RequestMapping(“assert”)
@Slf4j
public class AssertController {
@DeleteMapping(“/user/{id}”)
public void deleteUser(@PathVariable(“id”) String id) {
//模拟数据库查询用户
UserVO user =
getUserById(id);
Assert.notNull(user, “用户不存在!”);
}
private UserVO getUserById(String id) {
return null;
}
}
如上,AssertController有一个删除用户的接口,当删除用户时我们需要先校验用户是否存在。这里直接使用Assert.notNull()
进行UserVO
的非空校验。
此时访问接口,返回的json对象如下:
{
“timestamp”: “2022-01-10T14:17:13.335+00:00”,
“status”: 500,
“error”: “Internal Server Error”,
“message”: “”,
“path”: “/assert/user/javadaily”
}
从测试结果来看,assert抛出的异常是springboot原生json对象,很明显我们必须将其加入全局异常拦截器RestExceptionHandler
。
加入全局异常拦截器
查看Assert.notNull()
方法,可以看到Assert抛出的是IllegalArgumentException
异常,所以我们只需要在全局异常拦截器中加入IllegalArgumentException
拦截即可。
/**
* Assert异常
*/
@ExceptionHandler(IllegalArgumentException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ResultData exception(IllegalArgumentException e) {
return ResultData.fail(ReturnCode.ILLEGAL_ARGUMENT.getCode(),e.getMessage());
}
此时再次访问接口,返回的数据结果为:
{
“status”: 3001,
“message”: “用户不存在!”,
“data”: null,
“timestamp”: 1641825258876
}
符合结果预期。
常见的Assert使用场景
- 逻辑断言
-
isTrue()
如果条件为假抛出IllegalArgumentException 异常。 -
state()
该方法与isTrue一样,但抛出IllegalStateException异常。
- 对象和类型断言
-
notNull()
通过notNull()方法可以假设对象不null: -
isNull()
用来检查对象为null: -
isInstanceOf()
使用isInstanceOf()方法检查对象必须为另一个特定类型的实例 -
isAssignable()
使用Assert.isAssignable()方法检查类型
- 文本断言
-
hasLength()
如果检查字符串不是空符串,意味着至少包含一个空白,可以使用hasLength()方法。 -
hasText()
我们能增强检查条件,字符串至少包含一个非空白字符,可以使用hasText()方法。 -
doesNotContain()
我们能通过doesNotContain()方法检查参数不包含特定子串。
- Collection和map断言
-
Collection应用
notEmpty()
如其名称所示,notEmpty()方法断言collection不空,意味着不是null并包含至少一个元素。 -
map应用
notEmpty()
同样的方法重载用于map,检查map不null,并至少包含一个entry(key,value键值对)。
- 数组断言
-
notEmpty()
notEmpty()方法可以检查数组不null,且至少包括一个元素: -
noNullElements()
noNullElements()方法确保数组不包含null元素
mpty()方法断言collection不空,意味着不是null并包含至少一个元素。
- map应用
notEmpty()
同样的方法重载用于map,检查map不null,并至少包含一个entry(key,value键值对)。
- 数组断言
-
notEmpty()
notEmpty()方法可以检查数组不null,且至少包括一个元素: -
noNullElements()
noNullElements()方法确保数组不包含null元素