diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..250867ba --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +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/ + +.gradle/ +.idea/ +build/ +gradle/ +out/ diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..8487663b --- /dev/null +++ b/build.gradle @@ -0,0 +1,37 @@ +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-thymeleaf' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + implementation 'org.springframework.boot:spring-boot-starter-validation' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 00000000..f645b9e9 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,17 @@ +version: "3.8" +services: + mysql-container: + image: mysql:latest + container_name: mysql-container + restart: always + volumes: + - mysql-vol:/app + ports: + - "13306:3306" + environment: + MYSQL_ROOT_PASSWORD: 1234 + MYSQL_DATABASE: short_url + MYSQL_ROOT_HOST: '%' +volumes: + mysql-vol: + external: true \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..d64cd491 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..1af9e093 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 00000000..1aa94a42 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..93e3f59f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..c317cafe --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'short-url' diff --git a/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java b/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java new file mode 100644 index 00000000..b3645dbd --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/ShortUrlApplication.java @@ -0,0 +1,13 @@ +package com.prgrms.shorturl; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class ShortUrlApplication { + + public static void main(String[] args) { + SpringApplication.run(ShortUrlApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/shorturl/controller/UrlRestController.java b/src/main/java/com/prgrms/shorturl/controller/UrlRestController.java new file mode 100644 index 00000000..739b9636 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/controller/UrlRestController.java @@ -0,0 +1,40 @@ +package com.prgrms.shorturl.controller; + +import com.prgrms.shorturl.dto.UrlRequest; +import com.prgrms.shorturl.dto.UrlResponse; +import com.prgrms.shorturl.exception.RedirectionException; +import com.prgrms.shorturl.service.UrlService; +import jakarta.servlet.http.HttpServletResponse; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.io.IOException; + +@RestController +@RequestMapping("/api/v1") +@RequiredArgsConstructor +@Slf4j +public class UrlRestController { + private final UrlService urlService; + + @PostMapping("/shortUrl") + public ResponseEntity getShortUrl(@RequestBody UrlRequest req) { + HttpStatus status = urlService.isPresent(req) ? HttpStatus.OK : HttpStatus.CREATED; + UrlResponse res = urlService.getShortUrl(req); + return ResponseEntity.status(status).body(res); + } + + @GetMapping("/{shortUrl}") + public void findByShortUrl(@PathVariable String shortUrl, HttpServletResponse response) { + try { + String originalUrl = urlService.getOriginalUrl(shortUrl); + log.info("get original url: " + originalUrl); + response.sendRedirect("http://" + originalUrl); + } catch (IOException e) { + throw new RedirectionException("redirection 오류"); + } + } +} diff --git a/src/main/java/com/prgrms/shorturl/domain/Url.java b/src/main/java/com/prgrms/shorturl/domain/Url.java new file mode 100644 index 00000000..e7f7f894 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/domain/Url.java @@ -0,0 +1,53 @@ +package com.prgrms.shorturl.domain; + +import com.prgrms.shorturl.utils.Base62EncodingFactory; +import com.prgrms.shorturl.utils.EncodingFactory; +import com.prgrms.shorturl.utils.HashAlgorithm; +import jakarta.persistence.*; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Getter +@NoArgsConstructor +public class Url { + + @Id @GeneratedValue + @Column(name = "short_url_id") + private Long id; + + private String hash; + + @Column(nullable = false) + private String originalUrl; + + private String shortUrl; + + private int count; + + @Transient + private HashAlgorithm hashAlgorithm; + + public Url(String originalUrl, HashAlgorithm hashAlgorithm) { + this.originalUrl = originalUrl; + this.hashAlgorithm = hashAlgorithm; + this.count = 1; + } + + public void encode() { + EncodingFactory encodingFactory = new Base62EncodingFactory(hash); + this.shortUrl = encodingFactory.encode(); + } + + public void countRequire() { + count++; + } + + public void hashing() { + this.hash = hashAlgorithm.hashing(this); + } + + public void changeHash(String hash) { + this.hash = hash; + } +} diff --git a/src/main/java/com/prgrms/shorturl/dto/UrlRequest.java b/src/main/java/com/prgrms/shorturl/dto/UrlRequest.java new file mode 100644 index 00000000..87c1de2b --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/dto/UrlRequest.java @@ -0,0 +1,12 @@ +package com.prgrms.shorturl.dto; + +import com.prgrms.shorturl.utils.HashAlgorithm; +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.Pattern; +import lombok.Builder; + +public record UrlRequest(@NotBlank @Pattern(regexp = "^((http|https)://)?(www.)?([a-zA-Z0-9]+)\\.[a-z]+([a-zA-Z0-9.?#]+)?") String originalUrl, HashAlgorithm hashAlgorithm) { + @Builder + public UrlRequest { + } +} diff --git a/src/main/java/com/prgrms/shorturl/dto/UrlResponse.java b/src/main/java/com/prgrms/shorturl/dto/UrlResponse.java new file mode 100644 index 00000000..6e829122 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/dto/UrlResponse.java @@ -0,0 +1,20 @@ +package com.prgrms.shorturl.dto; + +import com.prgrms.shorturl.domain.Url; +import lombok.Builder; + +public record UrlResponse(Long id, String hash, String originalUrl, String shortUrl, int count) { + @Builder + public UrlResponse { + } + + public static UrlResponse toShortUrlResponse(Url url, String protocol) { + return UrlResponse.builder() + .id(url.getId()) + .hash(url.getHash()) + .originalUrl(protocol + url.getOriginalUrl()) + .shortUrl(url.getShortUrl()) + .count(url.getCount()) + .build(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/exception/HashingException.java b/src/main/java/com/prgrms/shorturl/exception/HashingException.java new file mode 100644 index 00000000..537c8261 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/exception/HashingException.java @@ -0,0 +1,7 @@ +package com.prgrms.shorturl.exception; + +public class HashingException extends RuntimeException { + public HashingException(String message) { + super(message); + } +} diff --git a/src/main/java/com/prgrms/shorturl/exception/NoSuchOriginalUrlException.java b/src/main/java/com/prgrms/shorturl/exception/NoSuchOriginalUrlException.java new file mode 100644 index 00000000..eb9d3350 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/exception/NoSuchOriginalUrlException.java @@ -0,0 +1,7 @@ +package com.prgrms.shorturl.exception; + +public class NoSuchOriginalUrlException extends RuntimeException { + public NoSuchOriginalUrlException(String message) { + super(message); + } +} diff --git a/src/main/java/com/prgrms/shorturl/exception/RedirectionException.java b/src/main/java/com/prgrms/shorturl/exception/RedirectionException.java new file mode 100644 index 00000000..6908263a --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/exception/RedirectionException.java @@ -0,0 +1,7 @@ +package com.prgrms.shorturl.exception; + +public class RedirectionException extends RuntimeException { + public RedirectionException(String message) { + super(message); + } +} diff --git a/src/main/java/com/prgrms/shorturl/handler/GlobalExceptionHandler.java b/src/main/java/com/prgrms/shorturl/handler/GlobalExceptionHandler.java new file mode 100644 index 00000000..ed656aef --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/handler/GlobalExceptionHandler.java @@ -0,0 +1,48 @@ +package com.prgrms.shorturl.handler; + +import com.prgrms.shorturl.exception.HashingException; +import com.prgrms.shorturl.exception.NoSuchOriginalUrlException; +import com.prgrms.shorturl.exception.RedirectionException; +import jakarta.validation.ValidationException; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +@RestControllerAdvice +@Slf4j +public class GlobalExceptionHandler { + + @ExceptionHandler(HashingException.class) + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + protected ResponseEntity hashingException(Exception e) { + log.info(e.getMessage()); + return ResponseEntity.status(500) + .body(e.getMessage()); + } + + @ExceptionHandler(NoSuchOriginalUrlException.class) + @ResponseStatus(HttpStatus.NOT_FOUND) + protected ResponseEntity noSuchOriginalUrlException(Exception e) { + log.info(e.getMessage()); + return ResponseEntity.status(404) + .body(e.getMessage()); + } + + @ExceptionHandler(RedirectionException.class) + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + protected ResponseEntity redirectionException(Exception e) { + log.info(e.getMessage()); + return ResponseEntity.status(500) + .body(e.getMessage()); + } + + @ExceptionHandler(ValidationException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + protected ResponseEntity requestException(Exception e) { + return ResponseEntity.status(400) + .body("입력하신 url의 형식이 올바르지 않습니다."); + } +} diff --git a/src/main/java/com/prgrms/shorturl/repository/UrlRepository.java b/src/main/java/com/prgrms/shorturl/repository/UrlRepository.java new file mode 100644 index 00000000..b5d62906 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/repository/UrlRepository.java @@ -0,0 +1,12 @@ +package com.prgrms.shorturl.repository; + +import com.prgrms.shorturl.domain.Url; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.Optional; + +public interface UrlRepository extends JpaRepository { + Optional findByOriginalUrl(String originalUrl); + Optional findByShortUrl(String shortUrl); + Optional findByHash(String hash); +} diff --git a/src/main/java/com/prgrms/shorturl/service/UrlService.java b/src/main/java/com/prgrms/shorturl/service/UrlService.java new file mode 100644 index 00000000..2960e0b8 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/service/UrlService.java @@ -0,0 +1,89 @@ +package com.prgrms.shorturl.service; + +import com.prgrms.shorturl.domain.Url; +import com.prgrms.shorturl.dto.UrlRequest; +import com.prgrms.shorturl.dto.UrlResponse; +import com.prgrms.shorturl.exception.NoSuchOriginalUrlException; +import com.prgrms.shorturl.repository.UrlRepository; +import com.prgrms.shorturl.utils.HashAlgorithm; +import jakarta.validation.Valid; +import jakarta.validation.constraints.NotEmpty; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; +import org.springframework.validation.annotation.Validated; + +import java.util.Optional; + +import static com.prgrms.shorturl.dto.UrlResponse.toShortUrlResponse; +import static com.prgrms.shorturl.utils.UrlFactory.deleteProtocol; +import static com.prgrms.shorturl.utils.UrlFactory.extractProtocol; + +@Service +@Slf4j +@RequiredArgsConstructor +@Validated +public class UrlService { + + private final UrlRepository urlRepository; + + public Url save(String originalUrl, HashAlgorithm hashAlgorithm) { + Url url = new Url(originalUrl, hashAlgorithm); + Url save = urlRepository.save(url); + log.info("url id: " + save.getId()); + + url.hashing(); + log.info("hashId: " + url.getHash()); + + url.changeHash(checkDuplication(url.getHash(), hashAlgorithm)); + log.info("completed hashId: " + url.getHash()); + + url.encode(); + return urlRepository.save(url); + } + + private String checkDuplication(String originalHash, HashAlgorithm hashAlgorithm) { + if(hashAlgorithm == HashAlgorithm.SEQUENCE) { + while(urlRepository.findByHash(originalHash).isPresent()) { + originalHash += "0"; + } + return originalHash; + } + + StringBuilder sb = new StringBuilder(originalHash.substring(0, 10)); + + int index = 10; + while(urlRepository.findByHash(sb.toString()).isPresent()) { + sb.append(originalHash.charAt(index++)); + } + return sb.toString(); + } + + @Transactional(readOnly = true) + public boolean isPresent(@Valid UrlRequest req) { + String manufacturedUrl = deleteProtocol(req.originalUrl()); + return urlRepository.findByOriginalUrl(manufacturedUrl).isPresent(); + } + + @Transactional + public UrlResponse getShortUrl(@Valid UrlRequest req) { + String extractedProtocol = extractProtocol(req.originalUrl()); + String manufacturedUrl = deleteProtocol(req.originalUrl()); + Optional find = urlRepository.findByOriginalUrl(manufacturedUrl); + if(find.isEmpty()) { + return toShortUrlResponse(save(manufacturedUrl, req.hashAlgorithm()), extractedProtocol); + } + + Url url = find.get(); + url.countRequire(); + return toShortUrlResponse(url, extractedProtocol); + } + + @Transactional(readOnly = true) + public String getOriginalUrl(@NotEmpty String shortUrl) { + Url find = urlRepository.findByShortUrl(shortUrl) + .orElseThrow(() -> new NoSuchOriginalUrlException("매칭되는 주소가 없습니다.")); + return find.getOriginalUrl(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/utils/Base62EncodingFactory.java b/src/main/java/com/prgrms/shorturl/utils/Base62EncodingFactory.java new file mode 100644 index 00000000..123a14d6 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/utils/Base62EncodingFactory.java @@ -0,0 +1,30 @@ +package com.prgrms.shorturl.utils; + +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +@RequiredArgsConstructor +@Slf4j +public class Base62EncodingFactory implements EncodingFactory { + + private final String hashString; + + @Override + public String encode() { + log.info("hashString: " + hashString); + long hashId = Long.parseLong(hashString, 16); + + log.info("long type hashID: " + hashId); + String[] base62Num = {"a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", + "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", + "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"}; + + StringBuilder sb = new StringBuilder(); + while (hashId > 0) { + long mod = (long) hashId % 62; + sb.append(base62Num[(int)mod]); + hashId /= 62; + } + return sb.toString(); + } +} diff --git a/src/main/java/com/prgrms/shorturl/utils/EncodingFactory.java b/src/main/java/com/prgrms/shorturl/utils/EncodingFactory.java new file mode 100644 index 00000000..1d1e500d --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/utils/EncodingFactory.java @@ -0,0 +1,5 @@ +package com.prgrms.shorturl.utils; + +public interface EncodingFactory { + String encode(); +} diff --git a/src/main/java/com/prgrms/shorturl/utils/HashAlgorithm.java b/src/main/java/com/prgrms/shorturl/utils/HashAlgorithm.java new file mode 100644 index 00000000..4d3bce0d --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/utils/HashAlgorithm.java @@ -0,0 +1,25 @@ +package com.prgrms.shorturl.utils; + +import com.prgrms.shorturl.domain.Url; +import lombok.Getter; + +@Getter +public enum HashAlgorithm { + SHA_256 { + @Override + public String hashing(Url url) { + HashFactory hashFactory = new HashFactory(SHA_256); + return hashFactory.generate(url.getOriginalUrl()); + } + }, + SEQUENCE { + @Override + public String hashing(Url url) { + return Long.toHexString(url.getId()); + } + }; + + public String hashing(Url url) { + return "default"; + } +} diff --git a/src/main/java/com/prgrms/shorturl/utils/HashFactory.java b/src/main/java/com/prgrms/shorturl/utils/HashFactory.java new file mode 100644 index 00000000..c16b7b92 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/utils/HashFactory.java @@ -0,0 +1,24 @@ +package com.prgrms.shorturl.utils; + +import com.prgrms.shorturl.exception.HashingException; +import lombok.RequiredArgsConstructor; + +import java.io.UnsupportedEncodingException; +import java.math.BigInteger; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +@RequiredArgsConstructor +public class HashFactory { + private final HashAlgorithm algorithm; + + public String generate(String originalUrl) { + try { + MessageDigest md = MessageDigest.getInstance("SHA-256"); + md.update(originalUrl.getBytes("UTF-8")); + return new BigInteger(1, md.digest()).toString(16); + } catch (NoSuchAlgorithmException | UnsupportedEncodingException e) { + throw new HashingException("hashing 도중 오류가 발생했습니다."); + } + } +} diff --git a/src/main/java/com/prgrms/shorturl/utils/UrlFactory.java b/src/main/java/com/prgrms/shorturl/utils/UrlFactory.java new file mode 100644 index 00000000..70ea8c34 --- /dev/null +++ b/src/main/java/com/prgrms/shorturl/utils/UrlFactory.java @@ -0,0 +1,17 @@ +package com.prgrms.shorturl.utils; + +public class UrlFactory { + public static String extractProtocol(String url) { + if (url.startsWith("http://")) { + return "http://"; + } else if (url.startsWith("https://")) { + return "https://"; + } else { + return ""; + } + } + + public static String deleteProtocol(String url) { + return url.replaceAll("^(http://|https://)", ""); + } +} diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml new file mode 100644 index 00000000..3b141a9f --- /dev/null +++ b/src/main/resources/application.yaml @@ -0,0 +1,13 @@ +spring: + datasource: + url: jdbc:mysql://${MYSQL_URL} + username: ${MYSQL_USERNAME} + password: ${MYSQL_PASSWORD} + driver-class-name: com.mysql.cj.jdbc.Driver + jpa: + database-platform: org.hibernate.dialect.MySQLDialect + hibernate: + ddl-auto: create + properties: + hibernate: + show_sql: true \ No newline at end of file diff --git a/src/test/java/com/prgrms/shorturl/UrlApplicationTests.java b/src/test/java/com/prgrms/shorturl/UrlApplicationTests.java new file mode 100644 index 00000000..fcc13b0a --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/UrlApplicationTests.java @@ -0,0 +1,13 @@ +package com.prgrms.shorturl; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class UrlApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/prgrms/shorturl/service/UrlServiceTest.java b/src/test/java/com/prgrms/shorturl/service/UrlServiceTest.java new file mode 100644 index 00000000..f6676911 --- /dev/null +++ b/src/test/java/com/prgrms/shorturl/service/UrlServiceTest.java @@ -0,0 +1,98 @@ +package com.prgrms.shorturl.service; + +import com.prgrms.shorturl.dto.UrlRequest; +import com.prgrms.shorturl.dto.UrlResponse; +import com.prgrms.shorturl.exception.NoSuchOriginalUrlException; +import com.prgrms.shorturl.repository.UrlRepository; +import com.prgrms.shorturl.utils.HashAlgorithm; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +@SpringBootTest +class UrlServiceTest { + + @Autowired + private UrlRepository urlRepository; + + @Autowired + private UrlService urlService; + + + @AfterEach + void afterEach() { + urlRepository.deleteAll(); + } + + @Test + @DisplayName("존재하는 original url인지 확인 - 존재하지 않을 경우") + void checkIsPresent() { + UrlRequest req = UrlRequest.builder() + .originalUrl("www.naver.com") + .hashAlgorithm(HashAlgorithm.SHA_256) + .build(); + boolean isPresent = urlService.isPresent(req); + assertThat(isPresent).isFalse(); + } + + @Test + @DisplayName("존재하는 original url인지 확인 - 존재할 경우") + void checkIsNotPresent() { + urlService.save("www.naver.com", HashAlgorithm.SHA_256); + UrlRequest req = UrlRequest.builder() + .originalUrl("www.naver.com") + .hashAlgorithm(HashAlgorithm.SHA_256) + .build(); + boolean isPresent = urlService.isPresent(req); + assertThat(isPresent).isTrue(); + } + + @Test + @DisplayName("shorturl 얻기 - SHA-256") + void getShortUrlSha256() { + UrlRequest req = UrlRequest.builder() + .originalUrl("www.naver.com") + .hashAlgorithm(HashAlgorithm.SHA_256) + .build(); + UrlResponse shortUrl = urlService.getShortUrl(req); + assertThat(shortUrl.originalUrl()).isEqualTo("www.naver.com"); + } + + @Test + @DisplayName("shorturl 얻기 - Sequence") + void getShortUrlSequence() { + UrlRequest req = UrlRequest.builder() + .originalUrl("www.naver.com") + .hashAlgorithm(HashAlgorithm.SEQUENCE) + .build(); + UrlResponse shortUrl = urlService.getShortUrl(req); + assertThat(shortUrl.originalUrl()).isEqualTo("www.naver.com"); + } + + @Test + @DisplayName("originalUrl 얻기") + void getOriginalUrl() { + UrlRequest req = UrlRequest.builder() + .originalUrl("www.naver.com") + .hashAlgorithm(HashAlgorithm.SEQUENCE) + .build(); + UrlResponse shortUrl = urlService.getShortUrl(req); + String originalUrl = urlService.getOriginalUrl(shortUrl.shortUrl()); + assertThat(originalUrl).isEqualTo("www.naver.com"); + } + + @Test + @DisplayName("originalUrl 얻기 - 실패") + void getOriginalUrlFail() { + assertThatThrownBy(() -> { + urlService.getOriginalUrl("VvY2d"); + }) + .isExactlyInstanceOf(NoSuchOriginalUrlException.class) + .hasMessage("매칭되는 주소가 없습니다."); + } +} \ No newline at end of file diff --git a/src/test/resources/applicaion-test.yaml b/src/test/resources/applicaion-test.yaml new file mode 100644 index 00000000..3b141a9f --- /dev/null +++ b/src/test/resources/applicaion-test.yaml @@ -0,0 +1,13 @@ +spring: + datasource: + url: jdbc:mysql://${MYSQL_URL} + username: ${MYSQL_USERNAME} + password: ${MYSQL_PASSWORD} + driver-class-name: com.mysql.cj.jdbc.Driver + jpa: + database-platform: org.hibernate.dialect.MySQLDialect + hibernate: + ddl-auto: create + properties: + hibernate: + show_sql: true \ No newline at end of file