diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..c547e656 --- /dev/null +++ b/.gitignore @@ -0,0 +1,61 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!src/main/** +!src/test/** + +### macOS ### +.DS_Store + +### 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/ + +# Ignore Gradle build output directory +build + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +### Gradle Patch ### +# Java heap dump +*.hprof + +# log file +logs/ + +# docker +docker/database +docker/mysql-init.d diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..ca45a645 --- /dev/null +++ b/build.gradle @@ -0,0 +1,42 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.4' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'com.programmers' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-validation' + implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' + + // Lombok + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + + // MySQL + runtimeOnly 'com.mysql:mysql-connector-j' + + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml new file mode 100644 index 00000000..11f5b095 --- /dev/null +++ b/docker/docker-compose.yml @@ -0,0 +1,22 @@ +version: "3.7" + +services: + vacation-db: + container_name: "springboot-url-shortener" + image: mysql + restart: always + environment: + MYSQL_ROOT_PASSWORD: "root" + MYSQL_DATABASE: "url_shortener" + MYSQL_USER: "localhost" + MYSQL_PASSWORD: "root" + TZ: Asia/Seoul + command: + - --character-set-server=utf8mb4 + - --collation-server=utf8mb4_unicode_ci + volumes: + - ./mysql-init.d:/docker-entrypoint-initdb.d + - ./database/datadir/:/var/lib/mysql + platform: linux/arm64/v8 + ports: + - 3306:3306 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 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 00000000..9f4197d5 --- /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 00000000..fcb6fca1 --- /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 00000000..93e3f59f --- /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 00000000..6be9ab47 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springboot-url-shortener' diff --git a/src/main/java/com/programmers/springbooturlshortener/SpringbootUrlShortenerApplication.java b/src/main/java/com/programmers/springbooturlshortener/SpringbootUrlShortenerApplication.java new file mode 100644 index 00000000..d11d292e --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/SpringbootUrlShortenerApplication.java @@ -0,0 +1,13 @@ +package com.programmers.springbooturlshortener; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringbootUrlShortenerApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringbootUrlShortenerApplication.class, args); + } + +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/aop/LoggerAspect.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/aop/LoggerAspect.java new file mode 100644 index 00000000..f03dce91 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/aop/LoggerAspect.java @@ -0,0 +1,40 @@ +package com.programmers.springbooturlshortener.global.domain.aop; + +import org.aspectj.lang.JoinPoint; +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.AfterThrowing; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +import com.programmers.springbooturlshortener.global.domain.exception.UrlApplicationException; + +@Aspect +@Component +public class LoggerAspect { + + private static final Logger logger = LoggerFactory.getLogger(LoggerAspect.class); + + @Around("execution(* com.programmers.springbooturlshortener..*Controller.*(..))") + public Object log(ProceedingJoinPoint joinPoint) throws Throwable { + + String className = joinPoint.getSignature().getDeclaringTypeName(); + String methodName = joinPoint.getSignature().getName(); + + long startTime = System.currentTimeMillis(); + Object proceed = joinPoint.proceed(); + long finishTime = System.currentTimeMillis(); + + double invokeTime = (finishTime - startTime) / 1000.0; + + logger.info("invoke method : {} - {} - / timeTaken : {} s", className, methodName, invokeTime); + return proceed; + } + + @AfterThrowing(pointcut = "execution (* com.programmers.springbooturlshortener..*(..))", throwing = "urlApplicationException") + public void urlApplicationException(JoinPoint joinPoint, UrlApplicationException urlApplicationException) { + logger.warn("\n", urlApplicationException); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/AlgorithmConverter.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/AlgorithmConverter.java new file mode 100644 index 00000000..831d40d7 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/AlgorithmConverter.java @@ -0,0 +1,8 @@ +package com.programmers.springbooturlshortener.global.domain.converter; + +public interface AlgorithmConverter { + + String encode(Long param); + + Long decode(String param); +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/Base62Converter.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/Base62Converter.java new file mode 100644 index 00000000..4334efc7 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/converter/Base62Converter.java @@ -0,0 +1,35 @@ +package com.programmers.springbooturlshortener.global.domain.converter; + +import org.springframework.stereotype.Component; + +@Component +public class Base62Converter implements AlgorithmConverter { + + private static final int BASE62_LENGTH = 62; + private static final String BASE62_CHAR = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + + @Override + public String encode(Long param) { + StringBuilder sb = new StringBuilder(); + + while(param > 0) { + sb.append(BASE62_CHAR.charAt((int) (param % BASE62_LENGTH))); + param /= BASE62_LENGTH; + } + + return sb.toString(); + } + + @Override + public Long decode(String param) { + long sum = 0; + long power = 1; + + for (int i = 0; i < param.length(); i++) { + sum += BASE62_CHAR.indexOf(param.charAt(i)) * power; + power *= BASE62_LENGTH; + } + + return sum; + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/EntityNotFound.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/EntityNotFound.java new file mode 100644 index 00000000..f148e570 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/EntityNotFound.java @@ -0,0 +1,17 @@ +package com.programmers.springbooturlshortener.global.domain.exception; + +import lombok.Getter; + +@Getter +public class EntityNotFound extends UrlApplicationException { + + private static final String MESSAGE = "저장된 정보를 찾을 수 없습니다."; + + public EntityNotFound() { + super(MESSAGE); + } + @Override + public int getStatusCode() { + return 400; + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/InvalidUrlRequest.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/InvalidUrlRequest.java new file mode 100644 index 00000000..3d1d0063 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/InvalidUrlRequest.java @@ -0,0 +1,23 @@ +package com.programmers.springbooturlshortener.global.domain.exception; + +import lombok.Getter; + +@Getter +public class InvalidUrlRequest extends UrlApplicationException { + + private static final String MESSAGE = "유효하지 않은 URL 입니다."; + + public InvalidUrlRequest() { + super(MESSAGE); + } + + public InvalidUrlRequest(String fieldName, String message) { + super(MESSAGE); + addValidation(fieldName, message); + } + + @Override + public int getStatusCode() { + return 400; + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/UrlApplicationException.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/UrlApplicationException.java new file mode 100644 index 00000000..49a197a2 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/exception/UrlApplicationException.java @@ -0,0 +1,26 @@ +package com.programmers.springbooturlshortener.global.domain.exception; + +import java.util.HashMap; +import java.util.Map; + +import lombok.Getter; + +@Getter +public abstract class UrlApplicationException extends RuntimeException { + + private final Map validation = new HashMap<>(); + + protected UrlApplicationException(String message) { + super(message); + } + + protected UrlApplicationException(String message, Throwable cause) { + super(message, cause); + } + + public abstract int getStatusCode(); + + public void addValidation(String fieldName, String message) { + validation.put(fieldName, message); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/domain/utils/PrefixModifier.java b/src/main/java/com/programmers/springbooturlshortener/global/domain/utils/PrefixModifier.java new file mode 100644 index 00000000..7560a2f4 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/domain/utils/PrefixModifier.java @@ -0,0 +1,21 @@ +package com.programmers.springbooturlshortener.global.domain.utils; + +public class PrefixModifier { + + public static final String URL_PREFIX = "^(http://|https://)?(www\\.)?"; + public static final String HTTPS_PREFIX = "https://www."; + + public static String modifyUrlPrefix(String param) { + return param.replaceAll(URL_PREFIX, ""); + } + + public static String removeBeforeLastSlash(String input) { + int lastSlashIndex = input.lastIndexOf('/'); + + if (lastSlashIndex != -1) { + return input.substring(lastSlashIndex + 1); + } else { + return input; + } + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/presentation/ExceptionController.java b/src/main/java/com/programmers/springbooturlshortener/global/presentation/ExceptionController.java new file mode 100644 index 00000000..885bf3cb --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/presentation/ExceptionController.java @@ -0,0 +1,44 @@ +package com.programmers.springbooturlshortener.global.presentation; + +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.FieldError; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +import com.programmers.springbooturlshortener.global.domain.exception.UrlApplicationException; +import com.programmers.springbooturlshortener.global.presentation.response.ExceptionResponse; + +@RestControllerAdvice +public class ExceptionController { + + @ResponseStatus(HttpStatus.BAD_REQUEST) + @ExceptionHandler(MethodArgumentNotValidException.class) + public ExceptionResponse invalidRequestHandler(MethodArgumentNotValidException e) { + ExceptionResponse response = ExceptionResponse.builder() + .code("400") + .message("잘못된 요청입니다.") + .build(); + + for (FieldError fieldError : e.getFieldErrors()) { + response.addValidation(fieldError.getField(), fieldError.getDefaultMessage()); + } + + return response; + } + + @ExceptionHandler(UrlApplicationException.class) + public ResponseEntity urlApplicationException(UrlApplicationException e) { + int statusCode = e.getStatusCode(); + + ExceptionResponse body = ExceptionResponse.builder() + .code(String.valueOf(statusCode)) + .message(e.getMessage()) + .validation(e.getValidation()) + .build(); + + return ResponseEntity.status(statusCode).body(body); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/global/presentation/response/ExceptionResponse.java b/src/main/java/com/programmers/springbooturlshortener/global/presentation/response/ExceptionResponse.java new file mode 100644 index 00000000..a899b102 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/global/presentation/response/ExceptionResponse.java @@ -0,0 +1,26 @@ +package com.programmers.springbooturlshortener.global.presentation.response; + +import java.util.HashMap; +import java.util.Map; + +import lombok.Builder; +import lombok.Getter; + +@Getter +public class ExceptionResponse { + + private final String code; + private final String message; + private final Map validation; + + @Builder + public ExceptionResponse(String code, String message, Map validation) { + this.code = code; + this.message = message; + this.validation = validation != null ? validation : new HashMap<>(); + } + + public void addValidation(String fieldName, String errorMessage) { + this.validation.put(fieldName, errorMessage); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/application/UrlService.java b/src/main/java/com/programmers/springbooturlshortener/url/application/UrlService.java new file mode 100644 index 00000000..25592ea2 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/application/UrlService.java @@ -0,0 +1,54 @@ +package com.programmers.springbooturlshortener.url.application; + +import java.util.Optional; + +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import com.programmers.springbooturlshortener.global.domain.converter.AlgorithmConverter; +import com.programmers.springbooturlshortener.global.domain.exception.EntityNotFound; +import com.programmers.springbooturlshortener.global.domain.utils.PrefixModifier; +import com.programmers.springbooturlshortener.url.application.port.UrlRepository; +import com.programmers.springbooturlshortener.url.domain.Url; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; + +import lombok.RequiredArgsConstructor; + +@Service +@RequiredArgsConstructor +@Transactional(readOnly = true) +public class UrlService { + + private final UrlRepository urlRepository; + private final AlgorithmConverter algorithmConverter; + + @Transactional + public Url create(UrlCreate urlCreate) { + String originUrl = PrefixModifier.modifyUrlPrefix(urlCreate.getOriginUrl()); + Optional url = urlRepository.findByOriginUrl(originUrl); + + if (url.isPresent()) { + Url existsUrl = url.get(); + existsUrl.increaseRequestCount(); + + return urlRepository.save(existsUrl); + } + + Url newUrl = urlRepository.save(Url.from(urlCreate)); + String shortUrlKey = algorithmConverter.encode(newUrl.getUrlId()); + newUrl.updateShortUrlKey(shortUrlKey); + + return urlRepository.save(newUrl); + } + + @Transactional + public String getOriginUrl(String shortUrl) { + String shortUrlKey = PrefixModifier.removeBeforeLastSlash(shortUrl); + + Url url = urlRepository.findById(algorithmConverter.decode(shortUrlKey)) + .orElseThrow(EntityNotFound::new); + url.increaseRequestCount(); + + return PrefixModifier.HTTPS_PREFIX + urlRepository.save(url).getOriginUrl(); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/application/port/UrlRepository.java b/src/main/java/com/programmers/springbooturlshortener/url/application/port/UrlRepository.java new file mode 100644 index 00000000..a2ffbc4f --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/application/port/UrlRepository.java @@ -0,0 +1,16 @@ +package com.programmers.springbooturlshortener.url.application.port; + +import java.util.Optional; + +import com.programmers.springbooturlshortener.url.domain.Url; + +public interface UrlRepository { + + Optional findById(Long id); + + Optional findByOriginUrl(String url); + + Url save(Url url); + + void deleteAll(); +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/domain/Url.java b/src/main/java/com/programmers/springbooturlshortener/url/domain/Url.java new file mode 100644 index 00000000..03dd1a1d --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/domain/Url.java @@ -0,0 +1,58 @@ +package com.programmers.springbooturlshortener.url.domain; + +import java.util.regex.Pattern; + +import com.programmers.springbooturlshortener.global.domain.exception.EntityNotFound; +import com.programmers.springbooturlshortener.global.domain.exception.InvalidUrlRequest; +import com.programmers.springbooturlshortener.global.domain.utils.PrefixModifier; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; + +import lombok.Builder; +import lombok.Getter; + +@Getter +public class Url { + + private static final Pattern URL_REGEX = Pattern.compile( + "(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&//=]*)" + ); + + private final Long urlId; + private final String originUrl; + private String shortUrlKey; + private long requestCount; + + @Builder + private Url(Long urlId, String originUrl, String shortUrlKey, long requestCount) { + validateUrl(originUrl); + this.urlId = urlId; + this.originUrl = originUrl; + this.shortUrlKey = shortUrlKey; + this.requestCount = requestCount; + } + + public static Url from(UrlCreate urlCreate) { + return Url.builder() + .originUrl(PrefixModifier.modifyUrlPrefix(urlCreate.getOriginUrl())) + .requestCount(0L) + .build(); + } + + public void updateShortUrlKey(String shortUrlKey) { + if (urlId == null) { + throw new EntityNotFound(); + } + + this.shortUrlKey = shortUrlKey; + } + + public void increaseRequestCount() { + this.requestCount++; + } + + private static void validateUrl(String url) { + if (!URL_REGEX.matcher(url).matches()) { + throw new InvalidUrlRequest(); + } + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlEntity.java b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlEntity.java new file mode 100644 index 00000000..c9134366 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlEntity.java @@ -0,0 +1,53 @@ +package com.programmers.springbooturlshortener.url.infrastructure; + +import com.programmers.springbooturlshortener.url.domain.Url; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Table; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Table(name = "urls") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class UrlEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + @Column(name = "url_id") + private Long urlId; + + @Column(name = "origin_url", unique = true, nullable = false) + private String originUrl; + + @Column(name = "short_url_key", unique = true, length = 8) + private String shortUrlKey; + + @Column(name = "request_count", nullable = false) + private long requestCount; + + public static UrlEntity from(Url url) { + UrlEntity urlEntity = new UrlEntity(); + urlEntity.urlId = url.getUrlId(); + urlEntity.originUrl = url.getOriginUrl(); + urlEntity.shortUrlKey = url.getShortUrlKey(); + urlEntity.requestCount = url.getRequestCount(); + + return urlEntity; + } + + public Url toModel() { + return Url.builder() + .urlId(urlId) + .originUrl(originUrl) + .shortUrlKey(shortUrlKey) + .requestCount(requestCount) + .build(); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlJpaRepository.java b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlJpaRepository.java new file mode 100644 index 00000000..4a8721db --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlJpaRepository.java @@ -0,0 +1,10 @@ +package com.programmers.springbooturlshortener.url.infrastructure; + +import java.util.Optional; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UrlJpaRepository extends JpaRepository { + + Optional findUrlEntityByOriginUrl(String url); +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlRepositoryImpl.java b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlRepositoryImpl.java new file mode 100644 index 00000000..6f3ae2cb --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/infrastructure/UrlRepositoryImpl.java @@ -0,0 +1,37 @@ +package com.programmers.springbooturlshortener.url.infrastructure; + +import java.util.Optional; + +import org.springframework.stereotype.Repository; + +import com.programmers.springbooturlshortener.url.application.port.UrlRepository; +import com.programmers.springbooturlshortener.url.domain.Url; + +import lombok.RequiredArgsConstructor; + +@Repository +@RequiredArgsConstructor +public class UrlRepositoryImpl implements UrlRepository { + + private final UrlJpaRepository urlJpaRepository; + + @Override + public Optional findById(Long id) { + return urlJpaRepository.findById(id).map(UrlEntity::toModel); + } + + @Override + public Optional findByOriginUrl(String url) { + return urlJpaRepository.findUrlEntityByOriginUrl(url).map(UrlEntity::toModel); + } + + @Override + public Url save(Url url) { + return urlJpaRepository.save(UrlEntity.from(url)).toModel(); + } + + @Override + public void deleteAll() { + urlJpaRepository.deleteAll(); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlRestController.java b/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlRestController.java new file mode 100644 index 00000000..a56bf1f0 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlRestController.java @@ -0,0 +1,46 @@ +package com.programmers.springbooturlshortener.url.presentation; + +import java.io.IOException; + +import org.springframework.http.HttpStatus; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestController; + +import com.programmers.springbooturlshortener.url.application.UrlService; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; +import com.programmers.springbooturlshortener.url.presentation.response.UrlResponse; + +import jakarta.servlet.http.HttpServletResponse; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; + +@RestController +@RequiredArgsConstructor +public class UrlRestController { + + private final UrlService urlService; + + @PostMapping("/shorten") + @ResponseStatus(HttpStatus.CREATED) + public UrlResponse shortenUrl(@RequestBody @Valid UrlCreate request) { + return UrlResponse.from(urlService.create(request)); + } + + @GetMapping("/shorten") + @ResponseStatus(HttpStatus.OK) + public String originUrl(@RequestParam String shortUrl) { + return urlService.getOriginUrl(shortUrl); + } + + @GetMapping("/{shortUrl}") + @ResponseStatus(HttpStatus.MOVED_PERMANENTLY) + public void redirectUrl(@PathVariable(name = "shortUrl") String shortUrl, HttpServletResponse response) throws + IOException { + response.sendRedirect(urlService.getOriginUrl(shortUrl)); + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlViewController.java b/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlViewController.java new file mode 100644 index 00000000..64982648 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/presentation/UrlViewController.java @@ -0,0 +1,13 @@ +package com.programmers.springbooturlshortener.url.presentation; + +import org.springframework.stereotype.Controller; +import org.springframework.web.bind.annotation.GetMapping; + +@Controller +public class UrlViewController { + + @GetMapping + public String home() { + return "home"; + } +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/presentation/request/UrlCreate.java b/src/main/java/com/programmers/springbooturlshortener/url/presentation/request/UrlCreate.java new file mode 100644 index 00000000..b87cc884 --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/presentation/request/UrlCreate.java @@ -0,0 +1,18 @@ +package com.programmers.springbooturlshortener.url.presentation.request; + +import jakarta.validation.constraints.Pattern; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@NoArgsConstructor +@AllArgsConstructor +public class UrlCreate { + + @Pattern( + regexp = "(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&//=]*)", + message = "올바르지 않은 URL 형식입니다. 다시 입력해주세요." + ) + private String originUrl; +} diff --git a/src/main/java/com/programmers/springbooturlshortener/url/presentation/response/UrlResponse.java b/src/main/java/com/programmers/springbooturlshortener/url/presentation/response/UrlResponse.java new file mode 100644 index 00000000..4bc3ba5a --- /dev/null +++ b/src/main/java/com/programmers/springbooturlshortener/url/presentation/response/UrlResponse.java @@ -0,0 +1,25 @@ +package com.programmers.springbooturlshortener.url.presentation.response; + +import com.programmers.springbooturlshortener.url.domain.Url; + +import lombok.Builder; +import lombok.Getter; + +@Getter +@Builder +public class UrlResponse { + + private Long urlId; + private String originUrl; + private String shortUrlKey; + private long requestCount; + + public static UrlResponse from(Url url) { + return UrlResponse.builder() + .urlId(url.getUrlId()) + .originUrl(url.getOriginUrl()) + .shortUrlKey(url.getShortUrlKey()) + .requestCount(url.getRequestCount()) + .build(); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..667b9b1e --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,17 @@ +server: + port: 8080 + +spring: + profiles: + include: db + + jpa: + hibernate: + ddl-auto: create-drop + show-sql: true + + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: jdbc:mysql://localhost/url_shortener + username: localhost + password: root diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml new file mode 100644 index 00000000..8545a576 --- /dev/null +++ b/src/main/resources/logback.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + logs/error.log + + logs/error-%d{yyyy-MM-dd}.log + + + + ${FILE_LOG_PATTERN} + + + + + + + + + + + diff --git a/src/main/resources/templates/home.html b/src/main/resources/templates/home.html new file mode 100644 index 00000000..31e26408 --- /dev/null +++ b/src/main/resources/templates/home.html @@ -0,0 +1,133 @@ + + + + + + 데브유니 단축 URL 생성기 + + + +
+
+
+

Dev Uni, Shorten Url Generator

+
+
+ 긴 Url을 단축시켜, 편하게 공유해보세요. +
+
+
+
+
+
+
+
+ +
+
+ +
+
+
+
+
+
+
+

단축 URL :

+

원래 URL :

+
요청 조회수 :
+
+
+
+
+
+
+
+ +
+
+ +
+
+
+
+
+
+
+

원래 URL :

+
+
+
+
+ + + + + + diff --git a/src/test/java/com/programmers/springbooturlshortener/url/application/UrlServiceTest.java b/src/test/java/com/programmers/springbooturlshortener/url/application/UrlServiceTest.java new file mode 100644 index 00000000..c2295df2 --- /dev/null +++ b/src/test/java/com/programmers/springbooturlshortener/url/application/UrlServiceTest.java @@ -0,0 +1,106 @@ +package com.programmers.springbooturlshortener.url.application; + +import static org.assertj.core.api.Assertions.*; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; + +import com.programmers.springbooturlshortener.global.domain.converter.AlgorithmConverter; +import com.programmers.springbooturlshortener.global.domain.converter.Base62Converter; +import com.programmers.springbooturlshortener.global.domain.utils.PrefixModifier; +import com.programmers.springbooturlshortener.url.domain.Url; +import com.programmers.springbooturlshortener.url.mock.FakeUrlRepository; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; + +class UrlServiceTest { + + private UrlService urlService; + + @BeforeEach + void init() { + FakeUrlRepository fakeUrlRepository = new FakeUrlRepository(); + AlgorithmConverter algorithmConverter = new Base62Converter(); + this.urlService = new UrlService(fakeUrlRepository, algorithmConverter); + + fakeUrlRepository.save(Url.builder() + .urlId(1L) + .originUrl("https://www.naver.com") + .build()); + } + + @DisplayName("새로운 Url 생성 테스트 - 성공") + @ParameterizedTest + @CsvSource({ + "http://www.naver.com", + "www.naver.com", + "naver.com", + }) + void new_url_create_success(String originUrl) { + // given + String prefixModifyUrl = PrefixModifier.modifyUrlPrefix(originUrl); + UrlCreate urlCreate = new UrlCreate(prefixModifyUrl); + + // when + Url result = urlService.create(urlCreate); + + // then + assertThat(result.getOriginUrl()).isEqualTo(prefixModifyUrl); + assertThat(result.getShortUrlKey()).isEqualTo("B"); + assertThat(result.getRequestCount()).isEqualTo(0L); + } + + @DisplayName("이미 존재하는 Url 인 경우 조회수 증가 - 성공") + @ParameterizedTest + @CsvSource({ + "https://www.naver.com" + }) + void exists_url_create_success(String originUrl) { + // given + String prefixModifyUrl = PrefixModifier.modifyUrlPrefix(originUrl); + UrlCreate urlCreate = new UrlCreate(prefixModifyUrl); + Url url = urlService.create(urlCreate); + + // when + Url result = urlService.create(urlCreate); + + // then + assertThat(result.getOriginUrl()).isEqualTo(prefixModifyUrl); + assertThat(result.getRequestCount()).isEqualTo(1L); + } + + @DisplayName("단축 Url 이용 원본 Url 조회 - 성공") + @ParameterizedTest + @CsvSource({ + "http://localhost:8080/B", + "B" + }) + void get_origin_url_success(String shortUrl) { + // given + String prefixModifyUrl = PrefixModifier.modifyUrlPrefix("https://www.naver.com"); + UrlCreate urlCreate = new UrlCreate(prefixModifyUrl); + Url url = urlService.create(urlCreate); + + String shortUrlKey = PrefixModifier.removeBeforeLastSlash(shortUrl); + + // when + String result = urlService.getOriginUrl(shortUrlKey); + + // then + assertThat(result).isEqualTo("https://www.naver.com"); + } + + @DisplayName("Url 조회 수 증가 테스트 - 성공") + @Test + void exists_url_increase_count_success() { + // given + UrlCreate urlCreate = new UrlCreate("http://www.naver.com"); + Url url = urlService.create(urlCreate); + + // when, then + String result = urlService.getOriginUrl(url.getShortUrlKey()); + assertThat(url.getRequestCount()).isEqualTo(1L); + } +} diff --git a/src/test/java/com/programmers/springbooturlshortener/url/domain/UrlTest.java b/src/test/java/com/programmers/springbooturlshortener/url/domain/UrlTest.java new file mode 100644 index 00000000..4c0a4183 --- /dev/null +++ b/src/test/java/com/programmers/springbooturlshortener/url/domain/UrlTest.java @@ -0,0 +1,100 @@ +package com.programmers.springbooturlshortener.url.domain; + +import static org.assertj.core.api.Assertions.*; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; + +import com.programmers.springbooturlshortener.global.domain.exception.EntityNotFound; +import com.programmers.springbooturlshortener.global.domain.exception.InvalidUrlRequest; +import com.programmers.springbooturlshortener.global.domain.utils.PrefixModifier; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; + +class UrlTest { + + @DisplayName("새로운 Url 생성 테스트 - 성공") + @ParameterizedTest + @CsvSource({ + "http://www.naver.com", + "https://www.naver.com", + "www.naver.com", + "naver.com", + }) + void url_create_success(String originUrl) { + // given + String prefixModifyUrl = PrefixModifier.modifyUrlPrefix(originUrl); + UrlCreate urlCreate = new UrlCreate(prefixModifyUrl); + + // when + Url url = Url.from(urlCreate); + + // then + assertThat(url.getOriginUrl()).isEqualTo(prefixModifyUrl); + assertThat(url.getRequestCount()).isZero(); + } + + @DisplayName("잘못된 Url 생성 시, 예외 던지는 지") + @ParameterizedTest + @CsvSource({ + "ftp://www.naver.com", + "http:/www.naver.com" + }) + void url_create_fail(String originUrl) { + // given + UrlCreate urlCreate = new UrlCreate(originUrl); + + // when, then + assertThatThrownBy(() -> Url.from(urlCreate)) + .isInstanceOf(InvalidUrlRequest.class) + .hasMessage(new InvalidUrlRequest().getMessage()); + } + + @DisplayName("단축된 Url 키 업데이트 - 성공") + @Test + void short_url_key_update_success() { + // given + Url url = Url.builder() + .urlId(1L) + .originUrl("https://www.naver.com") + .build(); + + // when + url.updateShortUrlKey("ABCDEF"); + + // then + assertThat(url.getShortUrlKey()).isEqualTo("ABCDEF"); + } + + @DisplayName("저장된 Url 없는 경우, 단축된 Url 키 업데이트 시 예외 던지는지") + @Test + void short_url_key_update_fail() { + // given + Url url = Url.builder() + .originUrl("https://www.naver.com") + .build(); + + // when, then + assertThatThrownBy(() -> url.updateShortUrlKey("ABCDEF")) + .isInstanceOf(EntityNotFound.class) + .hasMessage(new EntityNotFound().getMessage()); + } + + @DisplayName("Url 요청 조회수 증가 - 성공") + @Test + void increase_request_count_success() { + // given + Url url = Url.builder() + .originUrl("https://www.naver.com") + .requestCount(0L) + .build(); + + // when + url.increaseRequestCount(); + url.increaseRequestCount(); + + // then + assertThat(url.getRequestCount()).isEqualTo(2L); + } +} diff --git a/src/test/java/com/programmers/springbooturlshortener/url/mock/FakeUrlRepository.java b/src/test/java/com/programmers/springbooturlshortener/url/mock/FakeUrlRepository.java new file mode 100644 index 00000000..3603567e --- /dev/null +++ b/src/test/java/com/programmers/springbooturlshortener/url/mock/FakeUrlRepository.java @@ -0,0 +1,50 @@ +package com.programmers.springbooturlshortener.url.mock; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.atomic.AtomicLong; + +import com.programmers.springbooturlshortener.url.application.port.UrlRepository; +import com.programmers.springbooturlshortener.url.domain.Url; + +public class FakeUrlRepository implements UrlRepository { + + private final AtomicLong idGenerator = new AtomicLong(0); + private final List data = new ArrayList<>(); + + @Override + public Optional findById(Long id) { + return data.stream() + .filter(url -> url.getUrlId().equals(id)) + .findAny(); + } + + @Override + public Optional findByOriginUrl(String originUrl) { + return data.stream() + .filter(url -> url.getOriginUrl().equals(originUrl)) + .findAny(); + } + + @Override + public Url save(Url url) { + if (url.getUrlId() == null) { + Url createdUrl = Url.builder() + .urlId(idGenerator.incrementAndGet()) + .originUrl(url.getOriginUrl()) + .build(); + data.add(createdUrl); + return createdUrl; + } else { + data.removeIf(existingUrl -> existingUrl.getUrlId().equals(url.getUrlId())); + data.add(url); + return url; + } + } + + @Override + public void deleteAll() { + data.clear(); + } +} diff --git a/src/test/java/com/programmers/springbooturlshortener/url/presentation/UrlRestControllerTest.java b/src/test/java/com/programmers/springbooturlshortener/url/presentation/UrlRestControllerTest.java new file mode 100644 index 00000000..ea852bc0 --- /dev/null +++ b/src/test/java/com/programmers/springbooturlshortener/url/presentation/UrlRestControllerTest.java @@ -0,0 +1,143 @@ +package com.programmers.springbooturlshortener.url.presentation; + +import static org.assertj.core.api.Assertions.*; +import static org.springframework.http.MediaType.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.web.servlet.MockMvc; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.programmers.springbooturlshortener.global.domain.exception.EntityNotFound; +import com.programmers.springbooturlshortener.url.application.UrlService; +import com.programmers.springbooturlshortener.url.application.port.UrlRepository; +import com.programmers.springbooturlshortener.url.domain.Url; +import com.programmers.springbooturlshortener.url.presentation.request.UrlCreate; + +@AutoConfigureMockMvc +@SpringBootTest +class UrlRestControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @Autowired + private UrlRepository urlRepository; + + @Autowired + private UrlService urlService; + + @BeforeEach + void clean() { + urlRepository.deleteAll(); + } + + @DisplayName("POST: /shorten-url - 요청 Url 정상적이지 않으면 400") + @Test + void shortenUrl_invalid_request() throws Exception { + // given + UrlCreate request = new UrlCreate("http:/www.naver.com"); + String json = objectMapper.writeValueAsString(request); + + // expected + mockMvc.perform(post("/shorten") + .contentType(APPLICATION_JSON) + .content(json)) + .andExpect(status().isBadRequest()) + .andExpect(jsonPath("$.code").value(400)) + .andExpect(jsonPath("$.message").value("잘못된 요청입니다.")) + .andExpect(jsonPath("$.validation.originUrl").value("올바르지 않은 URL 형식입니다. 다시 입력해주세요.")) + .andDo(print()); + } + + @DisplayName("POST: /shorten-url - Url 생성 시 DB에 저장 성공") + @Test + void shortenUrl_create_success() throws Exception { + // given + UrlCreate request = new UrlCreate("https://www.naver.com"); + String json = objectMapper.writeValueAsString(request); + + // when + mockMvc.perform(post("/shorten") + .contentType(APPLICATION_JSON) + .content(json)) + .andExpect(status().isCreated()) + .andDo(print()); + + // then + Url url = urlRepository.findByOriginUrl("naver.com") + .orElseThrow(EntityNotFound::new); + + assertThat(url.getOriginUrl()).isEqualTo("naver.com"); + assertThat(url.getRequestCount()).isEqualTo(0L); + } + + @DisplayName("POST: /shorten-url - 이미 존재하는 Url 일 때, 조회 수 증가 성공") + @Test + void shortenUrl_increase_request_count_success() throws Exception { + // given + UrlCreate request = new UrlCreate("https://www.naver.com"); + urlService.create(request); + String json = objectMapper.writeValueAsString(request); + + // expected + mockMvc.perform(post("/shorten") + .contentType(APPLICATION_JSON) + .content(json)) + .andExpect(status().isCreated()) + .andDo(print()); + + Url result = urlRepository.findById(1L) + .orElseThrow(EntityNotFound::new); + + assertThat(result.getRequestCount()).isEqualTo(1L); + } + + @DisplayName("GET: /shorten/{shortUrl} - shortUrl 입력 시 originUrl 조회 성공") + @Test + void origin_url_success() throws Exception { + // given + UrlCreate urlCreate = new UrlCreate("https://www.naver.com"); + urlService.create(urlCreate); + + Url createdUrl = urlRepository.findByOriginUrl("naver.com") + .orElseThrow(EntityNotFound::new); + + // expected + mockMvc.perform(get("/shorten?shortUrl={shortUrl}", createdUrl.getShortUrlKey()) + .contentType(APPLICATION_JSON)) + .andExpect(status().isOk()) + .andDo(print()); + + String result = urlService.getOriginUrl(createdUrl.getShortUrlKey()); + + assertThat(result).isEqualTo("https://www.naver.com"); + } + + @DisplayName("GET: /{shortUrl} - shortUrl 입력 시 리다이렉트 성공") + @Test + void redicrect_success() throws Exception { + // given + UrlCreate urlCreate = new UrlCreate("https://www.naver.com"); + urlService.create(urlCreate); + + Url createdUrl = urlRepository.findByOriginUrl("naver.com") + .orElseThrow(EntityNotFound::new); + + // expected + mockMvc.perform(get("/{shortUrl}", createdUrl.getShortUrlKey()) + .contentType(APPLICATION_JSON)) + .andExpect(status().isFound()) + .andDo(print()); + } +}