[Spring] 리팩토링 해보기 (feat. 객체지향적인 관점)

💡 리팩토링이란?

 

리팩터링(refactoring)은 소프트웨어 공학에서 '결과의 변경 없이 코드의 구조를 재조정함'을 뜻한다. 주로 가독성을 높이고 유지보수를 편하게 한다. 버그를 없애거나 새로운 기능을 추가하는 행위는 아니다. 사용자가 보는 외부 화면은 그대로 두면서 내부 논리나 구조를 바꾸고 개선하는 유지보수 행위이다.

 

 

✏️ 리팩토링 전 코드 점검 항목

• 코드에 중복된 부분은 없는가?
• 코드가 무엇을 하는 것인지 이해하기 불편하지 않은가?
• 코드가 자신이 있어야 할 자리에 있는가?
• 앞으로 변경이 일어난다면 어떤 것이 있을 수 있고, 그 변화에 쉽게 대응할 수 있게 작성되어 있는가?

✏️ UserService를 리팩토링 해보자

 

각 User마다 갖고 있는 level을 login, recommend를 검사해 기준에 만족하면

Level을 업그레이드 시켜주는 레벨 관리 기능을 코드를 구현해봤다.

 

레벨 관리 기능의 사용자 관리 로직은 UserDaoJdbc에 만드는 것은 바람직하지 않아

UserService라는 클래스를 만들어주어 비즈니스 로직을 담당시켜주었다.

 

UserService.class

public class UserService {
	UserDao userDao;

	public void setUserDao(UserDao userDao) {
		this.userDao = userDao;
	}

	public void upgradeLevels() {
		List<User> users = userDao.getAll();
		for(User user : users) {
			Boolean changed = null;
			if(user.getLevel() == Level.BASIC && user.getLogin() >= 50) {
				user.setLevel(Level.SILVER);
				changed = true;
			}
			else if(user.getLevel() == Level.SILVER && user.getRecommend() >= 30) {
				user.setLevel(Level.GOLD);
				changed = true;
			}
			else if(user.getLevel() == Level.GOLD) { changed = false; }
			else { changed = false; }

			if(changed) { userDao.update(user); }
		}
	}
    
    public void add(User user) {
		if(user.getLevel() == null) user.setLevel(Level.BASIC);
		userDao.add(user);
	}
}

 

upgradeLevel()를 보면 많은 if/elseif/else 블록들에 문제가 있다는 것을 확인 할 수 있다.

 

만약 Level의 수가 많아지고, 총족해야하는 조건들이 많아지면 이 블록의 수는 더욱 많아져,

갈수록 이해하고 관리하기 힘들어질 뿐 아니라, 지저분해지는 코드 탓에 버그가 숨어들어 갈 가능성이 높아질 것이다.

 

따라서 if/elseif/else로 이뤄진 복잡한 조건식들을 제거하기 위해 리팩토링해보자

 

canUpgradeLevel(), upgradeLevel()을 만들어줌으로서 조건문을 최대한 쉽게 해결할 수 있다.

 

🔗 canUpgradeLevel : user가 가진 정보로 레벨이 업그레이드 할 수 있는 조건에 만족하는지 판별해주는 메소드

private boolean canUpgradeLevel(User user) {
	Level currentLevel = user.getLevel();
	switch(currentLevel) {
	case BASIC : return (user.getLogin() >= MIN_LOGCOUNT_FOR_SILVER);
	case SILVER : return (user.getRecommend() >= MIN_RECCOMEND_FOR_GOLD);
	case GOLD : return false;
	default : throw new IllegalArgumentException("Unknown Level : " + currentLevel);
	}
}

 

🔗 upgradeLevel : user가 가진 레벨을 업그레이드 해주는 메소드

private void upgradeLevel(User user) {
		if(user.getLevel() == Level.BASIC) user.setLevel(Level.SILVER);
		else if (user.getLevel() == Level.SILVER) user.setLevel(Level.GOLD);
		userDao.update(user);
	}

이렇게 메소드를 만들어 복잡한 if/else if/else문을 단순화시켜 줄 수 있다.

 

하지만 여전히 upgradeLevel 메소드에도 문제가 보일 것이다.

Level 마다 조건식을 만들어준 것을 볼 수 있는데 , 레벨이 많아지면 위와 같이 또 조건식이 수도 없이 많아질 것이다.

 

 

💡 객체지향적인 관점을 통해 이 문제를 해결해보자

 

우리는 JAVA를 사용하고 있다. 그렇기 때문에 객체지향적인 코드를 만들어줘야 한다. 

 

객체지향적인 코드란 다른 오브젝트의 데이터를 가져와서 작업하는 것이 아닌 데이터를 갖고 있는 다른 오브젝트에게

작업을 해달라고 요청하는 것이다.

 

즉, 오브젝트에게 데이터를 요구하는 것이 아닌, 작업을 요청하는 것이 객체지향 프로그래밍의 가장 기본 원리이다.

 

객체지향적 코드 관점을 생각하며 upgradeLevel를 리팩토링

 

우선 if/else 문으로 업그레이드 된 후의 Level을 알려주는 것을 Level Enum에게 작업을 요구하도록 하자.

기존의 Level Enum을 아래와 같이 고쳐 줄 수 있다.

public enum Level {
	GOLD(3, null),  SILVER(2, GOLD), BASIC(1, SILVER);
	
	private final int value;
	private final Level next;
	
	Level(int value, Level next){
		this.value = value;
		this.next = next;
	}
	
	public int intValue() {
		return value;
	}
	
	public Level nextLevel() {
		return this.next;
	}
	
	public static Level valueOf(int value) {
		switch(value) {
		case 1 : return BASIC;
		case 2 : return SILVER;
		case 3 : return GOLD;
		default : throw new AssertionError("Unknown value : " + value);
		}
	}
}

 

위와 같이 다음레벨을 판별해주는 작업은 UserService에서의 작업이 아닌, Level 객체에게 작업 요청을 할 수 있다.

 

또한 판별해준 nextLevel로 레벨을 다시 설정해주는 작업은 UserService가 아닌,

아래와 같이 User 클래스에서 upgradeLevel 메소드를 추가해 Level을 갖고 있는 User에게 요청 할 수  있다.

public class User {
	//...생략
    public void upgradeLevel() {
		Level nextLevel = this.level.nextLevel();
		if(nextLevel == null) {
			throw new IllegalStateException( this.level + "cannot be upgraded");
		}
		else {
			this.level = nextLevel;
		}
	}
}

이렇게 객체지향적인 코드의 관점을 갖고 리팩토링 해주면 더욱 코드는 간단해 질 것이다.

 

간단해진 upgradeLevel 메소드

private void upgradeLevel(User user) {
		user.upgradeLevel();
		userDao.update(user);
}

📃 정리

• 위와 같이 점검을 해준 후 리팩토링을 해주자!

• 자바를 쓰는 이상 객체지향적인 코드를 구현 할 수 있도록 하자!

참고 문서 : 

토비의 스프링3 (이일민)