[Proj. SARAMARA] 📝 개발일지 3

Pull Request Link: [Feat/게시글상세조회] 하나의 게시글 가져오기 #39

이번 주차에서는 작성된 게시글에서 게시글을 눌렀을 때 해당하는 게시글의 정보를 뱉어주기 위한 API를 개발하기로 했다.

게시글 작성때와 마찬가지로 가장 먼저 설계한 ERD와 API 명세서를 통해서 Entity 확인과 API path를 확인했다.
설계한 Entity를 확인을 한 이후, 하나의 게시글 조회에 필요한 Dto를 작성했다.
작성과는 다르게 RequestDto가 아닌 DataBase에 작성된 데이터를 불러오는 작업을 위해 ResponseDto으로 클래스를 만들었다.

public class BoardResponseDto {

    @Getter
    @AllArgsConstructor
    @NoArgsConstructor
    @Builder
    public static class ReadOneBoardResponseDto {

        private Long boardId;

        private String title;

        private String content;

        private CategoryBoard categoryBoard;

        private String memberNickname;

        private String memberEmail;

        private Long boardCnt;

        private Long likeCnt;

        private LocalDateTime deadLine;
    }
}

BoardResponseDto 클래스를 생성하여 Inner Class인 ReadOneBoardResponseDto를 작성하여 게시글 조회 결과를 담는 DTO를 구현하였다. 그리고 게시글에서 보여질 회원의 정보로 회원의 정보인 닉네임과 이메일을 사용해주기 위해서 별도의 memberNickName과 memberEmail의 컬럼값을 추가해주었다.

그리고 생성된 게시글을 불러오기 전에 Repository class에서 삭제되지 않은 boardId 값만 조회할 수 있도록 해주기 위해 BoardRepository 인터페이스에 findByBoardIdAndDeletedAtIsNull() 메서드를 추가하여 ID를 기준으로 게시글을 조회하는 쿼리를 작성하였다. (SoftDel 상황을 고려해서 Null 인 Id의 값만 조회하도록 구성)

public interface BoardRepository extends JpaRepository<Board, Long> {

    Optional<Board> findByBoardIdAndDeletedAtIsNull(Long boardId);
}

필요한 데이터를 조회하기 위한 작업을 마쳤다, 이제 비즈니스 로직을 작성하기 위해서 Service 인터페이스와 Service구현체 클래스에서 해당 로직을 아래와 같이 작성했다.

BoardService interface

public interface BoardService {

    //게시글 등록 요청 Method
    Board saveBoard(BoardRequestDto.SaveRequestDto requestDto);

    // boardId를 매개변수로 받아 해당 게시글을 조회하는 기능의 Method
    BoardResponseDto.ReadOneBoardResponseDto readOneBoard(Long boardId);
}

BoardServiceImpl class

@RequiredArgsConstructor
@Log4j2
@Service
public class BoardServiceImpl implements BoardService {

    private final BoardRepository boardRepository;
    private final MemberRepository memberRepository;

    // ... (게시글 작성 관련 코드 생략)
    
    @Override
    public BoardResponseDto.ReadOneBoardResponseDto readOneBoard(Long boardId) {

        Board board = boardRepository.findByBoardIdAndDeletedAtIsNull(boardId)
            .orElseThrow(() -> new EntityNotFoundException("게시글을 찾을 수 없습니다."));

        // Member information
        String memberNickname = board.getMember().getNickname();
        String memberEmail = board.getMember().getEmail();

        // 게시글 정보와 멤버 정보를 매핑해서 응답
        BoardResponseDto.ReadOneBoardResponseDto responseDto =
            BoardResponseDto.ReadOneBoardResponseDto.builder()
                .boardId(board.getBoardId())
                .title(board.getTitle())
                .content(board.getContent())
                .categoryBoard(board.getCategoryBoard())
                .memberNickname(memberNickname)
                .memberEmail(memberEmail)
                .boardCnt(board.getBoardCnt())
                .likeCnt(board.getBoardCnt())
                .deadLine(board.getDeadLine())
                .build();

        return responseDto;
    }
}

마지막으로 생성한 Service를 동작할 Controller 클래스를 작성해주었다.

BoardController

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/board")
public class BoardController {

    private final BoardService boardService;

	// ... (게시글 작성 관련 코드 생략)
    
    @GetMapping("/{boardId}")
    public ResponseEntity<Object> readOneBoard(@PathVariable Long boardId) {
        BoardResponseDto.ReadOneBoardResponseDto boardResponseDto = boardService.readOneBoard(boardId);

        // 응답 데이터 생성
        Map<String, Object> response = new HashMap<>();
        response.put("code", 200);
        response.put("msg", "success");

        // 게시글 정보
        response.put("data", boardResponseDto);

        return ResponseEntity.ok(response);
    }

}

결과는?

이번 스프린트는 트러블 이슈없이 어렵지 않게 Read 작업을 진행 할 수 있었다.

fix.(이미지 수정) API Path 경로는 Meeting을 통해 수정되어 이미지의 Path와 다릅니다.
수정 완료 Path: http://localhost:80/api/v1/board/{boardId}

🚀 팀원의 Review

팀원의 리뷰 사항으로 Controller에 작성된 response 반환 방법에 가독성이 좋은 방법으로 메서드 체이닝이라는 용어를 알게 되었다.

메서드 체이닝 : 메소드를 고리마냥 줄줄이 엵어서 메소드를 계속해서 사용할 수 있게끔 하는 방법

ok(response) 응답 객체를 바로 포함해서 반환했었지만, ok().body(response)로 명시적인 방법을 줄 수 있다는 것을 알게되었다.

하지만, 현재는 ok(response) 와 ok().body(response)는 코드를 읽고 해석할 때 큰 체감을 못 느꼈기 때문에 아직은 수정 작업은 하지 않았다.