🔥 TIL - Day 70 Kotlin & Springboot 01 CRUD Rest API 구현 및 Junit 테스트

전체소스 Github

처음 접하는 언어이고 다른 그대로 코드를 갖다 쓴 것이 아니기 때문에 오류가 있을 수 있습니다.

📌 도메인 설계

제목, 내용을 갖는 Article 클래스를 정의한다.
kotlin의 기본적인 문법을 알아보기 위함이므로 DB는 사용하지 않고 Pojo한 클래스로 작성한다.

data class Article(
    val title: String,
    val content: String,
)

Kotlin의 첫번째 매력 포인트...
위 클래스는 생성자, Getter, Equals And HashCode, ToString을 모두 포함한다.
body(중괄호)가 없는게 굉장히 인상적이다.

primary constructor 필드의 타입을 val로 지정하면 해당 필드를 public하게 읽을 수 있다. 실제로 Java class 파일로 디컴파일 된 결과 또한 Getter가 호출된다.

var로 작성하는 경우 해당 필드를 완전히 public하게 열어두는 것과 동일하다. 읽기와 수정 모두 필드에 직접 접근하여 수행 가능하다. (실제 Java 코드로는 getter, setter가 호출된다)

primary constructor에서 var를 사용하는 것은 쪼금 위험할 수도?
엔티티의 변경은 비즈니스 로직을 반영한 메서드를 사용하는 것이 좋을 듯 하다.

다음으로 class 앞에 붙은 data 키워드는 Equals And HashCode, ToString를 제공한다. Lombok의 @Data 와 비슷한 느낌이다. 이 역시 굉장히 편리하지만 위 클래스가 엔티티가 된다면 주의해야 할 것이다.

---

📌 InMemoryRepository 구현

메모리(Map)을 이용해서 Repository를 구현해보자.

@Repository
class ArticleRepositoryImpl : ArticleRepository {
    var sequence: Long = 0L
    var store = mutableMapOf<Long, Article>(
        ++sequence to Article("article1", "content1"),
        ++sequence to Article("article2", "content2"),
        ++sequence to Article("article3", "content3"),
    )
}

Map의 경우 수정이 가능하도록 mutableMap을 사용했다.

CRUD 구현

getArticle의 리턴타입이 Article?이다.
Kotlin의 장점 중 하나인 null safety의 한 부분인데 Java의 Optional과 비슷한 개념으로 생각하면 될 것 같다.

Java의 경우 null 객체에 length 혹은 getter 등 메서드를 호출한다면 NullPointException(NPE)이 발생된다. 이를 방지하기 위한 것은 null-safety 이다.

나중에 테스트 부분에서 나오겠지만 Article?로 리턴된 객체에 NPE가 발생하는 상황이 생긴다면 해당 부분을 무시한 채 진행한다.

@Repository
class ArticleRepositoryImpl : ArticleRepository {
    var sequence:  Long = 0L
    var store = mutableMapOf<Long, Article>(
        ++sequence to Article("article1", "content1"),
        ++sequence to Article("article2", "content2"),
        ++sequence to Article("article3", "content3"),
    )

    override fun getArticles() = this.store.values

    override fun getArticle(articleId: Long): Article? = this.store.get(articleId)

    override fun saveArticle(articleDto: ArticleRequestDto) {
        val article = Article(articleDto.title, articleDto.content)
        store[++sequence] = article
    }

    override fun deleteArticle(articleId: Long) {
        if (store.containsKey(articleId)) {
            store.remove(articleId)
        } else {
            throw IllegalArgumentException("존재하지 않는 게시글입니다.")
        }
    }

    override fun updateArticle(articleId: Long, articleDto: ArticleRequestDto) {
        if (store.containsKey(articleId)) {
            store[articleId] = Article(articleDto.title, articleDto.content)
        } else {
            throw IllegalArgumentException("존재하지 않는 게시글입니다.")
        }
    }
}

CURD 테스트

internal class ArticleRepositoryTest {

    private val articleRepository = ArticleRepositoryImpl()

    @DisplayName("1. Article 전체조회")
    @Test
    fun getArticles() {
        val articles = articleRepository.getArticles()

        assertEquals(3, articles.size)
    }

    @DisplayName("2. Article 단건조회")
    @Test
    fun getArticle() {
        val article = articleRepository.getArticle(1L)

        assertEquals("article1", article?.title)
    }

    @DisplayName("3. Article 단건조회 (존재하지 않는 id)")
    @Test
    fun failedGetArticle() {
        val article = articleRepository.getArticle(4L)

        assertEquals(null, article?.title)
    }

    @Test
    @DisplayName("4. Article 추가")
    fun addArticle() {
        val articleDto = ArticleRequestDto("article4", "content4")

        articleRepository.saveArticle(articleDto)

        assertEquals(4, articleRepository.store.size)
    }

    @Test
    @DisplayName("5. Article 삭제")
    fun deleteArticle() {
        // Given
        val deleteArticleId = 1L

        // When
        articleRepository.deleteArticle(deleteArticleId)

        // Then
        assertEquals(2, articleRepository.store.size)
    }

    @Test
    @DisplayName("6. Article 수정")
    fun updateArticle() {
        // Given
        val updateArticleId = 1L
        val updateArticleDto = ArticleRequestDto("updatedTitle", "updatedContent")

        // When
        articleRepository.updateArticle(updateArticleId, updateArticleDto)

        // Then
        assertEquals(3, articleRepository.store.size)
        assertEquals("updatedTitle", articleRepository.store[updateArticleId]?.title)
    }
}

---

📌 Service 계층 구현

깔___끔
문법적으로 정말 너무 좋다.

@Service
class ArticleService(private val articleRepository : ArticleRepositoryImpl) {

    /**
     * 전체 Article 조회
     */
    fun getArticles() = articleRepository.getArticles()

    /**
     * Article 단건조회
     */
    fun getArticle(articleId: Long) = articleRepository.getArticle(articleId)

    /**
     * Article 추가
     */
    fun saveArticle(articleDto: ArticleRequestDto) = articleRepository.saveArticle(articleDto)


    /**
     * Article 삭제
     */
    fun deleteArticle(articleId: Long) = articleRepository.deleteArticle(articleId)

    /**
     * Article 수정
     */
    fun updateArticle(articleId: Long, articleDto: ArticleRequestDto) = articleRepository.updateArticle(articleId, articleDto)
}

---

📌 Controller 계층 구현

@RequestMapping("/api/articles")
@RestController
class ArticleController(
    private val articleService: ArticleService
) {

    @GetMapping
    fun getArticles() = articleService.getArticles()

    @GetMapping("/{articleId}")
    fun getArticle(@PathVariable articleId: Long) = articleService.getArticle(articleId)

    @PostMapping
    fun postArticle(@RequestBody articleDto : ArticleRequestDto) : ResponseEntity<Any> {
        articleService.saveArticle(articleDto)
        return ResponseEntity(HttpStatus.CREATED)
    }

    @DeleteMapping("/{articleId}")
    fun deleteArticle(@PathVariable articleId: Long) = articleService.deleteArticle(articleId)

    @PutMapping("/{articleId}")
    fun updateArticle(
        @PathVariable articleId: Long,
        @RequestBody articleDto: ArticleRequestDto
    ) = articleService.updateArticle(articleId, articleDto)
}

Controller 테스트

@AutoConfigureMockMvc
@SpringBootTest
internal class ArticleControllerTest {

    @Autowired
    lateinit var mockMvc: MockMvc

    @DisplayName("Article 전체조회 API")
    @Test
    fun 전체조회() {
        mockMvc.get("/api/articles")
            .andExpect {
                content { contentType(MediaType.APPLICATION_JSON) }
                status { isOk() }
            }
            .andDo {
                print()
            }
    }

    @DisplayName("Article 단건조회 API")
    @Test
    fun 단건조회() {
        mockMvc.get("/api/articles/{articleId}", 1L)
            .andExpect {
                status { isOk()}
                content {contentType(MediaType.APPLICATION_JSON)}
                jsonPath("$.title") { "article1" }
            }.andDo {
                print()
            }
    }

    @DisplayName("Article 저장 API")
    @Test
    fun 추가() {
        val articleDto = ArticleRequestDto("article4", "content4")
        val articleDtoJson:String = Gson().toJson(articleDto)

        mockMvc.post("/api/articles") {
            content = articleDtoJson
            contentType = MediaType.APPLICATION_JSON
        }.andExpect {
            status { isCreated() }
        }.andDo {
            print()
        }
    }

    @DisplayName("Article 삭제 API")
    @Test
    fun 삭제() {
        mockMvc.delete("/api/articles/{articleId}", 3L)
            .andExpect {
                status { isOk() }
            }
            .andDo { print() }
    }

    @Test
    @DisplayName("Article 수정 API")
    fun 수정() {
        val updateRequestDto = ArticleRequestDto("updatedTitle", "updatedContent")
        val updateRequestDtoJosn = Gson().toJson(updateRequestDto)
        mockMvc.put("/api/articles/{articleId}", 1L)
            {
                contentType = MediaType.APPLICATION_JSON
                content = updateRequestDtoJosn
            }
            .andDo { print() }
            .andExpect {
                status { isOk() }
            }
    }
}

Kotlin .. 첫인상이 너무 좋다.