[Spring Boot JPA 게시판 만들기] 1. 환경설정

 Intro

 

Spring Boot와 JPA를 활용해서 간단한 게시판 기능을 구현해 보겠습니다. 글은 시리즈로 작성될 예정이며 현재 글에서는 프로젝트 생성, build.gradle과 dependencies, applicaiton.yaml 파일 설정에 대해 알아볼게요.

- IDE : IntelliJ

- java version : 17

 

 프로젝트 생성

 

일일이 수동으로 Spring 프로젝트를 생성하고 설정하는 것은 쉽지 않기 때문에 IntelliJ와 Spring Initializer를 사용해서 Spring Boot 프로젝트를 생성하는 방법을 알아봅시다!

 

IntelliJ IDEA  사용

 

 

인텔리 제이 유료 버전(IntelliJ IDEA)을 사용하신다면 프로젝트 생성 시 Spring Boot Generators를 사용할 수 있어요. 

 

 

dependencies는 위와 같이 설정해 주세요. 각 의존성이 의미하는 건 아래에 자세히 알아보겠습니다

 

Spring Initializer 사용

 

https://start.spring.io/

 

 

위 링크의 웹사이트를 이용하면 Spring Boot 프로젝트를 생성할 수 있어요. IntelliJ의 경우 무료 사용자에게는 Generator을 지원하지 않기 때문에 무료 버전의 IntelliJ를 사용하신다면 이 사이트를 이용하시면 됩니다. 

 

 

IntelliJ에서 스프링 부트 프로젝트를 생성하는 방법과 유사합니다. Gradle과 Maven을 선택할 수 있고, 언어로는 Java, Kotlin, Groovy를 선택해 줄 수 있습니다. 

SNAPSHOT 의 경우 아직 안정화가 되지 않은 버전이기 때문에 현재 글 작성 기준 3.2.4를 사용하겠습니다.

Project의 이름과 Package name등을 설정해 주고 Java 버전도 선택해 줍니다. 

 

 

오른쪽 상단에 ADD DEPENDENCIES 버튼을 누르면 dependencies를 추가할 수 있어요. 

 

간단한 Spring Boot 게시판을 만들기 위해 위와 같이 추가해 주세요

 

하단의 GENERATE 버튼을 누르면 zip 파일을 다운로드 받게 됩니다. 압축을 해제하고 IntelliJ에서 프로젝트 폴더를 열어주세요. 

상단 상태바에 File > Open을 눌러 해당 프로젝트 폴더로 이동하시면 됩니다. 

 

 Build.gradle

 

Build.gradle이란?

참고 사이트

[Gradle] build.gradle의 동작원리 한 번에 정리하기

 

public interface Project extends Comparable<Project>, ExtensionAware, PluginAware { }

 

프로젝트 단위에서 필요한 작업을 수행하기 위한 메서드와 프로퍼티를 모아놓은 슈퍼 객체입니다. plugins, repositories, dependencies 메서드등을 포함합니다. 

 

build.gradle 설정하기

 

 

build.gradle 파일을 들어가보면 프로젝트 생성시에 지정해 둔 dependencies 가 이미 작성되어 있습니다. 

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

 

 

 

각 dependency가 하는 역활을 알아볼게요!

 

lombok

 

롬복은 Getter, Setter, NoArgs, NoArgsConstructor와 같은 어노테이션을 제공합니다. 직접 getter, setter, 생성자 등의 코드 대신 어노테이션을 사용하여 복잡하고 반복되는 코드를 축소 시킬 수 있습니다. 

Builder를 사용해서 인스턴스를 쉽게 생성할 수 있습니다. 

 

    @Builder
    public Board(String title, String content, String author) {
        this.title = title;
        this.content = content;
        this.author = author;
    }

 

        Board board = Board.builder()
                .title(title)
                .content(content)
                .author("admin")
                .build();

 

Spring Web

https://mvnrepository.com/artifact/org.springframework/spring-web

 

웹 애플리케이션을 개발하기 위해 Spring이 제공하는 기능을 사용할 수 있습니다. 웹 요청 및 응답 처리, HTTP 요청을 java 객체로 변환, Java 객체를 HTTP 응답으로 변환하는 기능을 포함하고 있어요.

 

 Thymeleaf

 

Thymeleaf

 

참고 사이트

Thymeleaf(타임리프)란 ? 타임리프의 기본 기능알아보기

 

백엔드 서버에서 HTML을 동적으로 렌더링 할 수 있게 해주는 템플릿 엔진입니다. 다른 엔진으로는 JSP가 있습니다. 서버에 내용에 따라 동적으로 html에 내용을 담아 웹브라우저에서 확인할 수 있어요. 

이번 게시판 프로젝트에는 타임리프를 사용해서 프론트 개발을 해보겠습니다. 

 

 Spring JDBC

참고 사이트

https://mininkorea.tistory.com/39

JDBC(Spring JDBC)란? / 스프링 JDBC 알고넘어가기! ^^

 

JDBC(Java Database Connectivity)는 Java 애플리케이션에서 데이터베이스에 접근하여 데이터를 검색, 삽입, 갱신, 삭제할 수 있게 해줍니다.

JPA는 데이터베이스와 상호작용을 위해 내부적으로 JDBC를 사용합니다.

 

 MariaDB Driver

 

database로는 마리아 db를 사용해주겠습니다.

 

application.yaml

 

spring:
  mvc:
    hiddenmethod:
      filter:
        enabled: true
  jpa:
    hibernate:
      ddl-auto: update
    properties:
        hibernate:
            show_sql: true
            format_sql: true
  datasource:
    url: jdbc:mariadb://localhost:3306/dev
    driver-class-name: org.mariadb.jdbc.Driver
    username: dev
    password: 0000
logging:
  level:
    root: info

 

최종 application.yaml은 이렇습니다! 만약 application.yaml 파일이 없으면 생성해 주세요.

 

위치는 resources 폴더에 위치합니다!

 

 

spring.mvc.hiddenmethod.filter.enabled: true

 

HTTP Post 요청을 통해 오는 폼 데이터에 숨겨진 HTTP 메서드를 처리하기 위해 추가해 주었어요. HTML 폼에서 put이나 delete와 같은 메소드를 사용할 수 없는데 이를 사용해 주기 위해 설정해 줍니다.

 

spring.jpa.hibernate.ddl-auto: update

 

 

Hibernate를 사용해서 JPA 엔티티를 데이터베이스 스키마에 자동 매핑할 때 사용합니다. 엔티티 클래스의 변경 사항에 따라 데이터베이스 테이블을 업데이트 하는 전략입니다.

 

spring.jpa.properties.hibernate.show_sql: true

 

 

Hibernate가 생성하는 SQL 쿼리를 로깅하기 위해서 추가해 주었습니다. 

 

spring.jpa.properties.hibernate.format_sql: true

 

Hibernate가 생성하는 SQL 쿼리가 가독성이 좋은 쿼리로 떨궈주는 건 아니라 포멧 설정을 해줍니다. SQL 쿼리를 보기 쉽게 포멧 해줍니다.

 

spring.datasource.url: jdbc:mariadb://localhost:3306/dev

 

 

애플리케이션에서 사용할 JDBC 드라이버 클래스를 지정합니다. 위에 경우 MariaDB의 dev 스키마에 연결되요. mariadb의 경우 기본 포트는 3306입니다.

 

spring.datasource.driver-class-name: org.mariadb.jdbc.Driver

 

MariaDB JDBC 드라이버를 설정해 줍니다.

 

logging.level.root: info

 

루트 로거의 로깅 레벨을 지정합니다. 모든 로그를 보지 않고 INFO 이상의 로그만 출력해 줍니다.

 

 마무리

 

기본적인 설정이 끝났습니다! 스프링 부트를 사용하면 쉽게 웹 애플리케이션을 만들 수 있어요!

다음 포스팅에서는 프로젝트 구조에 대해 잠시 살펴 보겠습니다~

 

 

Ron Lach 님의 사진: https://www.pexels.com/ko-kr/photo/9903145/