diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..1db1dbf88 --- /dev/null +++ b/.gitignore @@ -0,0 +1,146 @@ +# Created by https://www.toptal.com/developers/gitignore/api/java,intellij +# Edit at https://www.toptal.com/developers/gitignore?templates=java,intellij + +### Intellij ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Intellij Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +# https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +# SonarQube Plugin +# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator-enh.xml +.idea/**/markdown-navigator/ + +# Cache file creation bug +# See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/$CACHE_FILE$ + +# CodeStream plugin +# https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +# Azure Toolkit for IntelliJ plugin +# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij +.idea/**/azureSettings.xml + +### Java ### +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* +replay_pid* + +# End of https://www.toptal.com/developers/gitignore/api/java,intellij +/.idea/ +/build/ +/gradle/ diff --git a/HELP.md b/HELP.md new file mode 100644 index 000000000..3eb79d1d3 --- /dev/null +++ b/HELP.md @@ -0,0 +1,28 @@ +# Getting Started + +### Reference Documentation + +For further reference, please consider the following sections: + +* [Official Gradle documentation](https://docs.gradle.org) +* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.1.2/gradle-plugin/reference/html/) +* [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.1.2/gradle-plugin/reference/html/#build-image) +* [Spring Web](https://docs.spring.io/spring-boot/docs/3.1.2/reference/htmlsinge/index.html#web) +* [Spring Data JPA](https://docs.spring.io/spring-boot/docs/3.1.2/reference/htmlsinge/index.html#data.sql.jpa-and-spring-data) +* [Spring REST Docs](https://docs.spring.io/spring-restdocs/docs/current/reference/html5/) + +### Guides + +The following guides illustrate how to use some features concretely: + +* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) +* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/) +* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/) +* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/) + +### Additional Links + +These additional references should also help you: + +* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle) + diff --git a/README.md b/README.md index cb154de0f..7962161f0 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,40 @@ Spring Boot JPA - Rest API를 강의를 듣고, 게시판 구현 미션을 수 1. 여러분 repo는 알아서 해주시고 😀(본인 레포니 main으로 하셔두 되져) 2. prgrms-be-devcourse/spring-board 레포로 PR시 branch는 본인 username을 적어주세요 :) base repo : `여기repo` base : `username` ← head repo : `여러분repo` compare : `main` + +# SpringBoot Part4 7. 게시판 구현 + +# **요구 사항** + +### **SpringDataJPA 를 설정한다.** + +- datasource : h2 or mysql + +### **엔티티를 구성한다** + +- 회원(User) + - id (PK) (auto increment) + - name + - age + - hobby + - **created_at** + - **created_by** +- 게시글(Post) + - id (PK) (auto increment) + - title + - content + - **created_at** + - **created_by** +- 회원과 게시글에 대한 연관관계를 설정한다. + - 회원과 게시글은 1:N 관계이다. +- 게시글 Repository를 구현한다. (PostRepository) + +### **API를 구현한다.** + +- 게시글 조회 + - 페이징 조회 (GET "/posts") + - 단건 조회 (GET "/posts/{id}") +- 게시글 작성 (POST "/posts") +- 게시글 수정 (POST "/posts/{id}") + +### **REST-DOCS를 이용해서 문서화한다.** diff --git a/build.gradle b/build.gradle new file mode 100644 index 000000000..610299a5c --- /dev/null +++ b/build.gradle @@ -0,0 +1,81 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.2' + id 'io.spring.dependency-management' version '1.1.2' + id 'org.asciidoctor.jvm.convert' version '3.3.2' +} + +group = 'kr.co.prgrms' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +ext { + snippetsDir = file('build/generated-snippets') +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } + asciidoctorExtensions +} + +repositories { + mavenCentral() +} + +ext { + set('snippetsDir', file("build/generated-snippets")) +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + 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' + + asciidoctorExtensions 'org.springframework.restdocs:spring-restdocs-asciidoctor' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' +} + +tasks.named('test') { + useJUnitPlatform() +} + +test { + outputs.dir snippetsDir + useJUnitPlatform() +} + +asciidoctor { + configurations 'asciidoctorExtensions' + baseDirFollowsSourceFile() + inputs.dir snippetsDir + dependsOn test +} + +asciidoctor.doFirst { + delete file('src/main/resources/static/docs') +} + +task copyDocument(type: Copy) { + dependsOn asciidoctor + + from file("build/docs/asciidoc") + into file("src/main/resources/static/docs") +} + +bootJar { + dependsOn copyDocument +} + +build { + dependsOn copyDocument +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..033e24c4c 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 000000000..9f4197d5f --- /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 000000000..fcb6fca14 --- /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 000000000..93e3f59f1 --- /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 000000000..0795530c5 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springboot-board-jpa' diff --git a/src/docs/asciidoc/asciidoc.adoc b/src/docs/asciidoc/asciidoc.adoc new file mode 100644 index 000000000..72435241f --- /dev/null +++ b/src/docs/asciidoc/asciidoc.adoc @@ -0,0 +1,55 @@ +ifndef::snippets[] +:snippets: ../../../build/generated-snippets +endif::[] + += Spring REST Docs +:toc: left +:toclevels: 2 +:sectlinks: + +[[resources-post]] +== Post + +[[resources-find-all]] +=== 모든 Post 조회하기 + +==== HTTP request + +include::{snippets}/Post-find-all/http-request.adoc[] + +==== HTTP response + +include::{snippets}/Post-find-all/http-response.adoc[] + +[[resources-find-by-id]] +=== Post ID로 조회하기 + +==== HTTP request + +include::{snippets}/Post-find-by-id/http-request.adoc[] + +==== HTTP response + +include::{snippets}/Post-find-by-id/http-response.adoc[] + +[[resources-save]] +=== Post 저장하기 + +==== HTTP request + +include::{snippets}/Post-save/http-request.adoc[] + +==== HTTP response + +include::{snippets}/Post-save/http-response.adoc[] + +[[resources-update]] +=== Post 업데이트하기 + +==== HTTP request + +include::{snippets}/Post-update/http-request.adoc[] + +==== HTTP response + +include::{snippets}/Post-update/http-response.adoc[] diff --git a/src/main/java/prgrms/board/SpringbootBoardJpaApplication.java b/src/main/java/prgrms/board/SpringbootBoardJpaApplication.java new file mode 100644 index 000000000..0fcbdd905 --- /dev/null +++ b/src/main/java/prgrms/board/SpringbootBoardJpaApplication.java @@ -0,0 +1,11 @@ +package prgrms.board; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringbootBoardJpaApplication { + public static void main(String[] args) { + SpringApplication.run(SpringbootBoardJpaApplication.class, args); + } +} diff --git a/src/main/java/prgrms/board/config/JpaConfig.java b/src/main/java/prgrms/board/config/JpaConfig.java new file mode 100644 index 000000000..393c1eee2 --- /dev/null +++ b/src/main/java/prgrms/board/config/JpaConfig.java @@ -0,0 +1,9 @@ +package prgrms.board.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@Configuration +@EnableJpaAuditing +public class JpaConfig { +} diff --git a/src/main/java/prgrms/board/global/domain/BaseEntity.java b/src/main/java/prgrms/board/global/domain/BaseEntity.java new file mode 100644 index 000000000..bbd19e4cb --- /dev/null +++ b/src/main/java/prgrms/board/global/domain/BaseEntity.java @@ -0,0 +1,24 @@ +package prgrms.board.global.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import lombok.Getter; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +@Getter +public abstract class BaseEntity { + @CreatedDate + @Column(name = "created_at") + private LocalDateTime createdAt; + + @LastModifiedDate + @Column(name = "updated_at") + private LocalDateTime updatedAt; +} diff --git a/src/main/java/prgrms/board/global/exception/ErrorCode.java b/src/main/java/prgrms/board/global/exception/ErrorCode.java new file mode 100644 index 000000000..58a505423 --- /dev/null +++ b/src/main/java/prgrms/board/global/exception/ErrorCode.java @@ -0,0 +1,33 @@ +package prgrms.board.global.exception; + +import org.springframework.http.HttpStatus; + +import static org.springframework.http.HttpStatus.*; + +public enum ErrorCode { + USER_NOT_FOUND(NOT_FOUND, "유저를 찾을 수 없습니다."), + INVALID_USER_AGE(BAD_REQUEST, "나이는 7세이상 120세 이하의 값만 가능합니다."), + INVALID_USER_NAME(BAD_REQUEST, "이름은 50글자이하 영어 혹은 한글만 가능합니다."), + + POST_NOT_FOUND(NOT_FOUND, "게시글을 찾을 수 없습니다."), + EMPTY_POST_TITLE(BAD_REQUEST, "게시글의 제목은 50글자이하로 비어있으면 안됩니다."), + EMPTY_POST_CONTENT(BAD_REQUEST, "게시글의 본문은 비어있으면 안됩니다."), + INVALID_CREATED_BY_VALUE(BAD_REQUEST, "작성자의 이름은 50글자이하로 비어있으면 안됩니다."); + + + private final HttpStatus status; + private final String message; + + ErrorCode(HttpStatus status, String message) { + this.status = status; + this.message = message; + } + + public HttpStatus getStatus() { + return status; + } + + public String getMessage() { + return message; + } +} diff --git a/src/main/java/prgrms/board/post/application/PostService.java b/src/main/java/prgrms/board/post/application/PostService.java new file mode 100644 index 000000000..a2faf8e39 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/PostService.java @@ -0,0 +1,88 @@ +package prgrms.board.post.application; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; +import prgrms.board.global.exception.ErrorCode; +import prgrms.board.post.application.dto.request.PostSaveRequest; +import prgrms.board.post.application.dto.request.PostUpdateRequest; +import prgrms.board.post.application.dto.response.PostFindResponse; +import prgrms.board.post.application.dto.response.PostSaveResponse; +import prgrms.board.post.application.dto.response.PostUpdateResponse; +import prgrms.board.post.domain.Post; +import prgrms.board.post.domain.PostRepository; +import prgrms.board.post.exception.PostNotFoundException; +import prgrms.board.user.domain.User; +import prgrms.board.user.domain.UserRepository; +import prgrms.board.user.exception.UserNotFoundException; + +import java.time.LocalDateTime; +import java.util.List; +import java.util.Optional; + +@Service +@Transactional(readOnly = true) +public class PostService { + private final PostRepository postRepository; + private final UserRepository userRepository; + + public PostService( + PostRepository postRepository, + UserRepository userRepository + ) { + this.postRepository = postRepository; + this.userRepository = userRepository; + } + + @Transactional + public PostSaveResponse savePost(PostSaveRequest request) { + Post newPost = request.toEntity(); + + Long userId = request.userId(); + User user = userRepository.findById(userId) + .orElseThrow(() -> new UserNotFoundException( + ErrorCode.USER_NOT_FOUND, + this.getClass().getName() + )); + newPost.updateUser(user); + + postRepository.save(newPost); + + return PostSaveResponse.of(newPost); + } + + @Transactional + public PostUpdateResponse updatePost( + Long postId, + PostUpdateRequest request + ) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new PostNotFoundException( + ErrorCode.POST_NOT_FOUND, + this.getClass().getName() + )); + + String postTitle = request.title(); + String postContent = request.content(); + post.updateTitle(postTitle); + post.updateContent(postContent); + + return PostUpdateResponse.of(post); + } + + public PostFindResponse findByPostId(Long postId) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new PostNotFoundException( + ErrorCode.POST_NOT_FOUND, + this.getClass().getName() + )); + + return PostFindResponse.of(post); + } + + public Page findAll(Pageable pageable) { + return postRepository.findAll(pageable) + .map(PostFindResponse::of); + } +} diff --git a/src/main/java/prgrms/board/post/application/dto/request/PostSaveRequest.java b/src/main/java/prgrms/board/post/application/dto/request/PostSaveRequest.java new file mode 100644 index 000000000..a6a6e0f41 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/dto/request/PostSaveRequest.java @@ -0,0 +1,14 @@ +package prgrms.board.post.application.dto.request; + + +import prgrms.board.post.domain.Post; + +public record PostSaveRequest( + Long userId, + String title, + String content +) { + public Post toEntity() { + return new Post(this.title, this.content); + } +} diff --git a/src/main/java/prgrms/board/post/application/dto/request/PostUpdateRequest.java b/src/main/java/prgrms/board/post/application/dto/request/PostUpdateRequest.java new file mode 100644 index 000000000..e4688a895 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/dto/request/PostUpdateRequest.java @@ -0,0 +1,7 @@ +package prgrms.board.post.application.dto.request; + +public record PostUpdateRequest( + String title, + String content +) { +} diff --git a/src/main/java/prgrms/board/post/application/dto/response/PostFindResponse.java b/src/main/java/prgrms/board/post/application/dto/response/PostFindResponse.java new file mode 100644 index 000000000..8e25a58f9 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/dto/response/PostFindResponse.java @@ -0,0 +1,24 @@ +package prgrms.board.post.application.dto.response; + +import prgrms.board.post.domain.Post; + +import java.time.LocalDateTime; + +public record PostFindResponse( + String createdBy, + String title, + String content, + LocalDateTime createdAt +) { + public static PostFindResponse of(Post post) { + String postCreatedBy = post.getCreatedBy(); + String postTitle = post.getTitle(); + String postContent = post.getContent(); + LocalDateTime postCreatedAt = post.getCreatedAt(); + + return new PostFindResponse( + postCreatedBy, postTitle, + postContent, postCreatedAt + ); + } +} diff --git a/src/main/java/prgrms/board/post/application/dto/response/PostSaveResponse.java b/src/main/java/prgrms/board/post/application/dto/response/PostSaveResponse.java new file mode 100644 index 000000000..de7f672d7 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/dto/response/PostSaveResponse.java @@ -0,0 +1,17 @@ +package prgrms.board.post.application.dto.response; + +import prgrms.board.post.domain.Post; + +import java.time.LocalDateTime; + +public record PostSaveResponse( + Long postId, + LocalDateTime createdAt +) { + public static PostSaveResponse of(Post newPost) { + long postId = newPost.getId(); + LocalDateTime postCreatedAt = newPost.getCreatedAt(); + + return new PostSaveResponse(postId, postCreatedAt); + } +} diff --git a/src/main/java/prgrms/board/post/application/dto/response/PostUpdateResponse.java b/src/main/java/prgrms/board/post/application/dto/response/PostUpdateResponse.java new file mode 100644 index 000000000..9465dcdd9 --- /dev/null +++ b/src/main/java/prgrms/board/post/application/dto/response/PostUpdateResponse.java @@ -0,0 +1,26 @@ +package prgrms.board.post.application.dto.response; + +import prgrms.board.post.domain.Post; + +import java.time.LocalDateTime; + +public record PostUpdateResponse( + Long postId, + String title, + String content, + String createdBy, + LocalDateTime updatedAt +) { + public static PostUpdateResponse of(Post post) { + Long postId = post.getId(); + String postTitle = post.getTitle(); + String postContent = post.getContent(); + String postCreatedBy = post.getCreatedBy(); + LocalDateTime postUpdatedAt = post.getUpdatedAt(); + + return new PostUpdateResponse( + postId, postTitle, postContent, + postCreatedBy, postUpdatedAt + ); + } +} diff --git a/src/main/java/prgrms/board/post/domain/Post.java b/src/main/java/prgrms/board/post/domain/Post.java new file mode 100644 index 000000000..25c03a3fc --- /dev/null +++ b/src/main/java/prgrms/board/post/domain/Post.java @@ -0,0 +1,94 @@ +package prgrms.board.post.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.springframework.util.StringUtils; +import prgrms.board.global.domain.BaseEntity; +import prgrms.board.global.exception.ErrorCode; +import prgrms.board.post.exception.IllegalPostDataException; +import prgrms.board.user.domain.User; + +import java.util.Objects; + +@Entity +@Table(name = "posts") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Post extends BaseEntity { + private static final String className = Post.class.getName(); + private static final int MAXIMUM_LENGTH = 50; + + @Id + @Column(name = "post_id") + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private long id; + @Column(nullable = false, length = 50) + private String title; + @Column(nullable = false) + private String content; + @Column(nullable = false, length = 50) + private String createdBy; + + @ManyToOne + @JoinColumn(name = "user_id") + private User user; + + public Post(String title, String content) { + validateTitle(title); + validateContent(content); + + this.title = title; + this.content = content; + } + + public void updateTitle(String title) { + validateTitle(title); + this.title = title; + } + + public void updateContent(String content) { + validateContent(content); + this.content = content; + } + + public void updateUser(User user) { + if (Objects.nonNull(this.user)) { + this.user.getPosts().remove(this); + } + + this.user = user; + user.getPosts().add(this); + String name = user.getName(); + updateCreatedBy(name); + } + + private void validateTitle(String title) { + if (!StringUtils.hasText(title) || + title.length() > MAXIMUM_LENGTH) { + throw new IllegalPostDataException(ErrorCode.EMPTY_POST_TITLE, className); + } + } + + private void validateContent(String content) { + if (!StringUtils.hasText(content)) { + throw new IllegalPostDataException(ErrorCode.EMPTY_POST_CONTENT, className); + } + } + + private void updateCreatedBy(String createdBy) { + if (!StringUtils.hasText(createdBy) || + createdBy.length() > MAXIMUM_LENGTH) { + throw new IllegalPostDataException(ErrorCode.INVALID_CREATED_BY_VALUE, className); + } + this.createdBy = createdBy; + } +} diff --git a/src/main/java/prgrms/board/post/domain/PostRepository.java b/src/main/java/prgrms/board/post/domain/PostRepository.java new file mode 100644 index 000000000..ece41211f --- /dev/null +++ b/src/main/java/prgrms/board/post/domain/PostRepository.java @@ -0,0 +1,9 @@ +package prgrms.board.post.domain; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.jpa.repository.JpaRepository; + +public interface PostRepository extends JpaRepository { + Page findAll(Pageable pageable); +} diff --git a/src/main/java/prgrms/board/post/exception/IllegalPostDataException.java b/src/main/java/prgrms/board/post/exception/IllegalPostDataException.java new file mode 100644 index 000000000..2ebc6adad --- /dev/null +++ b/src/main/java/prgrms/board/post/exception/IllegalPostDataException.java @@ -0,0 +1,16 @@ +package prgrms.board.post.exception; + +import lombok.Getter; +import prgrms.board.global.exception.ErrorCode; + +@Getter +public class IllegalPostDataException extends RuntimeException { + + private final ErrorCode errorCode; + private final String className; + + public IllegalPostDataException(ErrorCode errorCode, String className) { + this.errorCode = errorCode; + this.className = className; + } +} diff --git a/src/main/java/prgrms/board/post/exception/PostNotFoundException.java b/src/main/java/prgrms/board/post/exception/PostNotFoundException.java new file mode 100644 index 000000000..593cda3a8 --- /dev/null +++ b/src/main/java/prgrms/board/post/exception/PostNotFoundException.java @@ -0,0 +1,15 @@ +package prgrms.board.post.exception; + +import lombok.Getter; +import prgrms.board.global.exception.ErrorCode; + +@Getter +public class PostNotFoundException extends RuntimeException { + private final ErrorCode errorCode; + private final String className; + + public PostNotFoundException(ErrorCode errorCode, String className) { + this.errorCode = errorCode; + this.className = className; + } +} diff --git a/src/main/java/prgrms/board/post/presentation/PostController.java b/src/main/java/prgrms/board/post/presentation/PostController.java new file mode 100644 index 000000000..48d6b7354 --- /dev/null +++ b/src/main/java/prgrms/board/post/presentation/PostController.java @@ -0,0 +1,79 @@ +package prgrms.board.post.presentation; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.domain.Sort; +import org.springframework.data.web.PageableDefault; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +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.PutMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; +import prgrms.board.post.application.PostService; +import prgrms.board.post.application.dto.request.PostSaveRequest; +import prgrms.board.post.application.dto.request.PostUpdateRequest; +import prgrms.board.post.application.dto.response.PostFindResponse; +import prgrms.board.post.application.dto.response.PostSaveResponse; +import prgrms.board.post.application.dto.response.PostUpdateResponse; + +import java.util.List; + +@RestController +@RequestMapping("api/v1/posts") +public class PostController { + private final PostService postService; + + public PostController(PostService postService) { + this.postService = postService; + } + + @PostMapping + public ResponseEntity saveNewPost( + @RequestBody PostSaveRequest request + ) { + var response = postService.savePost(request); + + return ResponseEntity + .status(HttpStatus.CREATED) + .body(response); + } + + @PutMapping("/{id}") + public ResponseEntity updatePost( + @PathVariable Long id, + @RequestBody PostUpdateRequest request + ) { + var response = postService.updatePost(id, request); + + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } + + @GetMapping + public ResponseEntity> findAll( + @PageableDefault( + size = 10, sort = "createdAt", + direction = Sort.Direction.DESC + ) Pageable pageable + ) { + var response = postService.findAll(pageable); + + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } + + @GetMapping("/{id}") + public ResponseEntity findByPostId(@PathVariable Long id) { + var response = postService.findByPostId(id); + + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } +} diff --git a/src/main/java/prgrms/board/user/application/UserService.java b/src/main/java/prgrms/board/user/application/UserService.java new file mode 100644 index 000000000..05061b7f7 --- /dev/null +++ b/src/main/java/prgrms/board/user/application/UserService.java @@ -0,0 +1,34 @@ +package prgrms.board.user.application; + +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; +import prgrms.board.user.application.dto.request.UserSaveRequest; +import prgrms.board.user.application.dto.response.UserFindResponse; +import prgrms.board.user.application.dto.response.UserSaveResponse; +import prgrms.board.user.domain.User; +import prgrms.board.user.domain.UserRepository; + +@Service +@Transactional(readOnly = true) +public class UserService { + private final UserRepository userRepository; + + public UserService(UserRepository userRepository) { + this.userRepository = userRepository; + } + + @Transactional + public UserSaveResponse saveUser(UserSaveRequest request) { + User newUser = request.toEntity(); + User savedUser = userRepository.save(newUser); + + return UserSaveResponse.of(savedUser); + } + + public UserFindResponse findById(Long userId) { + User userById = userRepository.findById(userId) + .orElseThrow(); + + return UserFindResponse.of(userById); + } +} diff --git a/src/main/java/prgrms/board/user/application/dto/request/UserSaveRequest.java b/src/main/java/prgrms/board/user/application/dto/request/UserSaveRequest.java new file mode 100644 index 000000000..02a3ba82f --- /dev/null +++ b/src/main/java/prgrms/board/user/application/dto/request/UserSaveRequest.java @@ -0,0 +1,9 @@ +package prgrms.board.user.application.dto.request; + +import prgrms.board.user.domain.User; + +public record UserSaveRequest(String name, Integer age) { + public User toEntity() { + return new User(this.name, this.age); + } +} diff --git a/src/main/java/prgrms/board/user/application/dto/response/UserFindResponse.java b/src/main/java/prgrms/board/user/application/dto/response/UserFindResponse.java new file mode 100644 index 000000000..a6f6ce5ae --- /dev/null +++ b/src/main/java/prgrms/board/user/application/dto/response/UserFindResponse.java @@ -0,0 +1,25 @@ +package prgrms.board.user.application.dto.response; + +import prgrms.board.post.domain.Post; +import prgrms.board.user.domain.User; + +import java.util.List; + +public record UserFindResponse( + String name, + Integer age, + String hobby, + List posts +) { + public static UserFindResponse of(User user) { + String userName = user.getName(); + int userAge = user.getAge(); + String userHobby = user.getHobby(); + List userPosts = user.getPosts(); + + return new UserFindResponse( + userName, userAge, + userHobby, userPosts + ); + } +} diff --git a/src/main/java/prgrms/board/user/application/dto/response/UserSaveResponse.java b/src/main/java/prgrms/board/user/application/dto/response/UserSaveResponse.java new file mode 100644 index 000000000..8ee9ba192 --- /dev/null +++ b/src/main/java/prgrms/board/user/application/dto/response/UserSaveResponse.java @@ -0,0 +1,17 @@ +package prgrms.board.user.application.dto.response; + +import prgrms.board.user.domain.User; + +public record UserSaveResponse( + Long userId, + String name, + Integer age +) { + public static UserSaveResponse of(User user) { + long savedId = user.getId(); + String savedName = user.getName(); + int savedAge = user.getAge(); + + return new UserSaveResponse(savedId, savedName, savedAge); + } +} diff --git a/src/main/java/prgrms/board/user/domain/User.java b/src/main/java/prgrms/board/user/domain/User.java new file mode 100644 index 000000000..bd3302c13 --- /dev/null +++ b/src/main/java/prgrms/board/user/domain/User.java @@ -0,0 +1,83 @@ +package prgrms.board.user.domain; + +import jakarta.persistence.CascadeType; +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.FetchType; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.OneToMany; +import jakarta.persistence.Table; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.springframework.util.StringUtils; +import prgrms.board.global.domain.BaseEntity; +import prgrms.board.global.exception.ErrorCode; +import prgrms.board.post.domain.Post; +import prgrms.board.user.exception.IllegalUserDataException; + +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Pattern; + +@Entity +@Table(name = "users") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class User extends BaseEntity { + + private static final String NAME_REGEX_PATTERN = "^[가-힣a-zA-Z]+$"; + private static final int MAX_AGE = 120; + private static final int MIN_AGE = 7; + private static final int MAXIMUM_LENGTH = 50; + + @Id + @Column(name = "user_id") + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private long id; + @Column(nullable = false, length = 50) + private String name; + @Column(nullable = false) + private int age; + @Column + private String hobby; + @Column(nullable = false, length = 50) + private String createdBy; + + @OneToMany( + mappedBy = "user", + cascade = CascadeType.ALL, + orphanRemoval = true + ) + List posts = new ArrayList<>(); + + public User(String name, Integer age) { + validateName(name); + validateAge(age); + + this.name = name; + this.age = age; + this.createdBy = name; + } + + public void updateHobby(String hobby) { + this.hobby = hobby; + } + + private void validateAge(Integer age) { + if (age < MIN_AGE || age > MAX_AGE) { + throw new IllegalUserDataException(ErrorCode.INVALID_USER_AGE); + } + } + + private void validateName(String name) { + if (!StringUtils.hasText(name) || + name.length() > MAXIMUM_LENGTH || + !Pattern.matches(NAME_REGEX_PATTERN, name) + ) { + throw new IllegalUserDataException(ErrorCode.INVALID_USER_AGE); + } + } +} diff --git a/src/main/java/prgrms/board/user/domain/UserRepository.java b/src/main/java/prgrms/board/user/domain/UserRepository.java new file mode 100644 index 000000000..87781bb11 --- /dev/null +++ b/src/main/java/prgrms/board/user/domain/UserRepository.java @@ -0,0 +1,6 @@ +package prgrms.board.user.domain; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UserRepository extends JpaRepository { +} diff --git a/src/main/java/prgrms/board/user/exception/IllegalUserDataException.java b/src/main/java/prgrms/board/user/exception/IllegalUserDataException.java new file mode 100644 index 000000000..2559834e8 --- /dev/null +++ b/src/main/java/prgrms/board/user/exception/IllegalUserDataException.java @@ -0,0 +1,14 @@ +package prgrms.board.user.exception; + +import lombok.Getter; +import prgrms.board.global.exception.ErrorCode; + +@Getter +public class IllegalUserDataException extends RuntimeException { + + private final ErrorCode errorCode; + + public IllegalUserDataException(ErrorCode errorCode) { + this.errorCode = errorCode; + } +} diff --git a/src/main/java/prgrms/board/user/exception/UserNotFoundException.java b/src/main/java/prgrms/board/user/exception/UserNotFoundException.java new file mode 100644 index 000000000..22b1f7c51 --- /dev/null +++ b/src/main/java/prgrms/board/user/exception/UserNotFoundException.java @@ -0,0 +1,15 @@ +package prgrms.board.user.exception; + +import lombok.Getter; +import prgrms.board.global.exception.ErrorCode; + +@Getter +public class UserNotFoundException extends RuntimeException { + private final ErrorCode errorCode; + private final String className; + + public UserNotFoundException(ErrorCode errorCode, String className) { + this.errorCode = errorCode; + this.className = className; + } +} diff --git a/src/main/java/prgrms/board/user/presentation/UserController.java b/src/main/java/prgrms/board/user/presentation/UserController.java new file mode 100644 index 000000000..8c1523e3b --- /dev/null +++ b/src/main/java/prgrms/board/user/presentation/UserController.java @@ -0,0 +1,42 @@ +package prgrms.board.user.presentation; + +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +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.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; +import prgrms.board.user.application.UserService; +import prgrms.board.user.application.dto.request.UserSaveRequest; +import prgrms.board.user.application.dto.response.UserFindResponse; +import prgrms.board.user.application.dto.response.UserSaveResponse; + +@RestController +@RequestMapping("api/v1") +public class UserController { + private final UserService userService; + + public UserController(UserService userService) { + this.userService = userService; + } + + @PostMapping("/users") + public ResponseEntity saveUser(@RequestBody UserSaveRequest request) { + var response = userService.saveUser(request); + + return ResponseEntity + .status(HttpStatus.CREATED) + .body(response); + } + + @GetMapping("/users/{id}") + public ResponseEntity findById(@PathVariable Long id) { + UserFindResponse response = userService.findById(id); + + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..16868bb98 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,17 @@ +spring: + h2: + console: + enabled: true + jpa: + generate-ddl: true + database: H2 + show-sql: true + open-in-view: false + properties: + hibernate: + dialect: org.hibernate.dialect.H2Dialect + query.in_clause_parameter_padding: true + hbm2ddl: + auto: create-drop + connection: + autocommit: false diff --git a/src/test/java/prgrms/board/SpringbootBoardJpaApplicationTests.java b/src/test/java/prgrms/board/SpringbootBoardJpaApplicationTests.java new file mode 100644 index 000000000..c46bdc4c0 --- /dev/null +++ b/src/test/java/prgrms/board/SpringbootBoardJpaApplicationTests.java @@ -0,0 +1,13 @@ +package prgrms.board; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringbootBoardJpaApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/prgrms/board/post/application/PostServiceTest.java b/src/test/java/prgrms/board/post/application/PostServiceTest.java new file mode 100644 index 000000000..4edb3f35b --- /dev/null +++ b/src/test/java/prgrms/board/post/application/PostServiceTest.java @@ -0,0 +1,138 @@ +package prgrms.board.post.application; + +import org.junit.jupiter.api.BeforeEach; +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 org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.transaction.annotation.Transactional; +import prgrms.board.post.application.dto.request.PostSaveRequest; +import prgrms.board.post.application.dto.request.PostUpdateRequest; +import prgrms.board.post.application.dto.response.PostFindResponse; +import prgrms.board.post.application.dto.response.PostSaveResponse; +import prgrms.board.user.domain.User; +import prgrms.board.user.domain.UserRepository; +import prgrms.board.user.exception.UserNotFoundException; + +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +@SpringBootTest +@Transactional +class PostServiceTest { + @Autowired + private PostService postService; + + @Autowired + private UserRepository userRepository; + + private User user; + private PostSaveRequest postSaveRequest; + private String title = "게시판 테스트"; + private String content = "게시판임!!!"; + + @BeforeEach + void setUp() { + user = new User("고예성", 28); + userRepository.save(user); + Long userId = user.getId(); + + postSaveRequest = new PostSaveRequest( + userId, title, content + ); + } + + @Test + @DisplayName("새 Post 생성 성공 테스트") + void saveNewPostTest() { + // when + var saveResponse = postService.savePost(postSaveRequest); + Long postId = saveResponse.postId(); + + // then + assertThat(postService.findByPostId(postId)) + .isInstanceOf(PostFindResponse.class); + } + + @Test + @DisplayName("새 Post 생성 실패 테스트") + void savePostFailTest() { + // given + var request = new PostSaveRequest( + 500L, + "이거 저장안됨ㅎ", + "제곧내 저장 안됨~" + ); + + // when, then + assertThatThrownBy(() -> postService.savePost(request)) + .isInstanceOf(UserNotFoundException.class); + } + + @Test + @DisplayName("게시물 ID를 통한 조회 성공") + void findByPostIdTest() { + // given + PostSaveResponse response = postService.savePost(postSaveRequest); + Long postId = response.postId(); + + // when + PostFindResponse foundResponse = postService.findByPostId(postId); + String responseTitle = foundResponse.title(); + String responseContent = foundResponse.content(); + + // then + assertThat(responseTitle).isEqualTo(title); + assertThat(responseContent).isEqualTo(content); + } + + @Test + @DisplayName("게시물 전체 조회 성공") + void findAllPostTest() { + // given + for (int i = 0; i < 3; i++) { + postService.savePost(postSaveRequest); + } + Pageable unpaged = Pageable.unpaged(); + + // when + Page all = postService.findAll(unpaged); + List postFoundList = all.getContent(); + int listSize = postFoundList.size(); + String postTitle = postFoundList.get(1).title(); + String postContent = postFoundList.get(1).content(); + + // then + assertThat(listSize).isEqualTo(3); + assertThat(postTitle).isEqualTo(title); + assertThat(postContent).isEqualTo(content); + } + + @Test + @DisplayName("게시물 업데이트 성공") + void updatePostTest() { + // given + var saveResponse = postService.savePost(postSaveRequest); + Long postId = saveResponse.postId(); + String titleForUpdate = "업데이트된 제목임~"; + String contentForUpdate = "업데이트 성공이라구~~"; + PostUpdateRequest updateRequest = new PostUpdateRequest( + titleForUpdate, contentForUpdate + ); + + // when + var updateResponse = postService.updatePost(postId, updateRequest); + Long responseId = updateResponse.postId(); + String responseTitle = updateResponse.title(); + String responseContent = updateResponse.content(); + + // then + assertThat(responseId).isEqualTo(postId); + assertThat(responseTitle).isEqualTo(titleForUpdate); + assertThat(responseContent).isEqualTo(contentForUpdate); + } +} diff --git a/src/test/java/prgrms/board/post/presentation/PostControllerTest.java b/src/test/java/prgrms/board/post/presentation/PostControllerTest.java new file mode 100644 index 000000000..a36341786 --- /dev/null +++ b/src/test/java/prgrms/board/post/presentation/PostControllerTest.java @@ -0,0 +1,296 @@ +package prgrms.board.post.presentation; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.transaction.annotation.Transactional; +import prgrms.board.post.application.dto.request.PostSaveRequest; +import prgrms.board.post.application.dto.request.PostUpdateRequest; +import prgrms.board.post.domain.Post; +import prgrms.board.post.domain.PostRepository; +import prgrms.board.user.domain.User; +import prgrms.board.user.domain.UserRepository; + +import static org.springframework.http.MediaType.APPLICATION_JSON; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint; +import static org.springframework.restdocs.payload.JsonFieldType.BOOLEAN; +import static org.springframework.restdocs.payload.JsonFieldType.NUMBER; +import static org.springframework.restdocs.payload.JsonFieldType.STRING; +import static org.springframework.restdocs.payload.JsonFieldType.VARIES; +import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath; +import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields; +import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields; +import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName; +import static org.springframework.restdocs.request.RequestDocumentation.pathParameters; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@SpringBootTest +@AutoConfigureMockMvc +@AutoConfigureRestDocs +@Transactional +class PostControllerTest { + @Autowired + MockMvc mockMvc; + @Autowired + PostRepository postRepository; + @Autowired + UserRepository userRepository; + @Autowired + ObjectMapper objectMapper; + + User user; + + @BeforeEach + void setUp() { + user = new User("고예성", 28); + userRepository.save(user); + } + + @Test + @DisplayName("게시물 저장 성공 테스트") + void savePostTest() throws Exception { + // given + var request = new PostSaveRequest( + user.getId(), + "테스트테스트", + "에이요요요 마잌쳌" + ); + + // when, then + mockMvc.perform(post("/api/v1/posts") + .contentType(APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andDo(print()) + .andDo(document("Post-save", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()), + requestFields( + fieldWithPath("userId") + .type(NUMBER) + .description("user_id"), + fieldWithPath("title") + .type(STRING) + .description("title"), + fieldWithPath("content") + .type(STRING) + .description("content") + ), + responseFields( + fieldWithPath("postId") + .type(NUMBER) + .description("post_id"), + fieldWithPath("userId") + .type(NUMBER) + .description("user_id"), + fieldWithPath("createdAt") + .type(VARIES) + .description("created_at") + ) + )); + } + + @Test + @DisplayName("게시물 전체조회 성공 테스트") + void findAllTest() throws Exception { + // given + Post post1 = new Post( + "테스트 제목1", + "테스트 내용1" + ); + post1.updateUser(user); + postRepository.save(post1); + + Post post2 = new Post( + "테스트 제목2", + "테스트 내용2" + ); + post2.updateUser(user); + postRepository.save(post2); + + // when, then + mockMvc.perform(get("/api/v1/posts") + .contentType(APPLICATION_JSON)) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("Post-find-all", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()), + responseFields( + fieldWithPath("content[].createdBy") + .type(STRING) + .description("created_by"), + fieldWithPath("content[].title") + .type(STRING) + .description("title"), + fieldWithPath("content[].content") + .type(STRING) + .description("content"), + fieldWithPath("content[].createdAt") + .type(VARIES) + .description("created_at"), + fieldWithPath("pageable.sort.empty") + .type(BOOLEAN) + .description("pageable.sort.empty"), + fieldWithPath("pageable.sort.unsorted") + .type(BOOLEAN) + .description("pageable.sort.unsorted"), + fieldWithPath("pageable.sort.sorted") + .type(BOOLEAN) + .description("pageable.sort.sorted"), + fieldWithPath("pageable.offset") + .type(NUMBER) + .description("pageable.offset"), + fieldWithPath("pageable.pageNumber") + .type(NUMBER) + .description("pageable.pageNumber"), + fieldWithPath("pageable.pageSize") + .type(NUMBER) + .description("pageable.pageSize"), + fieldWithPath("pageable.paged") + .type(BOOLEAN) + .description("pageable.paged"), + fieldWithPath("pageable.unpaged") + .type(BOOLEAN) + .description("pageable.unpaged"), + fieldWithPath("last") + .type(BOOLEAN) + .description("last"), + fieldWithPath("totalPages") + .type(NUMBER) + .description("total_pages"), + fieldWithPath("totalElements") + .type(NUMBER) + .description("total_elements"), + fieldWithPath("first") + .type(BOOLEAN) + .description("first"), + fieldWithPath("size") + .type(NUMBER) + .description("size"), + fieldWithPath("number") + .type(NUMBER) + .description("number"), + fieldWithPath("sort.empty") + .type(BOOLEAN) + .description("sort.empty"), + fieldWithPath("sort.unsorted") + .type(BOOLEAN) + .description("sort.unsorted"), + fieldWithPath("sort.sorted") + .type(BOOLEAN) + .description("sort.sorted"), + fieldWithPath("numberOfElements") + .type(NUMBER) + .description("number_of_elements"), + fieldWithPath("empty") + .type(BOOLEAN) + .description("empty") + ) + )); + } + + @Test + @DisplayName("게시물 단건 조회 성공 테스트") + void findOneSuccessTest() throws Exception { + + // given + Post post = new Post( + "테스트 제목1", + "테스트 내용1" + ); + post.updateUser(user); + postRepository.save(post); + + // when, then + mockMvc.perform(RestDocumentationRequestBuilders.get("/api/v1/posts/{id}", post.getId()) + .contentType(APPLICATION_JSON)) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("post-find-by-id", + preprocessResponse(prettyPrint()), + pathParameters( + parameterWithName("id").description("Post Id")), + responseFields( + fieldWithPath("createdBy") + .type(STRING) + .description("created_by"), + fieldWithPath("title") + .type(STRING) + .description("title"), + fieldWithPath("content") + .type(STRING) + .description("content"), + fieldWithPath("createdAt") + .type(VARIES) + .description("created_at") + ))); + } + + @Test + @DisplayName("게시물 수정 성공 테스트") + void updatePostSuccessTest() throws Exception { + // given + Post post = new Post( + "수정 테스트1", + "수정됨욯" + ); + post.updateUser(user); + postRepository.save(post); + + PostUpdateRequest request = new PostUpdateRequest( + "수정 테스트1", + "수정됨욯" + ); + + // when, then + mockMvc.perform(RestDocumentationRequestBuilders.put("/api/v1/posts/{id}", post.getId()) + .contentType(APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("post-update", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()), + pathParameters( + parameterWithName("id").description("Post Id")), + requestFields( + fieldWithPath("title") + .type(STRING) + .description("updated_title"), + fieldWithPath("content") + .type(STRING) + .description("updated_content") + ), + responseFields( + fieldWithPath("postId") + .type(NUMBER) + .description("post_id"), + fieldWithPath("title") + .type(STRING) + .description("title"), + fieldWithPath("content") + .type(STRING) + .description("content"), + fieldWithPath("createdBy") + .type(STRING) + .description("created_by"), + fieldWithPath("updatedAt") + .type(VARIES) + .description("updated_at") + ))); + } +} diff --git a/src/test/java/prgrms/board/user/presentation/UserControllerTest.java b/src/test/java/prgrms/board/user/presentation/UserControllerTest.java new file mode 100644 index 000000000..187b31bcd --- /dev/null +++ b/src/test/java/prgrms/board/user/presentation/UserControllerTest.java @@ -0,0 +1,7 @@ +package prgrms.board.user.presentation; + +import static org.junit.jupiter.api.Assertions.*; + +class UserControllerTest { + +}