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..89636c9d --- /dev/null +++ b/build.gradle @@ -0,0 +1,37 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.4' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'com.programmers' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-validation' + 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' + 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..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..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..3ab648d0 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'url-shortener' diff --git a/src/main/java/com/programmers/urlshortener/UrlShortenerApplication.java b/src/main/java/com/programmers/urlshortener/UrlShortenerApplication.java new file mode 100644 index 00000000..2dc50033 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/UrlShortenerApplication.java @@ -0,0 +1,13 @@ +package com.programmers.urlshortener; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class UrlShortenerApplication { + + public static void main(String[] args) { + SpringApplication.run(UrlShortenerApplication.class, args); + } + +} diff --git a/src/main/java/com/programmers/urlshortener/algorithm/Algorithm.java b/src/main/java/com/programmers/urlshortener/algorithm/Algorithm.java new file mode 100644 index 00000000..96f6d95c --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/algorithm/Algorithm.java @@ -0,0 +1,7 @@ +package com.programmers.urlshortener.algorithm; + +public interface Algorithm { + R encode(T t); + + T decode(R r); +} diff --git a/src/main/java/com/programmers/urlshortener/algorithm/Base62.java b/src/main/java/com/programmers/urlshortener/algorithm/Base62.java new file mode 100644 index 00000000..6f8a6478 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/algorithm/Base62.java @@ -0,0 +1,32 @@ +package com.programmers.urlshortener.algorithm; + +import org.springframework.stereotype.Component; + +@Component +public class Base62 implements Algorithm { + + private static final String CODEC = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + + @Override + public String encode(Long id) { + final StringBuilder stringBuilder = new StringBuilder(); + while (id > 0) { + stringBuilder.append(CODEC.charAt((int)(id % CODEC.length()))); + id /= CODEC.length(); + } + + return stringBuilder.toString(); + } + + @Override + public Long decode(final String shorteningKey) { + long decodedId = 0; + long multiple = 1; + for (int i = 0; i < shorteningKey.length(); i++) { + decodedId += CODEC.indexOf(shorteningKey.charAt(i)) * multiple; + multiple += CODEC.length(); + } + + return decodedId; + } +} diff --git a/src/main/java/com/programmers/urlshortener/config/WebMvcConfig.java b/src/main/java/com/programmers/urlshortener/config/WebMvcConfig.java new file mode 100644 index 00000000..b0b07cc7 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/config/WebMvcConfig.java @@ -0,0 +1,14 @@ +package com.programmers.urlshortener.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +public class WebMvcConfig implements WebMvcConfigurer { + @Override + public void addViewControllers(ViewControllerRegistry registry) { + registry.addViewController("").setViewName("home"); + registry.addViewController("/total-url-clicks").setViewName("urlClickCounter"); + } +} diff --git a/src/main/java/com/programmers/urlshortener/error/ErrorResponse.java b/src/main/java/com/programmers/urlshortener/error/ErrorResponse.java new file mode 100644 index 00000000..6b0f234e --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/error/ErrorResponse.java @@ -0,0 +1,26 @@ +package com.programmers.urlshortener.error; + +import com.programmers.urlshortener.error.exception.ErrorCode; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@Getter +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) +public class ErrorResponse { + + private final String error; + + private final String code; + + private final String message; + + public static ErrorResponse from(final ErrorCode errorCode) { + return new ErrorResponse( + errorCode.name(), + errorCode.getCode(), + errorCode.getMessage() + ); + } +} diff --git a/src/main/java/com/programmers/urlshortener/error/GlobalExceptionHandler.java b/src/main/java/com/programmers/urlshortener/error/GlobalExceptionHandler.java new file mode 100644 index 00000000..5b3ab7c2 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/error/GlobalExceptionHandler.java @@ -0,0 +1,39 @@ +package com.programmers.urlshortener.error; + +import org.springframework.ui.Model; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; + +import com.programmers.urlshortener.error.exception.BaseException; +import com.programmers.urlshortener.error.exception.ErrorCode; + +import lombok.extern.slf4j.Slf4j; + +@Slf4j +@ControllerAdvice +public class GlobalExceptionHandler { + + @ExceptionHandler(Exception.class) + protected String handleException( + final Exception e, + final Model model + ) { + log.error("UnExpected Exception", e); + final ErrorResponse response = ErrorResponse.from(ErrorCode.INTERNAL_SERVER_ERROR); + model.addAttribute("response", response); + + return "error"; + } + + @ExceptionHandler(BaseException.class) + protected String handleBusinessException( + final BaseException e, + final Model model + ) { + log.error("BaseException", e); + final ErrorResponse response = ErrorResponse.from(e.getErrorCode()); + model.addAttribute("response", response); + + return "error"; + } +} diff --git a/src/main/java/com/programmers/urlshortener/error/exception/BaseException.java b/src/main/java/com/programmers/urlshortener/error/exception/BaseException.java new file mode 100644 index 00000000..2e7f4687 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/error/exception/BaseException.java @@ -0,0 +1,11 @@ +package com.programmers.urlshortener.error.exception; + +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@Getter +@RequiredArgsConstructor +public class BaseException extends RuntimeException { + + private final ErrorCode errorCode; +} diff --git a/src/main/java/com/programmers/urlshortener/error/exception/ErrorCode.java b/src/main/java/com/programmers/urlshortener/error/exception/ErrorCode.java new file mode 100644 index 00000000..2f267cfc --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/error/exception/ErrorCode.java @@ -0,0 +1,20 @@ +package com.programmers.urlshortener.error.exception; + +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@Getter +@RequiredArgsConstructor +public enum ErrorCode { + + // Common + INTERNAL_SERVER_ERROR("C_001", "Internal Server Error"), + + // Url + URL_NOT_FOUND("U_001", "URL을 찾을 수 없습니다."), + URL_NOT_VALID("U_002", "유효하지 않은 URL입니다."), + ; + + private final String code; + private final String message; +} diff --git a/src/main/java/com/programmers/urlshortener/url/controller/UrlController.java b/src/main/java/com/programmers/urlshortener/url/controller/UrlController.java new file mode 100644 index 00000000..893f504f --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/controller/UrlController.java @@ -0,0 +1,45 @@ +package com.programmers.urlshortener.url.controller; + +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.bind.annotation.RequestParam; +import org.springframework.web.servlet.view.RedirectView; + +import com.programmers.urlshortener.url.dto.UrlShortenResponse; +import com.programmers.urlshortener.url.dto.UrlTotalClicksResponse; +import com.programmers.urlshortener.url.service.UrlService; + +import lombok.RequiredArgsConstructor; + +@Controller +@RequiredArgsConstructor +public class UrlController { + + private final UrlService urlService; + + @PostMapping("/shorten-url") + public String shortenUrl(@RequestParam final String originalUrl, final Model model) { + final UrlShortenResponse response = urlService.shortenUrl(originalUrl); + model.addAttribute("response", response); + + return "shortenedUrl"; + } + + @GetMapping("/shortened-url/{shorteningKey}") + public RedirectView goToShortenedUrl(@PathVariable final String shorteningKey) { + final String originalUrl = urlService.getOriginalUrl(shorteningKey); + + return new RedirectView(originalUrl); + } + + @GetMapping("/total-url-clicks/{shorteningKey}") + public String getTotalClicks(@PathVariable final String shorteningKey, final Model model) { + final UrlTotalClicksResponse response = urlService.getTotalClicks(shorteningKey); + model.addAttribute("response", response); + + return "totalUrlClicks"; + } +} diff --git a/src/main/java/com/programmers/urlshortener/url/dto/UrlShortenResponse.java b/src/main/java/com/programmers/urlshortener/url/dto/UrlShortenResponse.java new file mode 100644 index 00000000..60efab4d --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/dto/UrlShortenResponse.java @@ -0,0 +1,15 @@ +package com.programmers.urlshortener.url.dto; + +public record UrlShortenResponse( + String originalUrl, + String shortenedUrl, + String shorteningKey +) { + public static UrlShortenResponse of( + final String originalUrl, + final String shortenedUrl, + final String shorteningKey + ) { + return new UrlShortenResponse(originalUrl, shortenedUrl, shorteningKey); + } +} diff --git a/src/main/java/com/programmers/urlshortener/url/dto/UrlTotalClicksResponse.java b/src/main/java/com/programmers/urlshortener/url/dto/UrlTotalClicksResponse.java new file mode 100644 index 00000000..a7c08c66 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/dto/UrlTotalClicksResponse.java @@ -0,0 +1,7 @@ +package com.programmers.urlshortener.url.dto; + +public record UrlTotalClicksResponse( + String shortenedUrl, + int totalClicks +) { +} diff --git a/src/main/java/com/programmers/urlshortener/url/entity/Url.java b/src/main/java/com/programmers/urlshortener/url/entity/Url.java new file mode 100644 index 00000000..03f1ee6d --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/entity/Url.java @@ -0,0 +1,44 @@ +package com.programmers.urlshortener.url.entity; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Table; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@Entity +@Table(name = "urls") +public class Url { + + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + @Column(name = "id") + private Long id; + + @Column(name = "shortening_key", length = 7) + private String shorteningKey; + + @Column(name = "original_url", nullable = false) + private String originalUrl; + + @Column(name = "total_clicks") + private int totalClicks; + + public Url(final String originalUrl) { + this.originalUrl = originalUrl; + } + + public void addShorteningKey(final String shorteningKey) { + this.shorteningKey = shorteningKey; + } + + public void increaseTotalClicks() { + this.totalClicks += 1; + } +} diff --git a/src/main/java/com/programmers/urlshortener/url/repository/UrlRepository.java b/src/main/java/com/programmers/urlshortener/url/repository/UrlRepository.java new file mode 100644 index 00000000..88907582 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/repository/UrlRepository.java @@ -0,0 +1,8 @@ +package com.programmers.urlshortener.url.repository; + +import org.springframework.data.jpa.repository.JpaRepository; + +import com.programmers.urlshortener.url.entity.Url; + +public interface UrlRepository extends JpaRepository { +} diff --git a/src/main/java/com/programmers/urlshortener/url/service/UrlService.java b/src/main/java/com/programmers/urlshortener/url/service/UrlService.java new file mode 100644 index 00000000..ec76eb07 --- /dev/null +++ b/src/main/java/com/programmers/urlshortener/url/service/UrlService.java @@ -0,0 +1,67 @@ +package com.programmers.urlshortener.url.service; + +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import com.programmers.urlshortener.algorithm.Algorithm; +import com.programmers.urlshortener.error.exception.BaseException; +import com.programmers.urlshortener.error.exception.ErrorCode; +import com.programmers.urlshortener.url.dto.UrlShortenResponse; +import com.programmers.urlshortener.url.dto.UrlTotalClicksResponse; +import com.programmers.urlshortener.url.entity.Url; +import com.programmers.urlshortener.url.repository.UrlRepository; + +import lombok.RequiredArgsConstructor; + +@Service +@RequiredArgsConstructor +@Transactional(readOnly = true) +public class UrlService { + + public static final String BASE_URL = "http://localhost:8080/"; + + private final UrlRepository urlRepository; + + private final Algorithm algorithm; + + @Transactional + public UrlShortenResponse shortenUrl(final String originalUrl) { + if (originalUrl.isBlank()) { + throw new BaseException(ErrorCode.URL_NOT_VALID); + } + + final Url url = new Url(originalUrl); + final Url savedUrl = urlRepository.save(url); + final String shorteningKey = algorithm.encode(savedUrl.getId()); + url.addShorteningKey(shorteningKey); + + return UrlShortenResponse.of(originalUrl, getShortenedUrl(shorteningKey), shorteningKey); + } + + @Transactional + public String getOriginalUrl(final String shorteningKey) { + final Url url = getUrl(shorteningKey); + url.increaseTotalClicks(); + + return url.getOriginalUrl(); + } + + public UrlTotalClicksResponse getTotalClicks(final String shorteningKey) { + final Url url = getUrl(shorteningKey); + final int totalClicks = url.getTotalClicks(); + final String shortenedUrl = getShortenedUrl(shorteningKey); + + return new UrlTotalClicksResponse(shortenedUrl, totalClicks); + } + + private Url getUrl(final String shorteningKey) { + final Long urlId = algorithm.decode(shorteningKey); + + return urlRepository.findById(urlId) + .orElseThrow(() -> new BaseException(ErrorCode.URL_NOT_FOUND)); + } + + private String getShortenedUrl(final String shorteningKey) { + return BASE_URL + shorteningKey; + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..556960f9 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,17 @@ +spring: + h2: + console: + enabled: true + + datasource: + url: jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE + username: sa + password: + driver-class-name: org.h2.Driver + + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + format_sql: true \ No newline at end of file diff --git a/src/main/resources/templates/error.html b/src/main/resources/templates/error.html new file mode 100644 index 00000000..ad607d49 --- /dev/null +++ b/src/main/resources/templates/error.html @@ -0,0 +1,43 @@ + + + + + + Error page + + + +
+
+ +

Something went wrong!

+ + + + + + + + + + + + + + + +
ErrorCodemessage
+
+
+ +
+
+
+
+ + \ No newline at end of file diff --git a/src/main/resources/templates/home.html b/src/main/resources/templates/home.html new file mode 100644 index 00000000..a6b378e9 --- /dev/null +++ b/src/main/resources/templates/home.html @@ -0,0 +1,40 @@ + + + + + + Bootstrap demo + + + +
+
+

URL Shortener

+
+

Paste the URL to be shortened

+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+
+
+
+ + \ No newline at end of file diff --git a/src/main/resources/templates/shortenedUrl.html b/src/main/resources/templates/shortenedUrl.html new file mode 100644 index 00000000..ff568969 --- /dev/null +++ b/src/main/resources/templates/shortenedUrl.html @@ -0,0 +1,55 @@ + + + + + + Bootstrap demo + + + +
+
+

URL Shortener

+
+

Original URL +

+
+
+ +
+
+

Your shortened URL

+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+
+ +
+
+ +
+
+
+
+ + \ No newline at end of file diff --git a/src/main/resources/templates/totalUrlClicks.html b/src/main/resources/templates/totalUrlClicks.html new file mode 100644 index 00000000..7c57551d --- /dev/null +++ b/src/main/resources/templates/totalUrlClicks.html @@ -0,0 +1,48 @@ + + + + + + Bootstrap demo + + + +
+
+

URL Shortener

+
+

Shortened URL

+
+
+ +
+
+

Total URL Clicks +

+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+
+
+
+ + \ No newline at end of file diff --git a/src/main/resources/templates/urlClickCounter.html b/src/main/resources/templates/urlClickCounter.html new file mode 100644 index 00000000..4f1a82d2 --- /dev/null +++ b/src/main/resources/templates/urlClickCounter.html @@ -0,0 +1,43 @@ + + + + + + Bootstrap demo + + + +
+
+

URL Click Counter

+
+

Enter the URL to track how many clicks it received. +

+
+
+ http://localhost:8080/ + +
+
+
+
+ +
+
+
+
+ + + +
+ + \ No newline at end of file