02. 자바 템플릿 메소드 패턴 (JAVA Template Method Pattern)

wkqk

# 참고한 영상

자바 디자인 패턴 이해 - YouTube

 

# 설명

알고리즘의 구조를 메소드에 정의 하고

하위 클래스에서 알고리즘 구조의 변경없이

알고리즘을 재정의 하는 패턴

 

어떤 소스코드상의 알고리즘에서 특정 환경 또는 상황에 맞게 확장
또는 변경을 해야 할 경우 유용하다

 

추상크래스와 구현클래스로 작성할 수 있으며, 메인이 되는 로직 부분은 추상클래스의 일반
메소드로 선언해서 사용합니다. 즉, 구현별로 달라질 수 있는 행동(메소드)들은 구현 클래스
에서 선언 후 호출하는 방식으로 사용합니다.

 

# 장점

코드 중복 감소

자식 클래스의 역할(롤) 감소시키면서 핵심로직 관리 용이

객체 추가 및 확장 쉽게 가능

 

# 단점

추상메소드가 너무 많아지면 클래스 관리가 복잡

추상클래스와 구현클래스간 복잡성 증대

 

# 사용 여부

구현하련느 알고리즘이 일정한 프로세스(과정)가 있다

구현하려는 알고리즘이 변경 가능성(추상)이 있다.

 

# 사용 방법

알고리즘을 여러 단계로 나눈다.

나눠진 알고리즘의 단계를 메소드로 선언한다.

알고리즘을 수행할 템플릿 메소드를 만든다

하위 클래스에서 나눠진 메소드를 구현한다

 

# 구조

카카오 접속 커넥트 / 네이버 접속 커넥트 / 페이스북 접속 커넥트 / 인스타그램 접속 커넥트 등

하나의 템플릿을 이용하여 여러개를 빠르게 만들 수 있다. (과정들을 묶은 클래스)

 

# 요구사항

1. 신작 게임의 접속을 구현해주세요. --> String requestConnection

2. 유저가 게임 접속시 다음을 고려해야 합니다.

• 보안 과정 : 보안 관련 부분을 처리합니다. --> String doSecurity
• 인증 과정 : user name과 password가 일치하는 지 확인합니다. --> boolean authentication
• 권한 과정 : 접속자가 유료 회원인지 무료회원인지 게임 마스터인지 확인합니다. --> int authorization
• 접속 과정 : 접속자에게 커넥션을 정보로 넘겨줍니다. --> String connection

# 변경사항

1. 카카오 접속을 구현해주세요 --> KakaoGameConnectHelper.java

2. 카카오 서버는 14살 이하는 10시 접속이 불가능하게 해주세요. --> boolean shutDown(){...}

 

# 결과

이미지 클릭

 

1. 기본 커넥트는 접속 성공

2. 카카오 커넥트는 셧다운으로 인해 접속 실패

 

# Abstract Class

public abstract class AbstGameConnectHelper {
 
    // STEP 1. 암호화 된 값을 복호화 시키는 단계
    protected abstract String doSecurity(String string);
 
    // STEP 2. 복호환 한 값이 맞는 지 확인하는 단계
    protected abstract boolean authentication(String id, String password);
 
    // STEP 3. 유저 권한을 확인하는 단계
    protected abstract int authorization(String email);
 
    // STEP 4. 서버 접속을 허락하여 정보를 응답(response) 단계
    protected abstract String connection(String info, int role);
 
    /** 템플릿 메소드 */
    public String requestConnection(String str) {
 
        System.out.println();
 
        // STEP 1. 보안 작업 -> 암호화 된 문자열을 복화화(디코드) 한다
        String decodedInfo = doSecurity(str);
        System.out.println("1. decodedInfo -> " + decodedInfo);
 
        // 반환 된 것을 가지고 아이디, 암호를 할당한다
        String email = getQueryEmail(decodedInfo);
        String password = getQueryPassword(decodedInfo);
 
        System.out.println();
 
        // STEP 2. 해당 아이디 검증
        System.out.println("2. authentication -> " + !authentication(email, password));
        if (!authentication(email, password)) {
            throw new Error("이메일 암호 불일치");
        }
 
        System.out.println();
 
        // STEP 3. 유저 현재 권한 확인
        int role = authorization(email);
 
        switch (role) {
            case 0: // 관리자
                System.out.println("3. role -> " + "관리자");
                break;
            case 1: // 유료 회원
                System.out.println("3. role -> " + "유료 회원");
                break;
            case 2: // 무료 회원
                System.out.println("3. role -> " + "무료 회원");
                break;
            case -1: // 권한 없음
                System.out.println("3. role -> " + "권한 없음");
                break;
            case -2: // 정지 회원
                System.out.println("3. role -> " + "정지 회원");
                break;
            default: // 기타 상황
                break;
        }
 
        System.out.println();
 
        // STEP 4. 유저 정보 응답 단계
        System.out.println("4. connection -> " + connection(decodedInfo, role));
        return connection(decodedInfo, role);
    }
 
    private static String getQueryEmail(String decodedInfo) {
        String key = decodedInfo.split("&")[0].split("=")[0];
        String value = decodedInfo.split("&")[0].split("=")[1];
        System.out.println("key -> " + key);
        System.out.println("value -> " + value);
        return value;
    }
 
    private static String getQueryPassword(String decodedInfo) {
        String key = decodedInfo.split("&")[1].split("=")[0];
        String value = decodedInfo.split("&")[1].split("=")[1];
        System.out.println("key -> " + key);
        System.out.println("value -> " + value);
        return value;
    }
}
 

 

# Concrete Class

DefaultGameConnectHelper.java

public class DefaultGameConnectHelper extends AbstGameConnectHelper {
 
    private static final String DB_EMAIL = "theheydaze@naver.com", DB_PASSWORD = "1004", DB_ADMIN_EMAIL = "admin@naver.com";
    private static final int DB_ROLE_ADMIN = 0;
 
    /** 디코드 */
    @Override
    protected String doSecurity(String string) {
        return new String(Base64.getDecoder().decode(string.getBytes())); // 디코드 된 내용
    }
 
    /** 아이디/암호 확인 과정 */
    @Override
    protected boolean authentication(String id, String password) {
        return (id.equalsIgnoreCase(DB_EMAIL) && password.equalsIgnoreCase(DB_PASSWORD));
    }
 
    /** 권한 확인 */
    @Override
    protected int authorization(String email) {
        // 0:= 관리자 / 1:= 유료 회원 / 2:= 무료 회원 / -1:= 권한 없음 / -2:= 정지 회원
        return email.equals(DB_ADMIN_EMAIL) ? DB_ROLE_ADMIN : 2;
    }
 
    /** 접속 단계 */
    @Override
    protected String connection(String info, int role) {
        return info + "&role=" + role; // 접속 단계에 필요한 정보를 넘겨줌
    }
}
 

 

KakaoGameConnectHelper.java

public class KakaoGameConnectHelper extends AbstGameConnectHelper {
 
    private static final String DB_EMAIL = "theheydaze@daum.net", DB_PASSWORD = "1004", DB_ADMIN_EMAIL = "admin@naver.com";
    private static final int SHUT_DOWN_TIME = 22, CURRENT_TIME = 23;
 
    /** 디코드 */
    @Override
    protected String doSecurity(String string) {
        return new String(Base64.getDecoder().decode(string.getBytes())); // 디코드 된 내용
    }
 
    /** 아이디/암호 확인 과정 */
    @Override
    protected boolean authentication(String id, String password) {
        return (id.equalsIgnoreCase(DB_EMAIL) && password.equalsIgnoreCase(DB_PASSWORD));
    }
 
    /** 권한 확인 */
    @Override
    protected int authorization(String email) {
 
        // 임시 나이
        int age = 13;
 
        // 셧 다운
        boolean shutDown = shutDown(age);
 
        // 접속 불가
        if (shutDown) {
            return -1;
        }
 
        // 0:= 관리자 / 1:= 유료 회원 / 2:= 무료 회원 / -1:= 권한 없음 / -2:= 정지 회원
        return 2;
    }
 
    /** 접속 단계 */
    @Override
    protected String connection(String info, int role) {
 
        if (role==-1) return "접속 실패";
 
        return info + "&role=" + role; // 접속 단계에 필요한 정보를 넘겨줌
    }
 
    /** 셧 다운 메소드 */
    private boolean shutDown(int age) {
        return age<=14 && CURRENT_TIME >= SHUT_DOWN_TIME;
    }
}
 

 

# Client

public class Client {
 
    // 사용자 입력한 파라미터
    private static final String REQUEST_DEFAULT_PARAM = "email=theheydaze@naver.com&password=1004";
    // 서버에 전송 된 암호화 된 파라미터
    private static final String ENCODED_DEFAULT_PARAM = Base64.getEncoder().encodeToString(REQUEST_DEFAULT_PARAM.getBytes());
    // 사용자 입력한 카카오 이메일 파라미터
    private static final String REQUEST_KAKAO_PARAM = "email=theheydaze@daum.net&password=1004";
    /// 서버에 전송 된 암호화 된 카카오 파라미터
    private static final String ENCODED_KAKAO_PARAM = Base64.getEncoder().encodeToString(REQUEST_KAKAO_PARAM.getBytes());
 
    public static void main(String[] args) {
 
        // 암호화 된 파라미터 값 출력
        System.out.println("0. encodeParam -> " + ENCODED_DEFAULT_PARAM);
 
        // 템플릿 메소드 패턴 (기본 커넥트)
        AbstGameConnectHelper defaultHelper = new DefaultGameConnectHelper();
 
        // 서버에 접속 요청 메소드
        defaultHelper.requestConnection(ENCODED_DEFAULT_PARAM);
 
        System.out.println("-----------------------------------------------------------");
 
        // 템플릿 메소드 패턴 (카카오 커넥트)
        AbstGameConnectHelper kakaoHelper = new KakaoGameConnectHelper();
 
        // 서버에 접속 요청 메소드
        kakaoHelper.requestConnection(ENCODED_KAKAO_PARAM);
 
    }
}
 

 

# Diagram