Springboot 使用断言Assert方式来校验业务的异常情况，消除 if else语句

原创

wx58763b21ae3ed 2023-04-08 08:40:24 ©著作权

文章标签 spring boot 后端 java assert 断言 文章分类 JavaScript 前端开发

©著作权归作者所有：来自51CTO博客作者wx58763b21ae3ed的原创作品，请联系作者获取转载授权，否则将追究法律责任

1、什么是断言

断言(assert)是一种编程中常用的手段。在通常情况下,断言就是将一个返回值总是需要为真的判别式放在语句中,用于排除在设计的逻辑上不应该产生的情况。比如一个函数总需要输入在一定的范围内的参数,那么程序员就可以对该参数使用断言,以迫使在该参数发生异常的时候程序退出,从而避免程序陷入逻辑的混乱。

2、使用断言比使用if else更简洁

test2使用断言代替if 语句

public class AssertTests {

	//if else的用法
    @Test
    public void test1() {
        Object o = null;
        if (o == null) {
            throw new IllegalArgumentException("用户不存在.");
        }
    }

	//断言的用法：更为简洁
    @Test
    public void test2() {
        // 另一种写法
        Object o = null;
        Assert.notNull(o, "用户不存在.");
    }
}

3、自定义断言

用断言的方式封装异常的抛出

@Slf4j
public abstract class MyAssert {

    /**
     * 断言对象不为空
     * 如果对象obj为空，则抛出异常
     * @param obj 待判断对象
     */
    public static void notNull(Object obj, ResponseEnum responseEnum) {
        if (obj == null) {
            log.info("obj is null...............");
            throw new MyException(responseEnum);
        }
    }
    
	public static void notNull(Object obj, String msg) {
        if (obj == null) {
            log.info("obj is null...............");
            throw new MyException(msg);
        }
    }
	 /**
     * 断言对象为空
     * 如果对象obj不为空，则抛出异常
     *
     * @param object
     * @param responseEnum
     */
    public static void isNull(Object object, ResponseEnum responseEnum) {
        if (object != null) {
            log.info("obj is not null......");
            throw new MyException(responseEnum);
        }
    }

    /**
     * 断言表达式为真
     * 如果不为真，则抛出异常
     *
     * @param expression 是否成功
     */
    public static void isTrue(boolean expression, ResponseEnum responseEnum) {
        if (!expression) {
            log.info("fail...............");
            throw new MyException(responseEnum);
        }
    }

    /**
     * 断言两个对象不相等
     * 如果相等，则抛出异常
     *
     * @param m1
     * @param m2
     * @param responseEnum
     */
    public static void notEquals(Object m1, Object m2, ResponseEnum responseEnum) {
        if (m1.equals(m2)) {
            log.info("equals...............");
            throw new MyException(responseEnum);
        }
    }

    /**
     * 断言两个对象相等
     * 如果不相等，则抛出异常
     *
     * @param m1
     * @param m2
     * @param responseEnum
     */
    public static void equals(Object m1, Object m2, ResponseEnum responseEnum) {
        if (!m1.equals(m2)) {
            log.info("not equals...............");
            throw new MyException(responseEnum);
        }
    }

    /**
     * 断言参数不为空
     * 如果为空，则抛出异常
     *
     * @param s
     * @param responseEnum
     */
    public static void notEmpty(String s, ResponseEnum responseEnum) {
        if (StringUtils.isEmpty(s)) {
            log.info("is empty...............");
            throw new MyException(responseEnum);
        }
    }
}

MyException 代码

@Data
@NoArgsConstructor
public class MyException extends RuntimeException{

    //错误码
    private Integer code;
    //错误信息
    private String msg;

    public MyException(String msg){
        this.msg = msg;
    }

    public MyException(Integer code, String msg){
        this.msg = msg;
        this.code = code;
    }

    public MyException(Integer code, String msg, Throwable cause){
        super(cause);
        this.msg = msg;
        this.code = code;
    }

    public MyException(ResponseEnum responseEnum){
        this.code = responseEnum.getCode();
        this.msg = responseEnum.getMsg();
    }
}

响应信息ResponseEnum

@Getter
@ToString
@AllArgsConstructor
public enum ResponseEnum {

    SUCCESS(0, "成功"),
    ERROR(-1, "服务器内部错误"),
    //-1xx 服务器错误
    BAD_SQL_GRAMMAR_ERROR(-101, "sql语法错误"),
    SERVLET_ERROR(-102, "servlet请求异常"), //-2xx 参数校验   
    ;

    //响应状态码
    private Integer code;
    //响应信息
    private String message;
}

4、自定义断言使用

校验手机号吗不能为空
是否是合法的手机号码
手机号是否注册

@ApiOperation("获取验证码")
    @GetMapping("/send/{mobile}")
    public R send(@ApiParam(value = "手机号", required = true)  @PathVariable String mobile) {

        //校验手机号吗不能为空
        MyAssert.notEmpty(mobile, ResponseEnum.MOBILE_NULL_ERROR);
        //是否是合法的手机号码
        MyAssert.isTrue(RegexValidateUtils.checkCellphone(mobile), ResponseEnum.MOBILE_ERROR);
        //手机号是否注册
        boolean result = userService.checkMobile(mobile);
        System.out.println("result = " + result);     
        MyAssert.isTrue(result == false, ResponseEnum.MOBILE_EXIST_ERROR);

        String code = RandomUtils.getFourBitRandom();
        HashMap<String, Object> map = new HashMap<>();
        map.put("code", code);
        //调用阿里云手机短信服务，发送验证码到手机
        smsService.send(mobile, SmsProperties.TEMPLATE_CODE, map);

        //将验证码存入redis
        redisTemplate.opsForValue().set(SysConst.REDIS_SMS_CODE + mobile, code, 5, TimeUnit.MINUTES);

        return R.ok().message("短信发送成功");
    }