feat: Url 엔티티 및 값 객체 생성

README.md

@@ -1,4 +1,5 @@
 # springboot-url-shortener
+
 SprintBoot URL Shortener 구현 미션 Repository 입니다.
 
 ## 요구사항
@@ -7,7 +8,7 @@ SprintBoot URL Shortener 구현 미션 Repository 입니다.
 - [ ] URL Shortening Key는 8 Character 이내로 생성
 - [ ] 단축된 URL 요청시 원래 URL로 리다이렉트
 - [ ] 단축된 URL에 대한 요청 수 정보저장 (optional)
-- [ ] Shortening Key를 생성하는 알고리즘 2개 이상 제공하며 애플리케이션 실행중 동적으로 변경 가능 (optional) 
+- [ ] Shortening Key를 생성하는 알고리즘 2개 이상 제공하며 애플리케이션 실행중 동적으로 변경 가능 (optional)
 
 ## API 명세
 
@@ -16,20 +17,24 @@ SprintBoot URL Shortener 구현 미션 Repository 입니다.
 ## 동작화면
 
 ## Short URL Service
+
 ### 읽으면 좋은 레퍼런스
+
 - [Naver 단축 URL API](https://developers.naver.com/docs/utils/shortenurl/)
 - [짧게 줄인 URL의 실제 URL 확인 원리 및 방법](https://metalkin.tistory.com/50)
 - [짧게 줄인 URL 알고리즘 고찰](https://metalkin.tistory.com/53)
 - [단축 URL 원리 및 개발](https://blog.siyeol.com/26)
 
 ### Short URL의 동작 과정
+
 1. 원본 URL을 입력하고 Shorten 버튼을 클릭합니다.
 2. Unique Key를 7문자 생성합니다.
 3. Unique Key와 원본 URL을 DB에 저장합니다.
 4. bitly.com/{Unique Key} 로 접근하면, DB를 조회하여 원본 URL로 redirect합니다.
 
 ### Short URL의 특징
-단축 URL서비스는 간편하지만, 단점(위험성)이 있습니다. 
+
+단축 URL서비스는 간편하지만, 단점(위험성)이 있습니다.
 링크를 클릭하는 사용자는 단축된 URL만 보고 클릭하기 때문에 어떤 곳으로 이동할지 알 수 없습니다.
 
 - Short URL 서비스는 주로 요청을 Redirect 시킵니다. (Redirect와 Forward의 차이점에 대해 검색해보세요.)
@@ -40,4 +45,5 @@ SprintBoot URL Shortener 구현 미션 Repository 입니다.
 - 기존의 원본 URL 변경되었더라도 단축 URL을 유지하여, 혼란을 방지할 수 있다.
 
 ### 예시 사이트
+
 [https://url.kr/](https://url.kr/)

src/main/java/com/tangerine/urlshortener/Algorithm.java

@@ -0,0 +1,27 @@
+package com.tangerine.urlshortener;
+
+import io.micrometer.common.util.StringUtils;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import jakarta.validation.constraints.NotBlank;
+import org.springframework.util.Assert;
+
+@Embeddable
+public class Algorithm {
+
+    @NotBlank
+    @Column(name = "algorithm", nullable = false)
+    private String algorithm;
+
+    public Algorithm(String algorithm) {
+        Assert.isTrue(StringUtils.isNotBlank(algorithm), "단축 Url 알고리즘은 반드시 주어져야 합니다.");
+        this.algorithm = algorithm;
+    }
+
+    protected Algorithm() {
+    }
+
+    public String getAlgorithm() {
+        return algorithm;
+    }
+}

src/main/java/com/tangerine/urlshortener/OriginUrl.java

@@ -0,0 +1,27 @@
+package com.tangerine.urlshortener;
+
+import io.micrometer.common.util.StringUtils;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import jakarta.validation.constraints.NotBlank;
+import org.springframework.util.Assert;
+
+@Embeddable
+public class OriginUrl {
+
+    @NotBlank
+    @Column(name = "origin_url", nullable = false, unique = true)
+    private String originUrlText;
+
+    public OriginUrl(String originUrlText) {
+        Assert.isTrue(StringUtils.isNotBlank(originUrlText), "원본 url은 반드시 주어져야 합니다.");
+        this.originUrlText = originUrlText;
+    }
+
+    protected OriginUrl() {
+    }
+
+    public String getOriginUrlText() {
+        return originUrlText;
+    }
+}

src/main/java/com/tangerine/urlshortener/RequestCount.java

@@ -0,0 +1,26 @@
+package com.tangerine.urlshortener;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import jakarta.validation.constraints.Positive;
+import org.springframework.util.Assert;
+
+@Embeddable
+public class RequestCount {
+
+    @Positive
+    @Column(name = "request_count", nullable = false)
+    private long requestCount;
+
+    public RequestCount(long requestCount) {
+        Assert.isTrue(requestCount >= 0, "호출 횟수는 양수여야 합니다.");
+        this.requestCount = requestCount;
+    }
+
+    protected RequestCount() {
+    }
+
+    public long getRequestCount() {
+        return requestCount;
+    }
+}

src/main/java/com/tangerine/urlshortener/ShortUrl.java

@@ -0,0 +1,28 @@
+package com.tangerine.urlshortener;
+
+import io.micrometer.common.util.StringUtils;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import jakarta.validation.constraints.NotBlank;
+import org.springframework.util.Assert;
+
+@Embeddable
+public class ShortUrl {
+
+    @NotBlank
+    @Column(name = "short_url", nullable = false, unique = true)
+    private String shortUrlText;
+
+    public ShortUrl(String shortUrlText) {
+        Assert.isTrue(StringUtils.isNotBlank(shortUrlText), "단축 url은 반드시 주어져야 합니다.");
+        Assert.isTrue(shortUrlText.length() <= 8, "단축 url은 8자 이하여야 합니다.");
+        this.shortUrlText = shortUrlText;
+    }
+
+    protected ShortUrl() {
+    }
+
+    public String getShortUrlText() {
+        return shortUrlText;
+    }
+}

src/main/java/com/tangerine/urlshortener/Url.java

@@ -0,0 +1,68 @@
+package com.tangerine.urlshortener;
+
+import jakarta.persistence.Embedded;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+
+@Entity
+@Table(name = "urls")
+public class Url {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Embedded
+    private OriginUrl originUrl;
+
+    @Embedded
+    private ShortUrl shortUrl;
+
+    @Embedded
+    private Algorithm algorithm;
+
+    @Embedded
+    private RequestCount requestCount;
+
+    public Url(OriginUrl originUrl, ShortUrl shortUrl, Algorithm algorithm, RequestCount requestCount) {
+        this.originUrl = originUrl;
+        this.shortUrl = shortUrl;
+        this.algorithm = algorithm;
+        this.requestCount = requestCount;
+    }
+
+    protected Url() {
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public OriginUrl getOriginUrl() {
+        return originUrl;
+    }
+
+    public String getOriginUrlText() {
+        return originUrl.getOriginUrlText();
+    }
+
+    public ShortUrl getShortUrl() {
+        return shortUrl;
+    }
+
+    public String getShortUrlText() {
+        return shortUrl.getShortUrlText();
+    }
+
+    public Algorithm getAlgorithm() {
+        return algorithm;
+    }
+
+    public RequestCount getRequestCount() {
+        return requestCount;
+    }
+
+}

src/main/resources/application.yaml

@@ -1,4 +1,3 @@
-
 spring:
   h2:
     console:

src/test/java/com/tangerine/urlshortener/UrlTest.java

@@ -0,0 +1,51 @@
+package com.tangerine.urlshortener;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.catchException;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+class UrlTest {
+
+    @Test
+    @DisplayName("올바른 정보로 생성한다.")
+    void instance_Success() {
+        // Given
+        String originUrlText = "origin";
+        String shortUrlText = "short";
+
+        // When
+        Url url = new Url(
+                new OriginUrl(originUrlText),
+                new ShortUrl(shortUrlText),
+                new Algorithm("알고리즘"),
+                new RequestCount(0)
+        );
+
+        // Then
+        assertThat(url.getOriginUrlText()).isEqualTo(originUrlText);
+        assertThat(url.getShortUrlText()).isEqualTo(shortUrlText);
+    }
+
+    @Test
+    @DisplayName("올바르지 않은 정보로 생성 실패한다.")
+    void instance_fail() {
+        // Given
+        String originUrlText = "";
+        String shortUrlText = "short";
+
+        // When
+        Exception exception = catchException(() ->
+                new Url(
+                        new OriginUrl(originUrlText),
+                        new ShortUrl(shortUrlText),
+                        new Algorithm(""),
+                        new RequestCount(-1)
+                ));
+
+        // Then
+        assertThat(exception).isInstanceOf(IllegalArgumentException.class);
+    }
+
+}