diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..c2065bc2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..9924f0cb --- /dev/null +++ b/build.gradle @@ -0,0 +1,30 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.2.0' + id 'io.spring.dependency-management' version '1.1.4' +} + +group = 'com.springboot' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.projectlombok:lombok:1.18.22' + implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..d64cd491 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..1af9e093 --- /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.5-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..1aa94a42 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && 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=SC2039,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=SC2039,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, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +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..551628f1 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springboot-url-shortner' diff --git a/src/main/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplication.java b/src/main/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplication.java new file mode 100644 index 00000000..d4ee0eb7 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplication.java @@ -0,0 +1,13 @@ +package com.springboot.springbooturlshortner; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringbootUrlShortnerApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringbootUrlShortnerApplication.class, args); + } + +} diff --git a/src/main/java/com/springboot/springbooturlshortner/controller/UrlController.java b/src/main/java/com/springboot/springbooturlshortner/controller/UrlController.java new file mode 100644 index 00000000..8c24ac95 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/controller/UrlController.java @@ -0,0 +1,43 @@ +package com.springboot.springbooturlshortner.controller; + +import com.springboot.springbooturlshortner.service.ShortenUrlRequestDto; +import com.springboot.springbooturlshortner.service.UrlService; +import jakarta.servlet.http.HttpServletResponse; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.ModelAttribute; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; + +import java.io.IOException; + +@Controller +public class UrlController { + + private final UrlService urlService; + + public UrlController(UrlService urlService) { + this.urlService = urlService; + } + + @GetMapping("/") + public String showDefaultPage() { + return "shortenUrl"; + } + + @PostMapping("/shorten-url") + public String shortenUrl(@ModelAttribute ShortenUrlRequestDto shortenUrlRequestDto, Model model) { + String shortenUrl = urlService.createShortenUrl(shortenUrlRequestDto); + model.addAttribute("shortenUrl", shortenUrl); + + return "shortenUrl"; + } + + @GetMapping("/jeurl.com/{uniqueKey}") + public void redirectToOriginUrl(@PathVariable String uniqueKey, HttpServletResponse response) throws IOException { + String originUrl = urlService.getOriginUrl(uniqueKey); + + response.sendRedirect(originUrl); + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/domain/Url.java b/src/main/java/com/springboot/springbooturlshortner/domain/Url.java new file mode 100644 index 00000000..c56314eb --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/domain/Url.java @@ -0,0 +1,48 @@ +package com.springboot.springbooturlshortner.domain; + +import com.springboot.springbooturlshortner.exception.UrlException; +import com.springboot.springbooturlshortner.exception.UrlExceptionCode; +import jakarta.persistence.*; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +import java.util.regex.Pattern; + +@Entity +@Table(name = "urls") +@NoArgsConstructor +@Getter +@Slf4j +public class Url { + + private static final String ORIGIN_URL_PATTERN = "^(https?://).*"; + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "indexGenerator") + @SequenceGenerator(name = "indexGenerator", initialValue = 10000) + private Long id; + @Column(name = "originUrl") + private String originUrl; + @Column(name = "requestCnt") + private long requestCnt = 0; + + public Url(String originUrl) { + if (checkOriginUrl(originUrl)) { + this.originUrl = originUrl; + } else { + throw new UrlException(UrlExceptionCode.INVALID_ORIGIN_URL); + } + } + + public void increaseRequestCntOne() { + this.requestCnt++; + } + + private boolean checkOriginUrl(String originUrl) { + return Pattern.matches(ORIGIN_URL_PATTERN, originUrl); + } + + public void setId(Long id) { + this.id = id; + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/exception/GlobalExceptionHandler.java b/src/main/java/com/springboot/springbooturlshortner/exception/GlobalExceptionHandler.java new file mode 100644 index 00000000..fc8dafe4 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/exception/GlobalExceptionHandler.java @@ -0,0 +1,26 @@ +package com.springboot.springbooturlshortner.exception; + + +import lombok.extern.slf4j.Slf4j; +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; + +@Slf4j +@ControllerAdvice +public class GlobalExceptionHandler { + + @ExceptionHandler(UrlException.class) + public String handleUrlException(UrlException e, Model model) { + log.warn(e.getMessage()); + model.addAttribute("errorMessage", e.getMessage()); + return "errorPage"; + } + + @ExceptionHandler(Exception.class) + public String handleException(Exception e, Model model) { + log.warn(e.getMessage()); + model.addAttribute("errorMessage", "서버 에러가 발생했습니다."); + return "errorPage"; + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/exception/UrlException.java b/src/main/java/com/springboot/springbooturlshortner/exception/UrlException.java new file mode 100644 index 00000000..dbc5cdef --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/exception/UrlException.java @@ -0,0 +1,13 @@ +package com.springboot.springbooturlshortner.exception; + +import lombok.Getter; + +@Getter +public class UrlException extends RuntimeException { + + private final String message; + + public UrlException(UrlExceptionCode urlExceptionCode) { + this.message = urlExceptionCode.getMessage(); + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/exception/UrlExceptionCode.java b/src/main/java/com/springboot/springbooturlshortner/exception/UrlExceptionCode.java new file mode 100644 index 00000000..24d9797e --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/exception/UrlExceptionCode.java @@ -0,0 +1,17 @@ +package com.springboot.springbooturlshortner.exception; + +import lombok.Getter; + +@Getter +public enum UrlExceptionCode { + + NOT_FOUND("존재하지 않는 URL입니다."), + INVALID_ORIGIN_URL("올바르지 않은 URL 형식입니다."); + + private final String message; + + UrlExceptionCode(String message) { + this.message = message; + } + +} diff --git a/src/main/java/com/springboot/springbooturlshortner/repository/UrlRepository.java b/src/main/java/com/springboot/springbooturlshortner/repository/UrlRepository.java new file mode 100644 index 00000000..458f2279 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/repository/UrlRepository.java @@ -0,0 +1,9 @@ +package com.springboot.springbooturlshortner.repository; + +import com.springboot.springbooturlshortner.domain.Url; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface UrlRepository extends JpaRepository { +} \ No newline at end of file diff --git a/src/main/java/com/springboot/springbooturlshortner/service/ShortenUrlRequestDto.java b/src/main/java/com/springboot/springbooturlshortner/service/ShortenUrlRequestDto.java new file mode 100644 index 00000000..9d7b4ae7 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/service/ShortenUrlRequestDto.java @@ -0,0 +1,16 @@ +package com.springboot.springbooturlshortner.service; + +import com.springboot.springbooturlshortner.domain.Url; +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class ShortenUrlRequestDto { + + private String originUrl; + + public Url toUrlEntity() { + return new Url(originUrl); + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/service/UrlService.java b/src/main/java/com/springboot/springbooturlshortner/service/UrlService.java new file mode 100644 index 00000000..60e17731 --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/service/UrlService.java @@ -0,0 +1,39 @@ +package com.springboot.springbooturlshortner.service; + +import com.springboot.springbooturlshortner.domain.Url; +import com.springboot.springbooturlshortner.exception.UrlException; +import com.springboot.springbooturlshortner.exception.UrlExceptionCode; +import com.springboot.springbooturlshortner.repository.UrlRepository; +import com.springboot.springbooturlshortner.util.Base62Util; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@RequiredArgsConstructor +@Slf4j +public class UrlService { + + private final UrlRepository urlRepository; + private final Base62Util base62Util; + @Value("${spring.start-url}") + private String startUrl; + + @Transactional + public String createShortenUrl(ShortenUrlRequestDto shortenUrlRequestDto) { + Url url = urlRepository.save(shortenUrlRequestDto.toUrlEntity()); + String shortenUrl = startUrl + "/" + base62Util.encoding(url.getId()); + + return shortenUrl; + } + + @Transactional + public String getOriginUrl(String shortenUrl) { + Url url = urlRepository.findById(base62Util.decoding(shortenUrl)).orElseThrow(() -> new UrlException(UrlExceptionCode.NOT_FOUND)); + url.increaseRequestCntOne(); + + return url.getOriginUrl(); + } +} diff --git a/src/main/java/com/springboot/springbooturlshortner/util/Base62Util.java b/src/main/java/com/springboot/springbooturlshortner/util/Base62Util.java new file mode 100644 index 00000000..29379c1b --- /dev/null +++ b/src/main/java/com/springboot/springbooturlshortner/util/Base62Util.java @@ -0,0 +1,30 @@ +package com.springboot.springbooturlshortner.util; + +import org.springframework.stereotype.Component; + +@Component +public class Base62Util { + + private final String BASE62_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; + private final int BASE62_CHARS_SIZE = 62; + + public String encoding(long urlId) { + StringBuffer sb = new StringBuffer(); + int charactersLength = BASE62_CHARS.length(); + while (urlId > 0) { + sb.append(BASE62_CHARS.charAt((int) (urlId % charactersLength))); + urlId /= BASE62_CHARS_SIZE; + } + return sb.toString(); + } + + public long decoding(String uniqueKey) { + long urlId = 0, power = 1; + for (int i = 0; i < uniqueKey.length(); i++) { + urlId += BASE62_CHARS.indexOf(uniqueKey.charAt(i)) * power; + power *= BASE62_CHARS_SIZE; + } + return urlId; + } + +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..11bfeeea --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,16 @@ +spring: + jpa: + properties: + hibernate: + format_sql: true + show-sql: true + hibernate: + ddl-auto: create + + datasource: + url: jdbc:mysql://localhost:3306/shorten_url + driver-class-name: com.mysql.cj.jdbc.Driver + username: root + password: "#e020221" + + start-url: http://localhost:8080/jeurl.com diff --git a/src/main/resources/templates/errorPage.html b/src/main/resources/templates/errorPage.html new file mode 100644 index 00000000..002e9364 --- /dev/null +++ b/src/main/resources/templates/errorPage.html @@ -0,0 +1,15 @@ + + + + + + + + 에러 페이지 + + + +

Error Page

+

+ + \ No newline at end of file diff --git a/src/main/resources/templates/shortenUrl.html b/src/main/resources/templates/shortenUrl.html new file mode 100644 index 00000000..b4f5323d --- /dev/null +++ b/src/main/resources/templates/shortenUrl.html @@ -0,0 +1,31 @@ + + + + + + + + url 단축 + + + +

URL Shortener

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

Your Shorten URL:

+ +
+ + \ No newline at end of file diff --git a/src/test/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplicationTests.java b/src/test/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplicationTests.java new file mode 100644 index 00000000..64c64a15 --- /dev/null +++ b/src/test/java/com/springboot/springbooturlshortner/SpringbootUrlShortnerApplicationTests.java @@ -0,0 +1,13 @@ +package com.springboot.springbooturlshortner; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringbootUrlShortnerApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/springboot/springbooturlshortner/controller/UrlControllerTest.java b/src/test/java/com/springboot/springbooturlshortner/controller/UrlControllerTest.java new file mode 100644 index 00000000..cc3520ce --- /dev/null +++ b/src/test/java/com/springboot/springbooturlshortner/controller/UrlControllerTest.java @@ -0,0 +1,60 @@ +package com.springboot.springbooturlshortner.controller; + +import com.springboot.springbooturlshortner.service.ShortenUrlRequestDto; +import com.springboot.springbooturlshortner.service.UrlService; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.when; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +@WebMvcTest(UrlController.class) +class UrlControllerTest { + + @Autowired + private MockMvc mockMvc; + @MockBean + private UrlService urlService; + @Value("${spring.start-url}") + private String startUrl; + + @Test + @DisplayName("url 단축 요청 성공") + void Success_ShrotenUrl() throws Exception { + // given + String originUrl = "https://test-url"; + String shortenUrl = startUrl + "/" + "testkey"; + when(urlService.createShortenUrl(any(ShortenUrlRequestDto.class))).thenReturn(shortenUrl); + + // when, then + mockMvc.perform(MockMvcRequestBuilders.post("/shorten-url") + .param("originUrl", originUrl) // URL 인코딩이 필요한 경우에는 여기에서 수행 + .contentType("application/x-www-form-urlencoded")) + .andExpect(status().isOk()) + .andDo(print()) + .andExpect(view().name("shortenUrl")) + .andExpect(model().attribute("shortenUrl", shortenUrl)); + } + + @Test + @DisplayName("기존 url로 리다이렉트 성공") + void Success_RedirectToOriginUrl() throws Exception { + // given + String originUrl = "https://test-url"; + String uniqueKey = "testkey"; + when(urlService.getOriginUrl(uniqueKey)).thenReturn(originUrl); + + // when + mockMvc.perform(MockMvcRequestBuilders.get("/jeurl.com/{uniqueKey}", uniqueKey)) + .andExpect(status().is3xxRedirection()) + .andExpect(redirectedUrl(originUrl)); + } +} \ No newline at end of file diff --git a/src/test/java/com/springboot/springbooturlshortner/service/UrlServiceTest.java b/src/test/java/com/springboot/springbooturlshortner/service/UrlServiceTest.java new file mode 100644 index 00000000..b926826f --- /dev/null +++ b/src/test/java/com/springboot/springbooturlshortner/service/UrlServiceTest.java @@ -0,0 +1,108 @@ +package com.springboot.springbooturlshortner.service; + +import com.springboot.springbooturlshortner.domain.Url; +import com.springboot.springbooturlshortner.exception.UrlException; +import com.springboot.springbooturlshortner.exception.UrlExceptionCode; +import com.springboot.springbooturlshortner.repository.UrlRepository; +import com.springboot.springbooturlshortner.util.Base62Util; +import org.junit.jupiter.api.Assertions; +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.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.beans.factory.annotation.Value; + +import java.util.Optional; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.when; + +@ExtendWith(MockitoExtension.class) +class UrlServiceTest { + + @InjectMocks + private UrlService urlService; + @InjectMocks + private Base62Util base62Util; + @Mock + private UrlRepository urlRepository; + @Value("${spring.start-url}") + private String startUrl; + + @BeforeEach + void setUp() { + urlService = new UrlService(urlRepository, base62Util); + } + + @Test + @DisplayName("단축 url 생성 성공") + void Success_CreateShortenUrl() { + // given + String originUrl = "https://test-url"; + ShortenUrlRequestDto shortenUrlRequestDto = new ShortenUrlRequestDto(originUrl); + Url url = shortenUrlRequestDto.toUrlEntity(); + url.setId(10000L); + String expectedShortenUrl = startUrl + "/" + base62Util.encoding(url.getId()); + when(urlRepository.save(any(Url.class))).thenReturn(url); + + // when + String resultShortenUrl = urlService.createShortenUrl(shortenUrlRequestDto); + + // then + Assertions.assertEquals(expectedShortenUrl, resultShortenUrl); + } + + @Test + @DisplayName("단축 url 생성 실패 - 유효하지 않은 기존 url") + void Fail_CreateShortenUrl_With_InvalidOriginUrl() { + // given + String originUrl = "htt://test-url"; + ShortenUrlRequestDto shortenUrlRequestDto = new ShortenUrlRequestDto(originUrl); + + // when + UrlException e = Assertions.assertThrows(UrlException.class, () -> urlService.createShortenUrl(shortenUrlRequestDto)); + + // then + Assertions.assertEquals(UrlExceptionCode.INVALID_ORIGIN_URL.getMessage(), e.getMessage()); + } + + @Test + @DisplayName("기존 url 반환 성공") + void Success_GetOriginUrl() { + // given + String expectedOriginUrl = "https://test-url"; + ShortenUrlRequestDto shortenUrlRequestDto = new ShortenUrlRequestDto(expectedOriginUrl); + Url url = shortenUrlRequestDto.toUrlEntity(); + url.setId(10000L); + String shortenUrl = startUrl + "/" + base62Util.encoding(url.getId()); + when(urlRepository.findById(any(Long.class))).thenReturn(Optional.of(url)); + + // when + String resultOriginUrl = urlService.getOriginUrl(shortenUrl); + + // then + Assertions.assertEquals(expectedOriginUrl, resultOriginUrl); + } + + @Test + @DisplayName("단축 url 생성 실패 - 존재하지 않는 단축 url") + void Fail_GetOriginUrl_With_NotExistingShortenUrl() { + // given + String expectedOriginUrl = "https://test-url"; + ShortenUrlRequestDto shortenUrlRequestDto = new ShortenUrlRequestDto(expectedOriginUrl); + Url url = shortenUrlRequestDto.toUrlEntity(); + url.setId(10000L); + String shortenUrl = startUrl + "/" + base62Util.encoding(url.getId()) + "test"; + when(urlRepository.findById(any(Long.class))).thenReturn(Optional.empty()); + + // when + UrlException e = Assertions.assertThrows(UrlException.class, () -> urlService.getOriginUrl(shortenUrl)); + + // then + Assertions.assertEquals(UrlExceptionCode.NOT_FOUND.getMessage(), e.getMessage()); + } + +} \ No newline at end of file