Spring 断言语句

素颜马尾好姑娘i 2023-01-19 07:21 3阅读 0赞

# 1.概述 #

介绍Spring Assert类的用途

# 2.使用断言的目的 #

Spring Assert类帮助验证参数。 通过使用Assert类的方法，可以编写期望为真的假设。 如果不满足，则会抛出运行时异常。

每种Assert的方法都可以与Java assert语句进行比较。 如果Java assert语句的条件失败，则会在运行时引发错误。

这是Spring Assert方法的一些特征：

*  断言的方法是静态的
 *  抛出IllegalArgumentException或IllegalStateException
 *  第一个参数通常是用于验证的参数或要检查的逻辑条件
 *  最后一个参数通常是异常消息，如果验证失败，则会显示该异常消息
 *  该消息既可以作为String参数传递，也可以作为Supplier 参数传递

还要注意，尽管名称相似，但是Spring断言与JUnit和其他测试框架的断言没有共同之处。 Spring断言不是用于测试，而是用于调试。

# 3.使用示例 #

在Car类中定义公共方法drive()：

public class Car { 
        private String state = "stop";
    
        public void drive(int speed) { 
            Assert.isTrue(speed > 0, "speed must be positive");
            this.state = "drive";
        }
    }

可以看到速度必须是正数。 上一行是检查条件并在条件失败时引发异常的简短方法：

if (!(speed > 0)) { 
        throw new IllegalArgumentException("speed must be positive");
    }

每个Assert的public方法大致都包含此代码-一个条件块，带有运行时异常，不能从中恢复应用程序。

如果尝试使用负参数调用drive()方法，则将抛出IllegalArgumentException异常：

> Exception in thread “main” java.lang.IllegalArgumentException: speed must be positive

# 4.逻辑断言 #

## **4.1.** isTrue() ##

它接受布尔条件，并在条件为false时引发IllegalArgumentException。

## 4.2.state() ##

state()方法具有与isTrue()相同的签名，但会引发IllegalStateException。

当由于对象的非法状态而不能继续使用该方法时，应使用该方法。

如果汽车在行驶，将无法调用fuel()方法。 在这种情况下，使用state()断言：

public void fuel() { 
        Assert.state(this.state.equals("stop"), "car must be stopped");
    }

当然，可以使用逻辑断言来验证所有内容。 但是为了获得更好的可读性，可以使用其他断言来使我们的代码更具表现力。

# 5.对象和类型断言 #

## **5.1.** notNull() ##

使用notNull()方法判断一个对象不为空：

public void сhangeOil(String oil) { 
        Assert.notNull(oil, "oil mustn't be null");
    }

## 5.2. isNull() ##

另一方面，可以使用isNull()方法检查对象是否为空：

public void replaceBattery(CarBattery carBattery) { 
        Assert.isNull(
          carBattery.getCharge(), 
          "to replace battery the charge must be null");
    }

## 5.3. isInstanceOf() ##

要检查某个对象是否是特定类型的另一个对象的实例，可以使用isInstanceOf()方法：

public void сhangeEngine(Engine engine) { 
        Assert.isInstanceOf(ToyotaEngine.class, engine);
    }

## 5.4. isAssignable() ##

要检查类型，可以使用Assert.isAssignable()：

public void repairEngine(Engine engine) { 
        //isAssignable(Class<?> superType, Class<?> subType)
        Assert.isAssignable(Engine.class, ToyotaEngine.class);
    }

最近的两个断言表示一个is-a关系。

# 6.文本断言 #

文本断言用于对String参数执行检查。

## 6.1.hasLength() ##

可以使用hasLength()方法检查一个String是否不为空，这**意味着它至少包含一个空格**：

public void startWithHasLength(String key) { 
        Assert.hasLength(key, "key must not be null and must not the empty");
    }

## 6.2. hasText() ##

可以使用hasText()方法来加强条件并检查一个String是否至少包含一个非空白字符：

public void startWithHasText(String key) { 
        Assert.hasText(
          key, 
          "key must not be null and must contain at least one non-whitespace character");
    }

## 6.3. doesNotContain() ##

可以使用dosNotContain()方法确定String参数是否不包含特定的子字符串：

public void startWithNotContain(String key) { 
        Assert.doesNotContain(key, "123", "key mustn't contain 123");
    }

# 7.集合和Map断言 #

## 7.1.notEmpty()的集合 ##

notEmpty()方法断言集合不是空的，这意味着它不是null，并且至少包含一个元素：

public void repair(Collection<String> repairParts) { 
        Assert.notEmpty(
          repairParts, 
          "collection of repairParts mustn't be empty");
    
    }

## 7.2. notEmpty()的Maps ##

对于Map，重载了相同的方法，可以检查地图是否不为空并且至少包含一个条目：

public void repair(Map<String, String> repairParts) { 
        Assert.notEmpty(
          repairParts, 
          "map of repairParts mustn't be empty");
    }

# 8.数组断言 #

## 8.1.notEmpty()的数组 ##

可以使用notEmpty()方法检查数组是否不为空并且包含至少一个元素：

public void repair(String[] repairParts) { 
        Assert.notEmpty(
          repairParts, 
          "array of repairParts mustn't be empty");
    }

## 8.2. noNullElements() ##

可以使用noNullElements()方法来验证数组不包含空元素：

public void repairWithNoNull(String[] repairParts) { 
        Assert.noNullElements(
          repairParts, 
          "array of repairParts mustn't contain null elements");
    }

请注意，如果数组为空，只要其中没有空元素，此检查仍会通过。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20221021/3ac475ff09a34714a94ce2c1bdf1b5fd.png