DRY 原则

那就是 DRY 原则。它的英文描述为：Don’t RepeatYourself。中文直译为：不要重复自己。将它应用在编程中，可以理解为：不要写重复的代码。

你可能会觉得，这条原则非常简单、非常容易应用。只要两段代码长得一样，那就是违反DRY 原则了。真的是这样吗？答案是否定的。这是很多人对这条原则存在的误解。实际上，重复的代码不一定违反 DRY 原则，而且有些看似不重复的代码也有可能违反 DRY 原则。

有三种典型的代码重复情况，那就是：实现逻辑重复、功能语义重复、代码执行重复。三种代码重复，有的看似违反DRY，实际上并不违反；有的看似不违反，实际上却违反了

实现逻辑重复

看个例子：

public class UserAuthenticator {
	public void authenticate(String username, String password) {
		if (!isValidUsername(username)) {
			// ...throw InvalidUsernameException...
		}
		if (!isValidPassword(password)) {
			// ...throw InvalidPasswordException...
		}
		
		//... 省略其他代码...
	}
	private boolean isValidUsername(String username) {
			// check not null, not empty
		if (StringUtils.isBlank(password)) {
			return false;
		}
		// check length: 4~64
		int length = password.length();
		if (length < 4 || length > 64) {
			return false;
		}
		// contains only lowcase characters
		if (!StringUtils.isAllLowerCase(password)) {
			return false;
		}
		// contains only a~z,0~9,dot
		for (int i = 0; i < length; ++i) {
			char c = password.charAt(i);
			if (!(c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '.') {
				return false;
			}
		}
		return true;
	}

	private boolean isValidPassword(String password) {
			// check not null, not empty
		if (StringUtils.isBlank(password)) {
			return false;
		}
		// check length: 4~64
		int length = password.length();
		if (length < 4 || length > 64) {
			return false;
		}
		// contains only lowcase characters
		if (!StringUtils.isAllLowerCase(password)) {
			return false;
		}
		// contains only a~z,0~9,dot
		for (int i = 0; i < length; ++i) {
			char c = password.charAt(i);
			if (!(c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '.') {
				return false;
			}
		}
		return true;
	}

上面代码中，有两处非常明显的重复的代码片段：isValidUserName() 函数和 isValidPassword() 函数。重复的代码被敲了两遍，或者简单copy-paste 了一下，看起来明显违反 DRY 原则。为了移除重复的代码，我们对上面的代
码做下重构，将 isValidUserName() 函数和 isValidPassword() 函数，合并为一个更通用的函数isValidUserNameOrPassword()。重构后的代码如下所示：

public class UserAuthenticatorV2 {
	public void authenticate(String userName, String password) {
		if (!isValidUsernameOrPassword(userName)) {
			// ...throw InvalidUsernameException...
		}
		if (!isValidUsernameOrPassword(password)) {
			// ...throw InvalidPasswordException...
		}
	}
	private boolean isValidUsernameOrPassword(String usernameOrPassword) {
		// 省略实现逻辑
		// 跟原来的 isValidUsername() 或 isValidPassword() 的实现逻辑一样...
		return true;
	}
}

经过重构之后，代码行数减少了，也没有重复的代码了，是不是更好了呢？答案是否定的，原因如下：