CRUD 와 SOLID 원칙

Java

CRUD 와 SOLID 원칙

햄발자 2024. 7. 5. 15:27

콘솔을 활용한 간단한 퀴즈 게임 만들어 보기

DB , 테이블 설계
기본 데이터 입력(정규화)
자바측 라이브러리 설정
자바측 기능 구현 및 테스트
리팩토링

-- 데이터베이스 생성 
create database quizdb; 
use quizdb;

drop table quiz;

create table quiz(
	id int auto_increment primary key, 
	question varchar(500) not null, 
    answer varchar(500) not null
);

desc quiz;

-- 기본 샘플 데이터 입력 
insert into quiz(question, answer ) 
			values ('대한민국의 수도는?', '서울'),
					   ('한반도의 남쪽에 위치한 나라는?', '대한민국'),
            ('세계에서 가능 높은 산은', '에베레스트'),
            ('태양계의 세 번째 행성은?', '지구'),
            ('한국의 전통 명절 중 하나로, 음력 8월15일에 해당하는 날은?', '추석'),
            ('임진왜란 종전 년도는?' ,'159기8'),
            ('고기압과 저기압에서 바람이 부는 방향은?' ,'고기압');
                    
select * from quiz;

자바측 기본 코드 입력

package com.tenco.quiz;

import java.sql.Connection;
import java.sql.DriverManager;
import java.util.Scanner;

public class QuizGame {
	
	// 준비물 
	private static final String URL = "jdbc:mysql://localhost:3306/quizdb?serverTimezone=Asia/Seoul";
	private static final String USER = "root";
	private static final String PASSWORD = "asd123";
	
	public static void main(String[] args) {
		
		// JDBC 드리아버 로드 <-- 인터페이스 <--- 구현 클래스 필요 
		try {
			Class.forName("com.mysql.cj.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
			return;
		}
		
		try (Connection conn = DriverManager.getConnection(URL, USER, PASSWORD);
			  Scanner scanner = new Scanner(System.in)) {
			
			while(true) {
				System.out.println();
				System.out.println("-----------------------");
				System.out.println("1. 퀴즈 문제 추가");
				System.out.println("2. 퀴즈 문제 조회");
				System.out.println("3. 퀴즈 게임 시작");
				System.out.println("4. 종료");
				System.out.print("옵션을 선택 하세요: ");
				
				int choice = scanner.nextInt(); // 블로킹 
				
				if(choice == 1) {
					// 퀴즈 문제 추가 --> 함수로 만들기 
				} else if(choice == 2) {
					// 퀴즈 문제 조회 --> 함수로 만들기
				} else if(choice == 3) {
					// 퀴즈 게임 시작 --> 함수로 만들기
				} else if(choice == 4) {
					System.out.println("프로그램을 종료 합니다");
					break;
				} else  {
					System.out.println("잘못된 선택입니다. 다시 시도하세요.");
				}
			}
			
		} catch (Exception e) {
			
		}
		
		

	} // end of main 

}

1단계 코드 구현 완료

package com.tenco.quiz;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Scanner;

public class QuizGame {
	
	// 준비물 
	private static final String URL = "jdbc:mysql://localhost:3306/quizdb?serverTimezone=Asia/Seoul";
	private static final String USER = "root";
	private static final String PASSWORD = "asd123";
	
	public static void main(String[] args) {
		
		// JDBC 드리아버 로드 <-- 인터페이스 <--- 구현 클래스 필요 
		try {
			Class.forName("com.mysql.cj.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
			return;
		}
		
		try (Connection conn = DriverManager.getConnection(URL, USER, PASSWORD);
			  Scanner scanner = new Scanner(System.in)) {
			
			while(true) {
				System.out.println();
				System.out.println("----------------------------------------");
				System.out.println("1. 퀴즈 문제 추가");
				System.out.println("2. 퀴즈 문제 조회");
				System.out.println("3. 퀴즈 게임 시작");
				System.out.println("4. 종료");
				System.out.print("옵션을 선택 하세요: ");
				
				int choice = scanner.nextInt(); // 블로킹 
				
				if(choice == 1) {
					addQuizQuestion(conn, scanner);
				} else if(choice == 2) {
					viewQuizQuestion(conn);
				} else if(choice == 3) {
					playQuizGame(conn, scanner);
				} else if(choice == 4) {
					System.out.println("프로그램을 종료 합니다");
					break;
				} else  {
					System.out.println("잘못된 선택입니다. 다시 시도하세요.");
				}
			}
			
		} catch (Exception e) {
			
		}

	} // end of main

	private static void playQuizGame(Connection conn, Scanner scanner) {
		String sql = " select * from quiz order by rand() limit 1  ";
		
		try (PreparedStatement pstmt = conn.prepareStatement(sql)) {
			ResultSet rs = pstmt.executeQuery();
			
			if(rs.next()) {
				
				String question = rs.getString("question");
				String answer = rs.getString("answer");
				
				System.out.println("퀴즈 문제 : " + question);
				// 버그처리 
				scanner.nextLine();
				System.out.print("당신에 답: ");
				String userAnswer = scanner.nextLine();
				
				if(userAnswer.equalsIgnoreCase(answer)) {
					System.out.println("정답입니다! 점수를 얻었습니다.");
				} else {
					System.out.println("오답입니다!");
					System.out.println("퀴즈 정답은 -->  " + answer);
				}
			} else {
				System.out.println("죄송합니다 아직 퀴즈 문제를 만들고 있습니다.");
			}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}

	private static void viewQuizQuestion(Connection conn) {
		String sql = " select * from quiz  ";
	 	try (PreparedStatement pstmt = conn.prepareStatement(sql)){
	 		ResultSet resultSet =  pstmt.executeQuery();
	 		while(resultSet.next()) {
	 			System.out.println("문제 ID : " + resultSet.getInt("id"));
	 			System.out.println("문제 : " + resultSet.getString("question"));
	 			System.out.println("정답 : " + resultSet.getString("answer"));
	 			if(!resultSet.isLast()) {
	 				System.out.println("----------------------------------------");
	 			}
	 		}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}

	private static void addQuizQuestion(Connection conn, Scanner scanner) {
		
		System.out.println("퀴즈 문제를 입력하세요: ");
		scanner.nextLine();
		String question = scanner.nextLine();
		System.out.println("퀴즈 정답을 입력하세요: ");
		String answer = scanner.nextLine();
		
		String sql = " insert into quiz(question, answer) values(?, ?) ";
		
		try (PreparedStatement pstmt = conn.prepareStatement(sql)){
			pstmt.setString(1, question);
			pstmt.setString(2, answer);
			int rowsInsertedCount = pstmt.executeUpdate();
			System.out.println("추가된 행의 수 : " + rowsInsertedCount);
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}
}  // end of class

코드 리팩토링 - 1단계 DB 연결을 처리하는 클래스를 따로 분리하면 재사용성과 유지보수성이 높아집니다

1단계 핵심

DBConnectionManager 클래스 만들어 보기 데이터베이스 연결을 관리하는 DBConnectionManager 클래스를 만들어 봅시다.

package com.tenco.quiz;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public class DBConnectionManager {
	
	private static final String URL = "jdbc:mysql://localhost:3306/quizdb?serverTimezone=Asia/Seoul";
	private static final String USER = "root";
	private static final String PASSWORD = "asd123";
	
	// static {} 블록 - 정적 초기화 블록 
	// 클래스가 처음 로드될 때 한 번 실행 됩니다. 
	// 정적 변수의 초기화나 복잡한 초기화 작업을 수행할 때 사용 
	// static {} 블록안에 예외를 던질 수도 있다. 
	static {
		try {
			Class.forName("com.mysql.cj.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
	
	// 정적 메서드(함수) 커넥션 객체를 리턴하는 함수를 만들어 보자
	public static Connection getConnection() throws SQLException {
		return DriverManager.getConnection(URL, USER, PASSWORD);
	}
	
} // end of class

사용

package com.tenco.quiz.ver1;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Scanner;

import com.tenco.quiz.DBConnectionManager;

public class QuizGame {
	
	private static final String ADD_QUIZ = " insert into quiz(question, answer) values(?, ?) "; 
	private static final String VIEW_QUIZ = " select * from quiz "; 
	private static final String RANDOM_QUIZ = " select * from quiz order by rand() limit 1 "; 
	
	
	public static void main(String[] args) {
		
		try (Connection conn = DBConnectionManager.getConnection();
			  Scanner scanner = new Scanner(System.in)) {
			
			while(true) {
				printMenu();
				int choice = scanner.nextInt(); // 블로킹 
				
				if(choice == 1) {
					addQuizQuestion(conn, scanner);
				} else if(choice == 2) {
					viewQuizQuestion(conn);
				} else if(choice == 3) {
					playQuizGame(conn, scanner);
				} else if(choice == 4) {
					System.out.println("프로그램을 종료 합니다");
					break;
				} else  {
					System.out.println("잘못된 선택입니다. 다시 시도하세요.");
				}
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	} // end of main

	private static void printMenu() {
		System.out.println();
		System.out.println("----------------------------------------");
		System.out.println("1. 퀴즈 문제 추가");
		System.out.println("2. 퀴즈 문제 조회");
		System.out.println("3. 퀴즈 게임 시작");
		System.out.println("4. 종료");
		System.out.print("옵션을 선택 하세요: ");
	}

	private static void playQuizGame(Connection conn, Scanner scanner) {
		
		try (PreparedStatement pstmt = conn.prepareStatement(RANDOM_QUIZ)) {
			ResultSet rs = pstmt.executeQuery();
			
			if(rs.next()) {
				
				String question = rs.getString("question");
				String answer = rs.getString("answer");
				
				System.out.println("퀴즈 문제 : " + question);
				// 버그처리 
				scanner.nextLine();
				System.out.print("당신에 답: ");
				String userAnswer = scanner.nextLine();
				
				if(userAnswer.equalsIgnoreCase(answer)) {
					System.out.println("정답입니다! 점수를 얻었습니다.");
				} else {
					System.out.println("오답입니다!");
					System.out.println("퀴즈 정답은 -->  " + answer);
				}
			} else {
				System.out.println("죄송합니다 아직 퀴즈 문제를 만들고 있습니다.");
			}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}

	private static void viewQuizQuestion(Connection conn) {
		
	 	try (PreparedStatement pstmt = conn.prepareStatement(VIEW_QUIZ)){
	 		ResultSet resultSet =  pstmt.executeQuery();
	 		while(resultSet.next()) {
	 			System.out.println("문제 ID : " + resultSet.getInt("id"));
	 			System.out.println("문제 : " + resultSet.getString("question"));
	 			System.out.println("정답 : " + resultSet.getString("answer"));
	 			if(!resultSet.isLast()) {
	 				System.out.println("----------------------------------------");
	 			}
	 		}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}

	private static void addQuizQuestion(Connection conn, Scanner scanner) {
		
		System.out.println("퀴즈 문제를 입력하세요: ");
		scanner.nextLine();
		String question = scanner.nextLine();
		System.out.println("퀴즈 정답을 입력하세요: ");
		String answer = scanner.nextLine();
				
		try (PreparedStatement pstmt = conn.prepareStatement(ADD_QUIZ)){
			pstmt.setString(1, question);
			pstmt.setString(2, answer);
			int rowsInsertedCount = pstmt.executeUpdate();
			System.out.println("추가된 행의 수 : " + rowsInsertedCount);
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}
}  // end of class

코드 리팩토링 - 2단계 QuizGame을 SOLID 원칙에 따라 리팩토링해보기

단일 책임 원칙 (Single Responsibility Principle, SRP): 클래스는 하나의 책임만 가져야 합니다.
개방-폐쇄 원칙 (Open/Closed Principle, OCP): 소프트웨어 개체는 확장에는 열려 있어야 하지만, 수정에는 닫혀 있어야 합니다.
리스코프 치환 원칙 (Liskov Substitution Principle, LSP): 프로그램의 객체는 프로그램의 정확성을 깨뜨리지 않으면서 하위 타입의 인스턴스로 바꿀 수 있어야 합니다.
인터페이스 분리 원칙 (Interface Segregation Principle, ISP): 특정 클라이언트를 위한 인터페이스 여러 개가 범용 인터페이스 하나보다 낫다.
의존성 역전 원칙 (Dependency Inversion Principle, DIP): 고수준 모듈은 저수준 모듈에 의존해서는 안되며, 둘 다 추상화에 의존해야 한다.

package com.tenco.quiz;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public class DBConnectionManager {
	
	private static final String URL = "jdbc:mysql://localhost:3306/quizdb?serverTimezone=Asia/Seoul";
	private static final String USER = "root";
	private static final String PASSWORD = "asd123";
	
	// static {} 블록 - 정적 초기화 블록 
	// 클래스가 처음 로드될 때 한 번 실행 됩니다. 
	// 정적 변수의 초기화나 복잡한 초기화 작업을 수행할 때 사용 
	// static {} 블록안에 예외를 던질 수도 있다. 
	static {
		try {
			Class.forName("com.mysql.cj.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
	
	// 정적 메서드(함수) 커넥션 객체를 리턴하는 함수를 만들어 보자
	public static Connection getConnection() throws SQLException {
		
		new Thread().run();
		
		return DriverManager.getConnection(URL, USER, PASSWORD);
	}
	
} // end of class

package com.tenco.quiz.ver2;

import java.sql.SQLException;
import java.util.List;

public interface QuizRepository {
	
	int addQuizQuestion(String question, String answer) throws SQLException ;
	List<QuizDTO> viewQuizQuestion() throws SQLException;
	QuizDTO playQuizGame() throws SQLException;
}

package com.tenco.quiz.ver2;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class QuizDTO {
	
	private int id; 
	private String question; 
	private String answer; 
	
}

package com.tenco.quiz.ver2;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

import com.tenco.quiz.DBConnectionManager;

public class QuizRepositoryImpl implements QuizRepository {
	
	public static final String ADD_QUIZ = " insert into quiz(question, answer) values(?, ?) "; 
	public static final String VIEW_QUIZ = " select * from quiz "; 
	public static final String RANDOM_QUIZ = " select * from quiz order by rand() limit 1 "; 
	
	@Override
	public int addQuizQuestion(String question, String answer) throws SQLException {
		int resultRowCount = 0; 
		try (Connection conn = DBConnectionManager.getConnection()){
			PreparedStatement pstmt = conn.prepareStatement(ADD_QUIZ);
			// 트랜잭션 처리 가능 - 수동모드 커밋 사용 가능 
			pstmt.setString(1, question);
			pstmt.setString(2, answer);
			pstmt.executeUpdate();
		} 
		return resultRowCount;
	}

	@Override
	public List<QuizDTO> viewQuizQuestion() throws SQLException {
		List<QuizDTO> list = new ArrayList<>();
		try(Connection conn = DBConnectionManager.getConnection()) {
			PreparedStatement pstmt = conn.prepareStatement(VIEW_QUIZ);
			ResultSet rs = pstmt.executeQuery();
			while(rs.next()) {
				int id = rs.getInt("id");
				String question = rs.getString("question");
				String answer = rs.getString("answer");
				list.add(new QuizDTO(id, question, answer))  ;
			}
		}
		return list;
	}

	@Override
	public QuizDTO playQuizGame() throws SQLException {
		QuizDTO quizDTO = null;
		try (Connection conn = DBConnectionManager.getConnection()) {
			PreparedStatement pstmt = conn.prepareStatement(RANDOM_QUIZ);
			ResultSet rs = pstmt.executeQuery();
			if(rs.next()) {
				int id = rs.getInt("id");
				String question = rs.getString("question");
				String answer = rs.getString("answer");
				quizDTO = new QuizDTO(id, question, answer);
			}
		} 
		return quizDTO;
	}
}