diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..789343b0 --- /dev/null +++ b/build.gradle @@ -0,0 +1,39 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.2.0' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'org.prgms' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter' + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'com.mysql:mysql-connector-j:8.2.0' + implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + testCompileOnly 'org.projectlombok:lombok' + testAnnotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..e69de29b diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..3fa8f862 --- /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.4-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/src/main/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplication.java b/src/main/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplication.java new file mode 100644 index 00000000..2d3c3059 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplication.java @@ -0,0 +1,11 @@ +package org.prgms.springbooturlshortener; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringBootUrlShortenerApplication { + public static void main(String[] args) { + SpringApplication.run(SpringBootUrlShortenerApplication.class); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/config/WebMvcConfig.java b/src/main/java/org/prgms/springbooturlshortener/config/WebMvcConfig.java new file mode 100644 index 00000000..949ce8f4 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/config/WebMvcConfig.java @@ -0,0 +1,13 @@ +package org.prgms.springbooturlshortener.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +public class WebMvcConfig implements WebMvcConfigurer { + @Override + public void addResourceHandlers(ResourceHandlerRegistry registry) { + registry.addResourceHandler("favicon.ico").resourceChain(false); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/ShortUrl.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/ShortUrl.java new file mode 100644 index 00000000..f4475cd0 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/ShortUrl.java @@ -0,0 +1,51 @@ +package org.prgms.springbooturlshortener.domain.shorturl; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.hibernate.annotations.DynamicInsert; +import org.hibernate.annotations.DynamicUpdate; +import org.prgms.springbooturlshortener.domain.shorturl.common.ShortUrlUtil; +import org.prgms.springbooturlshortener.domain.shorturl.service.dto.TransformedShortUrlDto; + +import java.time.LocalDateTime; + +@Entity +@NoArgsConstructor +@DynamicInsert +@DynamicUpdate +public class ShortUrl { + @Id + @Getter + @Column(name = "transformed_url") + private String transformedUrl; + + @Getter + @Column(name = "original_url", unique = true, nullable = false) + private String originalUrl; + + @Column(name = "visit_count", nullable = false) + private Long visitCount; + + @Column(name = "last_visit_time") + private LocalDateTime lastVisitTime; + + @Builder + public ShortUrl(String transformedUrl, String originalUrl) { + this.transformedUrl = transformedUrl; + this.originalUrl = ShortUrlUtil.deleteProtocol(originalUrl); + this.visitCount = 0L; + this.lastVisitTime = null; + } + + public void increaseVisit() { + this.visitCount++; + } + + public TransformedShortUrlDto toTransformedShortUrlDto() { + return new TransformedShortUrlDto(this.transformedUrl, this.originalUrl, this.visitCount, this.lastVisitTime); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlConstant.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlConstant.java new file mode 100644 index 00000000..016a73e2 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlConstant.java @@ -0,0 +1,5 @@ +package org.prgms.springbooturlshortener.domain.shorturl.common; + +public class ShortUrlConstant { + public static final String[] PROTOCOLS = {"http://", "https://"}; +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlUtil.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlUtil.java new file mode 100644 index 00000000..fe21b6c7 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/common/ShortUrlUtil.java @@ -0,0 +1,9 @@ +package org.prgms.springbooturlshortener.domain.shorturl.common; + +import java.util.Arrays; + +public class ShortUrlUtil { + public static String deleteProtocol(String originalUrl) { + return Arrays.stream(ShortUrlConstant.PROTOCOLS).reduce(originalUrl, (url, protocol) -> url.replace(protocol, "")); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ExceptionController.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ExceptionController.java new file mode 100644 index 00000000..b8db1af0 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ExceptionController.java @@ -0,0 +1,31 @@ +package org.prgms.springbooturlshortener.domain.shorturl.controller; + +import lombok.extern.slf4j.Slf4j; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlException; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; + +@ControllerAdvice +@Slf4j +public class ExceptionController { + private static final int HTTP_500_ERROR_BOUND = 400; + @ExceptionHandler(UrlException.class) + public String showUrlErrorPage(UrlException ex) { + if (ex.getUrlErrorCode() > HTTP_500_ERROR_BOUND) { + log.warn("서버에서의 에러: {}", ex.getMessage()); + + return "error/500"; + } + + log.info("클라이언트에서 잘못된 입력. {}", ex.getMessage()); + + return "error/400"; + } + + @ExceptionHandler(Exception.class) + public String showDefaultError(Exception ex) { + log.error("예상하지 못한 에러 발생: {}", ex.getMessage()); + + return "error/500"; + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ShortUrlController.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ShortUrlController.java new file mode 100644 index 00000000..6fd74b52 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/controller/ShortUrlController.java @@ -0,0 +1,60 @@ +package org.prgms.springbooturlshortener.domain.shorturl.controller; + +import jakarta.servlet.http.HttpServletRequest; +import lombok.extern.slf4j.Slf4j; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlErrorCode; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlException; +import org.prgms.springbooturlshortener.domain.shorturl.service.ShortUrlService; +import org.prgms.springbooturlshortener.domain.shorturl.service.dto.TransformRequestUrlDto; +import org.prgms.springbooturlshortener.domain.shorturl.service.dto.TransformedShortUrlDto; +import org.springframework.stereotype.Controller; +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.servlet.mvc.support.RedirectAttributes; + +@Controller +@Slf4j +public class ShortUrlController { + + private final String REDIRECT_URL = "localhost:8080"; + private final ShortUrlService shortUrlService; + + public ShortUrlController(ShortUrlService shortUrlService) { + this.shortUrlService = shortUrlService; + } + + @GetMapping("/") + public String showMain() { + return "index"; + } + + @GetMapping("/{transformedUrl}") + public String redirectToOriginalUrl(@PathVariable String transformedUrl) { + String originalUrl = shortUrlService.getOriginalUrl(transformedUrl); + + return "redirect:https://" + originalUrl; + } + + @PostMapping("/shorten") + public String transformOriginalUrl(TransformRequestUrlDto transformRequestUrlDto, RedirectAttributes redirectAttributes) { + TransformedShortUrlDto transformedShortUrlDto = shortUrlService.saveOriginalUrl(transformRequestUrlDto.originalUrl()); + + redirectAttributes.addFlashAttribute("transformedShortUrlDto", transformedShortUrlDto); + + return "redirect:/shorten"; + } + + @GetMapping("/shorten") + public String showTransformedUrl(TransformedShortUrlDto transformedShortUrlDto, Model model) { + if (transformedShortUrlDto.shortUrl() == null) { + throw new UrlException(UrlErrorCode.ORIGINAL_URL_NOT_FOUND); + } + + model.addAttribute("transformedShortUrlDto", transformedShortUrlDto); + model.addAttribute("domain", REDIRECT_URL); + + return "short-url-info"; + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlErrorCode.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlErrorCode.java new file mode 100644 index 00000000..b55ae01e --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlErrorCode.java @@ -0,0 +1,14 @@ +package org.prgms.springbooturlshortener.domain.shorturl.exception; + +import lombok.Getter; + +@Getter +public enum UrlErrorCode { + ORIGINAL_URL_NOT_FOUND(1100); + + private final int errorCode; + + UrlErrorCode(int errorCode) { + this.errorCode = errorCode; + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlException.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlException.java new file mode 100644 index 00000000..1efbb38b --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/exception/UrlException.java @@ -0,0 +1,13 @@ +package org.prgms.springbooturlshortener.domain.shorturl.exception; + +public class UrlException extends RuntimeException { + private final UrlErrorCode urlErrorCode; + + public UrlException(UrlErrorCode urlErrorCode) { + this.urlErrorCode = urlErrorCode; + } + + public int getUrlErrorCode() { + return urlErrorCode.getErrorCode(); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/repository/ShortUrlRepository.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/repository/ShortUrlRepository.java new file mode 100644 index 00000000..79a9f7e7 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/repository/ShortUrlRepository.java @@ -0,0 +1,10 @@ +package org.prgms.springbooturlshortener.domain.shorturl.repository; + +import org.prgms.springbooturlshortener.domain.shorturl.ShortUrl; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.Optional; + +public interface ShortUrlRepository extends JpaRepository { + Optional findByOriginalUrl(String originalUrl); +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlService.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlService.java new file mode 100644 index 00000000..e75da32f --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlService.java @@ -0,0 +1,69 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service; + +import java.util.Optional; +import org.prgms.springbooturlshortener.domain.shorturl.ShortUrl; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlErrorCode; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlException; +import org.prgms.springbooturlshortener.domain.shorturl.repository.ShortUrlRepository; +import org.prgms.springbooturlshortener.domain.shorturl.service.dto.TransformedShortUrlDto; +import org.prgms.springbooturlshortener.domain.shorturl.service.transformer.UrlTransformer; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.stereotype.Service; + +@Service +public class ShortUrlService { + private final UrlTransformer urlTransformer; + private final ShortUrlRepository urlRepository; + + public ShortUrlService(@Qualifier("BASE62") UrlTransformer urlTransformer, ShortUrlRepository urlRepository) { + this.urlTransformer = urlTransformer; + this.urlRepository = urlRepository; + } + + public TransformedShortUrlDto saveOriginalUrl(String originalUrl) { + Optional foundShortUrl = urlRepository.findByOriginalUrl(originalUrl); + + if (foundShortUrl.isPresent()) { + ShortUrl shortUrl = foundShortUrl.get(); + return shortUrl.toTransformedShortUrlDto(); + } + + String generatedUrl = getRandomUrl(); + + ShortUrl savedShortUrl = getSavedShortUrl(originalUrl, generatedUrl); + + return savedShortUrl.toTransformedShortUrlDto(); + } + + public String getOriginalUrl(String transformedUrl) { + ShortUrl shortUrl = urlRepository.findById(transformedUrl) + .orElseThrow(() -> new UrlException(UrlErrorCode.ORIGINAL_URL_NOT_FOUND)); + + increaseVisit(shortUrl); + + return shortUrl.getOriginalUrl(); + } + + private ShortUrl getSavedShortUrl(String originalUrl, String generatedUrl) { + ShortUrl shortUrl = ShortUrl.builder() + .transformedUrl(generatedUrl) + .originalUrl(originalUrl) + .build(); + return urlRepository.save(shortUrl); + } + + private String getRandomUrl() { + String generatedUrl; + + do { + generatedUrl = urlTransformer.transform(); + } while (urlRepository.findById(generatedUrl).isPresent()); + + return generatedUrl; + } + + private void increaseVisit(ShortUrl shortUrl) { + shortUrl.increaseVisit(); + urlRepository.save(shortUrl); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformRequestUrlDto.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformRequestUrlDto.java new file mode 100644 index 00000000..288db780 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformRequestUrlDto.java @@ -0,0 +1,9 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service.dto; + +import org.prgms.springbooturlshortener.domain.shorturl.common.ShortUrlUtil; + +public record TransformRequestUrlDto (String originalUrl) { + public TransformRequestUrlDto(String originalUrl) { + this.originalUrl = ShortUrlUtil.deleteProtocol(originalUrl); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformedShortUrlDto.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformedShortUrlDto.java new file mode 100644 index 00000000..9a28018b --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/dto/TransformedShortUrlDto.java @@ -0,0 +1,9 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service.dto; + +import java.time.LocalDateTime; + +public record TransformedShortUrlDto (String shortUrl, + String originalUrl, + Long visitCount, + LocalDateTime lastVisitTime) { +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/Base62UrlTransformer.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/Base62UrlTransformer.java new file mode 100644 index 00000000..d8f614fa --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/Base62UrlTransformer.java @@ -0,0 +1,29 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service.transformer; + +import java.util.Random; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.stereotype.Component; + +@Component +@Qualifier("BASE62") +public class Base62UrlTransformer implements UrlTransformer{ + private static final String BASE62_TOKENS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + private static final short NUM_OF_URL = 6; + private static final int DIVIDE_NUM = 62; + + public String transform() { + Random random = new Random(); + int number = random.nextInt(0, Integer.MAX_VALUE); + + StringBuilder sb = new StringBuilder(); + + for (short i = 0; i < NUM_OF_URL; i++) { + char token = BASE62_TOKENS.charAt(number % DIVIDE_NUM); + + sb.append(token); + number /= DIVIDE_NUM; + } + + return sb.toString(); + } +} diff --git a/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/UrlTransformer.java b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/UrlTransformer.java new file mode 100644 index 00000000..3abfe007 --- /dev/null +++ b/src/main/java/org/prgms/springbooturlshortener/domain/shorturl/service/transformer/UrlTransformer.java @@ -0,0 +1,5 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service.transformer; + +public interface UrlTransformer { + String transform(); +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..3f682214 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,11 @@ +spring: + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + username: root + password: 1234 + url: jdbc:mysql://localhost:3306/prod + jpa: + properties: + hibernate: + show_sql: true + format_sql: true diff --git a/src/main/resources/schema.sql b/src/main/resources/schema.sql new file mode 100644 index 00000000..94fa0bb2 --- /dev/null +++ b/src/main/resources/schema.sql @@ -0,0 +1,7 @@ +CREATE TABLE IF NOT EXISTS short_url ( + transformed_url CHAR(6) PRIMARY KEY, + original_url VARCHAR(2047) NOT NULL, + visit_count BIGINT DEFAULT 0 NOT NULL, + last_visit_time TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), + INDEX idx_original_url (original_url(255)) +); diff --git a/src/main/resources/templates/error/400.html b/src/main/resources/templates/error/400.html new file mode 100644 index 00000000..18c655f2 --- /dev/null +++ b/src/main/resources/templates/error/400.html @@ -0,0 +1,11 @@ + + + + + Error Page 400 + + +클라 에러입니당. +홈으로 가기 + + diff --git a/src/main/resources/templates/error/500.html b/src/main/resources/templates/error/500.html new file mode 100644 index 00000000..9473bbce --- /dev/null +++ b/src/main/resources/templates/error/500.html @@ -0,0 +1,11 @@ + + + + + Error Page 500 + + +서버 에러입니당~ +홈으로 가기 + + diff --git a/src/main/resources/templates/index.html b/src/main/resources/templates/index.html new file mode 100644 index 00000000..d509083c --- /dev/null +++ b/src/main/resources/templates/index.html @@ -0,0 +1,19 @@ + + + + + URL Shortener + +
+ +
+ +

아래에 변환할 URL을 붙여 넣으세요!

+
+ + +
+ + diff --git a/src/main/resources/templates/short-url-info.html b/src/main/resources/templates/short-url-info.html new file mode 100644 index 00000000..7dde72fb --- /dev/null +++ b/src/main/resources/templates/short-url-info.html @@ -0,0 +1,44 @@ + + + + + url info + +
+ +
+ +

변환된 URL 정보

+
+
+ 변환된 URL:

+
+
+ 원본 URL:

+
+
+
+

+

+
+ + + + + + diff --git a/src/test/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplicationTest.java b/src/test/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplicationTest.java new file mode 100644 index 00000000..e37a0d7e --- /dev/null +++ b/src/test/java/org/prgms/springbooturlshortener/SpringBootUrlShortenerApplicationTest.java @@ -0,0 +1,11 @@ +package org.prgms.springbooturlshortener; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringBootUrlShortenerApplicationTest { + @Test + void contextLoad() { + } +} diff --git a/src/test/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlServiceTest.java b/src/test/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlServiceTest.java new file mode 100644 index 00000000..bfe95cf0 --- /dev/null +++ b/src/test/java/org/prgms/springbooturlshortener/domain/shorturl/service/ShortUrlServiceTest.java @@ -0,0 +1,85 @@ +package org.prgms.springbooturlshortener.domain.shorturl.service; + +import lombok.extern.slf4j.Slf4j; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.prgms.springbooturlshortener.domain.shorturl.ShortUrl; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlErrorCode; +import org.prgms.springbooturlshortener.domain.shorturl.exception.UrlException; +import org.prgms.springbooturlshortener.domain.shorturl.repository.ShortUrlRepository; +import org.prgms.springbooturlshortener.domain.shorturl.service.dto.TransformedShortUrlDto; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; + +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; + +@SpringBootTest +@Slf4j +class ShortUrlServiceTest { + @Autowired + private ShortUrlService shortUrlService; + @Autowired + private ShortUrlRepository shortUrlRepository; + + private final String preSavedOriginalUrl = "youtube.com"; + private TransformedShortUrlDto preSavedTransformedShortUrlDto; + + @BeforeEach + void setUp() { + preSavedTransformedShortUrlDto = shortUrlService.saveOriginalUrl(preSavedOriginalUrl); + } + + @AfterEach + void tearDown() { + shortUrlRepository.deleteAll(); + } + + @Test + @DisplayName("새로운 URL을 짧은 URL로 변환할 수 있다.") + void saveNewOriginalUrl() { + String originalUrl = "https://naver.com"; + TransformedShortUrlDto transformedUrl = shortUrlService.saveOriginalUrl(originalUrl); + + ShortUrl savedShortUrl = shortUrlRepository.findById(transformedUrl.shortUrl()) + .orElseThrow(() -> new UrlException(UrlErrorCode.ORIGINAL_URL_NOT_FOUND)); + + assertThat(savedShortUrl.getTransformedUrl()).isEqualTo(transformedUrl.shortUrl()); + } + + @Test + @DisplayName("이미 존재하는 URL이면 짧은 URL을 생성 없이 즉시 반환한다.") + void getAlreadyExistingOriginalUrl() { + TransformedShortUrlDto transformedShortUrlDto = shortUrlService.saveOriginalUrl(preSavedOriginalUrl); + + assertThat(transformedShortUrlDto.shortUrl()).isEqualTo(preSavedTransformedShortUrlDto.shortUrl()); + } + + @Test + @DisplayName("기존 URL을 가져올 수 있다.") + void getOriginalUrl() { + String originalUrl = shortUrlService.getOriginalUrl(preSavedTransformedShortUrlDto.shortUrl()); + + assertThat(originalUrl).isEqualTo(preSavedOriginalUrl); + } + + @Test + @DisplayName("짧은 URL을 이용해 기존 URL을 가져온다면 방문 횟수와 마지막 방문 일시가 수정되어야 한다.") + void updateLastVisitTimeAndVisitCountWhenFindUrl() { + shortUrlService.getOriginalUrl(preSavedTransformedShortUrlDto.shortUrl()); + + Optional shortUrl = shortUrlRepository.findById(preSavedTransformedShortUrlDto.shortUrl()); + + assertThat(shortUrl.isPresent()).isTrue(); + + TransformedShortUrlDto urlInfoAfterVisit = shortUrl.get().toTransformedShortUrlDto(); + + assertThat(urlInfoAfterVisit.lastVisitTime()).isNotEqualTo(preSavedTransformedShortUrlDto.lastVisitTime()); + assertThat(urlInfoAfterVisit.visitCount()).isEqualTo(preSavedTransformedShortUrlDto.visitCount() + 1); + + log.info("before lastVisitTime:{}, after lastVisitTime:{}", preSavedTransformedShortUrlDto.lastVisitTime(), urlInfoAfterVisit.lastVisitTime()); + } +} diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml new file mode 100644 index 00000000..8dbfcc1b --- /dev/null +++ b/src/test/resources/application.yml @@ -0,0 +1,11 @@ +spring: + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + username: root + password: 1234 + url: jdbc:mysql://localhost:3306/test + jpa: + properties: + hibernate: + show_sql: true + format_sql: true