2022.05.03 「주석을 작성하는 방법 & Back 중심 개발 수정 및 시작」

스프링 부트 프로젝트를 시작한 지 일주일이 좀 되어간다. 잘 되어가고 있나 생각을 해보았다. 하지만 아무리 생각해도 이상하다는 생각이 계속 들었다.

1. 분명 Backend 개발이 목적인데 왜 나는 Front(Thymeleaf, CSS 등등)에 시간을 더 쏟고 있는 것인가?
2. 주석 처리 방법이 난잡하다?

이를 고민하다가 결국 개발자분의 조언을 듣고 클래스와 메서드 단위의 주석을 작성하는 방법, Back 중심 개발을 시작하기로 생각했다.

 

주석을 다는 방법?

기존에 나는 기준 없이 다른 사람이 이 정도면 알아보겠지라는 생각으로 나름 주석을 잘 작성했다고 생각했다. 

그건 나만의 착각이었다. 아무리 잘 작성했다 생각한 주석도 남이 볼 땐 그저 난잡하고 의미 없이 달린 주석일 수 있다는 생각을 하지 못했던 것이다.

이전 주석들. 메서드별로 친절히 설명했다고 생각했다.

enum 클래스 주석도 마찬가지. 괜찮지 않나..?

주석은 주관적인 판단이 아니라 규칙을 통해 작성하는 것이 맞는 것이다. 기준이 정해져 있기 때문에 협업 시 생각을 하나로 통합하여 불필요한 커뮤니케이션을 줄이고 개발에 몰두할 수 있는 것이다.

 

그래서 나는 javadoc을 작성하는 방법을 공부하여 이를 적용시켜 클래스와 메서드에 주석을 적용시켜 보았다.

클래스에 적용한 예시

> @로 시작하는 javadoc 전용 태그를 통해 여러가지 파라미터나 정보를 담을 수 있다.

필드 주석 이게 맞는건가 싶다 아직도

메서드 전용 주석 Param Return의 전용 태그 이용

=> 이런 식으로 기준 주석을 달아 보다 규칙적인 주석 작성 방법에 다가가 보았다.

 

참조 : https://araikuma.tistory.com/653

[Javadoc] 주석의 구성

 

Backend 다운 개발?

백엔드 중심 개발? 무엇일까 이것이.

 

1. 기존 스프링 코드

기존 코드

=> 틀린 건 아니다. 하지만 의존도는 view가 상위 개념으로 잡힌다. 예로 들어 페이지마다 필요한 즉각적인 api를 요청하여 뷰 네임을 반환하기 때문에 상위 모듈은 view라고 보면 된다. back 관련 로직이 view에 딸려 있는 느낌인 거다.

 

2. 수정한 컨트롤러

Class는 RestController

해당 컨트롤러의 핸들러메서드 객체 그대로 반환

=> 중요한 건 View가 아니다. 내가 집중해야 할 부분은 Back관련 로직을 구상하는 것이 핵심 과제이다. RestFulController를 이용하여 View 중심 개발이 아닌 해당 로직 핸들러를 구현하는데 더 초점을 맞췄다. 결과는? Postman이라는 프로그램을 이용해서 Json 형식으로 확인하면 된다! 스프링부트는 기본적으로 rest Data 응답 시 Json으로  응답하는 것이 기본이기 때문. (Jackson data bind) (XML을 원할 경우 설정하면 됨)

이런 것만 보면 됨!

>  수정을 바탕으로 백에 더 집중적인 프로그래밍을 해보자!