From 16bdac5240ba8894661bacb72485adc46d52ece8 Mon Sep 17 00:00:00 2001 From: thombergs Date: Sat, 29 Feb 2020 15:18:13 +1100 Subject: [PATCH] MethodArgumentResolver example --- spring-boot/argumentresolver/.gitignore | 32 ++++ spring-boot/argumentresolver/build.gradle | 28 +++ spring-boot/argumentresolver/gradlew | 172 ++++++++++++++++++ spring-boot/argumentresolver/gradlew.bat | 84 +++++++++ spring-boot/argumentresolver/settings.gradle | 1 + .../ArgumentresolverApplication.java | 13 ++ .../argumentresolver/ErrorHandler.java | 16 ++ .../argumentresolver/NotFoundException.java | 11 ++ .../argumentresolver/Repository.java | 12 ++ .../RepositoryArgumentResolver.java | 58 ++++++ ...positoryArgumentResolverConfiguration.java | 20 ++ .../argumentresolver/RepositoryFinder.java | 9 + .../RepositoryArgumentResolverTest.java | 43 +++++ .../argumentresolver/TestController.java | 17 ++ 14 files changed, 516 insertions(+) create mode 100644 spring-boot/argumentresolver/.gitignore create mode 100644 spring-boot/argumentresolver/build.gradle create mode 100644 spring-boot/argumentresolver/gradlew create mode 100644 spring-boot/argumentresolver/gradlew.bat create mode 100644 spring-boot/argumentresolver/settings.gradle create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ArgumentresolverApplication.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ErrorHandler.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/NotFoundException.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/Repository.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolver.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverConfiguration.java create mode 100644 spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryFinder.java create mode 100644 spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverTest.java create mode 100644 spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/TestController.java diff --git a/spring-boot/argumentresolver/.gitignore b/spring-boot/argumentresolver/.gitignore new file mode 100644 index 0000000..6c01878 --- /dev/null +++ b/spring-boot/argumentresolver/.gitignore @@ -0,0 +1,32 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/** +!**/src/test/** + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/spring-boot/argumentresolver/build.gradle b/spring-boot/argumentresolver/build.gradle new file mode 100644 index 0000000..9575f2f --- /dev/null +++ b/spring-boot/argumentresolver/build.gradle @@ -0,0 +1,28 @@ +plugins { + id 'org.springframework.boot' version '2.2.5.RELEASE' + id 'io.spring.dependency-management' version '1.0.9.RELEASE' + id 'java' +} + +group = 'io.reflectoring' +version = '0.0.1-SNAPSHOT' +sourceCompatibility = '11' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter' + implementation 'org.springframework.boot:spring-boot-starter-web' + testImplementation('org.springframework.boot:spring-boot-starter-test') { + exclude group: 'org.junit.vintage', module: 'junit-vintage-engine' + } + + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' +} + +test { + useJUnitPlatform() +} diff --git a/spring-boot/argumentresolver/gradlew b/spring-boot/argumentresolver/gradlew new file mode 100644 index 0000000..cccdd3d --- /dev/null +++ b/spring-boot/argumentresolver/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/spring-boot/argumentresolver/gradlew.bat b/spring-boot/argumentresolver/gradlew.bat new file mode 100644 index 0000000..f955316 --- /dev/null +++ b/spring-boot/argumentresolver/gradlew.bat @@ -0,0 +1,84 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +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 init + +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 + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-boot/argumentresolver/settings.gradle b/spring-boot/argumentresolver/settings.gradle new file mode 100644 index 0000000..4ade9c7 --- /dev/null +++ b/spring-boot/argumentresolver/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'argumentresolver' diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ArgumentresolverApplication.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ArgumentresolverApplication.java new file mode 100644 index 0000000..a4b54ff --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ArgumentresolverApplication.java @@ -0,0 +1,13 @@ +package io.reflectoring.argumentresolver; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class ArgumentresolverApplication { + + public static void main(String[] args) { + SpringApplication.run(ArgumentresolverApplication.class, args); + } + +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ErrorHandler.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ErrorHandler.java new file mode 100644 index 0000000..f0b6419 --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/ErrorHandler.java @@ -0,0 +1,16 @@ +package io.reflectoring.argumentresolver; + +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.client.HttpStatusCodeException; + +@ControllerAdvice +class ErrorHandler { + + @ExceptionHandler(HttpStatusCodeException.class) + ResponseEntity handleHttpStatusCodeException(HttpStatusCodeException e) { + return ResponseEntity.status(e.getStatusCode()).build(); + } + +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/NotFoundException.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/NotFoundException.java new file mode 100644 index 0000000..3bb84ac --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/NotFoundException.java @@ -0,0 +1,11 @@ +package io.reflectoring.argumentresolver; + +import org.springframework.http.HttpStatus; +import org.springframework.web.client.HttpStatusCodeException; + +public class NotFoundException extends HttpStatusCodeException { + + protected NotFoundException() { + super(HttpStatus.NOT_FOUND); + } +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/Repository.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/Repository.java new file mode 100644 index 0000000..f9abb4d --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/Repository.java @@ -0,0 +1,12 @@ +package io.reflectoring.argumentresolver; + + +import lombok.Value; + +@Value +public class Repository { + + private final Long id; + private final String slug; + +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolver.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolver.java new file mode 100644 index 0000000..331ec5d --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolver.java @@ -0,0 +1,58 @@ +package io.reflectoring.argumentresolver; + +import java.util.Optional; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import lombok.RequiredArgsConstructor; +import org.springframework.core.MethodParameter; +import org.springframework.web.bind.support.WebDataBinderFactory; +import org.springframework.web.context.request.NativeWebRequest; +import org.springframework.web.context.request.ServletWebRequest; +import org.springframework.web.method.support.HandlerMethodArgumentResolver; +import org.springframework.web.method.support.ModelAndViewContainer; + +@RequiredArgsConstructor +class RepositoryArgumentResolver implements HandlerMethodArgumentResolver { + + private static final Pattern SLUG_PATTERN = Pattern.compile("^/([^/]*).*$"); + + private final RepositoryFinder repositoryFinder; + + @Override + public boolean supportsParameter(MethodParameter parameter) { + return parameter.getParameter().getType() == Repository.class; + } + + @Override + public Object resolveArgument( + MethodParameter parameter, + ModelAndViewContainer mavContainer, + NativeWebRequest webRequest, + WebDataBinderFactory binderFactory) { + + String requestPath = ((ServletWebRequest) webRequest).getRequest().getPathInfo(); + + Matcher matcher = SLUG_PATTERN.matcher(requestPath); + + if (!matcher.matches()) { + throw new IllegalArgumentException(String.format( + "Cannot resolve argument of type Site. Expecting the slug to be the first part of the request path (%s).", + requestPath)); + } + + String slug = matcher.group(1); + if (slug == null || slug.isBlank()) { + throw new IllegalArgumentException(String.format( + "Cannot resolve argument of type Site. Slug is empty (request path: %s).", + requestPath)); + } + + Optional repository = repositoryFinder.findBySlug(slug); + + if (repository.isEmpty()) { + throw new NotFoundException(); + } + + return repository.get(); + } +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverConfiguration.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverConfiguration.java new file mode 100644 index 0000000..a12e9c7 --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverConfiguration.java @@ -0,0 +1,20 @@ +package io.reflectoring.argumentresolver; + +import java.util.List; +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Component; +import org.springframework.web.method.support.HandlerMethodArgumentResolver; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Component +@RequiredArgsConstructor +class RepositoryArgumentResolverConfiguration implements WebMvcConfigurer { + + private final RepositoryFinder repositoryFinder; + + @Override + public void addArgumentResolvers(List resolvers) { + resolvers.add(new RepositoryArgumentResolver(repositoryFinder)); + } + +} diff --git a/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryFinder.java b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryFinder.java new file mode 100644 index 0000000..02d5684 --- /dev/null +++ b/spring-boot/argumentresolver/src/main/java/io/reflectoring/argumentresolver/RepositoryFinder.java @@ -0,0 +1,9 @@ +package io.reflectoring.argumentresolver; + +import java.util.Optional; + +public interface RepositoryFinder { + + Optional findBySlug(String slug); + +} diff --git a/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverTest.java b/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverTest.java new file mode 100644 index 0000000..ce14a4a --- /dev/null +++ b/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/RepositoryArgumentResolverTest.java @@ -0,0 +1,43 @@ +package io.reflectoring.argumentresolver; + +import static org.mockito.BDDMockito.given; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import java.util.Optional; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.web.servlet.MockMvc; + +@WebMvcTest(controllers = TestController.class) +class RepositoryArgumentResolverTest { + + @Autowired + private MockMvc mockMvc; + + @MockBean + private RepositoryFinder repositoryFinder; + + @Test + void resolvesSiteSuccessfully() throws Exception { + + given(repositoryFinder.findBySlug("my-repo")) + .willReturn(Optional.of(new Repository(1L, "my-repo"))); + + mockMvc.perform(get("/my-repo/foo")) + .andExpect(status().isOk()); + } + + @Test + void notFoundOnUnknownSlug() throws Exception { + + given(repositoryFinder.findBySlug("unknownSlug")) + .willReturn(Optional.empty()); + + mockMvc.perform(get("/unknownSlug/foo")) + .andExpect(status().isNotFound()); + } + +} \ No newline at end of file diff --git a/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/TestController.java b/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/TestController.java new file mode 100644 index 0000000..4ed049a --- /dev/null +++ b/spring-boot/argumentresolver/src/test/java/io/reflectoring/argumentresolver/TestController.java @@ -0,0 +1,17 @@ +package io.reflectoring.argumentresolver; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +class TestController { + + @GetMapping("/{slug}/foo") + String getSomething(Repository repository) { + assertThat(repository.getId()).isEqualTo(1L); + return "test"; + } + +}