diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..649136df --- /dev/null +++ b/.gitignore @@ -0,0 +1,39 @@ +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/ + +*.yml diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..04a3a2f4 --- /dev/null +++ b/build.gradle @@ -0,0 +1,38 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.4' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'com.prgrms' +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-validation' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + + implementation 'org.springframework.boot:spring-boot-starter-cache' +} + +tasks.named('test') { + useJUnitPlatform() +} 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 100644 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..07dc400b --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'shorturl' diff --git a/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java b/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java new file mode 100644 index 00000000..b3645dbd --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java @@ -0,0 +1,13 @@ +package com.prgrms.shorturl; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class ShortUrlApplication { + + public static void main(String[] args) { + SpringApplication.run(ShortUrlApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/global/config/CacheEvictScheduler.java b/src/main/java/com/prgrms/shorturl/global/config/CacheEvictScheduler.java new file mode 100644 index 00000000..7afb588c --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/global/config/CacheEvictScheduler.java @@ -0,0 +1,26 @@ +package com.prgrms.shorturl.global.config; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cache.CacheManager; +import org.springframework.scheduling.annotation.Scheduled; +import org.springframework.stereotype.Component; + +@Slf4j +@Component +public class CacheEvictScheduler { + + private final CacheManager cacheManager; + + @Autowired + public CacheEvictScheduler(CacheManager cacheManager) { + this.cacheManager = cacheManager; + } + + @Scheduled(fixedRate = 3600000) + public void evictUrlsCache() { + log.info("캐시는 1시간 뒤에 지워집니다."); + cacheManager.getCache("urls").clear(); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/global/config/CachingConfig.java b/src/main/java/com/prgrms/shorturl/global/config/CachingConfig.java new file mode 100644 index 00000000..b895aa33 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/global/config/CachingConfig.java @@ -0,0 +1,23 @@ +package com.prgrms.shorturl.global.config; + +import org.springframework.cache.CacheManager; +import org.springframework.cache.annotation.EnableCaching; +import org.springframework.cache.concurrent.ConcurrentMapCacheManager; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.List; + +@EnableCaching +@Configuration +public class CachingConfig { + + @Bean + public CacheManager cacheManager() { + ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager(); + cacheManager.setAllowNullValues(false); + cacheManager.setCacheNames(List.of("urls")); + return cacheManager; + } + +} diff --git a/src/main/java/com/prgrms/shorturl/global/error/ErrorCode.java b/src/main/java/com/prgrms/shorturl/global/error/ErrorCode.java new file mode 100644 index 00000000..3f7d2dd4 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/global/error/ErrorCode.java @@ -0,0 +1,26 @@ +package com.prgrms.shorturl.global.error; + +import lombok.Getter; + +@Getter +public enum ErrorCode { + //global + INTERNAL_SERVER_ERROR("G001", "Internal Server Error"), + + INVALID_INPUT_VALUE_ERROR("G002", "유효하지 않은 입력값입니다."), + INVALID_METHOD_ERROR("G003", "Method Argument가 적절하지 않습니다."), + REQUEST_BODY_MISSING_ERROR("G004", "RequestBody에 데이터가 존재하지 않습니다."), + REQUEST_PARAM_MISSING_ERROR("G005", "RequestParam에 데이터가 전달되지 않았습니다."), + + //url + DUPLICATED_CREATE_ORIGIN_URL_ERROR("U001", "이미 존재하는 origin Url입니다."); + + private final String code; + private final String message; + + ErrorCode(String code, String message) { + this.code = code; + this.message = message; + } + +} diff --git a/src/main/java/com/prgrms/shorturl/global/error/handler/GlobalExceptionHandler.java b/src/main/java/com/prgrms/shorturl/global/error/handler/GlobalExceptionHandler.java new file mode 100644 index 00000000..b25070a7 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/global/error/handler/GlobalExceptionHandler.java @@ -0,0 +1,89 @@ +package com.prgrms.shorturl.global.error.handler; + +import com.prgrms.shorturl.global.error.response.ErrorResponse; +import com.prgrms.shorturl.url.exception.ExistedOriginUrlException; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.MissingServletRequestParameterException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; + +import static com.prgrms.shorturl.global.error.ErrorCode.*; + +@RequiredArgsConstructor +@RestControllerAdvice +@Slf4j +public class GlobalExceptionHandler { + + /** + * [Custom Exception] Origin Url이 이미 존재하는 경우 + */ + @ExceptionHandler(ExistedOriginUrlException.class) + protected ResponseEntity handleExistedOriginUrlException(ExistedOriginUrlException e) { + log.warn("Handle ExistedOriginUrlException", e); + final ErrorResponse response = ErrorResponse.of(e.getErrorCode(), e.getMessage()); + + return ResponseEntity + .status(HttpStatus.BAD_REQUEST) + .body(response); + } + + + /** + * [Exception] 객체 혹은 파라미터의 데이터 값이 유효하지 않은 경우 + */ + @ExceptionHandler(MethodArgumentNotValidException.class) + protected ResponseEntity handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { + log.warn("Handle MethodArgumentNotValidException", e.getMessage()); + final ErrorResponse response = ErrorResponse.of(INVALID_METHOD_ERROR, e.getBindingResult()); + + return ResponseEntity + .status(HttpStatus.BAD_REQUEST) + .body(response); + } + + /** + * [Exception] 클라이언트에서 request의 '파라미터로' 데이터가 넘어오지 않았을 경우 + */ + @ExceptionHandler(MissingServletRequestParameterException.class) + protected ResponseEntity handleMissingRequestHeaderExceptionException( + MissingServletRequestParameterException ex) { + log.warn("Handle MissingServletRequestParameterException", ex); + final ErrorResponse response = ErrorResponse.of(REQUEST_PARAM_MISSING_ERROR, ex.getMessage()); + + return ResponseEntity + .status(HttpStatus.BAD_REQUEST) + .body(response); + } + + /** + * [Exception] enum type 일치하지 않아 binding 못할 경우 + * 주로 @RequestParam enum으로 binding 못했을 경우 발생 + */ + @ExceptionHandler(MethodArgumentTypeMismatchException.class) + protected ResponseEntity handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e) { + log.warn("Handle MethodArgumentTypeMismatchException", e); + final ErrorResponse response = ErrorResponse.of(INVALID_INPUT_VALUE_ERROR, e.getMessage()); + + return ResponseEntity + .status(HttpStatus.BAD_REQUEST) + .body(response); + } + + /** + * [Exception] 서버에 정의되지 않은 모든 예외 + */ + @ExceptionHandler(Exception.class) + public ResponseEntity handleAllException(Exception e) { + log.error("Handle Exception :", e); + final ErrorResponse response = ErrorResponse.of(INTERNAL_SERVER_ERROR, e.getMessage()); + return ResponseEntity + .status(HttpStatus.INTERNAL_SERVER_ERROR) + .body(response); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/global/error/response/ErrorResponse.java b/src/main/java/com/prgrms/shorturl/global/error/response/ErrorResponse.java new file mode 100644 index 00000000..4ecd8437 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/global/error/response/ErrorResponse.java @@ -0,0 +1,74 @@ +package com.prgrms.shorturl.global.error.response; + +import com.prgrms.shorturl.global.error.ErrorCode; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.springframework.validation.BindingResult; + +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; + +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class ErrorResponse { + private String code; + private String message; + private List fieldDetailErrors; + private String reason; + + public static ErrorResponse of(final ErrorCode errorCode, final BindingResult bindingResult) { + return new ErrorResponse(errorCode, FieldDetailError.of(bindingResult)); + } + + public static ErrorResponse of(ErrorCode errorCode) { + return new ErrorResponse(errorCode); + } + + public static ErrorResponse of(final ErrorCode errorCode, final String reason) { + return new ErrorResponse(errorCode, reason); + } + + private ErrorResponse(final ErrorCode errorCode) { + this.code = errorCode.getCode(); + this.message = errorCode.getMessage(); + this.fieldDetailErrors = new ArrayList<>(); + } + + private ErrorResponse(final ErrorCode errorCode, final String reason) { + this.code = errorCode.getCode(); + this.message = errorCode.getMessage(); + this.reason = reason; + } + + private ErrorResponse(final ErrorCode errorCode, final List fieldDetailErrors) { + this.code = errorCode.getCode(); + this.message = errorCode.getMessage(); + this.fieldDetailErrors = fieldDetailErrors; + } + + @Getter + public static class FieldDetailError { + private final String field; + private final String value; + private final String reason; + + private static List of(final BindingResult bindingResult) { + final List fieldErrors = bindingResult.getFieldErrors(); + return fieldErrors.stream() + .map(error -> new FieldDetailError( + error.getField(), + error.getRejectedValue() == null ? "" : error.getRejectedValue().toString(), + error.getDefaultMessage())) + .collect(Collectors.toList()); + } + + private FieldDetailError(String field, String value, String reason) { + this.field = field; + this.value = value; + this.reason = reason; + } + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/ShortUrlController.java b/src/main/java/com/prgrms/shorturl/url/controller/ShortUrlController.java new file mode 100644 index 00000000..88d79a17 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/ShortUrlController.java @@ -0,0 +1,61 @@ +package com.prgrms.shorturl.url.controller; + +import com.prgrms.shorturl.url.controller.dto.ShortUrlCreatApiRequest; +import com.prgrms.shorturl.url.controller.dto.ShortUrlCreateApiResponse; +import com.prgrms.shorturl.url.controller.dto.ShortUrlFindApiResponse; +import com.prgrms.shorturl.url.controller.mapper.ShortUrlApiMapper; +import com.prgrms.shorturl.url.service.ShortUrlService; + +import jakarta.validation.Valid; + +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; +import org.springframework.web.servlet.support.ServletUriComponentsBuilder; + +import java.net.URI; + +@RequestMapping("/api/short/") +@RestController +public class ShortUrlController { + + private final ShortUrlService shortUrlService; + private final ShortUrlApiMapper shortUrlApiMapper; + + public ShortUrlController(ShortUrlService shortUrlService, ShortUrlApiMapper shortUrlApiMapper) { + this.shortUrlService = shortUrlService; + this.shortUrlApiMapper = shortUrlApiMapper; + } + + @PostMapping( + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE + ) + public ResponseEntity createShortUrl( + @RequestBody @Valid ShortUrlCreatApiRequest request) { + String shortUrl = shortUrlService.creatShortUrl(request.originUrl(), request.strategyType()); + URI uri = createURI(shortUrl); + + return ResponseEntity.created(uri).body(shortUrlApiMapper.toShortUrlCreateApiResponse(uri.toString())); + } + + @GetMapping(value = "/{shortUrl}") + public ResponseEntity findOriginUrl( + @PathVariable String shortUrl) { + String originUrl = shortUrlService.getOriginUrl(shortUrl); + + return ResponseEntity.status(HttpStatus.MOVED_PERMANENTLY) + .location(URI.create(originUrl)) + .body(shortUrlApiMapper.toShortUrlFindApiResponse(originUrl)); + } + + private URI createURI(String shortUrl) { + return ServletUriComponentsBuilder + .fromCurrentRequest() + .path("/{shortUrl}") + .buildAndExpand(shortUrl) + .toUri(); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreatApiRequest.java b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreatApiRequest.java new file mode 100644 index 00000000..84431fe1 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreatApiRequest.java @@ -0,0 +1,10 @@ +package com.prgrms.shorturl.url.controller.dto; + +import com.prgrms.shorturl.url.controller.validation.HttpUrl; +import jakarta.validation.constraints.NotBlank; + +public record ShortUrlCreatApiRequest( + @HttpUrl @NotBlank(message = "origin url은 null이거나 빈 값일 수 없습니다.") String originUrl, + @NotBlank(message = "인코딩 방법은 null이거나 빈 값일 수 없습니다.") String strategyType +) { +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreateApiResponse.java b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreateApiResponse.java new file mode 100644 index 00000000..7f4c5408 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlCreateApiResponse.java @@ -0,0 +1,6 @@ +package com.prgrms.shorturl.url.controller.dto; + +public record ShortUrlCreateApiResponse( + String shortUrl +) { +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlFindApiResponse.java b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlFindApiResponse.java new file mode 100644 index 00000000..b92b369f --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/dto/ShortUrlFindApiResponse.java @@ -0,0 +1,6 @@ +package com.prgrms.shorturl.url.controller.dto; + +public record ShortUrlFindApiResponse( + String originUrl +) { +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/mapper/ShortUrlApiMapper.java b/src/main/java/com/prgrms/shorturl/url/controller/mapper/ShortUrlApiMapper.java new file mode 100644 index 00000000..f063ba0a --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/mapper/ShortUrlApiMapper.java @@ -0,0 +1,18 @@ +package com.prgrms.shorturl.url.controller.mapper; + +import com.prgrms.shorturl.url.controller.dto.ShortUrlCreateApiResponse; +import com.prgrms.shorturl.url.controller.dto.ShortUrlFindApiResponse; +import org.springframework.stereotype.Component; + +@Component +public class ShortUrlApiMapper { + + public ShortUrlCreateApiResponse toShortUrlCreateApiResponse(String shortUrl) { + return new ShortUrlCreateApiResponse(shortUrl); + } + + public ShortUrlFindApiResponse toShortUrlFindApiResponse(String originUrl) { + return new ShortUrlFindApiResponse(originUrl); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpUrl.java b/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpUrl.java new file mode 100644 index 00000000..a180e7e8 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpUrl.java @@ -0,0 +1,20 @@ +package com.prgrms.shorturl.url.controller.validation; + +import jakarta.validation.Constraint; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Constraint(validatedBy = HttpsUrlValidator.class) +@Target(ElementType.FIELD) +@Retention(RetentionPolicy.RUNTIME) +public @interface HttpUrl { + String message() default "origin url은 \"http://\" 또는 \"https://\"로 시작해야 합니다."; + + Class[] groups() default {}; + + Class[] payload() default {}; + +} diff --git a/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpsUrlValidator.java b/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpsUrlValidator.java new file mode 100644 index 00000000..324a2b3a --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/controller/validation/HttpsUrlValidator.java @@ -0,0 +1,15 @@ +package com.prgrms.shorturl.url.controller.validation; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; + +public class HttpsUrlValidator implements ConstraintValidator { + @Override + public boolean isValid(String value, ConstraintValidatorContext context) { + if (value == null || value.isBlank()) { + return true; + } + return value.startsWith("https://") || value.startsWith("http://"); + } +} + diff --git a/src/main/java/com/prgrms/shorturl/url/encoder/Base62Encoder.java b/src/main/java/com/prgrms/shorturl/url/encoder/Base62Encoder.java new file mode 100644 index 00000000..bfcfdc0f --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/encoder/Base62Encoder.java @@ -0,0 +1,31 @@ +package com.prgrms.shorturl.url.encoder; + +import org.springframework.stereotype.Component; + +@Component +public class Base62Encoder implements ShortUrlStrategy { + + private static final int URL_LENGTH_LIMIT = 8; + private static final int TOKENS_SIZE = 62; + private final char[] TOKENS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789".toCharArray(); + + @Override + public String encodeOriginUrl(Long id) { + StringBuilder encodedString = new StringBuilder(); + while (id > 0) { + if (isSameUrlLimit(encodedString)) { + break; + } + + encodedString.append(TOKENS[(int) (id % TOKENS_SIZE)]); + id /= TOKENS_SIZE; + } + + return encodedString.toString(); + } + + private boolean isSameUrlLimit(StringBuilder url) { + return url.length() > URL_LENGTH_LIMIT; + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/encoder/RandomEncoder.java b/src/main/java/com/prgrms/shorturl/url/encoder/RandomEncoder.java new file mode 100644 index 00000000..1a98ff53 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/encoder/RandomEncoder.java @@ -0,0 +1,27 @@ +package com.prgrms.shorturl.url.encoder; + +import org.springframework.stereotype.Component; + +import java.util.Random; + +@Component +public class RandomEncoder implements ShortUrlStrategy { + + private static final int URL_LENGTH_LIMIT = 8; + private final char[] RANDOM_CHAR_TOKENS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789".toCharArray(); + private final Random random = new Random(); + + @Override + public String encodeOriginUrl(Long id) { + StringBuilder encodedString = new StringBuilder(URL_LENGTH_LIMIT); + + for (int i = 0; i < URL_LENGTH_LIMIT; i++) { + int randomNumber = random.nextInt(RANDOM_CHAR_TOKENS.length); + int index = (int) ((randomNumber + id) % RANDOM_CHAR_TOKENS.length); + + encodedString.append(RANDOM_CHAR_TOKENS[index]); + } + + return encodedString.toString(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategy.java b/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategy.java new file mode 100644 index 00000000..5beaf3f4 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategy.java @@ -0,0 +1,5 @@ +package com.prgrms.shorturl.url.encoder; + +public interface ShortUrlStrategy { + String encodeOriginUrl(Long id); +} diff --git a/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategyConfig.java b/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategyConfig.java new file mode 100644 index 00000000..3b15ce6b --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/encoder/ShortUrlStrategyConfig.java @@ -0,0 +1,22 @@ +package com.prgrms.shorturl.url.encoder; + +import org.springframework.stereotype.Component; + +import java.util.HashMap; +import java.util.Map; + +@Component +public class ShortUrlStrategyConfig { + + private final Map strategies = new HashMap<>(); + + public ShortUrlStrategyConfig(Base62Encoder base62Encoder, RandomEncoder randomEncoder) { + strategies.put("RANDOM", randomEncoder); + strategies.put("BASE62", base62Encoder); + } + + public ShortUrlStrategy find(String strategy) { + return strategies.get(strategy); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/exception/ExistedOriginUrlException.java b/src/main/java/com/prgrms/shorturl/url/exception/ExistedOriginUrlException.java new file mode 100644 index 00000000..eb41271b --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/exception/ExistedOriginUrlException.java @@ -0,0 +1,17 @@ +package com.prgrms.shorturl.url.exception; + +import com.prgrms.shorturl.global.error.ErrorCode; + +import lombok.Getter; + +@Getter +public class ExistedOriginUrlException extends RuntimeException { + + private final ErrorCode errorCode; + + public ExistedOriginUrlException(final ErrorCode errorCode) { + super(errorCode.getMessage()); + this.errorCode = errorCode; + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/model/RequestCount.java b/src/main/java/com/prgrms/shorturl/url/model/RequestCount.java new file mode 100644 index 00000000..384a77cd --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/model/RequestCount.java @@ -0,0 +1,47 @@ +package com.prgrms.shorturl.url.model; + +import jakarta.persistence.Embeddable; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.Objects; + +@Getter +@Embeddable +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class RequestCount { + + private static final int REQUEST_COUNT_MIN_LIMIT = 0; + + private int requestCount; + + public RequestCount(int requestCount) { + isValidated(requestCount); + this.requestCount = requestCount; + } + + private void isValidated(int requestCount) { + if (requestCount < REQUEST_COUNT_MIN_LIMIT) { + throw new IllegalArgumentException("요청 횟수는 음수가 나올 수 없습니다."); + } + } + + public void plusOneCount() { + requestCount++; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + RequestCount that = (RequestCount) o; + return Objects.equals(requestCount, that.requestCount); + } + + @Override + public int hashCode() { + return Objects.hash(requestCount); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/model/ShortUrl.java b/src/main/java/com/prgrms/shorturl/url/model/ShortUrl.java new file mode 100644 index 00000000..0def8db0 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/model/ShortUrl.java @@ -0,0 +1,52 @@ +package com.prgrms.shorturl.url.model; + +import jakarta.persistence.Embeddable; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.Objects; + +@Getter +@Embeddable +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class ShortUrl { + + public static final int SHORT_URL_MAX_LENGTH = 8; + + private String shortUrl; + + public ShortUrl(String shortUrl) { + isNotBlank(shortUrl); + isLimitLength(shortUrl); + + this.shortUrl = shortUrl; + } + + private void isNotBlank(String shortUrl) { + if (shortUrl == null || shortUrl.isBlank()) { + throw new IllegalArgumentException("Short URL은 null이거나 빈 값일 수 없습니다."); + } + } + + private void isLimitLength(String shortUrl) { + if (shortUrl.length() > SHORT_URL_MAX_LENGTH) { + throw new IllegalArgumentException("Short URL의 길이는" + SHORT_URL_MAX_LENGTH + "를 넘을 수 없습니다."); + } + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ShortUrl shortUrl1 = (ShortUrl) o; + return Objects.equals(shortUrl, shortUrl1.shortUrl); + } + + @Override + public int hashCode() { + return Objects.hash(shortUrl); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/model/Urls.java b/src/main/java/com/prgrms/shorturl/url/model/Urls.java new file mode 100644 index 00000000..34eccda4 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/model/Urls.java @@ -0,0 +1,65 @@ +package com.prgrms.shorturl.url.model; + +import jakarta.persistence.*; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@Entity +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Urls { + + private static final String SHORT_URL_DEFAULT_BLANK = "."; + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Column + private String originUrl; + + @Column + @Embedded + private ShortUrl shortUrl; + + @Column + @Embedded + private RequestCount requestCount; + + public Urls(String originUrl) { + isNotBlank(originUrl); + this.originUrl = originUrl; + this.shortUrl = new ShortUrl(SHORT_URL_DEFAULT_BLANK); + this.requestCount = new RequestCount(0); + } + + public void registerShortUrl(ShortUrl shortUrl) { + this.shortUrl = shortUrl; + } + + public int getRequestCount() { + return requestCount.getRequestCount(); + } + + public String getShortUrl() { + return shortUrl.getShortUrl(); + } + + public String getOriginUrl() { + addRequestCount(); + return originUrl; + } + + private void addRequestCount() { + requestCount.plusOneCount(); + } + + private void isNotBlank(String originUrl) { + if (originUrl == null || originUrl.isBlank()) { + throw new IllegalArgumentException("origin URL은 null이거나 빈 값일 수 없습니다."); + } + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlJpaRepository.java b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlJpaRepository.java new file mode 100644 index 00000000..e1a5eb2b --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlJpaRepository.java @@ -0,0 +1,18 @@ +package com.prgrms.shorturl.url.repository; + +import com.prgrms.shorturl.url.model.Urls; + +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; + +import java.util.Optional; + +public interface ShortUrlJpaRepository extends JpaRepository { + + Optional findByOriginUrl(@Param(value = "originUrl") String originUrl); + + @Query("select u from Urls u where u.shortUrl.shortUrl=:shortUrl") + Optional findByShortUrl(@Param(value = "shortUrl") String shortUrl); + +} diff --git a/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepository.java b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepository.java new file mode 100644 index 00000000..765268f7 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepository.java @@ -0,0 +1,19 @@ +package com.prgrms.shorturl.url.repository; + +import com.prgrms.shorturl.url.model.Urls; + +import java.util.Optional; + +public interface ShortUrlRepository { + + void isExistedOriginUrl(String originUrl); + + Urls getUrlByShortUrl(String shortUrl); + + Optional findByOriginUrl(String originUrl); + + Optional findByShortUrl(String shortUrl); + + Urls save(Urls urls); + +} diff --git a/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImpl.java b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImpl.java new file mode 100644 index 00000000..c7964788 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImpl.java @@ -0,0 +1,59 @@ +package com.prgrms.shorturl.url.repository; + +import com.prgrms.shorturl.url.exception.ExistedOriginUrlException; +import com.prgrms.shorturl.url.model.Urls; + +import jakarta.persistence.EntityNotFoundException; + +import lombok.extern.slf4j.Slf4j; + +import org.springframework.cache.annotation.CacheConfig; +import org.springframework.cache.annotation.Cacheable; +import org.springframework.stereotype.Repository; + +import java.util.Optional; + +import static com.prgrms.shorturl.global.error.ErrorCode.DUPLICATED_CREATE_ORIGIN_URL_ERROR; + +@Slf4j +@Repository +@CacheConfig(cacheNames = "urls") +public class ShortUrlRepositoryImpl implements ShortUrlRepository { + + private final ShortUrlJpaRepository shortUrlJpaRepository; + + public ShortUrlRepositoryImpl(ShortUrlJpaRepository shortUrlJpaRepository) { + this.shortUrlJpaRepository = shortUrlJpaRepository; + } + + @Override + public void isExistedOriginUrl(String originUrl) { + if (findByOriginUrl(originUrl).isPresent()) { + throw new ExistedOriginUrlException(DUPLICATED_CREATE_ORIGIN_URL_ERROR); + } + } + + @Override + @Cacheable(value = "urls", key = "#shortUrl", unless = "#result?.getRequestCount() < 10") + public Urls getUrlByShortUrl(String shortUrl) { + return findByShortUrl(shortUrl).orElseThrow(() -> new EntityNotFoundException("존재하지 않은 URL입니다.")); + } + + @Override + public Optional findByOriginUrl(String originUrl) { + return shortUrlJpaRepository.findByOriginUrl(originUrl); + } + + @Override + public Optional findByShortUrl(String shortUrl) { + Optional byShortUrl = shortUrlJpaRepository.findByShortUrl(shortUrl); + + return byShortUrl; + } + + @Override + public Urls save(Urls urls) { + return shortUrlJpaRepository.save(urls); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/url/service/ShortUrlService.java b/src/main/java/com/prgrms/shorturl/url/service/ShortUrlService.java new file mode 100644 index 00000000..cc1ba8bf --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/service/ShortUrlService.java @@ -0,0 +1,8 @@ +package com.prgrms.shorturl.url.service; + +public interface ShortUrlService { + + String creatShortUrl(String originUrl, String strategyType); + + String getOriginUrl(String shortUrl); +} diff --git a/src/main/java/com/prgrms/shorturl/url/service/ShortUrlServiceImpl.java b/src/main/java/com/prgrms/shorturl/url/service/ShortUrlServiceImpl.java new file mode 100644 index 00000000..7c215a10 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/url/service/ShortUrlServiceImpl.java @@ -0,0 +1,43 @@ +package com.prgrms.shorturl.url.service; + +import com.prgrms.shorturl.url.encoder.ShortUrlStrategy; +import com.prgrms.shorturl.url.encoder.ShortUrlStrategyConfig; +import com.prgrms.shorturl.url.model.ShortUrl; +import com.prgrms.shorturl.url.model.Urls; +import com.prgrms.shorturl.url.repository.ShortUrlRepository; + +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +public class ShortUrlServiceImpl implements ShortUrlService { + private final ShortUrlStrategyConfig shortUrlStrategyConfig; + private final ShortUrlRepository shortUrlRepository; + + public ShortUrlServiceImpl(ShortUrlStrategyConfig shortUrlStrategyConfig, ShortUrlRepository shortUrlRepository) { + this.shortUrlStrategyConfig = shortUrlStrategyConfig; + this.shortUrlRepository = shortUrlRepository; + } + + @Override + @Transactional + public String creatShortUrl(String originUrl, String strategyType) { + shortUrlRepository.isExistedOriginUrl(originUrl); + Urls urls = shortUrlRepository.save(new Urls(originUrl)); + + ShortUrlStrategy shortUrlStrategy = shortUrlStrategyConfig.find(strategyType); + String shortUrl = shortUrlStrategy.encodeOriginUrl(urls.getId()); + urls.registerShortUrl(new ShortUrl(shortUrl)); + + return shortUrl; + } + + @Override + @Transactional + public String getOriginUrl(String shortUrl) { + Urls url = shortUrlRepository.getUrlByShortUrl(shortUrl); + + return url.getOriginUrl(); + } + +} diff --git a/src/main/resources/static/index.html b/src/main/resources/static/index.html new file mode 100644 index 00000000..673b8c50 --- /dev/null +++ b/src/main/resources/static/index.html @@ -0,0 +1,71 @@ + + + + + + Short URL Service + + + +
+

Short URL Service

+ + + + + + + + + + + +

+ +

+ +
+ + + + diff --git a/src/test/java/com/prgrms/shorturl/Fixtures.java b/src/test/java/com/prgrms/shorturl/Fixtures.java new file mode 100644 index 00000000..e769871c --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/Fixtures.java @@ -0,0 +1,16 @@ +package com.prgrms.shorturl; + +import com.prgrms.shorturl.url.model.ShortUrl; +import com.prgrms.shorturl.url.model.Urls; + +public class Fixtures { + + public static ShortUrl oneLengthShortUrl() { + return new ShortUrl("A"); + } + + public static Urls naverUrlInOriginUrl() { + return new Urls("https://search.shopping.naver.com/search/category/100000015?NaPm=ct%3Dlnhoca02%7Cci%3Dshoppingwindow%7Ctr%3Dnsh%7Chk%3Df6aa7e43c22b8f359e4ac3efbaf097bbdfb9e7b7%7Ctrx%3D"); + } + +} diff --git a/src/test/java/com/prgrms/shorturl/url/model/RequestCountTest.java b/src/test/java/com/prgrms/shorturl/url/model/RequestCountTest.java new file mode 100644 index 00000000..82a6102d --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/url/model/RequestCountTest.java @@ -0,0 +1,17 @@ +package com.prgrms.shorturl.url.model; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertThrows; + +class RequestCountTest { + + @Test + @DisplayName("요청 횟수가 음수인 경우 예외를 던진다.") + void isisValidated_negativeRequest_throwException() { + //when_then + assertThrows(IllegalArgumentException.class, () -> new RequestCount(-1)); + } + +} diff --git a/src/test/java/com/prgrms/shorturl/url/model/ShortUrlTest.java b/src/test/java/com/prgrms/shorturl/url/model/ShortUrlTest.java new file mode 100644 index 00000000..4d9979f5 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/url/model/ShortUrlTest.java @@ -0,0 +1,36 @@ +package com.prgrms.shorturl.url.model; + +import com.prgrms.shorturl.Fixtures; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertThrows; + +class ShortUrlTest { + + @Test + @DisplayName("short url이 null이거나 빈 값인 경우 예외를 던진다.") + void createShortUrl_nullOrBlank_throwException() { + //when_then + assertThrows(IllegalArgumentException.class, () -> new ShortUrl(null)); + assertThrows(IllegalArgumentException.class, () -> new ShortUrl("")); + assertThrows(IllegalArgumentException.class, () -> new ShortUrl(" ")); + } + + @Test + @DisplayName("short url의 길이가 최대 길이를 넘어가면 예외를 던진다.") + void createShortUrl_overMaxLength_throwException() { + //given + ShortUrl url = Fixtures.oneLengthShortUrl(); + int maxLength = url.SHORT_URL_MAX_LENGTH; + StringBuilder sb = new StringBuilder(url.getShortUrl()); + + while (sb.length() <= maxLength) { + sb.append("A"); + } + + //when_then + assertThrows(IllegalArgumentException.class, () -> new ShortUrl(sb.toString())); + } + +} diff --git a/src/test/java/com/prgrms/shorturl/url/model/UrlsTest.java b/src/test/java/com/prgrms/shorturl/url/model/UrlsTest.java new file mode 100644 index 00000000..9fa8045f --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/url/model/UrlsTest.java @@ -0,0 +1,19 @@ +package com.prgrms.shorturl.url.model; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertThrows; + +class UrlsTest { + + @Test + @DisplayName("origin url이 null이거나 빈 값으로 Urls를 만들려고 시도하는 경우 예외를 던진다") + void createUrlsWithOriginUrl_nullOrBlank_throwException() { + //when_then + assertThrows(IllegalArgumentException.class, () -> new Urls(null)); + assertThrows(IllegalArgumentException.class, () -> new Urls("")); + assertThrows(IllegalArgumentException.class, () -> new Urls(" ")); + } + +} diff --git a/src/test/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImplTest.java b/src/test/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImplTest.java new file mode 100644 index 00000000..561df0e3 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/url/repository/ShortUrlRepositoryImplTest.java @@ -0,0 +1,61 @@ +package com.prgrms.shorturl.url.repository; + +import com.prgrms.shorturl.Fixtures; +import com.prgrms.shorturl.url.model.Urls; +import com.prgrms.shorturl.url.service.ShortUrlService; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cache.CacheManager; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; + +@ExtendWith(SpringExtension.class) +@SpringBootTest +class ShortUrlRepositoryImplTest { + + @Autowired + private CacheManager cacheManager; + + @Autowired + private ShortUrlRepositoryImpl shortUrlRepository; + + @Autowired + private ShortUrlService shortUrlService; + + private Urls savedNaverUrl; + + @BeforeEach + void setUp() { + Urls naverUrlToSave = Fixtures.naverUrlInOriginUrl(); + shortUrlService.creatShortUrl(naverUrlToSave.getOriginUrl(), "BASE62"); + savedNaverUrl = shortUrlRepository.findByOriginUrl(naverUrlToSave.getOriginUrl()).get(); + + for (int i = 0; i < 20; i++) { + shortUrlService.getOriginUrl(savedNaverUrl.getShortUrl()); + } + + } + + private Optional getCacheUrl(String shortUrl) { + return Optional.ofNullable(cacheManager.getCache("urls")).map(c -> c.get(shortUrl, Urls.class)); + } + + @Test + @DisplayName("요청 횟수가 정해진 limit 수를 넘어가면 2차 캐시에 저장하여 다음 요청에서 2차 캐시에 있는 origin url을 반환한다.") + void getUrlByShortUrl_overLimitedBoundCount_returnCache() { + //when + Urls urlByShortUrl = shortUrlRepository.getUrlByShortUrl(savedNaverUrl.getShortUrl()); + + //then + assertThat(urlByShortUrl).isEqualTo(getCacheUrl(savedNaverUrl.getShortUrl()).get()); + } + +} diff --git a/src/test/java/com/prgrms/shorturl/url/service/ShortUrlServiceImplTest.java b/src/test/java/com/prgrms/shorturl/url/service/ShortUrlServiceImplTest.java new file mode 100644 index 00000000..0a613108 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/url/service/ShortUrlServiceImplTest.java @@ -0,0 +1,78 @@ +package com.prgrms.shorturl.url.service; + +import com.prgrms.shorturl.Fixtures; +import com.prgrms.shorturl.url.encoder.Base62Encoder; +import com.prgrms.shorturl.url.encoder.ShortUrlStrategyConfig; +import com.prgrms.shorturl.url.exception.ExistedOriginUrlException; +import com.prgrms.shorturl.url.model.Urls; +import com.prgrms.shorturl.url.repository.ShortUrlJpaRepository; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.context.annotation.Import; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.transaction.annotation.Transactional; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assertions.assertThrows; + +@SpringBootTest +@ActiveProfiles("test") +@Transactional +@Import(ShortUrlStrategyConfig.class) +class ShortUrlServiceImplTest { + + private final Urls NAVERURL = Fixtures.naverUrlInOriginUrl(); + ; + private final String STRATEGY_TYPE = "BASE62"; + + @Autowired + private ShortUrlServiceImpl shortUrlService; + + @Autowired + private ShortUrlJpaRepository shortUrlRepository; + + @Autowired + private Base62Encoder base62Encoder; + + @Test + @DisplayName("새로운 Origin url을 base62 인코딩 요청하면 short Url을 반환한다.") + void creatShortUrl_newOriginUrl_returnShortUrl() { + //when + String result = shortUrlService.creatShortUrl(NAVERURL.getOriginUrl(), STRATEGY_TYPE); + + Urls savedUrl = shortUrlRepository.findByOriginUrl(NAVERURL.getOriginUrl()).get(); + String expectedShortUrl = base62Encoder.encodeOriginUrl(savedUrl.getId()); + + //then + assertThat(result).isEqualTo(expectedShortUrl); + } + + @Test + @DisplayName("저장된 Origin url을 가지고 short url 생성을 요청하면 이미 저장된 origin url이라는 예외를 던진다.") + void creatShortUrl_existedOriginUrl_throwExcpeiton() { + //given + shortUrlService.creatShortUrl(NAVERURL.getOriginUrl(), STRATEGY_TYPE); + + //when_then + assertThrows(ExistedOriginUrlException.class, () -> shortUrlService.creatShortUrl(NAVERURL.getOriginUrl(), STRATEGY_TYPE)); + } + + @Test + @DisplayName("short url로 origin url를 잘 찾는지 확인한다.") + void getOriginUrl_shortUrl_equals() { + //given + String shortUrl = shortUrlService.creatShortUrl(NAVERURL.getOriginUrl(), STRATEGY_TYPE); + + //when + String originUrl = shortUrlService.getOriginUrl(shortUrl); + + //when_then + assertThat(originUrl).isEqualTo(NAVERURL.getOriginUrl()); + } + +} +