软件设计重构秘笈25式-24引入契约模式

概念

本文中的”引入契约式设计”是指我们应该对应该对输入和输出进行验证，以确保系统不会出现我们所想象不到的异常和得不到我们想要的结果。

意图

契约式设计规定方法应该对输入和输出进行验证，这样你便可以保证你得到的数据是可以工作的，一切都是按预期进行的，如果不是按预期进行， 异常或是错误就应该被返回，下面我们举的例子中，我们方法中的参数可能会值为null的情况， 在这种情况下由于我们没有验证，NullPointerException异常会报出。 另外在方法的结尾处我们也没有保证会返回一个正确的double值给调用方法的对象。

案例

public class CashRegister {

    public double totalOrder(List<Product> products, Customer customer)
    {
        double orderTotal = products.stream().mapToDouble(product -> product.getPrice()).sum();
        double balance = customer.getBalance();
        balance += orderTotal;
        return balance;
    }

}

public class Product {

    private double price;

    private double availableDiscounts;

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    public double getAvailableDiscounts() {
        return availableDiscounts;
    }

    public void setAvailableDiscounts(double availableDiscounts) {
        this.availableDiscounts = availableDiscounts;
    }
}

public class Customer {

    private double balance;

    public double getBalance() {
        return balance;
    }

    public void setBalance(double balance) {
        this.balance = balance;
    }
}

重构

对上面的代码重构是很简单的，首先我们处理不会有一个null值的customer对象，检查我们最少会有一个product对象。 在返回订单总和之前先确保我们会返回一个有意义的值。如果上面说的检查有任何一个失败， 我们就抛出对应的异常，并在异常里说明错误的详细信息，而不是直接抛出NullPointerException。

public class CashRegister {

    public double totalOrder(List<Product> products, Customer customer)
    {
        if (customer == null)
            throw new IllegalArgumentException("Customer cannot be null");
        if (products.size() == 0)
            throw new IllegalArgumentException("Must have at least one product to total");

        double orderTotal = products.stream().mapToDouble(product -> product.getPrice()).sum();
        double balance = customer.getBalance();
        balance += orderTotal;
        if (balance == 0)
            throw new RuntimeException("Order Total should not be zero");

        return balance;
    }

}

总结

上面的代码中添加了额外的代码来进行验证，虽然看起来代码复杂度增加了，但我认为这是非常值得做的， 因为当NullPointerException发生时去追查异常的详细信息真是很令人讨厌的事情。 这个重构建议大家经常使用，这会增强整个系统的稳定性和健壮性。