스프링부트 게시판 API 만들기 (1) - 프로젝트 생성

 

 

 

제가 만들 게시판은 "에브리타임"과 같은 일반적인 게시판입니다.

질문을 올릴 수도,  정보공유를 할 수도,  잡다한 이야기들을 올릴 수도 있는 게시판이라 볼 수 있겠죠.

 

기본적인 애플리케이션의 기능은 이러합니다. 중간에 추가되거나 삭제될 수도 있습니다.

(그냥 하고싶은걸 순서 생각 없이 적어둔것이니, 순서대로 진행하지 않을 수 있습니다.)

 

• 시큐리티를 이용한 JSON 데이터로 로그인
• JWT를 이용한 인증
• 도메인, 테이블 설계, 엔티티 생성
• 댓글 삭제 로직 구현
• 회원가입 + 정보수정 등 회원 서비스 구현
• 게시판 서비스 구현
• 댓글 서비스 구현 (1댓글 -> *(무한) 대댓글 구조)
• 예외 처리
• 예외 메세지 국제화
• 카테고리별 게시판 분류
• 게시글 페이징
• 동적인 검색 조건을 사용한 검색
• 사용자 간 쪽지 기능
• 무한 쪽지 스크롤
• 게시물 & 댓글에 대한 알람
• 쪽지에 대한 알람
• 접속한 사용자 간 실시간 채팅
• 회원가입 시 검증(예: XX대학교 XX과가 아니면 가입할 수 없게)
• Swagger를 사용한 API 문서 만들기
• 신고 & 블랙리스트 기능
• AOP를 통한 로그
• 어드민 페이지
• 캐시
• 배포 (+ 무중단 배포)
• 배포 자동화
• ...

 

막상 적어보니 하고싶은게 정말 많네요...

언젠간 이것들을 다 할 수 있길 바라며.. 

프로젝트 생성부터 해보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

프로젝트 생성

 

 

 

 

• Web : 웹 관련 기능을 수행합니다
• Data JPA : JPA를 편하게 사용할 수 있는 기능을 제공해줍니다.
• Security : 인가와 인증 관련한 기능들을 제공해줍니다.
• Lombok : 어노테이션을 사용하여 생성자, 수정자 등을 간편하게 생성해줍니다.
• Validation : HTTP 요청이 들어왔을 때, 요청이 포함한 데이터 형식을 검증해줍니다
• H2 Database : DB로는 H2를 사용합니다. 개발 단계에서는 간편하고 좋습니다. (이후 배포 시 다른 DB로 변경할 예정입니다.)

 

 

 

 

 

 

 

 

 

초기 설정

프로젝트를 열어줍니다.

File -> Setting -> gradle을 검색합니다.

Build and run using과 Run test using을 Gradle에서 IntelliJ IDEA 로 바꾸어줍니다.

Gradle로 설정할 경우 실행을 Gradle에게 위임하기 때문에 조금 더 시간이 오래걸립니다.

 

추가로 저는 자바의 버전을 17버전을 사용하기 때문에 Gradle JVM도 17로 바꾸어주었습니다. (없다면 다운받아 주셔야 합니다)

 

 

 

 

 

다음으로는 롬복을 사용하기 위한 설정입니다.

File -> Setting -> AnnotationProcessors을 검색합니다.

annotaionProcessor는 컴파일 시점에 Annotation 기반으로 코드를 변경하거나 생성하는 방법을 말합니다.

우리는 Lombok을 통해 여러 코드를 생성할 것이니 Enable annotation processing을 체크해주어 사용할 수 있도록 해줍니다.

 

 

 

 

 

 

다음으로는 Project Structure 관련 설정입니다.

File -> Project Structure로 이동합니다.

 

왜인지는 모르겠지만 저는 항상 SDK가 16 버전으로 설정되어 있더라구요. 

그래서 17버전의 자바를 사용하기 위해 17버전으로 설정을 변경해줍니다.

 

 

 

 

 

 

 

 

 

build.gradle에 추가

다음을 추가하여 SQL 로그를 좀 더 보기 쉽도록 남기도록 하겠습니다.

//p6spy 적용
implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.7.1'

 

 

 

 

전체 코드는 다음과 같습니다.

plugins {
   id 'org.springframework.boot' version '2.6.2'
   id 'io.spring.dependency-management' version '1.0.11.RELEASE'
   id 'java'
}

group = 'boardexample'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

configurations {
   compileOnly {
      extendsFrom annotationProcessor
   }
}

repositories {
   mavenCentral()
}

dependencies {
   implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
   implementation 'org.springframework.boot:spring-boot-starter-security'
   implementation 'org.springframework.boot:spring-boot-starter-validation'
   implementation 'org.springframework.boot:spring-boot-starter-web'
   compileOnly 'org.projectlombok:lombok'
   runtimeOnly 'com.h2database:h2'
   annotationProcessor 'org.projectlombok:lombok'
   testImplementation 'org.springframework.boot:spring-boot-starter-test'
   testImplementation 'org.springframework.security:spring-security-test'

   //p6spy 적용
   implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.7.1'

   implementation 'com.auth0:java-jwt:3.18.2'
}

test {
   useJUnitPlatform()
}

 

 

 

 

 

 

 

 

 

 

 

 

application.yml 설정

우선 application.properties 파일의 이름을 application.yml로 바꾸어 주겠습니다. 

(이유는 yml 파일이 구조를 파악하기 더 쉽습니다.)

그리고 다음과 같이 설정해주겠습니다.

spring:
  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:tcp://localhost/~/jpa
    username: sa
    password: 1


  jpa:
    properties:
      hibernate:
        format_sql: true
        user_sql_cooments: true

    hibernate:
      ddl-auto: create

logging:
  level:
    org:
      apache:
        coyote:
          http11: debug

      hiberante:
        SQL: debug

    boardexample:
      myboard: info

 

 

(세팅은 아래 게시물을 확인해주세요)

[Setting] H2 DataBase 사용 설정

[Setting] JPA 데이터베이스 설정

[MVC] Http 요청정보 로그 남기기 (스프링 MVC)

[Setting] Slf4J 로그 남기기

 

 

 

 

 

 

 

 

 

 

 

 

실행

잘 실행되는지 실행시켜보도록 하겠습니다.

데이터베이스를 실행시키지 않아서 오류가 발생함

 

 

 

데이터베이스를 켜주고 다시 실행시켜보면

잘 작동함

 

 

 

 

http://localhost:8080/ 으로 이동해서 잘 작동하는지 확인합니다.

 

 

 

 

이렇게 뜨면 모두 잘 된겁니다.

 

 

로그도 잘 나오네요.

 

이제 회원가입과 JWT를 활용한 로그인을 구현해 보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

AnnotationProcessor 관련

Configure annotation processors | IntelliJ IDEA

 

[Java] Annotation Processor

 

게시판 참고

스프링부트 게시판 API 서버 만들기 (1) - 프로젝트 생성