1. 목표와 기능

1.1 목표

• JAVA, DB를 바탕으로 실제 백엔드 애플리케이션을 직접 제작한다.
• 손수 구현해보며, 중간중간 기술 바탕이 되는 기본 이론들을 익혀본다.

1.2 기능

• 3.요구사항 명세와 기능 명세 항목 참고

2. 팀 소개 및 개발 환경 / URL 구조

2.1게시판 서비스 B.E팀 구성

역할 분담

• CTO : 박 조은
• BE : 김 현지
• BE : 우 비주
• BE : 김 도현

2.1-1 개발 환경

• Spring Boot 3.4.x
• MySQL 8.x
• PostMan

2.1-2 URL 구조

• 회원 API

App	URL	HTTP Method	Note	로그인 권한 필요
Auth	/sign	POST	회원가입
Auth	/login	POST	로그인
Auth	/logout		로그아웃

• 게시글 API

App	URL	HTTP Method	Note	로그인 권한 필요
Post	post	GET	게시판 전체 목록
Post	post/email	GET	이메일로 목록 필터링
Post	post/write	POST	게시글 작성	✅
Post	post/edit	UPDATE	게시글 수정	✅
Post	post/delete	DELETE	게시글 삭제	✅

• 댓글 API

App	URL	HTTP Method	Note	로그인 권한 필요
Comment	/comment/post-comments	GET	게시글 댓글목록
Comment	/comment/write	POST	댓글 작성	✅
Comment	/comment/edit/id	UPDATE	댓글 수정	✅
Comment	/comment/delete/id	DELETE	댓글 삭제	✅

• 좋아요 API

App	URL	HTTP Method	Note	로그인 권한 필요
Good	/good/{id}	GET	좋아요 check 여부	✅
Good	/good{id}	DELETE	좋아요 삭제	✅

3. 요구사항 및 기능 명세와 예시 데이터 명세

게시판 기능

기능	상세	참고
회원	1. 이메일 비밀번호 입력하여 회원가입 API 2. 이메일 비밀번호 입력하여 접속하는 API 3. 접속된 유저 로그아웃
조회	1. 게시물 전체 조회하는 API 2. 작성자 이메일을 통해 특정 게시물들을 검색하는 API 3. 댓글을 조회하는 API
생성	1. 댓글을 새롭게 만들 수 있는 API 2. 게시물을 새롭게 만들 수 있는 API
수정	1. 기존 댓글의 글을 수정하는 API 2. 게시물을 새롭게 수정할 수 있는 API
삭제	1. 게시물을 삭제하는 API 2. 댓글을 삭제하는 API
옵션	1. 이메일과 같이 게시글 좋아요를 할 수 있는 기능

게시판 기능 API 인터페이스 스펙

이메일 비밀번호 입력하여 회원가입 API

• HTTP 메소드: POST
• 엔드포인트: /api/signup

요청 본문(JSON 형식):

{ "email": "user@example.com", "password": "user_password" }

응답 본문(JSON 형식):

{ "message": "회원가입이 완료되었습니다." }

​

이메일 비밀번호 입력하여 접속하는 API

• HTTP 메소드: POST
• 엔드포인트: /api/login

요청 본문(JSON 형식):

{ "email": "user@example.com", "password": "user_password"

​ 응답 본문 HTTP ( token 해더로 )

HTTP/1.1 200 OK Content-Type: application/json Authorization: Bearer your_access_token_here { "message": "로그인이 성공적으로 완료되었습니다." }

접속된 유저 로그아웃

• HTTP 메소드: POST
• 엔드포인트: /api/logout

요청 본문(JSON 형식):

{ "email": "user@example.com" }

응답 본문(JSON 형식):

{ "message": "로그아웃되었습니다." }

게시물 전체 조회하는 API

• HTTP 메소드: GET
• 엔드포인트: /post

응답 본문(JSON 형식):

[
    {
        "idx": 1,
        "title": "제목",
        "body": "내용",
        "email": "이메일",
        "author": "직성자",
        "created_at": "작성일시"
    },
    {
        "idx": 2,
        "title": "제목",
        "body": "내용",
        "email": "이메일",
        "author": "작성자",
        "created_at": "작성일시"
    },
 ]

작성자 이메일을 통해 특정 게시물들을 검색하는 API

• HTTP 메소드: GET
• 엔드포인트: /post/email
• 쿼리 파라미터: ?author_email=user@example.com

응답 본문(JSON 형식):

[
    {
        "idx": 2,
        "title": "제목",
        "body": "내용",
        "email": "이메일",
        "author": "작성자",
        "created_at": "작성일시"
    },
 ]

​

게시글 댓글을 조회하는 API

• HTTP 메소드: GET
• 엔드포인트: /api/comment/post-comments
• 쿼리 파라미터: ?idx=1

응답 본문(JSON 형식):

{ "comments": 
	 [ 
		 { "id": 1, "content": "댓글 내용", "author": "작성자", "post_id": 1, "created_at": "작성일시" },
		 { "id": 2, "content": "댓글 내용", "author": "작성자", "post_id": 1, "created_at": "작성일시" },
	 ... 
	 ]
  }

댓글을 새롭게 만들 수 있는 API

• HTTP 메소드: POST
• 엔드포인트: /api/comments/write
• 로그인 필요 요청 본문(JSON 형식):

{ "content": "댓글 내용",  "post_id": 1 }

응답 본문(JSON 형식):

{
  "message": "댓글이 성공적으로 작성되었습니다.",
  "status": 200,
  "comment": {
    "id": "댓글id",
    "content": "댓글 내용",
    "author": "작성자",
    "postId": "게시글 id",
    "createdAt": "작성일자"
  }
}

게시물을 새롭게 만들 수 있는 API

• HTTP 메소드: POST
• 엔드포인트: /api/posts
• 로그인필요(Bearer Token)

요청 본문(JSON 형식):

{
    "title": "제목",
    "body": "내용용"
}

응답 본문(JSON 형식):

{ "message": "게시물이 성공적으로 작성되었습니다." }

기존 댓글의 글을 수정하는 API

• HTTP 메소드: PUT
• 엔드포인트: /api/comment/edit/:comment_id
• 로그인필요(Bearer Token)

요청 본문(JSON 형식):

{ "content": "수정된 댓글 내용" }

응답 본문(JSON 형식):

{
  "message": "21번 댓글이 성공적으로 수정되었습니다.",
  "status": 200
}

게시물을 새롭게 수정할 수 있는 API

• HTTP 메소드: PUT
• 엔드포인트: /api/posts/:post_id
• 요청 본문(JSON 형식):

{   "idx": 4, 
  "title": "제목",
  "body": "내용"
}

응답 본문(JSON 형식):

{
	게시글이 성공적으로 수정되었습니다.
}

좋아요를 추가할수 있는 API

• HTTP 메소드: POST
• 엔드포인트: /api/goods/:post_id ![스크린샷 2024-12-13 오전 10.05.29.png]

좋아요를 취소할수 있는 API

• HTTP 메소드: DELETE
• 엔드포인트: /api/goods/:post_id ![스크린샷 2024-12-13 오전 10.06.47.png]

기존 댓글을 삭제하는 API

• HTTP 메소드: DELETE
• 엔드포인트: /api/comment/delete/:comment_id
• 로그인필요(Bearer Token)

응답 본문(JSON 형식):

{
  "message": "21번 댓글이 성공적으로 삭제되었습니다.",
  "status": 200
}

기존 게시을 삭제하는 API

• HTTP 메소드: DELETER
• 엔드포인트: /post/DELETE
• 로그인필요(Bearer Token)

응답 본문(JSON 형식):

{
	게시글이 성공적으로 삭제되었습니다.
}

4. 개발 일정(WBS)

요구 사항 분석 : 2024-12-09, 5d 게시글API 개발 - 박조은 : 2024-12-09, 5d 댓글API 개발 - 김현지 : 2024-12-09, 5d 좋아요API 개발 - 우비주 : 2024-12-09, 5d 회원API 개발 - 김도현 : 2024-12-09, 5d

테스트 : 2024-12-13, 1d 문서 작성 : 2024-12-11, 1d

5. 화면 설계( U.I )

로그인 폼
게시글 전체 목록 폼
게시글 작성 폼
게시글 상세 내용 폼
댓글 작성 폼
댓글 내용 폼
]

사진 자료가 없네?

6. 데이터베이스 모델링( ERD )

7. 메인 기능

• 여기에 각자 구현한 기능을 작성

로그인 시 클라이언트가 로그인 요청을 하고, 웹 서버가 로그인 정보를 요구한 후, 서버가 해당 정보를 검증하여 성공 또는 실패 결과를 클라이언트에게 전달하는 과정

8. 에러와 에러 해결

박 조 은

에러 및 에러 해결

• 데이터베이스를 참조할 때 컬럼명은 일치시켜야 하지만, postman에서 응답하는 값은 변수명을 설정해서 바꿔도 된다. 그리고 데이터베이스의 설정에 따라서도 에러가 엄청 많이 나는 걸 알게 되어서 일단 구현해보기 위해서 무작정 이것저것 만지면서 하면 안된다.

Posts post = postRepository.findByIdx(postRequest.getIdx())        
.orElseThrow(() -> new InvalidValueException("해당 idx의 게시글이 없습니다."));if(!post.getUser().getUserId().equals(postRequest.getUserIdx())) {    throw new AccessDeniedException("작성자 불일치 : 게시글 수정 권한이 없습니다."); }post.setBody(postRequest.getBody());post.setTitle(postRequest.getTitle());

• 예외처리를 이중으로 하는 방법이 try-catch만 알았는데, else throw를 두 번씩 쓰면 더 간단하게 이중으로 처리할 수 있다.

        Integer userId = userDetails.getUserId();
        Integer idx = Integer.valueOf(request.get("idx"));
        String body = request.get("body");
        String title = request.get("title");
        PostRequest postRequest = new PostRequest();
        postRequest.setTitle(title);
        postRequest.setBody(body);
        postRequest.setIdx(idx);
        postRequest.setUserIdx(userId);
        PostResponse updatedPost = postService.updateBodyByIdx(postRequest);
        return ResponseEntity.ok("게시물이 성공적으로 수정되었습니다.");

• 코드는 짧을 수록 좋다고 하는데, 쓰면 쓸수록 길어진다.

김 현 지

에러 및 에러 해결

• 댓글을 생성하는 과정에서 생성일에 값을 넣어주지 않고 insert 했더니 에러가 났다. DB table 에 생성일 부분을 not null 로 설정해두고 저장할 때 날짜를 넣지 않아서 에러가 났었는데, 엔티티에 @DynamicInsert와 @CreationTimestamp를 추가해서 해결할 수 있었다. @DynamicInsert 는 데이터를 insert 할 때 null인 값을 굳이 넣어주지 않는 역할이고, @CreationTimestamp 는 생성일 컬럼 위에 적어주면, 생성일을 알아서 넣어주는 어노테이션이었다. 어노테이션을 얼마나 아는가에 따라서 코드를 많이 줄일 수 있다. 아는 만큼 간결해지는 것 같다.

• user 테이블과 조인하여 작성자 정보를 가져오기 위해서 jpa와 @Query를 사용

@Query("SELECT c FROM Comments c JOIN FETCH c.user u")
List<Comments> findAllByPostsIdxOrderByCreatedAtAsc(Integer postIdx);

-> 단순히 조인 쿼리를 넣었더니 postIdx에 해당하는 댓글들만 불러왔어야했는데 전체를 불러오는 것을 확인

@Query("SELECT c FROM Comments c JOIN FETCH c.user u WHERE c.postsIdx = :postIdx ORDER BY c.createdAt ASC")
List<Comments> findAllByPostsIdxOrderByCreatedAtAsc(@Param("postIdx") Integer postIdx);

-> where절을 추가하고, 변수로 받는 부분을 @Param으로 받아서 :postIdx 로 사용해서 쿼리절 안에서 불러주니 원하는대로 게시글 당 댓글을 불러 올 수 있었다.

우 비 주

에러 및 에러 해결

• 좋아요 기능 자체가 유저의 로그인 정보와 게시글의 정보를 가지고 하는거라, 회원가입부터 조인하면서의 오류가 많이 발생함
• user 시간 생성부분이 null로 뜨면서 로그인자체가 안되서 시간 자동생성해주는 @PrePersist 삽입함

@PrePersist
 public void prePersist() {
 if (this.createdAt == null) {
 this.createdAt = LocalDateTime.now(); // 자동으로 현재 시간 설정
 }
 }

-> 그런데 어노테이션으로 간편하게 시간을 생성해주는 @CreationTimestamp 를 넣으면 똑같이 작동한다는것을 깨달음

• 로그인 진행하면서 X-AUTH-TOKEN 으로 반환하는 걸로 진행하니 로그인 문제가 해결이 함되서 Bearer Token 으로 변경해서 작업하는것이 좋겠다고 제안

김 도 현

에러 및 에러 해결

• 원인 : 비동기 통신으로, 서버에서 응답을 받아 데이터를 처리

  -> 컨트롤러에서 뷰가 아닌 해당 데이터를 반환하는 경우 @ResponseBody 어노테이션을 반드시 추가해야 한다 (사실 @RestController 쓰려고 작성하던 것이었을지도..)

• 원인 : HTTP요청의 URL이 비프린터블 ASCII문자를 포함하고 있어서 발생되었다 - 웹 서버나 애플리케이션 서버가 URI의 유효성을 검사할 때, 요청 URI에 포함된 문자가 ASCII 범위를 벗어나거나 인쇄할 수 없는 문자가 포함되어 있음

.authorizeHttpRequests(authz -> authz
                       .requestMatchers("/").permitAll()
                       .requestMatchers("/api/air-reservation/*").hasAuthority("ROLE_USER")
                       .anyRequest().authenticated()
               )

-> WebConfiguration을 설정하는 클래스의 fliterChain메서드에서 아래의 코드를 작성하여 접근 제한을 했기 때문에 팀원들이 기능을 구현한 뒤에 작성한 URL에 맞춰서 재설정

• 원인 : DataSource를 생성할 때 driverClassName이 비어 있다는 것을 의미

-> @ConfigurationProperties(prefix = "spring.datasource")와 @EnableConfigurationProperties(DataSourceProperties.class) 작성이 되어 서로 합이 되는 어노테이션이기에 확인이 필요하고 prefix작성시 yaml의경로를 확인하여 작성이 필요하다.

• Spring Boot의 기본 설정에서 해당 프로퍼티를 인식하지 못하는 것을 의미

-> yaml의 경로를 정확히 확인하여 작성하는 것이 필요

• 원인 : yaml파일이 많은 상황에서 Active Profiles를 지정하지 않거나 지정하지 않은 파일로 설정되어 있어도 문제가 발생할 수 있고 @Repository를 작성하지 않은 Repo클래스가 있는 경우 파일 찾지 못할 때도 문제가 생김

@EnableJpaRepositories(
        basePackages = {"com.github.movieproject.repository.auth.user","com.github.movieproject.repository.auth.role"},
        entityManagerFactoryRef = "entityManagerFactoryBean1",
        transactionManagerRef = "tmJpa1"
)

-> copy reference를 통해 basePackage의 파일 경로를 확인하고 @Repository가 설정된 파일을 점검, Active Profies를 확인하여 yaml파일 경로를 확인하는 것도 중요하다.

• JwtProvider의 resolveToken메서드를 반환하는 값이 X-AUTH-TOKEN으로 하고 있었는데 토큰이 일치하지 않아서 동작하지 않았다?

    public String resolveToken(HttpServletRequest request) {
        String bearerToken = request.getHeader("Authorization");
        if (bearerToken != null && bearerToken.startsWith("Bearer ")) {
            return bearerToken.substring(7);
        }
        return null;
//   바꾸기 전 코드 : return request.getHeader("X-AUTH-TOKEN");
    }

->Bearer Token으로 교체 작업을 진행함.

• createToken에서 username은 있는데 email 값이 들어오진 않았다.

        Claims claims = Jwts.claims()
                .setSubject(email);
                .setSubject(username);
        claims.put("roles", roles);

{
          "sub": "acron",
          "roles": [
            "ROLE_USER"
          ],
          "iat": 1733901025,
          "exp": 1733904625
}

-> setSubject는 주체를 정하는 것은 한번만 적용이 되고 마지막에 작성한 것을 기준으로 주체를 삼는다. 그래서 아래 코드와 같이 변경했다.

        Claims claims = Jwts.claims()
                .setSubject(email);
        claims.put("username", username);
        claims.put("roles", roles);

9. 개발하며 느낀점

박 조 은

개발하며 느낀점

• 내가 혼자서 구현한 게 아니라 팀원들의 도움을 받아 구현을 할 수 있었다. CTO의 역할에 대해 잘 모르고 하게 되었는데, 질문이 가장 많이 하는 CTO라고 생각이 들어서 혼자서도 오류를 찾아보고 해결하고, 공부를 더 해야겠다고 생각을 했다.
• 이번엔 깃에 대한 사용법을 모르고, 오류가 있어서 마지막에 거의 머지할 때만 할 수가 있었는데, 합쳐보니 다시 실행이 안되는 문제가 일어나 더 어렵게 해결한 것 같다. 중간중간 확인해서 진행할 수 있도록 깃 사용법을 익혀야겠다.
• 좀 어렵게 생각하고 접근을 해서 오히려 간단한 문제도 스스로 해결하지 못한 것 같다. 조금은 간단하게 접근을 해봐야겠다.

김 현 지

개발하며 느낀점

• 프로젝트를 처음 시작할 때, 어떤 것 부터해야할지 몰라 속으로 당황했었다. 그동안 강의에서 하는 실습만 따라하다가 처음으로 뭔가 시작하려고 하니까 어려웠다. 그래도 팀에서 잘 알려주셔서 너무 헤매지 않고 할 수 있었던 것 같다. 깃을 사용하는 게 너무 어렵고 조심스러웠다. 깃을 더 접해봐야겠다.

• jpa로 데이터를 가져오는 방식이 어려웠다. 쿼리로는 어떻게 하면되는 지 알겠는데 jpa에서는 네이밍 규칙이 있었고, 조인을 하기 위해서 쓰는 쿼리도 기본의 쿼리와는 살짝 달랐다. 조인을 했을 경우 네이밍규칙에 의해 썼던 조건이 안먹히는 경우도 있어서 다시 @Query에서 조건을 다시 쓰기도 하고 거기에 변수를 넣어주기 위한 @Param 이 있다는 것도 알게 되었다.

• 예외처리를 얼마나 해야하고 어떻게 해야하는지를 고민했다. 우선은 String으로만 처리를 해뒀는데, 다음에 더 시간이 있다면 메세지와 코드를 넣어서 보내고 싶다. 컨트롤러와 서비스에서 나눠서 예외처리를 했는데, 분명 배울 때는 컨트롤러는 짧을 수록 좋다고 했는데 예외처리를 여기에서 하는 게 맞는가? 하는 의문도 들었다. 어느정도의 예외처리를 해야하고, 그 예외처리를 하면서 코드 줄 수를 길게 쓰지 않는 방법은 없는지 찾아봐야겠다.

우 비 주

개발하며 느낀점

• 처음에 깃으로 각자 브랜치를 만들어서 작업을 했는데 , 중간에 커밋을 한번도 안하고 작업하다가 git add . 하면서 오류가 발생해 코드가 전체 날라갔었음. 진짜 멘붕이었지만 다행이 로컬리소스에서 작업변경했던 내용을 찾아서 코드 복붙으로 연결하긴 했지만 , 지금이야 코드가 간결했다고 하더라도 코드가 길고 복잡했다면 정말 큰일나는 상황이었다. 깃에 관해서 너무 몰랐던거 아닌가 싶다. 이번 프로젝트를 하면서 느낀거는 코드를 짜는 것 보단 어떻게 하면 깃을 잘 쓸수 있을까 제대로 공부를 하고 써야된다는 것을 깨달았다..

김 도 현

개발하며 느낀점

• OneToOne과 ManyToOne에서 지정하는 데이터 타입 설정을 몰랐음, repository에서 @Query에서 SQL문 작성 시 Join문에서 동작이 안되었음, OneToOne과 ManyToOne을 사용할 때 작성이 필요한 코드를 몰랐음 ->테이블 간 관계도와 join구문에 대한 이해가 부족하다. 추가적인 학습이 필요하다.

• Spring Security에서 변경이 가능한 UserDetailsService의 loadByUsername메서드 작성 시 authorities()의 데이터를 처리할 때 문제가 발생하고 해결하는데 까지 상당히 시간이 많이 소요됨 -> 스트림과 람다식에 대한 이해가 부족하다. 추가적인 학습이 필요하다.

• JwtToken 구현 후 구조가 비슷한 RefreshToken하는 코드를 작성하지 못함, Argument Resolver가 들어가야하는 위치를 찾지 못하고 있음 -> JWT Token,RefreshToken,Argument Resolver에 대한 이해 및 사용 이유를 제대로 이해하지 못했다. 추가적인 학습이 필요하다.