[SpringBoot] IntelliJ 스프링부트 프로젝트 생성 / 초기 설정(인텔리제이 2023Ver)

스프링 이니셜라이저(https://start.spring.io/)를 사용하지 않고 초기 세팅을 해보도록 하겠다. 지금 공부하며 글을 작성하는 책(스프링부트와 AWS로 혼자 구현하는 웹 서비스)은 스프링부트를 제대로 이해하기 위해선 build.gradle에 하나하나 초기 세팅을 해가며 스프링부트 개발환경을 구성해 보는 것을 추천하기 때문에 build.gradle에 하나하나 입력해가며 초기 setting을 해보면 좋을 것 같다. 이 책이 옛날 책이라 그런지 개발환경을 구성하거나 gradle 버전도 옛날거라 좀 다르게 설정해야 하는 부분들이 있어서 그 부분들도 수정해보겠다.

IntelliJ에서 New Project 생성

언어는 Java를 사용할 것이기 때문에 Java로 설정해준다. build system으론 gradle, Gradle DSL(Domain Specific Language)로는 Groovy를 이용하도록 한다. 위의 세팅을 해주고 Create버튼을 누르면 자바 프로젝트가 생성되고 그 프로젝트 안의 build.grale 파일이 생성되는데, 기본적으로 생성된 코드는 이렇다. 아주 기본적인 코드만 작성되어 기본적인 부분만 설정되어 있는 상태이다.

plugins {
    id 'java'
}

group = 'org.example'
version = '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    testImplementation platform('org.junit:junit-bom:5.9.1')
    testImplementation 'org.junit.jupiter:junit-jupiter'
}

test {
    useJUnitPlatform()
}

위의 코드의 맨 앞에

buildscript {
    ext {
        springBootVersion = '2.1.7.RELEASE'
    }
    repositories {
        mavenCentral()
        jcenter()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

코드를 추가해준다. 

springBootVersion변수에 설정된 문자열은 스프링부트 버전을 의미하는데 굳이 저 버전으로 설정해줄 필요 없다. 왜냐하면 책이 옛날버전이라 최신걸로 해도 상관없다.

ext

: ext 블록은 build script에서 사용할 변수를 정의하는 데 사용. springBootVersion이란 변수를 전역 변수로 선언해주는 역할.

repositories

: build script에서 사용할 라이브러리 또는 플러그인을 다운로드할 저장소(repository)를 정의. 여기서 mavenCentral()과 jcenter() 메서드를 호출하여 Maven Central Repository와 JCentral Repository를 사용하도록 설정해준다. 이 저장소들은 Maven 중앙 저장소에서 라이브러리를 가져올 수 있게 해준다. 

dependencies

: build script에서 사용할 외부 의존성(dependency)를 정의. classpath(~)에서 Spring Boot Gradle 플러그인에 대한 의존성을 정의. ${springBootVersion}은 앞서 ext를 통해 정의한 변수를 이용해 스프링부트 버전을 지정해준다. 이 플러그인은 스프링부트 프로젝트의 빌드와 패키징을 지원한다.

plugins {
    id 'java'
    id 'eclipse'
    id 'org.springframework.boot'
    id 'io.spring.dependency-management'
}

다음으로는 이 코드를 추가해준다. (Gradle 플러그인을 적용하는 부분)

특히 io.spring.dependency-management는 Spring 프로젝트에서 종속성 관리를 간편하게 처리할 수 있도록 도와준다.

repositories {
    mavenCentral()
}

-> 각종 의존성들을 어떤 원격 저장소에서 받을지를 설정

compile('org.springframework.boot:spring-boot-starter-web')
testCompile('org.springframework.boot:spring-boot-starter-test')

다음으로는 이 코드를 추가해주어야 한다고 책에 나와있지만, 이전 버전의 Gradle에서 사용되는 구문이라고 한다. 따라서 

dependencies {
    implementation('org.springframework.boot:spring-boot-starter-web')
    testImplementation('org.springframework.boot:spring-boot-starter-test')
}

코드를 통해 의존성을 선언한다.

이렇게 해서 책과 같이 코드를 완성했는데 Gradle 버전 문제가 발생해 gradle 파일의 gradle-wrapper.properties 파일에 들어가

distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip

에서 원래 오류 없이 쓰던 버전인 8.0 ver로 바꾸어주었다. (저기서 8.2라고 되어 있는 부분에서 원하는 버전으로 바꾸어주고 코끼리 버튼을 누르면 된다.)

Lombok 설정

compile('org.projectlombok:lombok')

책에서는 dependencies 블록에 이런 코드를 추가하라고 하였다. 하지만 그렇게 했더니 Test 코드 실행때

error: variable name not initialized in the default constructor

와 같은 오류가 발생했다.

 

찾아보니 최신 버전의 gradle에서는 annotationProcessor도 같이 작성해주어야 한다고 하여 이 코드를 추가해주었다.

implementation('org.projectlombok:lombok')
annotationProcessor('org.projectlombok:lombok')

후에 settings -> Plugins -> MarketPlace에서 Lombok을 설치하고 IntelliJ를 재시작한다. 

또한 settings -> Build, Excution, Deployment -> Compiler -> AnnotationProcessor 에서 Default를 클릭 후 Enable annotation processint 체크박스에 체크를 클릭한다.

Test 결과

build.gradle 전체 코드

buildscript {
    ext {
        springBootVersion = '3.0.5'
    }
    repositories {
        mavenCentral()
        jcenter()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

plugins {
    id 'java'
    id 'eclipse'
    id 'org.springframework.boot' version '3.0.5'
    id 'io.spring.dependency-management' version '1.1.0'
}

group = 'com.sujin.book'
version = '1.0-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
}

dependencies {
    implementation('org.springframework.boot:spring-boot-starter-web')
    testImplementation('org.springframework.boot:spring-boot-starter-test')
    testImplementation('junit:junit:4.12')      // Junit 4.12 라이브러리 추가
    implementation('org.projectlombok:lombok')
    annotationProcessor('org.projectlombok:lombok')
}

test {
    useJUnitPlatform()
}

이렇게 전체 코드를 입력 후,

코끼리 버튼을 누르면 스프링부트 개발환경 초기 설정이 완료된다. (Lombok Setting까지 완료된 전체 코드이다.)

-> 이렇게 우측의 코끼리버튼 -> Dependencies를 통해 스프링부트 spring-boot-starter-web과 spring-boot-starter-test 의존성이 잘 추가된 것을 볼 수 있다.

Reference

book: 스프링부트와 AWS로 혼자 구현하는 웹 서비스(저자-이동욱)