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/build.gradle b/build.gradle new file mode 100644 index 000000000..80a260b1e --- /dev/null +++ b/build.gradle @@ -0,0 +1,51 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '2.7.17' + id 'io.spring.dependency-management' version '1.0.15.RELEASE' + id 'org.asciidoctor.jvm.convert' version '3.3.2' +} + +group = 'com.prgrms' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '11' +} + +configurations { + asciidoctorExt + compileOnly { + extendsFrom annotationProcessor + } +} + +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' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' +} + +tasks.named('test') { + outputs.dir snippetsDir + useJUnitPlatform() +} + +tasks.named('asciidoctor') { + inputs.dir snippetsDir + configurations 'asciidoctorExt' + 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..7f93135c4 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..3fa8f862f --- /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.4-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..1aa94a426 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && 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=SC2039,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=SC2039,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, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +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..6689b85be --- /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..5f717a7cc --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'board' diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 000000000..d91047f28 --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,47 @@ +:hardbreaks: +ifndef::snippets[] +:snippets: ../../../build/generated-snippets +endif::[] + +=== 게시글 작성 + + +.Request +include::{snippets}/create-post/http-request.adoc[] + +.Response +include::{snippets}/create-post/response-body.adoc[] +include::{snippets}/create-post/response-fields.adoc[] + +--- +=== 게시글 수정 + + +.Request +include::{snippets}/update-post/http-request.adoc[] + +.Response +include::{snippets}/update-post/response-body.adoc[] +include::{snippets}/update-post/response-fields.adoc[] + +--- +=== 게시글 전체 조회 + + +.Request +include::{snippets}/get-posts/http-request.adoc[] + +.Response +include::{snippets}/get-posts/response-body.adoc[] +include::{snippets}/get-posts/response-fields.adoc[] + +--- +=== 게시글 단건 조회 + + +.Request +include::{snippets}/get-post/http-request.adoc[] + +.Response +include::{snippets}/get-post/response-body.adoc[] +include::{snippets}/get-post/response-fields.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/index.pdf b/src/docs/asciidoc/index.pdf new file mode 100644 index 000000000..7ea4e5855 Binary files /dev/null and b/src/docs/asciidoc/index.pdf differ diff --git a/src/main/java/com/prgrms/board/BoardApplication.java b/src/main/java/com/prgrms/board/BoardApplication.java new file mode 100644 index 000000000..2e01314ef --- /dev/null +++ b/src/main/java/com/prgrms/board/BoardApplication.java @@ -0,0 +1,13 @@ +package com.prgrms.board; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class BoardApplication { + + public static void main(String[] args) { + SpringApplication.run(BoardApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/board/controller/PostApiController.java b/src/main/java/com/prgrms/board/controller/PostApiController.java new file mode 100644 index 000000000..f9fd09ac6 --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/PostApiController.java @@ -0,0 +1,88 @@ +package com.prgrms.board.controller; + +import com.prgrms.board.controller.request.CreatePostRequest; +import com.prgrms.board.controller.request.UpdatePostRequest; +import com.prgrms.board.controller.response.CreatePostResponse; +import com.prgrms.board.controller.response.FindPostResponse; +import com.prgrms.board.controller.response.FindPostsResponse; +import com.prgrms.board.controller.response.UpdatePostResponse; +import com.prgrms.board.service.PostService; +import com.prgrms.board.service.dto.PostDto; +import com.prgrms.board.service.dto.PostListDto; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Pageable; +import org.springframework.data.web.PageableDefault; +import org.springframework.http.ResponseEntity; +import org.springframework.transaction.annotation.Transactional; +import org.springframework.web.bind.annotation.*; + +import java.util.List; +import java.util.stream.Collectors; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/posts") +public class PostApiController { + + private final PostService postService; + + /** + * 게시글 작성 + * + * @param createPostRequest + * @return CreatePostResponse + */ + @PostMapping + @Transactional + public ResponseEntity createPost(@RequestBody CreatePostRequest createPostRequest) { + + Long userId = createPostRequest.getUserId(); + String title = createPostRequest.getTitle(); + String content = createPostRequest.getContent(); + Long postId = postService.create(userId, new PostDto(title, content)); + return ResponseEntity.ok(new CreatePostResponse(postId)); + } + + /** + * 게시글 수정 + * + * @param postId + * @param updatePostRequest + * @return + */ + @PostMapping("/{postId}") + @Transactional + public ResponseEntity updatePost(@PathVariable Long postId, @RequestBody UpdatePostRequest updatePostRequest) { + + Long updatedPostId = postService.update(postId, updatePostRequest.getContent()); + return ResponseEntity.ok(new UpdatePostResponse(updatedPostId)); + } + + + /** + * 게시글 전체 페이징 조회 + * + * @param pageable + * @return + */ + @GetMapping + public ResponseEntity getPosts(@PageableDefault(size = 10, sort = "id") Pageable pageable){ + PostListDto postListDto = postService.findAll(pageable); + List findPostResponseList = postListDto.getPostDtoList().stream() + .map(it -> new FindPostResponse(it.getId(), it.getTitle(), it.getContent())) + .collect(Collectors.toList()); + return ResponseEntity.ok(new FindPostsResponse(postListDto.getCount(), findPostResponseList)); + } + + /** + * 게시글 단일 조회 + * + * @param postId + * @return + */ + @GetMapping("/{postId}") + public ResponseEntity getPost(@PathVariable("postId") Long postId){ + PostDto postDto = postService.findById(postId); + return ResponseEntity.ok(new FindPostResponse(postDto.getId(), postDto.getTitle(), postDto.getContent())); + } +} diff --git a/src/main/java/com/prgrms/board/controller/request/CreatePostRequest.java b/src/main/java/com/prgrms/board/controller/request/CreatePostRequest.java new file mode 100644 index 000000000..e1a41d595 --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/request/CreatePostRequest.java @@ -0,0 +1,18 @@ +package com.prgrms.board.controller.request; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import static lombok.AccessLevel.PROTECTED; + +@Getter +@NoArgsConstructor(access = PROTECTED) +@AllArgsConstructor +public class CreatePostRequest { + + private Long userId; + private String title; + private String content; + +} diff --git a/src/main/java/com/prgrms/board/controller/request/UpdatePostRequest.java b/src/main/java/com/prgrms/board/controller/request/UpdatePostRequest.java new file mode 100644 index 000000000..0e84eca7a --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/request/UpdatePostRequest.java @@ -0,0 +1,15 @@ +package com.prgrms.board.controller.request; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import static lombok.AccessLevel.PROTECTED; + +@Getter +@NoArgsConstructor(access = PROTECTED) +@AllArgsConstructor +public class UpdatePostRequest { + + private String content; +} diff --git a/src/main/java/com/prgrms/board/controller/response/CreatePostResponse.java b/src/main/java/com/prgrms/board/controller/response/CreatePostResponse.java new file mode 100644 index 000000000..83798cb85 --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/response/CreatePostResponse.java @@ -0,0 +1,12 @@ +package com.prgrms.board.controller.response; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class CreatePostResponse { + + private Long postId; + +} diff --git a/src/main/java/com/prgrms/board/controller/response/FindPostResponse.java b/src/main/java/com/prgrms/board/controller/response/FindPostResponse.java new file mode 100644 index 000000000..0da19802d --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/response/FindPostResponse.java @@ -0,0 +1,13 @@ +package com.prgrms.board.controller.response; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class FindPostResponse { + + private Long id; + private String title; + private String content; +} diff --git a/src/main/java/com/prgrms/board/controller/response/FindPostsResponse.java b/src/main/java/com/prgrms/board/controller/response/FindPostsResponse.java new file mode 100644 index 000000000..66aed8da0 --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/response/FindPostsResponse.java @@ -0,0 +1,15 @@ +package com.prgrms.board.controller.response; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import java.util.List; + +@Getter +@AllArgsConstructor +public class FindPostsResponse { + + int count; + + List findPostResponseList; +} diff --git a/src/main/java/com/prgrms/board/controller/response/UpdatePostResponse.java b/src/main/java/com/prgrms/board/controller/response/UpdatePostResponse.java new file mode 100644 index 000000000..563c82ca5 --- /dev/null +++ b/src/main/java/com/prgrms/board/controller/response/UpdatePostResponse.java @@ -0,0 +1,11 @@ +package com.prgrms.board.controller.response; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class UpdatePostResponse { + + private Long postId; +} diff --git a/src/main/java/com/prgrms/board/domain/Base.java b/src/main/java/com/prgrms/board/domain/Base.java new file mode 100644 index 000000000..3187abf0c --- /dev/null +++ b/src/main/java/com/prgrms/board/domain/Base.java @@ -0,0 +1,16 @@ +package com.prgrms.board.domain; + +import lombok.Getter; + +import javax.persistence.Column; +import javax.persistence.MappedSuperclass; +import java.time.LocalDateTime; + +@Getter +@MappedSuperclass +public abstract class Base { + + @Column(columnDefinition = "TIMESTAMP") + private LocalDateTime created_at; + +} diff --git a/src/main/java/com/prgrms/board/domain/Post.java b/src/main/java/com/prgrms/board/domain/Post.java new file mode 100644 index 000000000..0b4bcdf9d --- /dev/null +++ b/src/main/java/com/prgrms/board/domain/Post.java @@ -0,0 +1,42 @@ +package com.prgrms.board.domain; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import javax.persistence.*; + +import static javax.persistence.FetchType.LAZY; +import static javax.persistence.GenerationType.IDENTITY; + +@Getter +@Entity +@Table(name = "post") +@AllArgsConstructor +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Post extends Base { + + @Id + @Column(name = "post_id") + @GeneratedValue(strategy = IDENTITY) + private Long id; + + private String title; + + private String content; + + @ManyToOne(fetch = LAZY) + @JoinColumn(name = "user_id") + private User user; + + public Post(String title, String content, User user) { + this.title = title; + this.content = content; + this.user = user; + } + + public void setContent(String content) { + this.content = content; + } +} diff --git a/src/main/java/com/prgrms/board/domain/User.java b/src/main/java/com/prgrms/board/domain/User.java new file mode 100644 index 000000000..c9241c8b7 --- /dev/null +++ b/src/main/java/com/prgrms/board/domain/User.java @@ -0,0 +1,42 @@ +package com.prgrms.board.domain; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import javax.persistence.*; + +import java.util.ArrayList; +import java.util.List; + +import static javax.persistence.GenerationType.*; + +@Getter +@Entity +@Table(name = "users") +@AllArgsConstructor +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class User extends Base { + + @Id + @Column(name = "user_id") + @GeneratedValue(strategy = IDENTITY) + private Long id; + + @Column(name = "user_name") + private String name; + + private int age; + + private String hobby; + + @OneToMany(mappedBy = "user", cascade = CascadeType.ALL, orphanRemoval = true) + private List postList = new ArrayList<>(); + + public User(String name, int age, String hobby) { + this.name = name; + this.age = age; + this.hobby = hobby; + } +} diff --git a/src/main/java/com/prgrms/board/init/initDB.java b/src/main/java/com/prgrms/board/init/initDB.java new file mode 100644 index 000000000..4779d7e4c --- /dev/null +++ b/src/main/java/com/prgrms/board/init/initDB.java @@ -0,0 +1,39 @@ +package com.prgrms.board.init; + +import com.prgrms.board.domain.User; +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Component; +import org.springframework.transaction.annotation.Transactional; + +import javax.annotation.PostConstruct; +import javax.persistence.EntityManager; + +@Component +@RequiredArgsConstructor +public class initDB { + + private final UserService userService; + + @PostConstruct + public void init(){ + userService.dbinit(); + } + + @Component + @Transactional + @RequiredArgsConstructor + static class UserService { + + private final EntityManager em; + + public void dbinit() { + User user1 = new User("최인준", 20, "헬스"); + User user2 = new User("남은찬", 21, "클라이밍"); + + em.persist(user1); + em.persist(user2); + } + + } + +} diff --git a/src/main/java/com/prgrms/board/repository/PostRepository.java b/src/main/java/com/prgrms/board/repository/PostRepository.java new file mode 100644 index 000000000..33649ad83 --- /dev/null +++ b/src/main/java/com/prgrms/board/repository/PostRepository.java @@ -0,0 +1,9 @@ +package com.prgrms.board.repository; + +import com.prgrms.board.domain.Post; +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/repository/UserRepository.java b/src/main/java/com/prgrms/board/repository/UserRepository.java new file mode 100644 index 000000000..c444559e3 --- /dev/null +++ b/src/main/java/com/prgrms/board/repository/UserRepository.java @@ -0,0 +1,9 @@ +package com.prgrms.board.repository; + +import com.prgrms.board.domain.User; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface UserRepository extends JpaRepository { +} diff --git a/src/main/java/com/prgrms/board/service/PostService.java b/src/main/java/com/prgrms/board/service/PostService.java new file mode 100644 index 000000000..2d2e1cb9c --- /dev/null +++ b/src/main/java/com/prgrms/board/service/PostService.java @@ -0,0 +1,55 @@ +package com.prgrms.board.service; + +import com.prgrms.board.domain.Post; +import com.prgrms.board.domain.User; +import com.prgrms.board.repository.PostRepository; +import com.prgrms.board.repository.UserRepository; +import com.prgrms.board.service.dto.PostDto; +import com.prgrms.board.service.dto.PostListDto; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; +import java.util.stream.Collectors; + +@Service +@RequiredArgsConstructor +public class PostService { + + private final PostRepository postRepository; + private final UserRepository userRepository; + + @Transactional + public Long create(Long userId, PostDto postDto) { + User user = userRepository.findById(userId).orElseThrow(); + Post post = new Post(postDto.getTitle(), postDto.getContent(), user); + Post savedPost = postRepository.save(post); + return savedPost.getId(); + } + + @Transactional + public Long update(Long postId, String content) { + Post post = postRepository.findById(postId).orElseThrow(); + post.setContent(content); + return postId; + } + + @Transactional(readOnly = true) + public PostListDto findAll(Pageable pageable){ + Page postList = postRepository.findAll(pageable); + List postDtoList = postList.stream() + .map(it -> new PostDto(it.getId(), it.getTitle(), it.getContent())) + .collect(Collectors.toList()); + return new PostListDto(postList.getSize(), postDtoList); + } + + @Transactional(readOnly = true) + public PostDto findById(Long postId){ + Post findPost = postRepository.findById(postId) + .orElseThrow(); + return new PostDto(findPost.getId(), findPost.getTitle(), findPost.getContent()); + } +} diff --git a/src/main/java/com/prgrms/board/service/dto/PostDto.java b/src/main/java/com/prgrms/board/service/dto/PostDto.java new file mode 100644 index 000000000..e76c6678b --- /dev/null +++ b/src/main/java/com/prgrms/board/service/dto/PostDto.java @@ -0,0 +1,20 @@ +package com.prgrms.board.service.dto; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor +public class PostDto { + + private Long id; + + private String title; + + private String content; + + public PostDto(String title, String content) { + this.title = title; + this.content = content; + } +} diff --git a/src/main/java/com/prgrms/board/service/dto/PostListDto.java b/src/main/java/com/prgrms/board/service/dto/PostListDto.java new file mode 100644 index 000000000..f7f132614 --- /dev/null +++ b/src/main/java/com/prgrms/board/service/dto/PostListDto.java @@ -0,0 +1,16 @@ +package com.prgrms.board.service.dto; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import java.util.List; + +@Getter +@AllArgsConstructor +public class PostListDto { + + int count; + + List postDtoList; + +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..70cc15ff8 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,14 @@ +spring: + jpa: + show-sql: true + hibernate: + ddl-auto: create-drop + properties: + hibernate: + format_sql: true + generate-ddl: true + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: ${DB_URL} + username: ${DB_USERNAME} + password: ${DB_PASSWORD} \ No newline at end of file diff --git a/src/test/java/com/prgrms/board/controller/PostApiControllerTest.java b/src/test/java/com/prgrms/board/controller/PostApiControllerTest.java new file mode 100644 index 000000000..c2428337f --- /dev/null +++ b/src/test/java/com/prgrms/board/controller/PostApiControllerTest.java @@ -0,0 +1,194 @@ +package com.prgrms.board.controller; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.prgrms.board.controller.request.CreatePostRequest; +import com.prgrms.board.controller.request.UpdatePostRequest; +import com.prgrms.board.controller.utils.DatabaseCleaner; +import org.json.JSONObject; +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.http.MediaType; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.test.context.TestPropertySource; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.ResultActions; +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; +import org.springframework.transaction.annotation.Transactional; + +import java.util.Set; + +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.payload.PayloadDocumentation.*; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; + +@AutoConfigureRestDocs +@AutoConfigureMockMvc +@TestPropertySource("classpath:h2.properties") +@SpringBootTest +class PostApiControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + ObjectMapper objectMapper; + + private DatabaseCleaner databaseCleaner; + private static final Set tableNameSet = Set.of("post", "users"); + + @Autowired + public void setDatabaseCleaner(DatabaseCleaner databaseCleaner) { + this.databaseCleaner = databaseCleaner; + } + +// @BeforeEach +// void cleanUpDB() { +// databaseCleaner.dbCleanUp(tableNameSet); +// } + + + @DisplayName("게시글 작성") + @Test + @Transactional + void testCreatePost() throws Exception { + // given + String content = getCreatePostRequest(1L, "title1", "content1"); + + // when + ResultActions resultActions = createPost(content); + + // then + resultActions.andExpectAll( + jsonPath("$.postId").isNumber() + ) + .andDo(print()) + .andDo( + document("create-post", + requestFields( + fieldWithPath("userId").type(JsonFieldType.NUMBER).description("사용자 아이디"), + fieldWithPath("title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("content").type(JsonFieldType.STRING).description("내용") + ), + responseFields( + fieldWithPath("postId").type(JsonFieldType.NUMBER).description("게시글 아이디") + ) + ) + ); + } + + @DisplayName("게시글 수정") + @Test + void testUpdatePost() throws Exception { + // given + String postId = createPostAndGetPostId(1L, "title1", "content1"); + UpdatePostRequest updatePost = new UpdatePostRequest("updatePost"); + String updateContent = objectMapper.writeValueAsString(updatePost); + + // when + ResultActions resultActions = mockMvc.perform(MockMvcRequestBuilders + .post("/posts/" + postId) + .accept(MediaType.APPLICATION_JSON) + .contentType(MediaType.APPLICATION_JSON) + .content(updateContent)); + + // then + resultActions.andExpectAll( + jsonPath("$.postId").isNumber() + ) + .andDo(print()) + .andDo( + document("update-post", + requestFields( + fieldWithPath("content").type(JsonFieldType.STRING).description("수정된 게시글") + ), + responseFields( + fieldWithPath("postId").type(JsonFieldType.NUMBER).description("수정된 게시글 아이디") + )) + ); + } + + @DisplayName("게시글 전체 페이징 조회") + @Test + void testGetPosts() throws Exception { + // given + String content = getCreatePostRequest(1L, "testTitle", "testContent"); + createPost(content); + + // when + ResultActions resultActions = mockMvc.perform(MockMvcRequestBuilders + .get("/posts") + ); + + // then + resultActions.andExpectAll( + jsonPath("$.count").isNotEmpty(), + jsonPath("$.findPostResponseList").isArray() + ) + .andDo(print()) + .andDo(document("get-posts", + responseFields( + fieldWithPath("count").type(JsonFieldType.NUMBER).description("전체 게시글 갯수"), + fieldWithPath("findPostResponseList").type(JsonFieldType.ARRAY).description("전체 게시글"), + fieldWithPath("findPostResponseList[].id").type(JsonFieldType.NUMBER).description("게시글 id"), + fieldWithPath("findPostResponseList[].title").type(JsonFieldType.STRING).description("게시글 제목"), + fieldWithPath("findPostResponseList[].content").type(JsonFieldType.STRING).description("게시글 내용") + ) + ) + ); + + } + + @DisplayName("게시글 단일 조회") + @Test + void testGetPost() throws Exception { + // given + String postId = createPostAndGetPostId(1L, "testTitle", "testContent"); + + // when + ResultActions resultActions = mockMvc.perform(MockMvcRequestBuilders + .get("/posts/" + postId) + ); + + // then + resultActions.andExpectAll( + jsonPath("$.id").isNumber(), + jsonPath("$.title").isString(), + jsonPath("$.content").isString() + ) + .andDo(print()) + .andDo(document("get-post", + responseFields( + fieldWithPath("id").type(JsonFieldType.NUMBER).description("게시글 id"), + fieldWithPath("title").type(JsonFieldType.STRING).description("제목"), + fieldWithPath("content").type(JsonFieldType.STRING).description("내용") + ) + )); + } + + private ResultActions createPost(String content) throws Exception { + return mockMvc.perform(MockMvcRequestBuilders + .post("/posts") + .accept(MediaType.APPLICATION_JSON) + .contentType(MediaType.APPLICATION_JSON) + .content(content)); + } + + private String getCreatePostRequest(Long id, String title, String content) throws JsonProcessingException { + CreatePostRequest createPostRequest = new CreatePostRequest(id, title, content); + return objectMapper.writeValueAsString(createPostRequest); + } + + private String createPostAndGetPostId(Long id, String title, String content) throws Exception { + ResultActions resultActions = createPost(getCreatePostRequest(id, title, content)); + String stringResponse = resultActions.andReturn().getResponse().getContentAsString(); + JSONObject jsonObject = new JSONObject(stringResponse); + return jsonObject.getString("postId"); + } +} \ No newline at end of file diff --git a/src/test/java/com/prgrms/board/controller/utils/DatabaseCleaner.java b/src/test/java/com/prgrms/board/controller/utils/DatabaseCleaner.java new file mode 100644 index 000000000..a38d730bf --- /dev/null +++ b/src/test/java/com/prgrms/board/controller/utils/DatabaseCleaner.java @@ -0,0 +1,30 @@ +package com.prgrms.board.controller.utils; + +import org.springframework.data.jpa.repository.Modifying; +import org.springframework.stereotype.Component; +import org.springframework.transaction.annotation.Transactional; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import java.util.Set; + +@Component +public class DatabaseCleaner { + + @PersistenceContext + protected EntityManager entityManager; + + @Transactional + @Modifying + public void dbCleanUp(Set tableNameSet) { + entityManager.createNativeQuery(H2Dialect.REFERER_FALSE).executeUpdate(); + tableNameSet.forEach(n -> entityManager.createNativeQuery(H2Dialect.TRUNCATE + n)); + entityManager.createNativeQuery(H2Dialect.REFERER_TRUE).executeUpdate(); + } + + private static final class H2Dialect { + private static final String REFERER_TRUE = "SET REFERENTIAL_INTEGRITY TRUE"; + private static final String REFERER_FALSE = "SET REFERENTIAL_INTEGRITY FALSE"; + private static final String TRUNCATE = "TRUNCATE TABLE "; + } +} diff --git a/src/test/resources/h2.properties b/src/test/resources/h2.properties new file mode 100644 index 000000000..339b2c6db --- /dev/null +++ b/src/test/resources/h2.properties @@ -0,0 +1,16 @@ +spring.datasource.driver-class-name = org.h2.Driver +spring.datasource.url = jdbc:h2:mem:test;MODE=MySQL + +spring.jpa.hibernate.ddl-auto = create-drop +spring.jpa.database-platform = org.hibernate.dialect.H2Dialect + +spring.datasource.hikari.maximum-pool-size = 4 +spring.datasource.hikari.pool-name = H2_TEST_POOL + +### FOR DEBUGGING ### +logging.level.org.hibernate.SQL = debug +logging.level.org.hibernate.type.descriptor.sql = trace + +spring.jpa.properties.hibernate.format_sql = true +spring.jpa.properties.hibernate.highlight_sql = true +spring.jpa.properties.hibernate.use_sql_comments = true