[개발환경 세팅] spring 애플리케이션 생성 및 gradle 프로젝트 구조

스프링 애플리케이션 생성

스프링 애플리케이션은 👉 Spring Initializer 를 이용하면 간단하게 생성할 수 있다. 아래처럼 dependency 에서 web, jpa, lombok, devtools 라이브러리를 추가해주고 generate 를 클릭하면 zip 파일이 다운로드 된다. 다운받은 zip 파일을 압축 해제 후 IntelliJ 에서 open 하면 된다.

• web : Spring MVC를 사용하여 RESTful을 포함한 웹 애플리케이션을 빌드. Apache Tomcat을 기본 내장 컨테이너로 사용한다.
• JPA(Java Persistence API) : ORM(Object Relational Mapping) 이라는 데이베이스 table 를 자바 객체로 매핑(변환이라고 생각하면 된다.) 시켜주는 기술의 표준으로, 이 ORM 을 사용하기 위한 인터페이스(AP 규격)의 모음이다. Hibernate 는 이를 구현한 프레임워크이다. 참고로 Spring Data JPA 는 Hibernate 등과 같은 JPA provider 를 사용하여 JPA 를 더 쉽게 적용하기 위해 JPA를 한 단계 더 추상화 시킨 것이다.
• lombok : Annotation 을 통해 getter, setter, builder 등의 반복 메소드를 자동으로 만들어주는 라이브러리다.
• devtools : 빠른 애플리케이션 재시작, LiveReload 및 구성을 제공한다.

 

gradle 프로젝트 구조

Gradle 로 생성한 스프링 프로젝트의 구조이다.

• .gradle : gradle 이 사용하는 폴더. task 로 생성된 파일이 저장되며 개발자가 편집하는 경우는 거의 없다.
• .idea : 로컬 IntelliJ IDE 구성이 포함된 폴더다.
• gradle : gradle 이 사용하는 폴더. gradle 환경을 정리한 wrapper 파일이 저장되어 있다.
• src : 프로젝트 폴더로 각종 소스코드와 리소스 파일이 들어가 있다.
  • main : java 소스 코드가 들어 있다.
  • test : test 파일이 들어 있다.
• .gitignore : git 이 무시할 파일들을 명시한 것이다.
• build.gradle : gradle 의 빌드 설정 파일이다. groovy 언어로 작성되어 있다. 여기에 dependency 를 명시한다.
• gradlew : gradle 의 명령 파일. macOS 와 Linux 용이다.
• gradle.bat : gradle 의 명령 파일. windows 용이다.
• setting.gradle : 프로젝트 설정 정보 파일이다.

 

build.gradle

플러그인과 라이브러리 같은 dependecy 의 이름 및 버전을 적으면 이후 gradle 이 빌드할 때 알아서 다운받아준다. spring initializer 에서 추가해주었던 jap, web, lombok, devtool 들이 추가되어 있다. 지금은 database 를 이용하지 않으니 jpa 를 주석처리 해준다. 안 하면 프로젝트 실행이 안 될 것이다.

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

...

dependencies {
	//implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

...

 

 

src/main/java/TodolistTutorialApplication.java

spring initializer 가 자동으로 만들어준 소스 코드다. 스프링 부트는 main 을 실행시키면 내장된 톰캣을 자체적으로 실행시키기 떄문에 spring 과 달리 별도의 웹서버를 다운받지 않고도 바로 실행시킬 수 있다.

package com.todolist.tutorial;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class TodolistTutorialApplication {

	public static void main(String[] args) {
		SpringApplication.run(TodolistTutorialApplication.class, args);
	}

}

 

애플리케이션 실행

IDE 에서 run 을 하면 실행된다.

 

커맨드라인에서 실행한다면 프로젝트 디렉토리 경로에서 gradle 혹은 ./gradlew 명령어로 실행한다. (window 에서는 gradlew)

~/Project/study/springboot/tutorial > gradle bootRun
~/Project/study/springboot/tutorial > ./gradlew bootRun

 

성공 시 아래와 같은 메시지가 출력되고 localhost:8080에 접속하면 error 페이지가 뜰 것이다.  만약 실행이 안 된다면 build.gradle 파일에서 jpa dependency 를 주석처리 했는지 확인한다.

2:13:48 오후: Executing task ':TodolistTutorialApplication.main()'...

> Task :compileJava
> Task :processResources UP-TO-DATE
> Task :classes

> Task :TodolistTutorialApplication.main()
14:13:50.772 [Thread-0] DEBUG org.springframework.boot.devtools.restart.classloader.RestartClassLoader - Created RestartClassLoader org.springframework.boot.devtools.restart.classloader.RestartClassLoader@18e2c412

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.5.7)

2021-11-19 14:13:51.126  INFO 19062 --- [  restartedMain] c.t.t.TodolistTutorialApplication        : Starting TodolistTutorialApplication using Java 1.8.0_202 on userui-MacBookPro.local with PID 19062 (/Users/user/Project/study/springboot/tutorial/build/classes/java/main started by user in /Users/user/Project/study/springboot/tutorial)
2021-11-19 14:13:51.134  INFO 19062 --- [  restartedMain] c.t.t.TodolistTutorialApplication        : No active profile set, falling back to default profiles: default
2021-11-19 14:13:51.180  INFO 19062 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
2021-11-19 14:13:51.180  INFO 19062 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : For additional web related logging consider setting the 'logging.level.web' property to 'DEBUG'
2021-11-19 14:13:51.980  INFO 19062 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2021-11-19 14:13:51.991  INFO 19062 --- [  restartedMain] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2021-11-19 14:13:51.991  INFO 19062 --- [  restartedMain] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.55]
2021-11-19 14:13:52.055  INFO 19062 --- [  restartedMain] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2021-11-19 14:13:52.055  INFO 19062 --- [  restartedMain] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 874 ms
2021-11-19 14:13:52.393  INFO 19062 --- [  restartedMain] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2021-11-19 14:13:52.423  INFO 19062 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2021-11-19 14:13:52.432  INFO 19062 --- [  restartedMain] c.t.t.TodolistTutorialApplication        : Started TodolistTutorialApplication in 1.651 seconds (JVM running for 2.058)
2021-11-19 14:15:16.716  INFO 19062 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2021-11-19 14:15:16.716  INFO 19062 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2021-11-19 14:15:16.718  INFO 19062 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 2 ms