Skip to content
/ RecipeSpark Public

[Personal Project] SpringBoot Monolothic - Layered Architecture

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

maxkim77/RecipeSpark

BranchesTags

Repository files navigation

RecipeSpark

title

1. 분석

1.1 사용자 요구사항 정의서 (User Requirements Specification)

프로젝트 이름: RecipeSpark

1.1.1 프로젝트 목표

  1. 요리 레시피 공유 및 요리 관련 커뮤니티 활성화.
  2. 인공지능을 활용한 맞춤형 레시피 추천 및 변환 기능 제공.
  3. 사용자의 재료 및 선호도를 기반으로 한 개인화된 요리 경험 지원.

1.1.2 주요 기능

기본 기능

  • 회원가입, 로그인, 프로필 기능
  • 커뮤니티 게시판 기능(레시피 게시판, Q&A 게시판)
  • AI 맞춤 레시피 및 변환 기능

부가 기능

  • 스크랩 기능
  • 투표 기능 (ex. 게시글 좋아요)
  • 댓글 기능

1.1.3 사용자 요구사항

ID 요구사항 우선순위 설명
UR-001 사용자는 회원가입 및 로그인을 통해 서비스를 이용할 수 있어야 한다. 필수 비회원 사용자는 일부 기능(열람)은 가능하지만, AI 추천 및 변환, 게시글 작성은 회원만 가능하다.
UR-002 사용자는 레시피 게시판에서 레시피를 등록, 수정, 삭제할 수 있어야 한다. 필수 본인이 작성한 레시피만 수정 및 삭제 가능.
UR-003 사용자는 Q&A 게시판에서 질문과 답변을 작성할 수 있어야 한다. 필수 요리 관련 궁금증 해결 및 커뮤니티 형성을 목적으로 한다.
UR-004 사용자는 AI 레시피 게시판에서 자신의 맞춤형 레시피를 관리하고 열람할 수 있어야 한다. 필수 AI가 추천한 레시피와 변환된 레시피를 개인 게시판에서 확인.
UR-005 사용자는 게시글에 좋아요를 누르거나 댓글을 작성할 수 있어야 한다. 선택 게시글에 대한 피드백 및 소통 기능 제공.
UR-006 사용자는 레시피를 스크랩하여 개인 저장소에 보관할 수 있어야 한다. 선택 관심 있는 레시피를 저장하고 관리할 수 있음.
UR-007 시스템은 모든 커뮤니티 게시글(Q&A, 레시피 게시판)의 열람은 회원/비회원 모두 가능해야 한다. 필수 접근성을 높이고 커뮤니티 활성화를 지원.
UR-008 시스템은 사용자 데이터와 게시글 정보를 안전하게 저장 및 관리해야 한다. 필수 MySQL DB와 Spring Security를 통해 데이터 보안 강화.

1.2 유스케이스 명세서

1.2.1 회원가입

유스케이스 이름 회원가입
행위자 비회원
목표 사용자가 RecipeSpark 서비스에 가입
사전조건 이메일과 비밀번호를 입력할 수 있어야 함.
사후조건 가입된 사용자 정보가 데이터베이스에 저장됨.
시나리오 1. 비회원이 회원가입 페이지를 연다.
2. 이메일, 비밀번호, 닉네임을 입력한다.
3. 가입 버튼을 클릭한다.
4. 시스템이 입력 정보를 검증하고 가입 처리한다.
5. 성공 시 환영 메시지가 출력되고 로그인 페이지로 리다이렉트된다.
예외 1. 이메일이 중복될 경우 오류 메시지 출력.
2. 필수 입력 항목이 비어 있을 경우 오류 메시지 출력.

1.2.2 레시피 게시판 CRUD

유스케이스 이름 레시피 게시판 CRUD
행위자 로그인 사용자
목표 사용자가 레시피를 등록, 수정, 삭제할 수 있음.
사전조건 사용자가 로그인 상태여야 함.
사후조건 게시판에 등록된 레시피가 데이터베이스에 저장됨.
시나리오 1. 사용자가 레시피 게시판 페이지를 연다.
2. 레시피를 등록하거나 기존 레시피를 수정 또는 삭제한다.
3. 변경된 내용이 시스템에 저장되고 화면에 반영된다.
예외 1. 비회원이 접근할 경우 오류 메시지 출력.
2. 필수 입력 항목이 비어 있을 경우 오류 메시지 출력.

1.2.3 Q&A 게시판 관리

유스케이스 이름 Q&A 게시판 관리
행위자 로그인 사용자 및 비회원
목표 사용자가 질문을 등록하고 답변을 작성할 수 있음.
사전조건 질문/답변 등록은 로그인 사용자만 가능.
사후조건 게시판에 질문과 답변이 저장되고 열람 가능.
시나리오 1. 사용자가 Q&A 게시판 페이지를 연다.
2. 질문을 열람하거나 새 질문을 작성한다.
3. 기존 질문에 대해 답변을 추가한다.
4. 시스템에 변경 사항이 반영된다.
예외 1. 질문 또는 답변 내용이 비어 있는 경우 오류 메시지 출력.
2. 비회원이 질문/답변을 등록하려고 할 경우 로그인 요청.

1.2.4 AI 맞춤 레시피 관리

유스케이스 이름 AI 맞춤 레시피 관리
행위자 로그인 사용자
목표 AI가 추천한 레시피를 저장 및 변환하여 개인 게시판에 관리
사전조건 사용자가 로그인 상태여야 함.
사후조건 AI가 생성한 레시피가 개인 AI 게시판에 저장됨.
시나리오 1. 사용자가 AI 추천 페이지를 연다.
2. 필요한 재료를 입력하거나 변환 요청을 진행한다.
3. 생성된 맞춤형 레시피가 개인 게시판에 저장된다.
4. 저장된 레시피는 이후 열람 및 수정 가능.
예외 1. 입력된 데이터가 없을 경우 오류 메시지 출력.
2. AI API 호출 실패 시 '일시적인 문제 발생' 메시지 출력.

1.3 요구사항 추적표

요구사항 ID 유스케이스 ID 기능 ID 설명
UR-001 UC-001 F-001 회원가입 및 로그인 기능 제공.
UR-002 UC-002 F-002 레시피 게시판 CRUD 기능 제공.
UR-003 UC-003 F-003 Q&A 게시판 질문 및 답변 기능 제공.
UR-004 UC-004 F-004 AI 기반 맞춤 레시피 관리 기능 제공.
UR-005 UC-005 F-005 좋아요 및 댓글 기능 제공.
UR-006 UC-006 F-006 레시피 스크랩 기능 제공.
UR-007 UC-007 F-007 모든 게시판의 열람 기능 제공.
UR-008 UC-008 F-008 데이터 보안 및 저장 관리 기능 제공.

1.4 개발 일정 (WBS)

image

2. 설계

2.1 아키텍처 설계

SystemArchitecture

2.2 데이터베이스 설계(ERD)

DBERD

2.3 클래스 설계

ClassDiagram

  • 클래스 간의 연관 관계, 상속 구조 등을 설계.
  • 도메인 로직과 데이터 구조를 기반으로 코드 구현 준비.

2.4 컴포넌트 설계

ComponentDiagram

  • 각 레이어의 역할과 책임 정의.
  • 레이어 간 호출 관계 설계.
  • 데이터 흐름과 주요 서비스 간 상호작용 정의.

2.6 인터페이스 설계 (D4)

  • 주요 API 엔드포인트 설계 (URL, HTTP 메서드)

2.6.1 AIReviewController

HTTP Method URL 기능 요청 파라미터 응답 결과
POST /submit-recipe AI 리뷰 요청 및 저장 recipeInput(String), language(String) 리뷰 결과 데이터 및 저장 완료 메시지
GET /submit-recipe 레시피 입력 폼 페이지 없음 레시피 입력 폼 뷰
GET /my-reviews 내 리뷰 목록 조회 page(int), keyword(String) 리뷰 목록 뷰 및 페이징 처리
POST /delete-review/{id} 특정 리뷰 삭제 reviewId(Long) 삭제 완료 후 리뷰 목록 리다이렉트

2.6.2 AnswerController

HTTP Method URL 기능 요청 파라미터 응답 결과
POST /answer/create 답변 생성 questionId(Integer), content(String) 답변 생성 후 질문 상세 페이지 리다이렉트
GET /answer/editForm/{answerId} 답변 수정 폼 조회 answerId(Integer) 답변 수정 폼 뷰
POST /answer/modify/{answerId} 답변 수정 answerId(Integer), content(String) 수정 완료 후 질문 상세 페이지 리다이렉트
POST /answer/delete/{answerId} 답변 삭제 answerId(Integer) 삭제 완료 후 질문 상세 페이지 리다이렉트

2.6.3 CommentController

HTTP Method URL 기능 요청 파라미터 응답 결과
POST /recipe/{recipeId}/comment 댓글 생성 recipeId(Long), content(String) 댓글 생성 후 레시피 상세 페이지 리다이렉트
GET /recipe/{recipeId}/comment/{id}/edit 댓글 수정 폼 조회 recipeId(Long), commentId(Long) 댓글 수정 폼 뷰
POST /recipe/{recipeId}/comment/{id}/edit 댓글 수정 recipeId(Long), commentId(Long), content(String) 수정 완료 후 레시피 상세 페이지 리다이렉트
POST /recipe/{recipeId}/comment/{id}/delete 댓글 삭제 recipeId(Long), commentId(Long) 삭제 완료 후 레시피 상세 페이지 리다이렉트

2.6.4 MainController

HTTP Method URL 기능 요청 파라미터 응답 결과
GET / 메인 페이지로 리다이렉트 없음 메인 페이지 리다이렉트
GET /main 메인 페이지 조회 없음 메인 페이지 뷰
GET /about 소개 페이지 조회 없음 소개 페이지 뷰

2.6.5 QuestionController

HTTP Method URL 기능 요청 파라미터 응답 결과
GET /question/list 질문 목록 조회 page(int), kw(String) 질문 목록 뷰 및 페이징 처리
GET /question/detail/{id} 질문 상세 조회 id(Integer) 질문 상세 뷰
GET /question/create 질문 생성 폼 조회 없음 질문 생성 폼 뷰
POST /question/create 질문 생성 title(String), content(String) 생성 완료 후 질문 목록 페이지 리다이렉트
GET /question/modify/{id} 질문 수정 폼 조회 id(Integer) 질문 수정 폼 뷰
POST /question/modify/{id} 질문 수정 id(Integer), title(String), content(String) 수정 완료 후 질문 상세 페이지 리다이렉트
POST /question/delete/{id} 질문 삭제 id(Integer) 삭제 완료 후 질문 목록 페이지 리다이렉트

2.6.6 RecipeController

HTTP Method URL 기능 요청 파라미터 응답 결과
GET /recipe/list 레시피 목록 조회 page(int), size(int), keyword(String) 레시피 목록 뷰 및 페이징 처리
GET /recipe/detail/{id} 레시피 상세 조회 id(Long) 레시피 상세 뷰
GET /recipe/create 레시피 생성 폼 조회 없음 레시피 생성 폼 뷰
POST /recipe/create 레시피 생성 title(String), content(String), image(MultipartFile) 생성 완료 후 레시피 목록 페이지 리다이렉트
GET /recipe/edit/{id} 레시피 수정 폼 조회 id(Long) 레시피 수정 폼 뷰
POST /recipe/edit/{id} 레시피 수정 id(Long), title(String), content(String), image(MultipartFile) 수정 완료 후 레시피 목록 페이지 리다이렉트
POST /recipe/delete/{id} 레시피 삭제 id(Long) 삭제 완료 후 레시피 목록 페이지 리다이렉트

2.7 사용자 인터페이스 설계

UI/UX

  • 화면 구성 요소(버튼, 입력 폼, 데이터 바인딩 등) 정의.
  • 페이지 간의 이동 흐름 설계.
  • 화면 요소의 위치 및 디자인 가이드 작성.

3.구현

3.1 개발 환경 및 배포

  • Backend: Spring Boot, Java 17
  • Database: MySQL
  • Frontend: Thymeleaf
  • API Integration: OpenAI API (ChatGPT)
  • Deployment: AWS EC2, RDS (MySQL)

3.2 개발일정

wbs

4. 테스트

4.1 단위 테스트 결과서

1. 테스트 개요

단위 테스트는 각 서비스 계층(AIReviewService, QuestionService, UserService, RecipeService)의 메서드가 예상대로 작동하는지 확인하는 과정입니다. 각 테스트는 주요 기능별로 검증되었습니다.

2. 테스트 케이스

테스트 ID 테스트 대상 입력값 예상 출력 결과
ATR001 generateAIReview recipeInput = "Test recipe input", user = testUser 생성된 AIReview 객체, 사용자 및 레시피 입력 포함 Pass
ATR002 saveReview AIReview 객체 저장된 AIReview 객체 Pass
ATR003 getUserReviews user = testUser 해당 사용자에 대한 모든 리뷰 반환 Pass
ATR004 deleteReview reviewId = 1L 해당 리뷰 삭제 Pass
ATR005 getUserByUsername username = "testUser" 해당 사용자 객체 반환 Pass
QSR001 getList keyword = "test", page = 0 검색된 질문 리스트 반환 Pass
QSR002 getQuestion questionId = 1 해당 ID의 질문 반환 Pass
QSR003 getQuestionNotFound questionId = 1 DataNotFoundException 발생 Pass
QSR004 createQuestion title = "New Question", content = "This is a new question content." 새로운 질문 생성 Pass
QSR005 modifyQuestion question 객체, newTitle = "Updated Title", newContent = "Updated Content" 질문 수정 Pass
QSR006 deleteQuestion question 객체 질문 삭제 Pass
USR001 createUser username = "testUser", email = "test@example.com", password = "password123" 새 사용자 생성 Pass
USR002 getUser (성공) username = "testUser" 해당 사용자 반환 Pass
USR003 getUser (실패) username = "nonExistingUser" DataNotFoundException 발생 Pass
USR004 validatePassword (성공) password1 = "password123", password2 = "password123" true 반환 Pass
USR005 validatePassword (실패) password1 = "password123", password2 = "differentPassword" false 반환 Pass
RSR001 createRecipe title = "Test Recipe", content = "Test content", user = testUser 새 레시피 객체 생성 Pass
RSR002 getRecipeById recipeId = 1L 해당 ID의 레시피 반환 Pass
RSR003 testSaveImage_InvalidFileType 잘못된 MIME 타입 RuntimeException 발생 Pass

3. 테스트 실행 결과 요약

모든 테스트 케이스가 예상한 대로 성공적으로 수행되었습니다. 주어진 입력값에 대한 적절한 반환 값 및 예외 처리가 확인되었습니다.

4. 결론

테스트 결과 서비스 로직이 예상대로 잘 작동하며, 각 메서드는 입력값에 대해 올바른 출력을 반환하거나, 예외를 올바르게 처리하고 있음을 확인했습니다.

4.2 통합 테스트 결과서

4.2.1 UserService 통합 테스트

테스트 항목
테스트 항목 결과 상세 설명
사용자 생성 (createUser()) Pass 사용자 생성 시, username, email, 암호화된 password가 올바르게 저장됨.
사용자 조회 (getUser()) Pass 생성된 사용자가 정상적으로 조회됨.
비밀번호 검증 (validatePassword()) Pass 두 비밀번호가 일치하면 true, 불일치하면 false 반환됨.

4.2.2 AIReviewService 통합 테스트

테스트 항목 목표 결과 비고
AIReviewService 통합 테스트 AIReviewService의 전체 흐름 검증 generateAIReview와 saveReview로 생성된 AIReview가 DB에 저장됨 성공: AIReview 객체가 DB에 성공적으로 저장됨
QuestionService 통합 테스트 QuestionService의 질문 생성 및 삭제 확인 createQuestion으로 질문 생성 후, deleteQuestion으로 삭제 확인됨 성공: 질문이 DB에 저장되고 삭제됨
RecipeService 통합 테스트 RecipeService의 레시피 생성 및 저장 확인 createRecipe로 생성된 레시피가 DB에 저장됨 성공: 레시피가 DB에 저장됨
UserService 통합 테스트 UserService의 사용자 생성, 조회 및 비밀번호 검증 createUser로 생성된 사용자와 validatePassword가 정상 작동함 성공: 사용자 생성 및 비밀번호 검증 정상 작동

5. 결론

  • 전체 결과: 모든 통합 테스트가 성공적으로 통과하였으며, 각 서비스가 DB와 연동하여 정상적으로 작동함을 확인하였습니다.
  • 다음 단계: 추가적인 서비스와 기능에 대한 통합 테스트를 진행하고, 테스트 커버리지를 더 확장할 필요가 있습니다.

4.3 시스템 테스트 결과서

4.3.1 시스템 테스트

테스트 항목 목표 결과 비고
레시피 생성 및 저장 사용자가 레시피를 생성하고 저장하는 기능 검증 createRecipe로 레시피가 DB에 성공적으로 저장됨 성공
사용자 생성 및 조회 사용자가 정상적으로 생성되고 조회되는지 확인 createUser로 사용자가 생성되고 조회됨 성공
AI 레시피 생성 및 저장 AI가 생성한 레시피를 저장하고 조회하는 기능 검증 generateAIReview 및 saveReview로 AI 레시피 생성 후 저장됨 성공
질문 생성 및 삭제 사용자가 질문을 생성하고 삭제하는 기능 검증 createQuestion로 질문 생성 후, deleteQuestion으로 삭제됨 성공

4.3.2 결론

  • 전체 결과: 시스템 테스트가 성공적으로 완료되었으며, 모든 주요 기능이 정상적으로 작동함을 확인하였습니다.
  • 다음 단계: 추가적인 비즈니스 로직 및 더 복잡한 시나리오에 대해 시스템 테스트를 확장할 예정입니다.

4.4 인수 테스트 결과서

4.4.1 인수 테스트

테스트 항목 목표 결과 비고
회원가입 및 로그인 사용자가 회원가입 후 로그인이 정상적으로 이루어지는지 검증 createUser로 사용자가 생성되고 login으로 로그인 처리됨 성공
레시피 생성 사용자가 레시피를 생성하는 기능 검증 createRecipe로 레시피 생성 후, getRecipeById로 조회 성공 성공
AI 레시피 생성 AI가 생성한 레시피를 저장하고 조회하는 기능 검증 generateAIReview 및 saveReview로 AI 레시피 생성 후 저장됨 성공
질문 게시판 생성 및 삭제 사용자가 질문을 생성하고 삭제하는 기능 검증 createQuestion로 질문 생성 후, deleteQuestion으로 삭제됨 성공

4.4.2 결론

  • 전체 결과: 인수 테스트가 성공적으로 완료되었으며, 사용자의 주요 요구사항이 정상적으로 처리됨을 확인하였습니다.
  • 다음 단계: 추가적인 기능에 대해 인수 테스트를 진행하고, 사용자 경험을 기반으로 한 검증을 강화할 예정입니다.

5. 시연

  • Main & About Page
    • 메인페이지 및 소개페이지
      MainAbout
  • Auth & Scrap Page
    • 로그인 기능 구현
    • 로그아웃 기능 구현
    • 회원가입 기능 구현
    • 프로필 기능 구현
    • 게시글 스크랩 기능
      Auth
  • Recipe Board Page
    • 게시글 CRUD 기능
    • 댓글 CRUD 기능
    • 검색기능
    • Pagination 기능
      RecipeBoard
  • QNA Board Page
    • 게시글 CRUD 기능
    • 댓글 CRUD 기능
    • 검색기능
    • Pagination 기능
      QNA
  • AI Board Page
    • 레시피 AI 응답생성 기능 및 삭제기능
    • 검색 기능
    • Pagination
      AI

6. 에러 해결 및 느낀점

에러 1: No qualifying bean of type 'PasswordEncoder'

에러 설명

Spring Security에서 PasswordEncoder를 Bean으로 등록하지 않았을 때 발생하는 오류입니다. 사용자 비밀번호를 암호화하는 PasswordEncoder가 없으면 인증 및 저장 과정에서 실패할 수 있습니다.

에러 사유

Spring Security가 내부적으로 PasswordEncoder Bean을 요구하지만, 프로젝트 설정에서 이를 제공하지 않아 발생한 문제입니다.

에러 해결 방법

@Configuration 클래스에 PasswordEncoder를 정의하여 Bean으로 등록합니다.

@Configuration
public class SecurityConfig {

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}

에러 2: Could not create query for method... No property 'id' found for type 'User'

에러 설명

Spring Data JPA에서 지정된 쿼리 메서드가 엔티티 필드와 일치하지 않아 발생하는 오류입니다.

에러 사유

엔티티 User 클래스의 필드명이 id가 아니라 userId로 정의되어 있지만, 쿼리 메서드에서 이를 올바르게 반영하지 못한 경우입니다.

에러 해결 방법

엔티티 필드명을 기준으로 쿼리 메서드를 수정합니다.

public interface AnswerVoterRepository extends JpaRepository<AnswerVoter, Long> {

    // 수정 전: findByUserId(Long id)
    // 수정 후:
    List<AnswerVoter> findByUserUserId(Long userId);
}

에러 3: OpenAI API 호출 중 인증 문제

에러 설명

OpenAI API 호출 시 API 키가 누락되거나 잘못 설정되어 인증 문제가 발생

에러 사유

환경 변수로 설정된 API 키가 제대로 로드되지 않거나, application.properties 또는 application.yml 파일에 설정이 누락된 경우입니다.

에러 해결 방법

  1. application.properties 파일에 다음과 같이 API 키를 설정
spring.ai.openai.api-key=${OPENAI_API_KEY}
  1. dot env로 환경변수 설정

OPENAI_API_KEY=your_api_key
  1. Spring Boot 애플리케이션을 재시작하여 키가 제대로 로드되었는지 확인

6.2 느낀점

  • Spring Security와 JPA 사용 시 세부 설정이 중요하며, 기본 설정에 의존하지 않고 명확한 코드 작성이 필요함을 깨달음
  • OpenAI API와 같은 외부 서비스를 연동할 때, 환경 변수 및 설정 파일 관리가 애플리케이션의 안정성과 보안성을 크게 좌우한다는 것을 배웠음
  • 스프링 부트 프레임워크를 다루면서 다른 프레임워크에 비해 어렵다고 느꼈는데 막상해보니 시행착오는 많았지만 원하는 기능들을 구현할 수 있었음

About

[Personal Project] SpringBoot Monolothic - Layered Architecture

Topics

community cook recipes-website

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages