[Proj. SARAMARA] 📝 개발일지 2

👨🏻‍💻 현재 팀원들의 코드리뷰가 진행중인 사항으로 포스트에 작성된 일부 코드가 후에 수정될 수 있습니다.
자세한 코드는 깃헙을 통해 확인이 가능합니다.
Link: [Feat/게시글작성] 게시글 작성 #30

내가 맡은 게시글 서비스를 개발하기 위해 먼저 게시글 작성에 대한 API를 개발했다.

API 개발 시작에 앞서 설계한 ERD와 API 명세서를 통해서 Entity 확인과 API path를 확인했다.
설계한 Entity를 확인을 한 이후, 게시글 작성에 필요한 Dto를 작성했다.
하지만, 이전에 불필요한 코드를 1차적으로 확인하고 삭제하거나 주석처리를 했음에도 불구하고 누락된 코드를 확인해고 이 부분들을 제거해주었다.

그리고나서, 전에는 Dto의 이해가 부족해서 Entity의 모든 값을 똑같이 넣어줘서 사용했으나, 현재는 요청에 필요하지않는 Colume을 포함하는 것이 비효율적으로 생각해서 요청에 필요한 Colume만을 Dto로 생성해서 필요에 맞춰 Dto를 사용하려 한다.

게시글 작성에 대한 Dto가 필요하기 때문에 BoardRequestDto 클래스를 생성하고 하위 클래스로 SaveRequestDto를 생성해 주었다.

이렇게 내부 클래스(inner class)로 정의하는 것은 코드의 구조화와 캡슐화를 위해 사용된다고 한다.

public class BoardRequestDto {

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

        @NotBlank(message = "제목을 입력해주세요.")
        private String title;

        @NotBlank(message = "내용을 입력해주세요.")
        private String content;

        @NotNull(message = "카테고리를 선택해주세요.")
        private Category category;

        @NotNull(message = "사용자의 고유번호가 존재하지 않습니다.")
        private Long memberId;

        private LocalDateTime deadLine;
    }
}

필자가 하위 클래스에 작성한 이유는 간단하다. 여러개의 클래스를 생성할 수 있지만, 클래스 파일이 많아지면 오히려 관리가 복잡해져서 비효율적인 관리가 될 수 있을 것이라고 생각했기 때문이다.
(개인적인 이유입니다.)

👨🏻‍💻 내부 클래스를 사용하는 이점

• 코드 구조화
  내부 클래스를 사용하면 연관된 클래스를 논리적으로 그룹화할 수 있다.
  SaveRequestDto는 BoardRequestDto에 관련된 기능을 제공하므로, 클래스 내에서 함께 선언함으로써 관련된 코드를 한 곳에 위치시킬 수 있다.
• 접근 제어
  내부 클래스를 사용하면 외부 클래스에서 내부 클래스의 멤버에 직접 접근하는 것을 제한할 수 있다.
  내부 클래스를 private으로 선언하거나, 필요에 따라 public, protected 등의 접근 제어자를 사용하여 외부에서의 접근을 제한할 수 있다.
• 코드 응집성
  내부 클래스를 사용하면 클래스 간의 관련된 데이터와 동작을 한 곳에 유지할 수 있다.
  SaveRequestDto가 BoardRequestDto의 일부로 정의되어 있기 때문에, SaveRequestDto의 데이터와 동작은 BoardRequestDto와 밀접하게 연관되어 있을 것이다.

내부 클래스를 사용하는 것은 선택사항이고, 코드의 구조와 설계에 따라 유연하게 대처할 수 있다.

이제, Dto 작성을 완료했고 Service 인터페이스에 게시글 작성에 대한 메서드(saveBoard)를 생성해주고 구현체인 BoardServiceImpl 클래스를 생성했다.

public interface BoardService {

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

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

    private final BoardRepository boardRepository;
    private final MemberRepository memberRepository;

    @Override
    public Board saveBoard(BoardRequestDto.SaveRequestDto requestDto) {

        // 요청된 데이터로 Member 객체를 조회
        Member member = memberRepository.findById(requestDto.getMemberId())
            .orElseThrow(() -> new IllegalArgumentException("사용자를 찾을 수 없습니다."));

        // 카테고리 값 설정
        Category category = requestDto.getCategory();

        // Board Entity 생성
        Board board = Board.builder()
            .member(member)
            .category(category)
            .title(requestDto.getTitle())
            .content(requestDto.getContent())
            .build();

        return boardRepository.save(board);
    }
}

그리고 API 동작을 위해서 작성한 Controller 코드는 아래와 같다.

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

    private final BoardService boardService;

    @PostMapping("/register")
    public ResponseEntity<?> createBoard(@RequestBody @Valid BoardRequestDto.SaveRequestDto requestDto) {
        Board savedBoard = boardService.saveBoard(requestDto);

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

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

        return ResponseEntity.ok(response);
    }
}

이렇게 해서 게시글 작성 API를 개발할 수 있었고 PostMan을 통해 API가 잘 동작하는지 테스트를 해보았다.

결과는?

1차 시도: 401 Error

생각해보니 이번 프로젝트는 한 모듈에 Member와 JWT 설정 패키지를 가지고 있기 때문에 개발하는 도중에도 JWT의 인증을 거치게 된다. 전에 JWT를 다룬 경험이 있어서 401 에러에 팀원이 성심껏 작성해준 message 덕분에 어떤 것이 문제인지 바로 알아차릴 수 있었다.

JWT를 확인하는 과정에서 내가 지정된 path가 검증대상이 되었고, Member의 개발이 완성되지 않은 상태에서 게시글을 작성하려니, 정석 절차대로 해결할 수는 없었다.

그래서 개발 단계이기 때문에, 필자가 지정해둔 API path 경로를 검증하지 않도록 임시로 구현해둔 다음에 Member와 Board의 개발이 완료되면 그 이후에 임시로 지정한 config를 수정해서 테스트 하기로 했다.

2차 시도: 200 Succes

원하는 값을 DB에 잘 저장시킨 것도 확인했다. (필자는 MariaDB를 사용해 개발을 진행하고 Tool로 DBeaver를 사용하고 있다.)

코드 리뷰를 통해 수정된 내용이 있다면 추가로 기록을 할 예정