본문 바로가기
Spring Boot

스프링 부트(Spring Boot) - 게시판 프로젝트 구조 알아보기 [Thymeleaf, MariaDB, IntelliJ, Gradle, MyBatis]

by 도뎡 2023. 3. 20.
반응형

이전 글에서는 자바 JDK 설치, 환경 변수 설정, 인텔리제이(IntelliJ) 설치 및 환경 설정, 스프링 부트 프로젝트 생성 및 Import 등 기본적인 게시판 개발환경을 세팅해 보았습니다.

 

이번에는 스프링 부트에서 중요한 역할을 하는 폴더와 파일들에 대해 알아보고, 스프링 레거시와의 차이점을 비교해 보도록 하겠습니다.

 

스프링 부트 프로젝트 구조

 

1. src/main/java 디렉터리

스프링 레거시와 마찬가지로 클래스, 인터페이스 등 Java 관련 파일이 위치하는 디렉터리입니다.

 

 

2. BoardApplication 클래스

이전 글에서 생성한 Board 프로젝트의 com.study 패키지에는 우리가 생성하지 않은 BoardApplication 클래스가 포함되어 있습니다. 파일을 열어보면 메서드 선언부에는 딸랑 main( ) 메서드 하나만 선언되어 있는데요. main( ) 메서드는 SpringApplication.run( )을 호출해서 웹 애플리케이션을 실행하는 역할을 합니다.

 

 

다음은 클래스 레벨에 선언된 @SpringBootAplication 어노테이션입니다. 해당 어노테이션은 다음의 세 가지 어노테이션으로 구성되어 있습니다.

어노테이션 설명
@EnableAutoConfiguration 스프링 부트는 개발에 필요한 몇 가지 필수적인 설정들의 처리가 되어 있으며, 해당 애너테이션에 의해 다양한 설정들의 일부가 자동으로 완료됩니다.
@ComponentScan XML 설정 방식을 이용하는 스프링 레거시는 빈(Bean)의 등록 및 스캔을 위해, 수동으로 ComponentScan을 여러 개 선언하는 방식을 사용했었습니다.

스프링 부트는 해당 어노테이션에 의해 자동으로 컴포넌트 클래스를 검색하고, 스프링 애플리케이션 콘텍스트(IoC 컨테이너)에 빈(Bean)으로 등록합니다. 쉽게 말해, 의존성 주입(DI) 과정이 더욱 간편해졌다고 생각할 수 있습니다.
@Configuration 해당 어노테이션이 선언된 클래스는 Java 기반의 설정 파일로 인식됩니다. 스프링 4 버전부터 Java 기반의 설정이 가능하게 되었으며, XML 설정에 큰 시간을 소모하지 않아도 됩니다.

 

 

3. src/main/resources 디렉터리

스프링 레거시는 프로젝트가 생성되었을 때 해당 디렉터리에 log4.xml 파일만 떡하니 생성되었습니다. 스프링 부트는 templates 폴더, static 폴더, application.properties 파일이 기본적으로 생성됩니다.

폴더 및 파일 설명
templates 스프링 레거시는 HTML 내에 Java 코드를 삽입하는 방식인 JSP를 주로 사용했었습니다. 하지만, 스프링 공식 문서에서는 View(화면) 영역에서 JSP가 아닌 타임리프(Thymeleaf) 템플릿 엔진의 사용을 권장하고 있습니다.

타임리프는 JSP와 마찬가지로 HTML 내에서 Java 영역의 데이터를 처리하는 데 사용됩니다. 문법 또한 JSTL과 유사하기에(큰 차이가 없음), JSP를 사용해 본 경험이 있으시다면 쉽게 접근하실 수 있을 겁니다.

결론적으로 해당 디렉터리에는 타임리프 관련 파일이 위치하게 되고, 타임리프는 HTML5 기반이기 때문에 HTML 파일로 화면을 구성합니다. 타임리프는 게시판의 기능들을 구현하면서 차근차근 알아가 보도록 하겠습니다.
static 해당 폴더에는 css, fonts, images, plugin, scripts 등의 정적 리소스 파일이 위치합니다.
application.properties 해당 파일은 웹 애플리케이션을 실행하면서 자동으로 로딩되는 파일입니다. 예를 들어, 부트에 내장된 톰캣의 포트 번호, 콘텍스트 패스(Context Path) 설정이나, 데이터베이스 관련 정보 등 애플리케이션에서 사용하는 여러가지 설정을 해당 파일에 Key - Value 형식으로 선언해서 사용할 수 있습니다.

선언한 속성은 일반적으로 설정(Configuration) 파일에서 사용하며, 자세한 사용법은 데이터베이스를 연동하는 과정에서 알아보도록 하겠습니다.

 

4. src/test/java 디렉터리

해당 디렉터리의 com.study 패키지에는 BoardApplicationTests 클래스가 생성되어 있습니다. 우리는 해당 클래스를 이용해서 개발 단계별로 단위 테스트를 진행하게 되며, 스프링 레거시와는 달리 복잡한 설정 없이 곧바로 테스트가 가능합니다.

 

 

5. build.gradle

우리는 프로젝트를 생성하면서 프로젝트의 빌드 도구를 그레이들(Gradle)로 선택했습니다. 기존의 스프링은 pom.xml에 dependency를 추가해서 라이브러리를 관리하는 방식의 메이븐(Maven)을 이용했었는데요. 메이븐을 이용하면서, 라이브러리의 버전 문제, 충돌 문제, 종속적인 문제 골치 아픈 상황을 여러 번 겪어보았습니다.

 

최근에는 메이븐 보다 그레이들을 선호하는 추세라고 합니다. 메이븐은 하나의 라이브러리를 추가하려면 평균적으로 네 줄 이상의 코드를 작성해야 하지만, 그레이들은단 한 줄의 코드로 라이브러리를 추가할 수 있습니다.

 

우리는 build.gradle에 필요한 라이브러리들을 차근차근 추가하며 개발하게 되는데요. 프로젝트에 포함된 모든 라이브러리는 IDE의 External Libraries에서 확인할 수 있습니다.

프로젝트 전체 라이브러리 확인 방법

 

 

6. MVC 패턴

스프링 부트라고 해서 다른 개발 패턴을 사용하는 것은 아닙니다. 기존의 스프링과 마찬가지로 MVC 패턴으로 개발하게 되며, MVC 패턴이 무엇인지 가볍게 알아보도록 하겠습니다.

 

패턴 설명
모델, Model - (M) 데이터를 처리하는 영역으로, 흔히 비즈니스 로직을 처리하는 영역이라고 이야기합니다. 해당 영역은 DB와 통신하고, 사용자가 원하는 데이터를 가공하는 역할을 합니다.
뷰, View - (V) 사용자가 보는 화면을 의미하며, 타임리프(HTML)를 이용해서 화면을 처리합니다.
뷰(View) == 화면(UI) == 사용자(User)
컨트롤러, Controller - (C) 모델(M)과 뷰(V)의 중간 다리 역할을 하는 영역입니다. 사용자가 웹에서 어떠한 요청을 하면 가장 먼저 컨트롤러를 경유합니다. 컨트롤러는 사용자의 요청을 처리할 어떠한 로직을 호출하고, 호출한 로직의 실행 결과를 사용자에게 전달하는 역할을 합니다.

예를 들어, 사용자가 게시글 등록을 요청하면 컨트롤러는 게시글의 제목, 내용, 작성자 등 사용자가 입력한 데이터(파라미터)를 전달받아 유효성을 검증합니다.

검증이 완료되면 모델 영역에 데이터의 가공을 요청하며, 가공이 완료되면 전달받은 데이터를 DB에 저장한 후, 데이터 등록 성공 또는 실패 여부를 컨트롤러로 전달합니다. 마지막으로 컨트롤러는 등록 요청에 대한 결과를 사용자(View)에게 전달합니다.

 

마치며

이번에는 스프링 부트의 필수 디렉터리 및 파일과 MVC 패턴에 대해 가볍게 알아보았습니다.


처음 개발을 접해보시는 거라면 당장은 이해가 쉽지 않으실 수도 있는데요. 실제로 게시판의 기능들을 하나씩 구현하다 보면 각 영역을 어떻게 처리해야 하며, 어떠한 흐름과 패턴으로 개발해야 할지 금방 감이 잡히실 테니 너무 걱정하지 않으셔도 됩니다!

 

다음 글에서는 스프링 부트와 데이터베이스(MariaDB)를 연동해 보도록 하겠습니다.

오늘도 방문해 주신 여러분께 진심으로 감사드립니다! 좋은 하루 보내세요 :)

반응형

댓글