땍땍 블로그

코드를 작성하다보면 에러를 발견하는 것은 너무나 당연한 수순이다.이러한 에러를 발견했을 때 이를 해결하기 위해 로그를 확인하고, 문제가 되는 부분을 추적해 해결해야만 한다.하지만, 로그를 한 번이라도 확인해봤으면 알겠지만 이러한 로그는 길이가 짧지 않아 이를 읽고 파악하는데 생각보다 많은 시간이 소요되게 된다.또한, 이러한 로그는 보안상 local 환경에서만 확인할 수 있도록 하여 별도의 처리가 없는 한 API를 가져다 쓰는 프론트 쪽에서는 오류가 발생해도 어떤 것이 문제인지 파악할 수 없는 경우가 빈번히 발생하게 된다.예시를 들어보겠다.아래 코드는 Integer a 를 전달 받고, 해당 값에 +3 을 더한 값을 반환하는 코드이다. @PostMapping("/post") public int po..

프로젝트의 규모가 크지 않거나, 시작 단계일 경우 하나의 Repository에서 모든 쿼리를 관리하는 경우를 종종 볼 수 있을 것이다.public interface MemberRepository extends JpaRepository { Optional findByEmailAndNickname(String email, String nickname); List findByRole(Role role); ... 등등}위의 코드는 아직 정의된 메소드가 두 가지 밖에 없기에 잘 와닿지 않겠지만, 관련 쿼리가 몇 십,백개가 넘어가거나현재는 Jpa만 사용하지만 jpsql 혹은 querydsl 등으로 직접 쿼리문을 작성하는 경우 하나에 파일에서 관리하게 되면 코드가 복잡해져 유지보수에 있어 어려움을 느낄 ..

https://start.spring.io/ 에서 생성된 프로젝트를 그대로 실행하였을 경우 springboot가 실행과 동시에 종료가 된다.다양한 이유가 있겠지만, 로그에 Tomcat 관련 내역이 없다면 의존성을 추가하지 않아 발생하는 오류일 가능성이 높다.해결 방법 → 의존성 추가implementation 'org.springframework.boot:spring-boot-starter-web'자칫 org.springframework.boot:spring-boot-starter 과 동일한 의존성인 줄 아는 분들도 계시지만, 다른 의존성이기에 별개로 추가해주어야 한다.

응답 공통 포맷은 협업에 있어 일관성 있는 형식으로 값을 제공함으로 효율적인 작업을 위해 설정하곤 한다.이러한 포맷은 어디까지나 편의를 위해 설정하는 만큼 서비스에 따라 설정 값은 다르지만,응답 상태 값 ( error code , message 등의 상태를 확인할 수 있는 값 )반환 데이터 값위 두 가지는 많은 곳에서 활용하는 것같다.아래 코드는 기본적인 코드이다.@Getterpublic class ApiResult { private final String code; private final String message; private final T data; public ApiResult(String code, String message, T data) { this.code = code; ..

코드를 작성하고 테스트를 하거나 디버깅을 하는 과정에서 로그를 봐야하는 상황은 정말 많이 존재한다.하지만 이러한 로그에는 구분을 위한 ID 값이 존재하지 않기에 특정 로그를 찾는데 어렵다는 문제점이 존재하였다.이러한 사항 과정의 불편함을 줄이기 위해 각 로그 별로 특정 ID를 생성해 함께 출력하도록 하려 한다.로그에 ID 값을 출력하기 위해서는 로그 포맷을 변경해주어야 하는데, 기본 설정의 경우 아래와 같은 형식으로 로그가 출력되고 있을 것이다. 포맷 변경을 위해서는 application.yml 에서 간단하게 처리할 수 있으나, 세부적인 설정이 불가하기에 이번에는 logback-spring.xml 을 통해 변경해보도록 하겠다.logback-spring.xml 파일은 resources 아래에 생성해주면 된..

서버를 두고 작업하는 경우 보통 로컬에서 사용하는 환경과, 서버에서 사용하는 환경을 분리해서 사용하는 경우가 있을 것이다.대표적으로 로컬에서는 h2를, 서버에서는 mysql과 같이 사용을 하거나, mysql을 사용하더라도 로컬에서는 localhost 를, 서버는 주소를 입력하여 사용하곤 할텐데 이를 간단하게 구분할 수 있는 방법이 있다.이는 application를 여러개 만들어 사용하는 방법인데, 보통은 아래와 같이 생성하여 사용하지만 필요한 만큼 생성하고 제거하면 된다.application , application-local , application-dev , application-prodapplication.yml 에는 어떤 환경에서든 공통적으로 사용하는 사항들 ( 스웨거, 변수,, 등등 )local..

개발을 진행함에 있어 작성한 코드를 기록하고 누구나 이해하기 쉽게 남기는 것은 너무나 중요한 사항이다.이러한 것들을 직접 손으로 기록하여 메신저를 통해 다른 사람에게 전달하는 방식도 물론 있으나 이러한 과정 없이 자동으로 내가 만들어낸 API를 문서화 시켜주는 도구들이 여럿 존재한다. ( swagger, postman, spring rest docs 등등 .. )그중 이번에는 스웨거 ( sawgger ) 에 대해 소개하고 사용하는 방법을 작성하려 한다.스프링부트에서 스웨거를 사용함에 있어 선택할 수 있는 사항이 크게 2가지가 있는데 Springfox와 Springdoc이다.사실 사용함에 있어 큰 차이점이 있는 것은 아니지만 Springfox는 2020년을 기준으로 업데이트를 중단했기 때문에 특별한 이유가..

처음 스웨거를 접하는 사람들은 공식 문서보다는 이해하기 쉬운 블로그 글들을 많이 접할 것이라 생각을 한다. 하지만 이러한 글들을 유심히 살펴보면 글마다 의존성들이 조금씩 다르다는 것을 알 수가 있다. 결론부터 말하자면 2024년 이후로 스프링부트를 사용하는 분이라면 Springdoc 를 사용하는 것을 추천한다. Springfox는 2020년 이후로 업데이트가 되지 않기에 최신 버전 스프링부트와 연결시 오류가 발생하며, 간혹 io.swagger.core.v3 와 같은 의존성 등을 추가하여 진행하는 경우도 있는데, 해당 의존성은 우리가 알고 있는 스웨거의 일부만을 가져오는 것이기 때문에 원하는 형태로 사용할 수 없을 가능성이 크다.