commit 8d078ebb101ad36638d3564e3f435a7d9cdb7acf Author: woozu-shin Date: Tue Oct 10 18:08:44 2023 +0900 [NO-ISSUE] Initialize project diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2065bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f0294d --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ + + +## `LoggingTestAPIController.java` + +### logging test - get w/ body +```shell +curl -X GET 'http://localhost:20090/api/v1/loggingTest/getWithBody' \ +--header 'Content-Type: application/json' \ +--data '{ + + "value1" : "v1!", + "value2" : 123, + "value3" : false +}' +``` + +### logging test - get w/ param +```shell +curl http://localhost:20090/api/v1/loggingTest/get?p1=v1&p2=v2 +``` + + +### logging test - post w/o body, w/ error +```shell +curl -X POST 'http://localhost:20090/api/v1/loggingTest/postWithBody' +``` + + + +### logging test - post w/ body +```shell +curl -X POST 'http://localhost:20090/api/v1/loggingTest/postWithBody' \ +--header 'Content-Type: application/json' \ +--data '{ + "value1" : "valu1!", + "value2" : 1111111, + "value3" : true +}' +``` + + +# Appendix + +## schema.sql for other dbms + +### mysql +```mysql +create table request_log +( + id bigint auto_increment primary key, + http_method varchar(255), + uri varchar(255), + query_string varchar(2047), + content_type varchar(255), + body mediumtext, + requested_at timestamp(6), + trace_id varchar(40), + created_at timestamp(6), + primary key (id) +); + +create table response_log +( + id bigint auto_increment primary key, + http_status integer, + content_type varchar(255), + body mediumtext, + responded_at timestamp(6), + trace_id varchar(40), + created_at timestamp(6), + primary key (id) +); +``` + +### postgresql +```postgresql +create table request_log +( + id bigint generated by default as identity primary key, + http_method varchar(255), + uri varchar(255), + query_string varchar(255), + content_type varchar(255), + body text, + requested_at timestamp(6) with time zone, + trace_id varchar(40), + created_at timestamp(6) with time zone +); + +create table response_log +( + id bigint generated by default as identity primary key, + http_status integer, + content_type varchar(255), + body text, + responded_at timestamp(6) with time zone, + trace_id varchar(40), + created_at timestamp(6) with time zone +); +``` \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..0bb0725 --- /dev/null +++ b/build.gradle @@ -0,0 +1,35 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.4' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'com.myoa.engineering' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..033e24c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..9f4197d --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..fcb6fca --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..e26fb90 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'spring-boot-request-response-logging-example' diff --git a/src/main/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplication.java b/src/main/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplication.java new file mode 100644 index 0000000..6a97ba4 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplication.java @@ -0,0 +1,13 @@ +package com.myoa.engineering.sample; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringBootRequestResponseLoggingExampleApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringBootRequestResponseLoggingExampleApplication.class, args); + } + +} diff --git a/src/main/java/com/myoa/engineering/sample/configuration/DataSourceConfiguration.java b/src/main/java/com/myoa/engineering/sample/configuration/DataSourceConfiguration.java new file mode 100644 index 0000000..5602fad --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/configuration/DataSourceConfiguration.java @@ -0,0 +1,9 @@ +package com.myoa.engineering.sample.configuration; + +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@EnableJpaAuditing +@Configuration +public class DataSourceConfiguration { +} diff --git a/src/main/java/com/myoa/engineering/sample/configuration/WebConfiguration.java b/src/main/java/com/myoa/engineering/sample/configuration/WebConfiguration.java new file mode 100644 index 0000000..2548912 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/configuration/WebConfiguration.java @@ -0,0 +1,21 @@ +package com.myoa.engineering.sample.configuration; + +import com.myoa.engineering.sample.configuration.logging.LoggingInterceptor; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.InterceptorRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +public class WebConfiguration implements WebMvcConfigurer { + private final LoggingInterceptor loggingInterceptor; + + public WebConfiguration(LoggingInterceptor loggingInterceptor) { + this.loggingInterceptor = loggingInterceptor; + } + + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(loggingInterceptor).addPathPatterns("/api/**"); + WebMvcConfigurer.super.addInterceptors(registry); + } +} diff --git a/src/main/java/com/myoa/engineering/sample/configuration/logging/CustomServletWrappingFilter.java b/src/main/java/com/myoa/engineering/sample/configuration/logging/CustomServletWrappingFilter.java new file mode 100644 index 0000000..0daddea --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/configuration/logging/CustomServletWrappingFilter.java @@ -0,0 +1,32 @@ +package com.myoa.engineering.sample.configuration.logging; + +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import lombok.extern.slf4j.Slf4j; +import org.slf4j.MDC; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; +import org.springframework.web.util.ContentCachingResponseWrapper; + +import java.io.IOException; +import java.util.UUID; + +@Slf4j +@Component +public class CustomServletWrappingFilter extends OncePerRequestFilter { + + + @Override + protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { + String traceId = UUID.randomUUID().toString(); + MDC.put("traceId", traceId); + RereadableRequestWrapper wrappedRequest = new RereadableRequestWrapper(request); + ContentCachingResponseWrapper wrappedResponse = new ContentCachingResponseWrapper(response); + filterChain.doFilter(wrappedRequest, wrappedResponse); + wrappedResponse.copyBodyToResponse(); + MDC.clear(); + } + +} diff --git a/src/main/java/com/myoa/engineering/sample/configuration/logging/LoggingInterceptor.java b/src/main/java/com/myoa/engineering/sample/configuration/logging/LoggingInterceptor.java new file mode 100644 index 0000000..96dedb9 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/configuration/logging/LoggingInterceptor.java @@ -0,0 +1,115 @@ +package com.myoa.engineering.sample.configuration.logging; + +import com.myoa.engineering.sample.entity.RequestLog; +import com.myoa.engineering.sample.entity.ResponseLog; +import com.myoa.engineering.sample.service.LogPersistenceService; +import jakarta.servlet.DispatcherType; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import lombok.extern.slf4j.Slf4j; +import org.slf4j.MDC; +import org.springframework.stereotype.Component; +import org.springframework.util.MimeTypeUtils; +import org.springframework.web.servlet.HandlerInterceptor; +import org.springframework.web.util.ContentCachingResponseWrapper; + +import java.io.IOException; +import java.time.Instant; + +@Slf4j +@Component +public class LoggingInterceptor implements HandlerInterceptor { + + private final LogPersistenceService logPersistenceService; + + public LoggingInterceptor(LogPersistenceService logPersistenceService) { + this.logPersistenceService = logPersistenceService; + } + + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { + if (isLoggable(request)) { + RequestLog requestLog = RequestLog.builder() + .httpMethod(request.getMethod()) + .uri(request.getRequestURI()) + .queryString(getQueryString(request)) + .contentType(request.getContentType()) + .body(getBodyIfAvailable(request)) + .requestedAt(Instant.now()) + .traceId(MDC.get("traceId")) + .build(); + loggingRequest(requestLog); + logPersistenceService.save(requestLog); + } + return HandlerInterceptor.super.preHandle(request, response, handler); + } + + private boolean isLoggable(HttpServletRequest request) { + return request.getDispatcherType() != DispatcherType.ERROR; + } + + private String getBodyIfAvailable(HttpServletRequest request) throws IOException { + if (request instanceof RereadableRequestWrapper wrappedRequest) { + if (wrappedRequest.getContentType() != null && wrappedRequest.getContentType().contains(MimeTypeUtils.APPLICATION_JSON_VALUE)) { + return new String(wrappedRequest.getContents()); + } + } + return null; + } + + private void loggingRequest(RequestLog requestLog) { + log.info("[REQUEST {}] {}{} ({}) [{}]\nbody: {}", + requestLog.getHttpMethod(), + requestLog.getUri(), + requestLog.getQueryString(), + requestLog.getContentType(), + requestLog.getTraceId(), + requestLog.getBody()); + } + + private String getQueryString(HttpServletRequest request) { + return request.getQueryString() == null || request.getQueryString().isEmpty() + ? "" + : "?" + request.getQueryString(); + } + + @Override + public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { + if (isLoggable()) { + ResponseLog responseLog = ResponseLog.builder() + .httpStatus(response.getStatus()) + .contentType(response.getContentType()) + .body(getBodyIfAvailable(response)) + .respondedAt(Instant.now()) + .traceId(MDC.get("traceId")) + .build(); + loggingResponse(responseLog); + logPersistenceService.save(responseLog); + } + + HandlerInterceptor.super.afterCompletion(request, response, handler, ex); + } + + private boolean isLoggable() { + String traceId = MDC.get("traceId"); + return traceId != null && traceId.isEmpty() == false; + } + + private String getBodyIfAvailable(HttpServletResponse response) { + if (response instanceof ContentCachingResponseWrapper wrappedResponse) { + if (wrappedResponse.getContentType() != null && wrappedResponse.getContentType().contains(MimeTypeUtils.APPLICATION_JSON_VALUE)) { + return new String(wrappedResponse.getContentAsByteArray()); + } + } + return null; + } + + private void loggingResponse(ResponseLog responseLog) { + log.info("[RESPONSE] {} ({}) [{}]\nbody: {}", + responseLog.getHttpStatus(), + responseLog.getContentType(), + responseLog.getTraceId(), + responseLog.getBody()); + } + +} diff --git a/src/main/java/com/myoa/engineering/sample/configuration/logging/RereadableRequestWrapper.java b/src/main/java/com/myoa/engineering/sample/configuration/logging/RereadableRequestWrapper.java new file mode 100644 index 0000000..0e2f888 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/configuration/logging/RereadableRequestWrapper.java @@ -0,0 +1,59 @@ +package com.myoa.engineering.sample.configuration.logging; + +import jakarta.servlet.ReadListener; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletRequestWrapper; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; + +public class RereadableRequestWrapper extends HttpServletRequestWrapper { + + private final ByteArrayOutputStream contents = new ByteArrayOutputStream(); + + public RereadableRequestWrapper(HttpServletRequest request) { + super(request); + } + + @Override + public ServletInputStream getInputStream() throws IOException { + super.getInputStream().transferTo(contents); + return new RereadableServletInputStream(contents); + } + + public byte[] getContents() throws IOException { + return this.getInputStream().readAllBytes(); + } + + private static class RereadableServletInputStream extends ServletInputStream { + + private final ByteArrayInputStream buffer; + + public RereadableServletInputStream(final ByteArrayOutputStream contents) { + buffer = new ByteArrayInputStream(contents.toByteArray()); + } + + @Override + public boolean isFinished() { + return buffer.available() == 0; + } + + @Override + public boolean isReady() { + return true; + } + + @Override + public void setReadListener(ReadListener listener) { + throw new RuntimeException("Not implemented"); + } + + @Override + public int read() throws IOException { + return buffer.read(); + } + } + +} diff --git a/src/main/java/com/myoa/engineering/sample/controller/LoggingTestAPIController.java b/src/main/java/com/myoa/engineering/sample/controller/LoggingTestAPIController.java new file mode 100644 index 0000000..db7c0d3 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/controller/LoggingTestAPIController.java @@ -0,0 +1,31 @@ +package com.myoa.engineering.sample.controller; + +import com.myoa.engineering.sample.dto.TestDataDTO; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +@Slf4j +@RestController +@RequestMapping("/api/v1/loggingTest") +public class LoggingTestAPIController { + + @GetMapping("/get") + public ResponseEntity get() { +// log.info("[API called] get"); + return ResponseEntity.ok("get"); + } + + @GetMapping("/getWithBody") + public ResponseEntity getWithBody(@RequestBody TestDataDTO dto) { +// log.info("[API called] getWithRequestBody"); + return ResponseEntity.ok(dto); + } + + + @PostMapping("/postWithBody") + public ResponseEntity postWithBody(@RequestBody TestDataDTO dto) { +// log.info("[API called] postWithRequestBody"); + return ResponseEntity.ok(dto); + } +} diff --git a/src/main/java/com/myoa/engineering/sample/dto/TestDataDTO.java b/src/main/java/com/myoa/engineering/sample/dto/TestDataDTO.java new file mode 100644 index 0000000..91f1295 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/dto/TestDataDTO.java @@ -0,0 +1,10 @@ +package com.myoa.engineering.sample.dto; + +import lombok.Data; + +@Data +public class TestDataDTO { + private String value1; + private Integer value2; + private Boolean value3; +} diff --git a/src/main/java/com/myoa/engineering/sample/entity/Auditable.java b/src/main/java/com/myoa/engineering/sample/entity/Auditable.java new file mode 100644 index 0000000..62429e6 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/entity/Auditable.java @@ -0,0 +1,21 @@ +package com.myoa.engineering.sample.entity; + +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import lombok.Getter; +import lombok.Setter; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.Instant; + +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +@Getter +@Setter +public abstract class Auditable { + + @CreatedDate + private Instant createdAt; + +} diff --git a/src/main/java/com/myoa/engineering/sample/entity/RequestLog.java b/src/main/java/com/myoa/engineering/sample/entity/RequestLog.java new file mode 100644 index 0000000..27c36f3 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/entity/RequestLog.java @@ -0,0 +1,29 @@ +package com.myoa.engineering.sample.entity; + +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import lombok.*; + +import java.time.Instant; + +@Getter +@Setter +@NoArgsConstructor +@Builder +@AllArgsConstructor +@Entity +public class RequestLog extends Auditable { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + private String httpMethod; + private String uri; + private String queryString; + private String contentType; + private String body; + private Instant requestedAt; + private String traceId; + +} diff --git a/src/main/java/com/myoa/engineering/sample/entity/ResponseLog.java b/src/main/java/com/myoa/engineering/sample/entity/ResponseLog.java new file mode 100644 index 0000000..d46546c --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/entity/ResponseLog.java @@ -0,0 +1,27 @@ +package com.myoa.engineering.sample.entity; + +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import lombok.*; + +import java.time.Instant; + +@Getter +@Setter +@NoArgsConstructor +@Builder +@AllArgsConstructor +@Entity +public class ResponseLog extends Auditable { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + private Integer httpStatus; + private String contentType; + private String body; + private Instant respondedAt; + private String traceId; + +} diff --git a/src/main/java/com/myoa/engineering/sample/infra/repository/RequestLogRepository.java b/src/main/java/com/myoa/engineering/sample/infra/repository/RequestLogRepository.java new file mode 100644 index 0000000..eab2853 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/infra/repository/RequestLogRepository.java @@ -0,0 +1,9 @@ +package com.myoa.engineering.sample.infra.repository; + +import com.myoa.engineering.sample.entity.RequestLog; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface RequestLogRepository extends JpaRepository { +} diff --git a/src/main/java/com/myoa/engineering/sample/infra/repository/ResponseLogRepository.java b/src/main/java/com/myoa/engineering/sample/infra/repository/ResponseLogRepository.java new file mode 100644 index 0000000..1865ad0 --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/infra/repository/ResponseLogRepository.java @@ -0,0 +1,9 @@ +package com.myoa.engineering.sample.infra.repository; + +import com.myoa.engineering.sample.entity.ResponseLog; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface ResponseLogRepository extends JpaRepository { +} diff --git a/src/main/java/com/myoa/engineering/sample/service/LogPersistenceService.java b/src/main/java/com/myoa/engineering/sample/service/LogPersistenceService.java new file mode 100644 index 0000000..509abec --- /dev/null +++ b/src/main/java/com/myoa/engineering/sample/service/LogPersistenceService.java @@ -0,0 +1,36 @@ +package com.myoa.engineering.sample.service; + +import com.myoa.engineering.sample.entity.RequestLog; +import com.myoa.engineering.sample.entity.ResponseLog; +import com.myoa.engineering.sample.infra.repository.RequestLogRepository; +import com.myoa.engineering.sample.infra.repository.ResponseLogRepository; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Slf4j +@Service +public class LogPersistenceService { + private final RequestLogRepository requestLogRepository; + private final ResponseLogRepository responseLogRepository; + + public LogPersistenceService(RequestLogRepository requestLogRepository, + ResponseLogRepository responseLogRepository) { + this.requestLogRepository = requestLogRepository; + this.responseLogRepository = responseLogRepository; + } + + @Transactional + public void save(RequestLog requestLog) { + requestLogRepository.save(requestLog); +// log.info("requestLog saved. id: {}", requestLog.getId()); + + } + + @Transactional + public void save(ResponseLog responseLog) { + responseLogRepository.save(responseLog); +// log.info("responseLog saved. id: {}", responseLog.getId()); + } + +} diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml new file mode 100644 index 0000000..9efc7c7 --- /dev/null +++ b/src/main/resources/application.yaml @@ -0,0 +1,22 @@ +server: + port: 20090 + +spring: + h2: + console: + enabled: true + path: /h2 + datasource: + url: jdbc:h2:mem:test + username: sa + password: + driver-class-name: org.h2.Driver + jpa: + properties: + hibernate: + format_sql: true + +logging: + level: + org.hibernate.SQL: DEBUG + org.hibernate.type.descriptor.sql: TRACE diff --git a/src/test/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplicationTests.java b/src/test/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplicationTests.java new file mode 100644 index 0000000..a39d271 --- /dev/null +++ b/src/test/java/com/myoa/engineering/sample/SpringBootRequestResponseLoggingExampleApplicationTests.java @@ -0,0 +1,13 @@ +package com.myoa.engineering.sample; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringBootRequestResponseLoggingExampleApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/myoa/engineering/sample/configuration/WebConfigurationTest.java b/src/test/java/com/myoa/engineering/sample/configuration/WebConfigurationTest.java new file mode 100644 index 0000000..8e2d20b --- /dev/null +++ b/src/test/java/com/myoa/engineering/sample/configuration/WebConfigurationTest.java @@ -0,0 +1,29 @@ +package com.myoa.engineering.sample.configuration; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.springframework.util.AntPathMatcher; + +class WebConfigurationTest { + + private final AntPathMatcher sut = new AntPathMatcher(); + + @Test + void test_ant_style_pattern_matching() { + assertTrueAntPattern("/api/**", "/api/v1/loggingTest/get"); + assertTrueAntPattern("/api/**", "/api/v1/loggingTest/getWithBody"); + assertTrueAntPattern("/api/**", "/api/v1/loggingTest/postWithBody"); + } + + public void assertTrueAntPattern(String pattern, String assertString) { + Assertions.assertTrue(isMatchedAntStylePattern(pattern, assertString)); + } + public void assertFalseAntPattern(String pattern, String assertString) { + Assertions.assertFalse(isMatchedAntStylePattern(pattern, assertString)); + } + + public boolean isMatchedAntStylePattern(String pattern, String assertString) { + return sut.match(pattern, assertString); + } + +} \ No newline at end of file