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..a631ec98 --- /dev/null +++ b/build.gradle @@ -0,0 +1,38 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '2.7.16' + id 'io.spring.dependency-management' version '1.0.15.RELEASE' +} + +group = 'com.prgrms' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = "16" +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + annotationProcessor 'org.projectlombok:lombok' + implementation 'org.springframework.boot:spring-boot-starter-validation' + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('test') { + useJUnitPlatform() +} +targetCompatibility = JavaVersion.VERSION_16 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..033e24c4 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..9f4197d5 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 00000000..fcb6fca1 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..07dc400b --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'shorturl' diff --git a/src/main/java/com/prgrms/shorturl/ShorturlApplication.java b/src/main/java/com/prgrms/shorturl/ShorturlApplication.java new file mode 100644 index 00000000..441f3126 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/ShorturlApplication.java @@ -0,0 +1,13 @@ +package com.prgrms.shorturl; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class ShorturlApplication { + + public static void main(String[] args) { + SpringApplication.run(ShorturlApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/algorithm/Algorithm.java b/src/main/java/com/prgrms/shorturl/algorithm/Algorithm.java new file mode 100644 index 00000000..43140189 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/algorithm/Algorithm.java @@ -0,0 +1,8 @@ +package com.prgrms.shorturl.algorithm; + +public interface Algorithm { + + String encode(Long id); + + Long decode(String shortUrl); +} diff --git a/src/main/java/com/prgrms/shorturl/algorithm/AlgorithmType.java b/src/main/java/com/prgrms/shorturl/algorithm/AlgorithmType.java new file mode 100644 index 00000000..2f30789e --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/algorithm/AlgorithmType.java @@ -0,0 +1,5 @@ +package com.prgrms.shorturl.algorithm; + +public enum AlgorithmType { + BASE62 +} diff --git a/src/main/java/com/prgrms/shorturl/algorithm/Base62.java b/src/main/java/com/prgrms/shorturl/algorithm/Base62.java new file mode 100644 index 00000000..c1e92b22 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/algorithm/Base62.java @@ -0,0 +1,60 @@ +package com.prgrms.shorturl.algorithm; + +import org.springframework.stereotype.Component; + +@Component +public class Base62 implements Algorithm { + + private static final String TOKENS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + + private static final int BASE62_LENGTH = 62; + private static final int SHORTEN_URL_LENGTH = 8; + private static final String PADDING_TOKEN = "A"; + + /** + * db에서 자동 생성된 id 값을 인코딩 + */ + @Override + public String encode(Long id) { + StringBuilder encodedTokenBuilder = new StringBuilder(); + + if (id > 0) { + encodedTokenBuilder.append(TOKENS.charAt((int)(id % BASE62_LENGTH))); + id /= BASE62_LENGTH; + } + + return padding(encodedTokenBuilder.toString()); + } + + @Override + public Long decode(String shortUrl) { + long originId = 0; + long power = 1; + + for (int i = 0; i < shortUrl.length(); i++) { + originId += TOKENS.indexOf(shortUrl.charAt(i)) * power; + power *= BASE62_LENGTH; + } + + return originId; + } + + /** + * 인코딩 된 url 길이가 8 미만일 경우 -> 길이 통일화 + */ + public String padding(String shortUrl) { + StringBuilder unificateTokenBuilder = new StringBuilder(); + + if (shortUrl.length() < SHORTEN_URL_LENGTH) { + int padding_count = SHORTEN_URL_LENGTH - shortUrl.length(); + + for (int i = 0; i < padding_count; i++) { + unificateTokenBuilder.append(PADDING_TOKEN); + } + + return unificateTokenBuilder.append(shortUrl).toString(); + } + + return shortUrl; + } +} diff --git a/src/main/java/com/prgrms/shorturl/common/exception/BaseException.java b/src/main/java/com/prgrms/shorturl/common/exception/BaseException.java new file mode 100644 index 00000000..de517afa --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/common/exception/BaseException.java @@ -0,0 +1,11 @@ +package com.prgrms.shorturl.common.exception; + +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@RequiredArgsConstructor +@Getter +public class BaseException extends RuntimeException{ + + private final ErrorCode errorCode; +} diff --git a/src/main/java/com/prgrms/shorturl/common/exception/ErrorCode.java b/src/main/java/com/prgrms/shorturl/common/exception/ErrorCode.java new file mode 100644 index 00000000..3e84603d --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/common/exception/ErrorCode.java @@ -0,0 +1,15 @@ +package com.prgrms.shorturl.common.exception; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@AllArgsConstructor +@Getter +public enum ErrorCode { + + NOT_FOUND_URL("U001", "해당 URL을 찾을 수 없습니다"), + INVALID_URL_FORMAT("u002", "올바른 URL 형식이 아닙니다."); + + private String code; + private String errorMessage; +} diff --git a/src/main/java/com/prgrms/shorturl/common/exception/ErrorResponse.java b/src/main/java/com/prgrms/shorturl/common/exception/ErrorResponse.java new file mode 100644 index 00000000..163bb714 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/common/exception/ErrorResponse.java @@ -0,0 +1,10 @@ +package com.prgrms.shorturl.common.exception; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class ErrorResponse { + private String errorMessage; +} diff --git a/src/main/java/com/prgrms/shorturl/common/exception/GlobalExceptionHandler.java b/src/main/java/com/prgrms/shorturl/common/exception/GlobalExceptionHandler.java new file mode 100644 index 00000000..74d7cbfe --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/common/exception/GlobalExceptionHandler.java @@ -0,0 +1,29 @@ +package com.prgrms.shorturl.common.exception; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +@RestControllerAdvice +@Slf4j +public class GlobalExceptionHandler { + + @ExceptionHandler(BaseException.class) + public ResponseEntity handleBaseException(BaseException e) { + log.warn(e.getMessage()); + return ResponseEntity + .status(HttpStatus.INTERNAL_SERVER_ERROR) + .body(new ErrorResponse(e.getErrorCode().getErrorMessage())); + } + + @ExceptionHandler(MethodArgumentNotValidException.class) + public ResponseEntity handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { + log.warn(e.getMessage()); + return ResponseEntity + .status(HttpStatus.BAD_REQUEST) + .body(new ErrorResponse(e.getMessage())); + } +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/controller/UrlController.java b/src/main/java/com/prgrms/shorturl/domain/url/controller/UrlController.java new file mode 100644 index 00000000..98765f8b --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/controller/UrlController.java @@ -0,0 +1,57 @@ +package com.prgrms.shorturl.domain.url.controller; + +import com.prgrms.shorturl.algorithm.AlgorithmType; +import com.prgrms.shorturl.domain.url.dto.request.UrlCreateRequestDTO; +import com.prgrms.shorturl.domain.url.dto.response.UrlResponseDTO; +import com.prgrms.shorturl.domain.url.service.UrlService; +import lombok.RequiredArgsConstructor; +import javax.validation.Valid; +import org.springframework.stereotype.Controller; +import org.springframework.validation.BindingResult; +import org.springframework.web.bind.annotation.*; +import org.springframework.web.servlet.mvc.support.RedirectAttributes; + +@Controller +@RequiredArgsConstructor +public class UrlController { + + private final UrlService urlService; + + @ModelAttribute("algorithmTypes") + public AlgorithmType[] algorithmTypes() { + return AlgorithmType.values(); + } + + @GetMapping + public String home(@ModelAttribute("url") UrlCreateRequestDTO urlCreateRequestDTO) { + return "index"; + } + + @PostMapping("/shorten-url") + public String makeShortUrl( + @ModelAttribute @Valid UrlCreateRequestDTO urlCreateRequestDTO, + BindingResult bindingResult, + RedirectAttributes redirectAttributes + ){ + if (bindingResult.hasErrors()) { + return "index"; + } + + UrlResponseDTO urlResponseDTO = urlService.createShortUrl(urlCreateRequestDTO); + redirectAttributes.addFlashAttribute("url",urlResponseDTO); + + return "redirect:/shorten-url"; + } + + @GetMapping("/shorten-url") + public String getShortUrl(@ModelAttribute(value = "url") UrlResponseDTO urlResponseDTO) { + return "shortUrlPage"; + } + + @GetMapping("/{shortUrl}") + public String redirectOriginUrl(@PathVariable String shortUrl) { + UrlResponseDTO originUrl = urlService.getOriginUrl(shortUrl); + + return "redirect:" + originUrl.originUrl(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/dto/request/UrlCreateRequestDTO.java b/src/main/java/com/prgrms/shorturl/domain/url/dto/request/UrlCreateRequestDTO.java new file mode 100644 index 00000000..27eee020 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/dto/request/UrlCreateRequestDTO.java @@ -0,0 +1,28 @@ +package com.prgrms.shorturl.domain.url.dto.request; + +import com.prgrms.shorturl.algorithm.AlgorithmType; +import com.prgrms.shorturl.domain.url.entity.Url; +import lombok.Builder; +import org.hibernate.validator.constraints.Length; +import org.hibernate.validator.constraints.URL; + +import javax.validation.constraints.NotBlank; +import javax.validation.constraints.NotNull; + +@Builder +public record UrlCreateRequestDTO( + @URL(message = "잘못된 URL 형식입니다.") + @NotBlank(message = "URL을 입력해주세요.") + @Length(max = 255, message = "URL 길이는 {max} 이하의 URL만 가능합니다.") + String originUrl, + + @NotNull(message = "알고리즘 타입을 선택해주세요.") + AlgorithmType algorithmType +) { + public Url toEntity() { + return Url.builder() + .originUrl(originUrl) + .algorithmType((algorithmType)) + .build(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/dto/response/UrlResponseDTO.java b/src/main/java/com/prgrms/shorturl/domain/url/dto/response/UrlResponseDTO.java new file mode 100644 index 00000000..0f5eba75 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/dto/response/UrlResponseDTO.java @@ -0,0 +1,8 @@ +package com.prgrms.shorturl.domain.url.dto.response; + +public record UrlResponseDTO( + String originUrl, + String shortUrl, + Long requestCount +) { +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/entity/Url.java b/src/main/java/com/prgrms/shorturl/domain/url/entity/Url.java new file mode 100644 index 00000000..5d236d13 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/entity/Url.java @@ -0,0 +1,65 @@ +package com.prgrms.shorturl.domain.url.entity; + +import com.prgrms.shorturl.algorithm.AlgorithmType; +import com.prgrms.shorturl.common.exception.BaseException; +import com.prgrms.shorturl.common.exception.ErrorCode; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import javax.persistence.*; +import java.util.regex.Pattern; + +@Entity +@Table(name = "urls") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Url { + + private static final String URL_REGEX = "^(https?:\\/\\/)?([^.][\\da-z\\.-]+\\.[a-z\\.]{2,6}|[\\d\\.]+)([\\/:?=&#]{1}[\\da-z\\.-]+)*[\\/\\?]?$"; + private static final Pattern URL_PATTERN = Pattern.compile(URL_REGEX); + + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private Long id; + + @Column(name = "origin_url", length = 255, nullable = false) + private String originUrl; + + @Column(name = "short_url", length = 8) + private String shortUrl; + + @Column(name = "algoritnm_type", nullable = false) + @Enumerated(EnumType.STRING) + private AlgorithmType algorithmType; + + @Column(name = "request_count") + private Long requestCount; + + @Builder + public Url( + String originUrl, + AlgorithmType algorithmType + ) { + validateUrl(originUrl); + + this.originUrl = originUrl; + this.algorithmType = algorithmType; + requestCount = 0L; + } + + public void setShortUrl(String shortUrl) { + this.shortUrl = shortUrl; + } + + public void increaseRequestCount() { + this.requestCount += 1; + } + + private void validateUrl(String url) { + if(!URL_PATTERN.matcher(url).matches()){ + throw new BaseException(ErrorCode.INVALID_URL_FORMAT); + } + } +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/repository/UrlRepository.java b/src/main/java/com/prgrms/shorturl/domain/url/repository/UrlRepository.java new file mode 100644 index 00000000..355230ff --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/repository/UrlRepository.java @@ -0,0 +1,12 @@ +package com.prgrms.shorturl.domain.url.repository; + +import com.prgrms.shorturl.domain.url.entity.Url; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.Optional; + +public interface UrlRepository extends JpaRepository { + Optional findByOriginUrl(String originUrl); + + Optional findByShortUrl(String shortUrl); +} diff --git a/src/main/java/com/prgrms/shorturl/domain/url/service/UrlService.java b/src/main/java/com/prgrms/shorturl/domain/url/service/UrlService.java new file mode 100644 index 00000000..13f801ed --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/url/service/UrlService.java @@ -0,0 +1,60 @@ +package com.prgrms.shorturl.domain.url.service; + +import com.prgrms.shorturl.algorithm.Algorithm; +import com.prgrms.shorturl.algorithm.Base62; +import com.prgrms.shorturl.domain.url.dto.request.UrlCreateRequestDTO; +import com.prgrms.shorturl.domain.url.dto.response.UrlResponseDTO; +import com.prgrms.shorturl.domain.url.entity.Url; +import com.prgrms.shorturl.domain.url.repository.UrlRepository; +import com.prgrms.shorturl.common.exception.BaseException; +import com.prgrms.shorturl.common.exception.ErrorCode; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; + +import org.springframework.transaction.annotation.Transactional; +import java.util.Optional; + +@Service +@Slf4j +@RequiredArgsConstructor +public class UrlService { + + private final UrlRepository urlRepository; + + private final Algorithm algorithm = new Base62(); + + @Transactional + public UrlResponseDTO createShortUrl(UrlCreateRequestDTO urlCreateRequestDTO) { + Url url = urlCreateRequestDTO.toEntity(); + + Optional originUrl = urlRepository.findByOriginUrl(url.getOriginUrl()); + + if (originUrl.isPresent()) { + Url savedUrl = originUrl.get(); + savedUrl.increaseRequestCount(); + + return new UrlResponseDTO(savedUrl.getOriginUrl(), savedUrl.getShortUrl(), savedUrl.getRequestCount()); + } + + Url savedUrl = urlRepository.save(url); + + String shortUrl = algorithm.encode(savedUrl.getId()); + + savedUrl.setShortUrl(shortUrl); + + return new UrlResponseDTO(savedUrl.getOriginUrl(), savedUrl.getShortUrl(), savedUrl.getRequestCount()); + } + + @Transactional(readOnly = true) + public UrlResponseDTO getOriginUrl(String shortUrl) { + Url url = urlRepository.findByShortUrl(shortUrl) + .orElseThrow(() -> { + log.warn("Url is not found"); + throw new BaseException(ErrorCode.NOT_FOUND_URL); + } + ); + + return new UrlResponseDTO(url.getOriginUrl(), url.getShortUrl(), url.getRequestCount()); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..8937e2ee --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,10 @@ +spring: + datasource: + url: jdbc:h2:tcp://localhost/~/shorturl + username: sa + password: + driver-class-name: org.h2.Driver + + jpa: + hibernate: + ddl-auto: create \ No newline at end of file diff --git a/src/main/resources/templates/index.html b/src/main/resources/templates/index.html new file mode 100644 index 00000000..1388776b --- /dev/null +++ b/src/main/resources/templates/index.html @@ -0,0 +1,33 @@ + + + + + + URL Shortener + + +
+
+
+
+
+ + +
+ + +
+ +
+
+
+
+
+ + diff --git a/src/main/resources/templates/shortUrlPage.html b/src/main/resources/templates/shortUrlPage.html new file mode 100644 index 00000000..12f53889 --- /dev/null +++ b/src/main/resources/templates/shortUrlPage.html @@ -0,0 +1,40 @@ + + + + + Short-url + + +
+
+

+
+ +
+ + +
+
+
+ + +
+
+
+ + +
+ +
+ +
+ +
+
+ + \ No newline at end of file diff --git a/src/test/java/com/prgrms/shorturl/ShorturlApplicationTests.java b/src/test/java/com/prgrms/shorturl/ShorturlApplicationTests.java new file mode 100644 index 00000000..8bdb6ef4 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/ShorturlApplicationTests.java @@ -0,0 +1,13 @@ +package com.prgrms.shorturl; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class ShorturlApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/prgrms/shorturl/domain/url/entity/UrlTest.java b/src/test/java/com/prgrms/shorturl/domain/url/entity/UrlTest.java new file mode 100644 index 00000000..8a284c69 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/domain/url/entity/UrlTest.java @@ -0,0 +1,26 @@ +package com.prgrms.shorturl.domain.url.entity; + +import com.prgrms.shorturl.algorithm.AlgorithmType; +import com.prgrms.shorturl.common.exception.BaseException; +import com.prgrms.shorturl.common.exception.ErrorCode; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class UrlTest { + + @Test + @DisplayName("[예외] 올바른 URL 형식이 아닐경우 예외를 발생시킨다.") + void cannotBuildInvalidUrlTest() { + //given + String url = "httpa://tech.kakaopay.com/post/msa-transaction/"; + + //when & then + assertThatThrownBy(() -> Url.builder() + .originUrl(url) + .algorithmType(AlgorithmType.BASE62) + .build()).isInstanceOf(BaseException.class) + .hasFieldOrPropertyWithValue("errorCode", ErrorCode.INVALID_URL_FORMAT); + } +} \ No newline at end of file diff --git a/src/test/java/com/prgrms/shorturl/domain/url/service/UrlServiceTest.java b/src/test/java/com/prgrms/shorturl/domain/url/service/UrlServiceTest.java new file mode 100644 index 00000000..03d0bc15 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/domain/url/service/UrlServiceTest.java @@ -0,0 +1,118 @@ +package com.prgrms.shorturl.domain.url.service; + +import com.prgrms.shorturl.algorithm.AlgorithmType; +import com.prgrms.shorturl.algorithm.Base62; +import com.prgrms.shorturl.domain.url.dto.request.UrlCreateRequestDTO; +import com.prgrms.shorturl.domain.url.dto.response.UrlResponseDTO; +import com.prgrms.shorturl.domain.url.entity.Url; +import com.prgrms.shorturl.domain.url.repository.UrlRepository; +import com.prgrms.shorturl.common.exception.ErrorCode; +import com.prgrms.shorturl.common.exception.BaseException; +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 java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +@ExtendWith(MockitoExtension.class) +class UrlServiceTest { + + @InjectMocks + UrlService urlService; + + @Mock + UrlRepository urlRepository; + + private Url url; + + private final Long savedUrlId = 1L; + + @BeforeEach + void setUp() { + url = Url.builder() + .originUrl("www.daangn.com") + .algorithmType(AlgorithmType.BASE62) + .build(); + } + + @Test + @DisplayName("[성공] 첫 요청일 때, shortURL 을 만들어낸다.") + void makeShortUrlTest() { + //given + UrlCreateRequestDTO urlCreateRequestDTO = UrlCreateRequestDTO.builder() + .originUrl(url.getOriginUrl()) + .algorithmType(url.getAlgorithmType()) + .build(); + + //mocking + url = mock(Url.class); + when(urlRepository.save(any(Url.class))).thenReturn(url); + when(url.getId()).thenReturn(savedUrlId); + + + //when + UrlResponseDTO urlResponseDTO = urlService.createShortUrl(urlCreateRequestDTO); + + //then + Assertions.assertEquals(url.getOriginUrl(), urlResponseDTO.originUrl()); + Assertions.assertEquals(url.getShortUrl(), urlResponseDTO.shortUrl()); + } + + @Test + @DisplayName("[성공] 두번째 이상 요청일 일때 origin url 조회에 성공한다.") + void getOriginUrlTest() { + //given + UrlCreateRequestDTO urlCreateRequestDTO = UrlCreateRequestDTO.builder() + .originUrl(url.getOriginUrl()) + .algorithmType(url.getAlgorithmType()) + .build(); + + url = mock(Url.class); + when(urlRepository.save(any(Url.class))).thenReturn(url); + when(url.getId()).thenReturn(savedUrlId); + + UrlResponseDTO urlResponseDTO = urlService.createShortUrl(urlCreateRequestDTO); + + Long requestCount = 1L; + + //mocking + url = mock(Url.class); + when(urlRepository.findByShortUrl(urlResponseDTO.shortUrl())).thenReturn(Optional.of(url)); + when(url.getOriginUrl()).thenReturn(urlResponseDTO.originUrl()); + when(url.getShortUrl()).thenReturn(urlResponseDTO.shortUrl()); + when(url.getRequestCount()).thenReturn(requestCount); + + UrlResponseDTO urlResponseDTO1 = urlService.getOriginUrl(urlResponseDTO.shortUrl()); + + //then + assertThat(urlResponseDTO1) + .hasFieldOrPropertyWithValue("originUrl", urlResponseDTO.originUrl()) + .hasFieldOrPropertyWithValue("shortUrl", urlResponseDTO.shortUrl()) + .hasFieldOrPropertyWithValue("requestCount", requestCount); + } + + @Test + @DisplayName("[예외] shortUrl에 해당하는 URL이 없으면 예외를 발생시킨다.") + void notFoundUrlTest() { + //given + String unknownUrl = "AAAAAABC"; + + when(urlRepository.findByShortUrl(unknownUrl)).thenReturn(Optional.empty()); + //when + assertThatThrownBy(() -> { + urlService.getOriginUrl(unknownUrl); + }).isInstanceOf(BaseException.class) + .hasFieldOrPropertyWithValue("errorCode", ErrorCode.NOT_FOUND_URL); + } +} \ No newline at end of file