diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..c2065bc26 --- /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/README.md b/README.md index cb154de0f..9998dc7ea 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,34 @@ -# [미션] Spring Boot JPA로 게시판 구현 +# **요구 사항** -## 미션 소개 😎 -Spring Boot JPA - Rest API를 강의를 듣고, 게시판 구현 미션을 수행해봅시다. +### **SpringDataJPA 를 설정한다.** -## 이곳은 공개 Repo입니다. -1. 여러분의 포트폴리오로 사용하셔도 됩니다. -2. 때문에 이 repo를 fork한 뒤 -3. 여러분의 개인 Repo에 작업하며 -4. 이 Repo에 PR을 보내어 멘토의 코드 리뷰와 피드백을 받으세요. +- datasource : h2 or mysql -## Branch 명명 규칙 -1. 여러분 repo는 알아서 해주시고 😀(본인 레포니 main으로 하셔두 되져) -2. prgrms-be-devcourse/spring-board 레포로 PR시 branch는 본인 username을 적어주세요 :) -base repo : `여기repo` base : `username` ← head repo : `여러분repo` compare : `main` +### **엔티티를 구성한다.** + +- 회원(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..fa20835c2 --- /dev/null +++ b/build.gradle @@ -0,0 +1,48 @@ +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 = 'com.prgrms' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +ext { + set('snippetsDir', file("build/generated-snippets")) +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + runtimeOnly 'com.mysql:mysql-connector-j' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' + testImplementation 'org.hamcrest:hamcrest:2.2' + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-validation' + runtimeOnly 'com.h2database:h2' +} + +tasks.named('test') { + outputs.dir snippetsDir + useJUnitPlatform() +} + +tasks.named('asciidoctor') { + inputs.dir snippetsDir + dependsOn test +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 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 100644 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/restrequest/post-request.http b/restrequest/post-request.http new file mode 100644 index 000000000..8c597196c --- /dev/null +++ b/restrequest/post-request.http @@ -0,0 +1,27 @@ +POST http://localhost:8080/api/posts +Content-Type: application/json + +{ + "title": "Test Title", + "content": "Test Content", + "userId": 1 +} + +### +GET http://localhost:8080/api/posts/1 + +### +GET http://localhost:8080/api/posts?page=0&size=10 + +### +PUT http://localhost:8080/api/posts/1 +Content-Type: application/json + +{ + "title": "Updated Title2", + "content": "Updated Content2", + "userId": 1 +} + +### + diff --git a/restrequest/user-request.http b/restrequest/user-request.http new file mode 100644 index 000000000..93c7ff068 --- /dev/null +++ b/restrequest/user-request.http @@ -0,0 +1,10 @@ +POST http://localhost:8080/api/users +Content-Type: application/json + +{ + "name": "Test Name", + "age": 25, + "hobby": "Coding" +} + +### 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/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 000000000..54de1b740 --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,41 @@ +ifndef::snippets[] +:snippets: ./build/generated-snippets +endif::[] + +== 게시판 API +:doctype: book +:icons: font +:source-highlighter: highlightjs +:toc: left +:toc-title: Table of Contents +:sectanchors: + +[user-save] +== 유저 생성 + +include::{snippets}/user-save/http-request.adoc[] +include::{snippets}/user-save/http-response.adoc[] + +[post-save] +== 게시글 생성 + +include::{snippets}/post-save/http-request.adoc[] +include::{snippets}/post-save/http-response.adoc[] + +[post-get] +== 게시글 단건 조회 + +include::{snippets}/post-get/http-request.adoc[] +include::{snippets}/post-get/http-response.adoc[] + +[post-getPage] +== 게시글 페이징 조회 + +include::{snippets}/post-getPage/http-request.adoc[] +include::{snippets}/post-getPage/http-response.adoc[] + +[post-update] +== 게시글 수정 + +include::{snippets}/post-update/http-request.adoc[] +include::{snippets}/post-update/http-response.adoc[] \ No newline at end of file diff --git a/src/main/java/com/prgrms/board/SpringbootBoardJpaApplication.java b/src/main/java/com/prgrms/board/SpringbootBoardJpaApplication.java new file mode 100644 index 000000000..b1f8b6591 --- /dev/null +++ b/src/main/java/com/prgrms/board/SpringbootBoardJpaApplication.java @@ -0,0 +1,18 @@ +package com.prgrms.board; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@SpringBootApplication +@EnableJpaAuditing( + auditorAwareRef = "customAuditAware", + dateTimeProviderRef = "customAuditAware" +) +public class SpringbootBoardJpaApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringbootBoardJpaApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/board/common/advice/ExceptionAdvice.java b/src/main/java/com/prgrms/board/common/advice/ExceptionAdvice.java new file mode 100644 index 000000000..288eebc5f --- /dev/null +++ b/src/main/java/com/prgrms/board/common/advice/ExceptionAdvice.java @@ -0,0 +1,41 @@ +package com.prgrms.board.common.advice; + +import com.prgrms.board.post.exception.PostNotFoundException; +import com.prgrms.board.user.exception.UserNotFoundException; +import org.springframework.context.support.DefaultMessageSourceResolvable; +import org.springframework.dao.DataAccessException; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +import java.util.List; + +@RestControllerAdvice +public class ExceptionAdvice { + + @ExceptionHandler(UserNotFoundException.class) + protected ResponseEntity handleUserNotFoundException(UserNotFoundException exception) { + return ResponseEntity.status(HttpStatus.NOT_FOUND).body(exception.getMessage()); + } + + @ExceptionHandler(PostNotFoundException.class) + protected ResponseEntity handlePostNotFoundException(PostNotFoundException exception) { + return ResponseEntity.status(HttpStatus.NOT_FOUND).body(exception.getMessage()); + } + + @ExceptionHandler(DataAccessException.class) + protected ResponseEntity handleDataAccessExceptionException(DataAccessException exception) { + return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(exception.getMessage()); + } + + @ExceptionHandler(MethodArgumentNotValidException.class) + public ResponseEntity> handleValidationExceptions(MethodArgumentNotValidException exception) { + List errors = exception.getBindingResult().getAllErrors().stream() + .map(DefaultMessageSourceResolvable::getDefaultMessage).toList(); + + return ResponseEntity.badRequest().body(errors); + } + +} diff --git a/src/main/java/com/prgrms/board/common/entity/BaseEntity.java b/src/main/java/com/prgrms/board/common/entity/BaseEntity.java new file mode 100644 index 000000000..0f7eeace9 --- /dev/null +++ b/src/main/java/com/prgrms/board/common/entity/BaseEntity.java @@ -0,0 +1,34 @@ +package com.prgrms.board.common.entity; + + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import org.springframework.data.annotation.CreatedBy; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +public abstract class BaseEntity { + @Column(nullable = false, updatable = false) + @CreatedDate + private LocalDateTime createdDate; + + @Column(updatable = false) + @CreatedBy + private String createdBy; + + protected BaseEntity() { + } + + public LocalDateTime getCreatedDate() { + return createdDate; + } + + public String getCreatedBy() { + return createdBy; + } +} diff --git a/src/main/java/com/prgrms/board/common/entity/CustomAuditAware.java b/src/main/java/com/prgrms/board/common/entity/CustomAuditAware.java new file mode 100644 index 000000000..0b272c6c1 --- /dev/null +++ b/src/main/java/com/prgrms/board/common/entity/CustomAuditAware.java @@ -0,0 +1,23 @@ +package com.prgrms.board.common.entity; + +import org.springframework.data.auditing.DateTimeProvider; +import org.springframework.data.domain.AuditorAware; +import org.springframework.stereotype.Component; + +import java.time.LocalDateTime; +import java.time.temporal.TemporalAccessor; +import java.util.Optional; + +@Component +public class CustomAuditAware implements AuditorAware, DateTimeProvider { + + @Override + public Optional getCurrentAuditor() { + return Optional.of("Yu-and-Ahn"); + } + + @Override + public Optional getNow() { + return Optional.of(LocalDateTime.now()); + } +} diff --git a/src/main/java/com/prgrms/board/post/controller/PostController.java b/src/main/java/com/prgrms/board/post/controller/PostController.java new file mode 100644 index 000000000..5dfec7c05 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/PostController.java @@ -0,0 +1,76 @@ +package com.prgrms.board.post.controller; + +import com.prgrms.board.post.controller.dto.*; +import com.prgrms.board.post.service.PostService; +import com.prgrms.board.post.service.dto.PostDetailedParam; +import com.prgrms.board.post.service.dto.PostDetailedResult; +import com.prgrms.board.post.service.dto.PostDetailedResults; +import com.prgrms.board.post.service.dto.PostShortResult; +import org.springframework.data.domain.Pageable; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.*; + +import static com.prgrms.board.post.controller.PostController.POST_REST_URI; +import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; + +@RestController +@RequestMapping(value = POST_REST_URI, + consumes = APPLICATION_JSON_VALUE, + produces = APPLICATION_JSON_VALUE) +public class PostController { + + public static final String POST_REST_URI = "api/posts"; + + private final PostService service; + private final PostControllerConverter converter; + + public PostController(PostService service, PostControllerConverter converter) { + this.service = service; + this.converter = converter; + } + + @PostMapping + public ResponseEntity create(@RequestBody @Validated PostDetailedRequest request) { + PostDetailedParam param = converter.toPostDetailedParam(request); + PostShortResult result = service.save(param); + + PostShortResponse response = converter.toPostShortResponse(result); + return ResponseEntity + .status(HttpStatus.CREATED) + .body(response); + } + + @GetMapping(value = "/{id}", consumes = MediaType.ALL_VALUE) + public ResponseEntity findById(@PathVariable Long id) { + PostDetailedResult result = service.findById(id); + + PostDetailedResponse response = converter.toPostDetailedResponse(result); + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } + + @GetMapping(consumes = MediaType.ALL_VALUE) + public ResponseEntity findAllWithPagination(Pageable pageable) { + PostDetailedResults retrievedPosts = service.findAllWithPagination(pageable); + PostDetailedResponses convertedPosts = converter.toPostDetailedResponses(retrievedPosts); + return ResponseEntity + .status(HttpStatus.OK) + .body(convertedPosts); + } + + @PutMapping("/{id}") + public ResponseEntity update(@PathVariable Long id, + @RequestBody @Validated PostDetailedRequest request) { + PostDetailedParam param = converter.toPostDetailedParam(request); + PostShortResult result = service.update(id, param); + + PostShortResponse response = converter.toPostShortResponse(result); + return ResponseEntity + .status(HttpStatus.OK) + .body(response); + } +} diff --git a/src/main/java/com/prgrms/board/post/controller/dto/PostControllerConverter.java b/src/main/java/com/prgrms/board/post/controller/dto/PostControllerConverter.java new file mode 100644 index 000000000..2161d2950 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/dto/PostControllerConverter.java @@ -0,0 +1,44 @@ +package com.prgrms.board.post.controller.dto; + +import com.prgrms.board.post.service.dto.PostDetailedParam; +import com.prgrms.board.post.service.dto.PostDetailedResult; +import com.prgrms.board.post.service.dto.PostDetailedResults; +import com.prgrms.board.post.service.dto.PostShortResult; +import org.springframework.stereotype.Component; + +import java.util.List; + +@Component +public class PostControllerConverter { + public PostDetailedParam toPostDetailedParam(PostDetailedRequest request) { + return new PostDetailedParam( + request.title(), + request.content(), + request.userId() + ); + } + + public PostShortResponse toPostShortResponse(PostShortResult result) { + return new PostShortResponse( + result.id() + ); + } + + public PostDetailedResponse toPostDetailedResponse(PostDetailedResult result) { + return new PostDetailedResponse( + result.id(), + result.title(), + result.content(), + result.createdBy(), + result.createdDate() + ); + } + + public PostDetailedResponses toPostDetailedResponses(PostDetailedResults results) { + List responseList = + results.list().stream() + .map(this::toPostDetailedResponse) + .toList(); + return new PostDetailedResponses(responseList); + } +} diff --git a/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedRequest.java b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedRequest.java new file mode 100644 index 000000000..fd620ab3e --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedRequest.java @@ -0,0 +1,21 @@ +package com.prgrms.board.post.controller.dto; + +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Positive; +import jakarta.validation.constraints.Size; + +public record PostDetailedRequest( + @NotBlank + @Size(min = 3, max = 100) + String title, + + @NotBlank + @Size(min = 10, max = 500) + String content, + + @NotNull + @Positive + Long userId +) { +} diff --git a/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponse.java b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponse.java new file mode 100644 index 000000000..1158f3135 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponse.java @@ -0,0 +1,12 @@ +package com.prgrms.board.post.controller.dto; + +import java.time.LocalDateTime; + +public record PostDetailedResponse( + Long id, + String title, + String content, + String createdBy, + LocalDateTime createdDate +) { +} diff --git a/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponses.java b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponses.java new file mode 100644 index 000000000..0aa591b2b --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/dto/PostDetailedResponses.java @@ -0,0 +1,9 @@ +package com.prgrms.board.post.controller.dto; + +import java.util.List; + +public record PostDetailedResponses(List list) { + public PostDetailedResponses(List list) { + this.list = List.copyOf(list); + } +} diff --git a/src/main/java/com/prgrms/board/post/controller/dto/PostShortResponse.java b/src/main/java/com/prgrms/board/post/controller/dto/PostShortResponse.java new file mode 100644 index 000000000..44a4e1573 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/controller/dto/PostShortResponse.java @@ -0,0 +1,4 @@ +package com.prgrms.board.post.controller.dto; + +public record PostShortResponse(Long id) { +} diff --git a/src/main/java/com/prgrms/board/post/domain/Post.java b/src/main/java/com/prgrms/board/post/domain/Post.java new file mode 100644 index 000000000..b47be4f2b --- /dev/null +++ b/src/main/java/com/prgrms/board/post/domain/Post.java @@ -0,0 +1,51 @@ +package com.prgrms.board.post.domain; + +import com.prgrms.board.common.entity.BaseEntity; +import jakarta.persistence.*; + +@Table(name = "posts") +@Entity +public class Post extends BaseEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + Long id; + + @Column(name = "title", length = 100, nullable = false) + String title; + + @Column(name = "content", length = 500, nullable = false) + String content; + + @Column(name = "user_id", nullable = false) + Long userId; + + protected Post() { + } + + public Post(String title, String content, Long userId) { + this.title = title; + this.content = content; + this.userId = userId; + } + + public void changeTitle(String title) { + this.title = title; + } + + public void changeContent(String content) { + this.content = content; + } + + public Long getId() { + return id; + } + + public String getTitle() { + return title; + } + + public String getContent() { + return content; + } +} diff --git a/src/main/java/com/prgrms/board/post/domain/PostRepository.java b/src/main/java/com/prgrms/board/post/domain/PostRepository.java new file mode 100644 index 000000000..c888b71a8 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/domain/PostRepository.java @@ -0,0 +1,9 @@ +package com.prgrms.board.post.domain; + +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface PostRepository extends JpaRepository { + +} diff --git a/src/main/java/com/prgrms/board/post/exception/PostNotFoundException.java b/src/main/java/com/prgrms/board/post/exception/PostNotFoundException.java new file mode 100644 index 000000000..eb712e424 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/exception/PostNotFoundException.java @@ -0,0 +1,7 @@ +package com.prgrms.board.post.exception; + +public class PostNotFoundException extends RuntimeException { + public PostNotFoundException(String message) { + super(message); + } +} diff --git a/src/main/java/com/prgrms/board/post/service/PostService.java b/src/main/java/com/prgrms/board/post/service/PostService.java new file mode 100644 index 000000000..56091dc0b --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/PostService.java @@ -0,0 +1,64 @@ +package com.prgrms.board.post.service; + +import com.prgrms.board.post.domain.Post; +import com.prgrms.board.post.domain.PostRepository; +import com.prgrms.board.post.exception.PostNotFoundException; +import com.prgrms.board.post.service.dto.*; +import com.prgrms.board.user.service.UserService; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@Transactional(readOnly = true) +public class PostService { + + private final UserService userService; + private final PostRepository postRepository; + private final PostServiceConverter converter; + + public PostService(PostRepository postRepository, UserService userService, PostServiceConverter converter) { + this.postRepository = postRepository; + this.userService = userService; + this.converter = converter; + } + + @Transactional + public PostShortResult save(PostDetailedParam postDetailedParam) { + userService.validateUserExistence(postDetailedParam.userId()); + Post savedPost = postRepository.save(converter.toPost(postDetailedParam)); + return converter.toPostShortResult(savedPost); + } + + public PostDetailedResult findById(Long id) { + Post retrievedPost = postRepository.findById(id) + .orElseThrow(() -> new PostNotFoundException("Post가 존재하지 않습니다.")); + return converter.toPostDetailedResult(retrievedPost); + + } + + public PostDetailedResults findAllWithPagination(Pageable pageable) { + Page retrievedPosts = postRepository.findAll(pageable); + if (retrievedPosts.getSize() == 0) { + throw new PostNotFoundException("Post가 존재하지 않습니다."); + } + return converter.toPostDetailedResults(retrievedPosts); + } + + @Transactional + public PostShortResult update(Long id, PostDetailedParam postDetailedParam) { + userService.validateUserExistence(postDetailedParam.userId()); + Post retrievedPost = postRepository.findById(id) + .orElseThrow(() -> new PostNotFoundException("Post가 존재하지 않습니다.")); + changePost(retrievedPost, postDetailedParam); + + Post updatedUser = postRepository.save(retrievedPost); + return converter.toPostShortResult(updatedUser); + } + + private void changePost(Post retrievedPost, PostDetailedParam postDetailedParam) { + retrievedPost.changeTitle(postDetailedParam.title()); + retrievedPost.changeContent(postDetailedParam.content()); + } +} diff --git a/src/main/java/com/prgrms/board/post/service/dto/PostDetailedParam.java b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedParam.java new file mode 100644 index 000000000..653970249 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedParam.java @@ -0,0 +1,4 @@ +package com.prgrms.board.post.service.dto; + +public record PostDetailedParam(String title, String content, Long userId) { +} diff --git a/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResult.java b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResult.java new file mode 100644 index 000000000..27aebb355 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResult.java @@ -0,0 +1,12 @@ +package com.prgrms.board.post.service.dto; + +import java.time.LocalDateTime; + +public record PostDetailedResult( + Long id, + String title, + String content, + String createdBy, + LocalDateTime createdDate +) { +} diff --git a/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResults.java b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResults.java new file mode 100644 index 000000000..f4e3e3784 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/dto/PostDetailedResults.java @@ -0,0 +1,9 @@ +package com.prgrms.board.post.service.dto; + +import java.util.List; + +public record PostDetailedResults(List list) { + public PostDetailedResults(List list) { + this.list = List.copyOf(list); + } +} diff --git a/src/main/java/com/prgrms/board/post/service/dto/PostServiceConverter.java b/src/main/java/com/prgrms/board/post/service/dto/PostServiceConverter.java new file mode 100644 index 000000000..a8262ada6 --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/dto/PostServiceConverter.java @@ -0,0 +1,39 @@ +package com.prgrms.board.post.service.dto; + +import com.prgrms.board.post.domain.Post; +import org.springframework.data.domain.Page; +import org.springframework.stereotype.Component; + +import java.util.List; + +@Component +public class PostServiceConverter { + public Post toPost(PostDetailedParam postDetailedParam) { + return new Post( + postDetailedParam.title(), + postDetailedParam.content(), + postDetailedParam.userId() + ); + } + + public PostShortResult toPostShortResult(Post savedPost) { + return new PostShortResult(savedPost.getId()); + } + + public PostDetailedResult toPostDetailedResult(Post retrievedPost) { + return new PostDetailedResult( + retrievedPost.getId(), + retrievedPost.getTitle(), + retrievedPost.getContent(), + retrievedPost.getCreatedBy(), + retrievedPost.getCreatedDate() + ); + } + + public PostDetailedResults toPostDetailedResults(Page retrievedPosts) { + List convertedList = retrievedPosts.stream() + .map(this::toPostDetailedResult) + .toList(); + return new PostDetailedResults(convertedList); + } +} diff --git a/src/main/java/com/prgrms/board/post/service/dto/PostShortResult.java b/src/main/java/com/prgrms/board/post/service/dto/PostShortResult.java new file mode 100644 index 000000000..ce333350b --- /dev/null +++ b/src/main/java/com/prgrms/board/post/service/dto/PostShortResult.java @@ -0,0 +1,4 @@ +package com.prgrms.board.post.service.dto; + +public record PostShortResult(Long id) { +} diff --git a/src/main/java/com/prgrms/board/user/controller/UserController.java b/src/main/java/com/prgrms/board/user/controller/UserController.java new file mode 100644 index 000000000..e6172f716 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/controller/UserController.java @@ -0,0 +1,45 @@ +package com.prgrms.board.user.controller; + +import com.prgrms.board.user.controller.dto.UserControllerConverter; +import com.prgrms.board.user.controller.dto.UserDetailedRequest; +import com.prgrms.board.user.controller.dto.UserShortResponse; +import com.prgrms.board.user.service.UserService; +import com.prgrms.board.user.service.dto.UserDetailedParam; +import com.prgrms.board.user.service.dto.UserShortResult; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; +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 static com.prgrms.board.user.controller.UserController.USER_REST_URI; +import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; + +@RestController +@RequestMapping(value = USER_REST_URI, + consumes = APPLICATION_JSON_VALUE, + produces = APPLICATION_JSON_VALUE) +public class UserController { + + public static final String USER_REST_URI = "api/users"; + + private final UserService service; + private final UserControllerConverter converter; + + public UserController(UserService service, UserControllerConverter converter) { + this.service = service; + this.converter = converter; + } + + @PostMapping + public ResponseEntity create(@RequestBody @Validated UserDetailedRequest request) { + UserDetailedParam param = converter.toUserDetailedParam(request); + UserShortResult result = service.save(param); + UserShortResponse response = converter.toUserResponse(result); + return ResponseEntity + .status(HttpStatus.CREATED) + .body(response); + } +} diff --git a/src/main/java/com/prgrms/board/user/controller/dto/UserControllerConverter.java b/src/main/java/com/prgrms/board/user/controller/dto/UserControllerConverter.java new file mode 100644 index 000000000..a278577dd --- /dev/null +++ b/src/main/java/com/prgrms/board/user/controller/dto/UserControllerConverter.java @@ -0,0 +1,20 @@ +package com.prgrms.board.user.controller.dto; + +import com.prgrms.board.user.service.dto.UserDetailedParam; +import com.prgrms.board.user.service.dto.UserShortResult; +import org.springframework.stereotype.Component; + +@Component +public class UserControllerConverter { + public UserDetailedParam toUserDetailedParam(UserDetailedRequest request) { + return new UserDetailedParam( + request.name(), + request.age(), + request.hobby() + ); + } + + public UserShortResponse toUserResponse(UserShortResult result) { + return new UserShortResponse(result.id()); + } +} diff --git a/src/main/java/com/prgrms/board/user/controller/dto/UserDetailedRequest.java b/src/main/java/com/prgrms/board/user/controller/dto/UserDetailedRequest.java new file mode 100644 index 000000000..78b47e3cd --- /dev/null +++ b/src/main/java/com/prgrms/board/user/controller/dto/UserDetailedRequest.java @@ -0,0 +1,17 @@ +package com.prgrms.board.user.controller.dto; + +import jakarta.validation.constraints.*; + +public record UserDetailedRequest( + @NotBlank + @Size(min = 2, max = 20) + String name, + + @NotNull + @Min(value = 0) + @Max(value = 120) + Integer age, + + String hobby +) { +} \ No newline at end of file diff --git a/src/main/java/com/prgrms/board/user/controller/dto/UserShortResponse.java b/src/main/java/com/prgrms/board/user/controller/dto/UserShortResponse.java new file mode 100644 index 000000000..208010401 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/controller/dto/UserShortResponse.java @@ -0,0 +1,5 @@ +package com.prgrms.board.user.controller.dto; + +public record UserShortResponse(Long id) { +} + diff --git a/src/main/java/com/prgrms/board/user/domain/User.java b/src/main/java/com/prgrms/board/user/domain/User.java new file mode 100644 index 000000000..a104af451 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/domain/User.java @@ -0,0 +1,39 @@ +package com.prgrms.board.user.domain; + +import com.prgrms.board.common.entity.BaseEntity; +import jakarta.persistence.*; + +@Table(name = "users") +@Entity +public class User extends BaseEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + @Column(name = "user_id") + private Long id; + + @Column(length = 20, nullable = false) + private String name; + + @Column(nullable = false) + private Integer age; + + private String hobby; + + protected User() { + } + + public User(String name, Integer age, String hobby) { + this.name = name; + this.age = age; + this.hobby = hobby; + } + + public Long getId() { + return id; + } + + public String getName() { + return name; + } +} diff --git a/src/main/java/com/prgrms/board/user/domain/UserRepository.java b/src/main/java/com/prgrms/board/user/domain/UserRepository.java new file mode 100644 index 000000000..fea9672e7 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/domain/UserRepository.java @@ -0,0 +1,6 @@ +package com.prgrms.board.user.domain; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UserRepository extends JpaRepository { +} diff --git a/src/main/java/com/prgrms/board/user/exception/UserNotFoundException.java b/src/main/java/com/prgrms/board/user/exception/UserNotFoundException.java new file mode 100644 index 000000000..2919688b0 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/exception/UserNotFoundException.java @@ -0,0 +1,7 @@ +package com.prgrms.board.user.exception; + +public class UserNotFoundException extends RuntimeException { + public UserNotFoundException(String message) { + super(message); + } +} diff --git a/src/main/java/com/prgrms/board/user/service/UserService.java b/src/main/java/com/prgrms/board/user/service/UserService.java new file mode 100644 index 000000000..f270a8b33 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/service/UserService.java @@ -0,0 +1,36 @@ +package com.prgrms.board.user.service; + +import com.prgrms.board.user.domain.User; +import com.prgrms.board.user.domain.UserRepository; +import com.prgrms.board.user.exception.UserNotFoundException; +import com.prgrms.board.user.service.dto.UserDetailedParam; +import com.prgrms.board.user.service.dto.UserServiceConverter; +import com.prgrms.board.user.service.dto.UserShortResult; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@Transactional(readOnly = true) +public class UserService { + + private final UserRepository repository; + private final UserServiceConverter converter; + + public UserService(UserRepository repository, UserServiceConverter converter) { + this.repository = repository; + this.converter = converter; + } + + @Transactional + public UserShortResult save(UserDetailedParam param) { + User savingUser = converter.toUser(param); + User savedUser = repository.save(savingUser); + return converter.toUserShortResult(savedUser); + } + + public void validateUserExistence(Long id) { + if (!repository.existsById(id)) { + throw new UserNotFoundException("User를 찾을 수 없습니다."); + } + } +} diff --git a/src/main/java/com/prgrms/board/user/service/dto/UserDetailedParam.java b/src/main/java/com/prgrms/board/user/service/dto/UserDetailedParam.java new file mode 100644 index 000000000..cb455c0ea --- /dev/null +++ b/src/main/java/com/prgrms/board/user/service/dto/UserDetailedParam.java @@ -0,0 +1,8 @@ +package com.prgrms.board.user.service.dto; + +public record UserDetailedParam( + String name, + Integer age, + String hobby +) { +} diff --git a/src/main/java/com/prgrms/board/user/service/dto/UserServiceConverter.java b/src/main/java/com/prgrms/board/user/service/dto/UserServiceConverter.java new file mode 100644 index 000000000..77eb18039 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/service/dto/UserServiceConverter.java @@ -0,0 +1,20 @@ +package com.prgrms.board.user.service.dto; + +import com.prgrms.board.user.domain.User; +import org.springframework.stereotype.Component; + +@Component +public class UserServiceConverter { + + public User toUser(UserDetailedParam param) { + return new User( + param.name(), + param.age(), + param.hobby() + ); + } + + public UserShortResult toUserShortResult(User savedUser) { + return new UserShortResult(savedUser.getId()); + } +} diff --git a/src/main/java/com/prgrms/board/user/service/dto/UserShortResult.java b/src/main/java/com/prgrms/board/user/service/dto/UserShortResult.java new file mode 100644 index 000000000..55e4ae085 --- /dev/null +++ b/src/main/java/com/prgrms/board/user/service/dto/UserShortResult.java @@ -0,0 +1,6 @@ +package com.prgrms.board.user.service.dto; + +public record UserShortResult( + Long id +) { +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..a7ee7fa2f --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,15 @@ +spring: + datasource: + url: jdbc:mysql://localhost:3380/board_management?useSSL=true + username: ${DB_USERNAME} + password: ${DB_PASSWORD} + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + show_sql: true + format_sql: true + dialect: org.hibernate.dialect.MySQLDialect +server: + port: 8080 \ No newline at end of file diff --git a/src/test/java/com/prgrms/board/SpringbootBoardJpaApplicationTests.java b/src/test/java/com/prgrms/board/SpringbootBoardJpaApplicationTests.java new file mode 100644 index 000000000..c1637fc3c --- /dev/null +++ b/src/test/java/com/prgrms/board/SpringbootBoardJpaApplicationTests.java @@ -0,0 +1,13 @@ +package com.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/com/prgrms/board/configuration/RestDocsConfiguration.java b/src/test/java/com/prgrms/board/configuration/RestDocsConfiguration.java new file mode 100644 index 000000000..4fd43b30e --- /dev/null +++ b/src/test/java/com/prgrms/board/configuration/RestDocsConfiguration.java @@ -0,0 +1,20 @@ +package com.prgrms.board.configuration; + +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; +import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; +import org.springframework.restdocs.operation.preprocess.Preprocessors; + +@TestConfiguration +public class RestDocsConfiguration { + + @Bean + public RestDocumentationResultHandler write() { + return MockMvcRestDocumentation.document( + "{class-name}/{method-name}", + Preprocessors.preprocessRequest(Preprocessors.prettyPrint()), + Preprocessors.preprocessResponse(Preprocessors.prettyPrint()) + ); + } +} diff --git a/src/test/java/com/prgrms/board/post/controller/PostControllerTest.java b/src/test/java/com/prgrms/board/post/controller/PostControllerTest.java new file mode 100644 index 000000000..8297ebe87 --- /dev/null +++ b/src/test/java/com/prgrms/board/post/controller/PostControllerTest.java @@ -0,0 +1,150 @@ +package com.prgrms.board.post.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.prgrms.board.post.controller.dto.PostDetailedRequest; +import com.prgrms.board.user.service.UserService; +import com.prgrms.board.user.service.dto.UserDetailedParam; +import com.prgrms.board.user.service.dto.UserShortResult; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Order; +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.http.MediaType; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.test.web.servlet.MockMvc; + +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get; +import static org.springframework.restdocs.payload.PayloadDocumentation.*; +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.post; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@AutoConfigureMockMvc +@AutoConfigureRestDocs +@SpringBootTest +class PostControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private UserService userService; + + @Autowired + private ObjectMapper objectMapper; + + @BeforeEach + void setUp() { + UserDetailedParam userDetailedParam = new UserDetailedParam( + "James", + 25, + "Baseball"); + UserShortResult savedUser = userService.save(userDetailedParam); + } + + @Test + @Order(1) + @DisplayName("[create] 저장") + void create_유효한값일때_엔티티로저장() throws Exception { + // Given + PostDetailedRequest request = new PostDetailedRequest( + "이것은 제목입니다.", + "이것은 내용입니다.", + 1L + ); + + // When // Then + mockMvc.perform(post("/api/posts") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andDo(print()) + .andDo(document("post-save", + requestFields( + fieldWithPath("title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("content").type(JsonFieldType.STRING).description("내용"), + fieldWithPath("userId").type(JsonFieldType.NUMBER).description("유저 아이디") + ) + )); + } + + @Test + @Order(2) + @DisplayName("[findById] 단건 조회") + void findById_유효한값일때_엔티티반환() throws Exception { + // Given // When // Then + mockMvc.perform(get("/api/posts/{id}", 1L)) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("post-get", + pathParameters( + parameterWithName("id").description("게시글 아이디") + ), + responseFields( + fieldWithPath("id").type(JsonFieldType.NUMBER).description("게시글 아이디"), + fieldWithPath("title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("content").type(JsonFieldType.STRING).description("내용"), + fieldWithPath("createdBy").type(JsonFieldType.STRING).description("생성자"), + fieldWithPath("createdDate").type(JsonFieldType.STRING).description("생성일") + ) + )); + } + + @Test + @Order(3) + @DisplayName("[findAllByPagination] 페이징 조회") + void findAllWithPagination_유효한값일때_페이지반환() throws Exception { + // Given // When // Then + mockMvc.perform(get("/api/posts") + .param("page", "0") + .param("size", "10") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("post-getPage", + responseFields( + fieldWithPath("list[].id").type(JsonFieldType.NUMBER).description("게시글 아이디"), + fieldWithPath("list[].title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("list[].content").type(JsonFieldType.STRING).description("내용"), + fieldWithPath("list[].createdBy").type(JsonFieldType.STRING).description("생성자"), + fieldWithPath("list[].createdDate").type(JsonFieldType.STRING).description("생성일") + ) + )); + } + + @Test + @Order(4) + @DisplayName("[update] 업데이트") + void update_유효한값일때_엔티티업데이트() throws Exception { + // Given + PostDetailedRequest request = new PostDetailedRequest( + "이것은 새로운 제목입니다..", + "이것은 새로운 내용입니다.", + 1L + ); + + // When // Then + mockMvc.perform(post("/api/posts") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andDo(print()) + .andDo(document("post-update", + requestFields( + fieldWithPath("title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("content").type(JsonFieldType.STRING).description("내용"), + fieldWithPath("userId").type(JsonFieldType.NUMBER).description("유저 아이디") + ), + responseFields( + fieldWithPath("id").type(JsonFieldType.NUMBER).description("게시글 아이디") + ) + )); + } +} \ No newline at end of file diff --git a/src/test/java/com/prgrms/board/user/controller/UserControllerTest.java b/src/test/java/com/prgrms/board/user/controller/UserControllerTest.java new file mode 100644 index 000000000..016f1a21f --- /dev/null +++ b/src/test/java/com/prgrms/board/user/controller/UserControllerTest.java @@ -0,0 +1,59 @@ +package com.prgrms.board.user.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.prgrms.board.user.controller.dto.UserDetailedRequest; +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.http.MediaType; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.test.web.servlet.MockMvc; + +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.payload.PayloadDocumentation.*; +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; + +@AutoConfigureRestDocs +@AutoConfigureMockMvc +@SpringBootTest +class UserControllerTest { + + @Autowired + ObjectMapper objectMapper; + + @Autowired + private MockMvc mockMvc; + + @Test + @DisplayName("[create] 저장") + void create_유효한값일때_엔티티로저장() throws Exception { + // Given + UserDetailedRequest request = new UserDetailedRequest( + "유원우", + 28, + "축구" + ); + + // When // Then + mockMvc.perform(post("/api/users") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andExpect(status().isCreated()) + .andDo(print()) + .andDo(document("user-save", + requestFields( + fieldWithPath("name").type(JsonFieldType.STRING).description("이름"), + fieldWithPath("age").type(JsonFieldType.NUMBER).description("나이"), + fieldWithPath("hobby").type(JsonFieldType.STRING).description("취미") + ), + responseFields( + fieldWithPath("id").type(JsonFieldType.NUMBER).description("USER ID") + ) + )); + } +} \ No newline at end of file diff --git a/src/test/resources/application-test.yml b/src/test/resources/application-test.yml new file mode 100644 index 000000000..ec4a7510c --- /dev/null +++ b/src/test/resources/application-test.yml @@ -0,0 +1,15 @@ +spring: + datasource: + url: jdbc:mysql://localhost:3380/board_management_test?useSSL=true + username: ${DB_PASSWORD} + password: ${DB_PASSWORD} + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + show_sql: true + format_sql: true + dialect: org.hibernate.dialect.MySQLDialect +server: + port: 8080 \ No newline at end of file