diff --git a/urlshortener/.gitignore b/urlshortener/.gitignore new file mode 100644 index 00000000..a281dd40 --- /dev/null +++ b/urlshortener/.gitignore @@ -0,0 +1,38 @@ +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/ +.DS_Store diff --git a/urlshortener/build.gradle b/urlshortener/build.gradle new file mode 100644 index 00000000..a695eac1 --- /dev/null +++ b/urlshortener/build.gradle @@ -0,0 +1,44 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.2.0' + id 'io.spring.dependency-management' version '1.1.4' +} + +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-web' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + + //MySQL + runtimeOnly 'com.mysql:mysql-connector-j' + + //validation + implementation 'org.springframework.boot:spring-boot-starter-validation' + + //thymeleaf + implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' + +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/urlshortener/gradle/wrapper/gradle-wrapper.jar b/urlshortener/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..d64cd491 Binary files /dev/null and b/urlshortener/gradle/wrapper/gradle-wrapper.jar differ diff --git a/urlshortener/gradle/wrapper/gradle-wrapper.properties b/urlshortener/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..1af9e093 --- /dev/null +++ b/urlshortener/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/urlshortener/gradlew b/urlshortener/gradlew new file mode 100755 index 00000000..1aa94a42 --- /dev/null +++ b/urlshortener/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/urlshortener/gradlew.bat b/urlshortener/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/urlshortener/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/urlshortener/settings.gradle b/urlshortener/settings.gradle new file mode 100644 index 00000000..2491c172 --- /dev/null +++ b/urlshortener/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'urlshortener' diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/UrlShortenerApplication.java b/urlshortener/src/main/java/com/prgrms/url_shortener/UrlShortenerApplication.java new file mode 100644 index 00000000..4eef0d67 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/UrlShortenerApplication.java @@ -0,0 +1,13 @@ +package com.prgrms.url_shortener; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class UrlShortenerApplication { + + public static void main(String[] args) { + SpringApplication.run(UrlShortenerApplication.class, args); + } + +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/algorithm/Base62Encoder.java b/urlshortener/src/main/java/com/prgrms/url_shortener/algorithm/Base62Encoder.java new file mode 100644 index 00000000..2c84d9aa --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/algorithm/Base62Encoder.java @@ -0,0 +1,31 @@ +package com.prgrms.url_shortener.algorithm; + +import lombok.AccessLevel; +import lombok.NoArgsConstructor; +import org.springframework.stereotype.Component; + +@Component +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class Base62Encoder { + + private static final char[] BASE62_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789".toCharArray(); + private static final int BASE62_LENGTH = 62; + + public static String encode(Long value) { + final StringBuilder sb = new StringBuilder(); + while (value > 0) { + char encodedChar = BASE62_CHARS[(int) (value % BASE62_LENGTH)]; + sb.append(encodedChar); + value /= BASE62_LENGTH; + } + return sb.toString(); + } + + public static Long decode(String value) { + long result = 0; + for (int i = 0; i < value.length(); i++) { + result += new String(BASE62_CHARS).indexOf(value.charAt(i)); + } + return result; + } +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/controller/UrlController.java b/urlshortener/src/main/java/com/prgrms/url_shortener/controller/UrlController.java new file mode 100644 index 00000000..c3e783a6 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/controller/UrlController.java @@ -0,0 +1,40 @@ +package com.prgrms.url_shortener.controller; + +import com.prgrms.url_shortener.dto.ShortenUrlRequest; +import com.prgrms.url_shortener.dto.ShortenUrlResponse; +import com.prgrms.url_shortener.service.UrlService; +import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; +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; + +@Controller +@RequiredArgsConstructor +public class UrlController { + + private final UrlService urlService; + + @GetMapping + public String home() { + return "index"; + } + + @PostMapping("/url") + public String getShortenUrl(@Valid @ModelAttribute ShortenUrlRequest request, Model model) { + ShortenUrlResponse response = urlService.getShortUrl(request); + model.addAttribute("shortenUrl", response.shortenUrl()); + model.addAttribute("requestCount", response.requestCount()); + + return "index"; + } + + @GetMapping("/url/{shortUri}") + public String redirectOriginUrl(@PathVariable String shortUri) { + String originUrl = urlService.getOriginUrl(shortUri); + return "redirect:" + originUrl; + } +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlRequest.java b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlRequest.java new file mode 100644 index 00000000..c113a3d5 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlRequest.java @@ -0,0 +1,12 @@ +package com.prgrms.url_shortener.dto; + +import com.prgrms.url_shortener.dto.valid.UrlValid; +import jakarta.validation.constraints.Size; + +public record ShortenUrlRequest( + @UrlValid + @Size(max = 255, message = "URL은 255자 이내입니다.") + String originUrl +) { + +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlResponse.java b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlResponse.java new file mode 100644 index 00000000..6b0a4b43 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/ShortenUrlResponse.java @@ -0,0 +1,8 @@ +package com.prgrms.url_shortener.dto; + +public record ShortenUrlResponse( + String shortenUrl, + int requestCount +) { + +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValid.java b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValid.java new file mode 100644 index 00000000..ba916865 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValid.java @@ -0,0 +1,20 @@ +package com.prgrms.url_shortener.dto.valid; + +import jakarta.validation.Constraint; +import jakarta.validation.Payload; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target(ElementType.FIELD) +@Retention(RetentionPolicy.RUNTIME) +@Constraint(validatedBy = UrlValidation.class) +public @interface UrlValid { + + String message() default "URL 형식이 올바르지 않습니다."; + + Class[] groups() default {}; + + Class[] payload() default {}; +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValidation.java b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValidation.java new file mode 100644 index 00000000..fc42f661 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/dto/valid/UrlValidation.java @@ -0,0 +1,32 @@ +package com.prgrms.url_shortener.dto.valid; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; +import java.net.URL; +import java.net.URLConnection; + +public class UrlValidation implements ConstraintValidator { + + private static final String HTTPS_PROTOCOL = "https://"; + private static final String HTTP_PROTOCOL = "http://"; + + @Override + public boolean isValid(String value, ConstraintValidatorContext context) { + try { + if (hasNotProtocol(value)) { + value = HTTPS_PROTOCOL + value; + } + + URL url = new URL(value); + URLConnection conn = url.openConnection(); + conn.connect(); + } catch (Exception e) { + return false; + } + return true; + } + + private boolean hasNotProtocol(String originUrl) { + return !(originUrl.startsWith(HTTPS_PROTOCOL) || originUrl.startsWith(HTTP_PROTOCOL)); + } +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/entity/Url.java b/urlshortener/src/main/java/com/prgrms/url_shortener/entity/Url.java new file mode 100644 index 00000000..faa4631c --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/entity/Url.java @@ -0,0 +1,37 @@ +package com.prgrms.url_shortener.entity; + +import static jakarta.persistence.GenerationType.IDENTITY; +import static lombok.AccessLevel.PROTECTED; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Getter +@NoArgsConstructor(access = PROTECTED) +public class Url { + + @Id + @GeneratedValue(strategy = IDENTITY) + @Column(name = "url_id") + private Long id; + + @Column(name = "origin_url", unique = true, nullable = false) + private String originUrl; + + @Column(name = "request_count") + private int requestCount; + + public Url(String originUrl) { + this.originUrl = originUrl; + this.requestCount = 1; + } + + public void increaseRequestCount() { + requestCount++; + } +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/exception/CustomException.java b/urlshortener/src/main/java/com/prgrms/url_shortener/exception/CustomException.java new file mode 100644 index 00000000..78d35b8f --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/exception/CustomException.java @@ -0,0 +1,11 @@ +package com.prgrms.url_shortener.exception; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class CustomException extends RuntimeException { + + private final String message; +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/exception/GlobalExceptionHandler.java b/urlshortener/src/main/java/com/prgrms/url_shortener/exception/GlobalExceptionHandler.java new file mode 100644 index 00000000..3e43c202 --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/exception/GlobalExceptionHandler.java @@ -0,0 +1,47 @@ +package com.prgrms.url_shortener.exception; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.ui.Model; +import org.springframework.validation.FieldError; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; + +@ControllerAdvice +@Slf4j +public class GlobalExceptionHandler { + + @ExceptionHandler(MethodArgumentNotValidException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + public String handleMethodArgumentNotValidException(MethodArgumentNotValidException exception, + Model model) { + log.error("handleMethodArgumentNotValidException", exception); + + StringBuilder sb = new StringBuilder(); + for (FieldError e : exception.getBindingResult().getFieldErrors()) { + sb.append(e.getDefaultMessage()); + sb.append(", "); + } + + model.addAttribute("errorMessage", sb.toString()); + return "errorPage"; + } + + @ExceptionHandler(CustomException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + public String handleCustomException(final CustomException exception, Model model) { + log.error("handleCustomException", exception); + model.addAttribute("errorMessage", exception.getMessage()); + return "errorPage"; + } + + @ExceptionHandler(Exception.class) + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + protected String handleException(final Exception exception, Model model) { + log.error("handleException", exception); + model.addAttribute("errorMessage", "서버에 오류가 발생하였습니다."); + return "errorPage"; + } +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/repository/UrlRepository.java b/urlshortener/src/main/java/com/prgrms/url_shortener/repository/UrlRepository.java new file mode 100644 index 00000000..7ac9722c --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/repository/UrlRepository.java @@ -0,0 +1,12 @@ +package com.prgrms.url_shortener.repository; + +import com.prgrms.url_shortener.entity.Url; +import java.util.Optional; +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UrlRepository extends JpaRepository { + + Optional findByOriginUrl(String originUrl); + + boolean existsByOriginUrl(String originUrl); +} diff --git a/urlshortener/src/main/java/com/prgrms/url_shortener/service/UrlService.java b/urlshortener/src/main/java/com/prgrms/url_shortener/service/UrlService.java new file mode 100644 index 00000000..b03714ed --- /dev/null +++ b/urlshortener/src/main/java/com/prgrms/url_shortener/service/UrlService.java @@ -0,0 +1,52 @@ +package com.prgrms.url_shortener.service; + +import com.prgrms.url_shortener.algorithm.Base62Encoder; +import com.prgrms.url_shortener.dto.ShortenUrlRequest; +import com.prgrms.url_shortener.dto.ShortenUrlResponse; +import com.prgrms.url_shortener.entity.Url; +import com.prgrms.url_shortener.exception.CustomException; +import com.prgrms.url_shortener.repository.UrlRepository; +import lombok.RequiredArgsConstructor; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@RequiredArgsConstructor +public class UrlService { + + private final UrlRepository urlRepository; + + @Value("${spring.base-url}") + private String BASE_URL; + + @Transactional + public ShortenUrlResponse getShortUrl(ShortenUrlRequest request) { + Url savedUrl = getSavedUrl(request.originUrl()); + + savedUrl.increaseRequestCount(); + String shortenUrl = BASE_URL + "/" + Base62Encoder.encode(savedUrl.getId()); + + return new ShortenUrlResponse(shortenUrl, savedUrl.getRequestCount()); + } + + @Transactional(readOnly = true) + public String getOriginUrl(String shortUri) { + Long urlId = Base62Encoder.decode(shortUri); + Url url = urlRepository.findById(urlId).orElseThrow(() -> { + throw new CustomException("존재하지 않는 URL입니다."); + }); + + return url.getOriginUrl(); + } + + private Url getSavedUrl(String originUrl) { + Url savedUrl; + if (urlRepository.existsByOriginUrl(originUrl)) { + savedUrl = urlRepository.findByOriginUrl(originUrl).orElseThrow(); + } else { + savedUrl = urlRepository.save(new Url(originUrl)); + } + return savedUrl; + } +} diff --git a/urlshortener/src/main/resources/application.yml b/urlshortener/src/main/resources/application.yml new file mode 100644 index 00000000..0a0d6ae1 --- /dev/null +++ b/urlshortener/src/main/resources/application.yml @@ -0,0 +1,17 @@ +spring: + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: jdbc:mysql://localhost:3304/url_shortener + username: root + password: root1234! + + jpa: + hibernate: + ddl-auto: none + show-sql: true + properties: + hibernate: + format_sql: true + open-in-view: false + + base-url : http://localhost:8080/url \ No newline at end of file diff --git a/urlshortener/src/main/resources/templates/errorPage.html b/urlshortener/src/main/resources/templates/errorPage.html new file mode 100644 index 00000000..34d44468 --- /dev/null +++ b/urlshortener/src/main/resources/templates/errorPage.html @@ -0,0 +1,17 @@ + + + + + 에러 페이지 + + + + +
+

Error Page

+

+ 홈으로 이동 +
+ + + \ No newline at end of file diff --git a/urlshortener/src/main/resources/templates/index.html b/urlshortener/src/main/resources/templates/index.html new file mode 100644 index 00000000..7c0edcec --- /dev/null +++ b/urlshortener/src/main/resources/templates/index.html @@ -0,0 +1,31 @@ + + + + + Short URL Generator + + + + + +
+
URL Shortener
+
+
+ + +
+ +
+
+ +
+ Your Shortened URL: + Shortened Link +
+
+ Request Count: +
+
+ + \ No newline at end of file diff --git a/urlshortener/src/test/java/com/prgrms/url_shortener/controller/UrlControllerTest.java b/urlshortener/src/test/java/com/prgrms/url_shortener/controller/UrlControllerTest.java new file mode 100644 index 00000000..8dbb1aa4 --- /dev/null +++ b/urlshortener/src/test/java/com/prgrms/url_shortener/controller/UrlControllerTest.java @@ -0,0 +1,35 @@ +package com.prgrms.url_shortener.controller; + +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.prgrms.url_shortener.dto.ShortenUrlRequest; +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.WebMvcTest; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.web.bind.MethodArgumentNotValidException; + +@WebMvcTest(controllers = UrlController.class) +class UrlControllerTest { + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @DisplayName("shortenUrl 생성 시 요청 URL이 유효하지 않으면 예외를 반환한다.") + @Test + void getShortenUrl_fail() throws Exception { + String originUrl = "https://not-existing-url"; + ShortenUrlRequest request = new ShortenUrlRequest(originUrl); + + mockMvc.perform(post("/url") + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isBadRequest()) + .andExpect(result -> assertTrue(result.getResolvedException() instanceof MethodArgumentNotValidException)); + } +} \ No newline at end of file diff --git a/urlshortener/src/test/java/com/prgrms/url_shortener/service/UrlServiceTest.java b/urlshortener/src/test/java/com/prgrms/url_shortener/service/UrlServiceTest.java new file mode 100644 index 00000000..dba5b6dc --- /dev/null +++ b/urlshortener/src/test/java/com/prgrms/url_shortener/service/UrlServiceTest.java @@ -0,0 +1,70 @@ +package com.prgrms.url_shortener.service; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.when; + +import com.prgrms.url_shortener.algorithm.Base62Encoder; +import com.prgrms.url_shortener.dto.ShortenUrlRequest; +import com.prgrms.url_shortener.dto.ShortenUrlResponse; +import com.prgrms.url_shortener.entity.Url; +import com.prgrms.url_shortener.repository.UrlRepository; +import java.util.Optional; +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.test.util.ReflectionTestUtils; + + +@ExtendWith(MockitoExtension.class) +class UrlServiceTest { + @Mock + private UrlRepository repository; + + @InjectMocks + private UrlService service; + + @DisplayName("Base62인코딩으로 shortenUrl을 생성할 수 있다.") + @Test + void create_url() { + //given + String originUrl = "https://daum.net"; + ShortenUrlRequest request = new ShortenUrlRequest(originUrl); + + Url url = new Url(originUrl); + ReflectionTestUtils.setField(url, "id", 1L); + + when(repository.existsByOriginUrl(originUrl)).thenReturn(false); + when(repository.save(any(Url.class))).thenReturn(url); + String shortUri = Base62Encoder.encode(1L); + + //when + ShortenUrlResponse response = service.getShortUrl(request); + + //then + assertThat(response.shortenUrl()).endsWith(shortUri); + } + + + @DisplayName("shortUri을 디코딩하여 DB에 저장된 originUrl을 가져올 수 있다.") + @Test + void get_origin_url() { + //given + String expectedOriginUrl = "https://daum.net"; + Url url = new Url(expectedOriginUrl); + ReflectionTestUtils.setField(url, "id", 1L); + + String shortUri = Base62Encoder.encode(1L); + + when(repository.findById(any(Long.class))).thenReturn(Optional.of(url)); + + //when + String actualOriginUrl = service.getOriginUrl(shortUri); + + //then + assertThat(actualOriginUrl).isEqualTo(expectedOriginUrl); + } +} \ No newline at end of file