스프링부트 15

Filter doFilter, ContentCachingWrapper, copyBodyToResponse 사용 이유 및 예시

이전 Filter를 이용해 응답/요청 로그를 출력하는 과정에서 doFilter, ContentCachingWrapper, copyBodyToResponse 를 왜 사용하는 것인지, 사용하지 않으면 발생하는 문제를 예시와 함께 설명하기 위한 글이다.이해를 돕기 위해 사용할 Controller 코드이다.@RequestMapping("/api")@RestController@Slf4jpublic class Controller { @PostMapping("/test") public String test(@RequestBody String a){ log.info("Controller : " + a); return a; }}우선 요청 값을 그대로 읽어 출력하는 코드를 작성해보..

Log 2024.08.06

ContentCachingRequestWrapper 동작 원리

ContentCachingRequestWrapper은 요청의 응답을 단 한 번 밖에 읽지 못 하기에 이를 여러번 사용할 수 있도록 해준다. 다만 여기에는 여러가지 조건과 제약이 있는데 이를 살펴보자.ContentCachingRequestWrapper를 사용하기 위해 보통 아래와 같은 방식을 사용하는데, 처음 이를 사용할 때 ContentCachingRequestWrapper는 request 값을 캐싱하여 담아두는 , 복사해둔다는 개념만 알았기에 선언과 동시에 이 값이 저장이 되는 것으로 생각하고 있었다.하지만 이를 자세히 살펴보면 , 선언과 동시에 저장되는 것은 request 값의 length뿐, 그 값은 저장이 되지 않은 것을 볼 수 있다.실제로 데이터를 저장하는 것은 값을 read 할 때이며, 때문에..

Log 2024.08.04

스프링부트 Filter를 이용한 로그(Request,Response ) 출력

스프링부트에서 로그 관리를 위해서는 크게 Filter, Interceptor,AOP 를 활용할 수 있다.이중 Interceptor와 AOP는 스프링 내부에서 동작하는 반면, Filter는 스프링 외부에서 동작하여 스프링 내에서 가공되기 전 요청과, 가공된 후의 응답 값을 가져와 읽을 수 있다는 장점이 있어 이번에는 Filter를 활용하여 Request와 Response의 값을 로그로 출력해보려한다.우선 로그를 출력하기 위해 아래 의존성을 추가해준다.( lombok이 아닌 다른 의존성 혹은 방법을 사용해도 무관하다 )implementation 'org.projectlombok:lombok'당연하게도 로그를 띄우기 위해서는 외부에서 전달 받은 Request 값을 스프링으로 보내기 전 무조건 한 번은 읽어야 ..

Log 2024.08.02

API 문서화 - swagger ( springboot )

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

Springboot 2024.07.18

스웨거 의존성 - swagger , Springfox, Springdoc …

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

등등 2024.07.15