Visual Studio Code - Spring boot 개발 환경 세팅

Summry

본 문서에서는 VSC(Visual Studio Code)에서 Spring boot 개발 환경을 구성하는 방법을 정리한다.

많은 사람들이 spring boot project에서 Intellij나 Eclipse를 IDE로 사용하지만 VSC가 익숙하고 또 VSC를 이용해 개발하고자 하는 사람들을 위해 VSCode에서 spring boot 기반 java application을 개발할 수 있는 환경을 구축하는 방법을 정리한다.

본 문서는 VSC IDE의 install 방법은 설명하지 않는다.

send me email if you have any questions.

plugin install

VSCode 내 확장 마켓플레이스 검색: Ctrl + Shift + X 를 눌러 VSCode ‘Extension Marketplace’ 를 패널을 띄운다.

Java Extension Pack

그림1

Java Extension Pack은 Visual Studio Code에서 Java 응용 프로그램을 작성, 테스트 및 디버그하는 데 도움이 될 수 있는 널리 사용되는 확장팩이다.

Spring Boot Extenstion Pack

그림2

Spring Boot 애플리케이션 개발 및 배포를 위한 확장팩이다.

Lombok Annotations Support for VS Code

그림3

Java 라이브러리로 반복되는 getter, setter, toString .. 등의 반복 메서드 작성 코드를 줄여준다.

Lombok Library 정리글

Spring Initializr Java Support

그림4

Spring Initializr Java Support 확장팩으로 VSCode 내에서 Spring Initialzr(https://start.spring.io/) API를 이용하여 스프링 부트 프로젝트를 구성할 수 있다.

Spring Boot Dashboard

그림5

피보탈이 이클립스를 통해 제공하는 대시보드와 유사하게 작동한다. 등록된 스프링 부트 애플리케이션 조회, 실행, 중단, 디브그 및 실행중인 스프링 부트 앱을 브라우저에서 열어볼 수 있다.

create project

Ctrl + Shift + P 를 눌러 커맨드 팔레트(Command palette)를 열어 ‘Spring initalizr: Create a Gradle Project’ 를 선택한다.
Spring Boot version 선택
Project language 선택
Group Id 등록
- 모든 프로젝트 중에서 당신의 프로젝트를 식별하게 해주는 식별자
- groupId는 Java의 패키지 이름 규칙을 따라야 함 즉 제어하는 도메인 이름의 반대로 시작 ex) org.apache.maven, org.apache.commons
- 만약에 프로젝트가 다중 모듈 프로젝트인 경우 부모의 groupId에 새 식별자를 추가해 사용
- org.apache.maven, org.apache.maven.plugins, org.apache.maven.reporting
Artifact Id
- artifactId는 버전이 없는 jar의 이름
Packaging type 선택: JAR
Java Version 선택
Dependnecies 선택(사용하려는 기술에 따라 다름)
- Spring Boot DevTools
- Lombok
- Spring Configuration Processor
- Spring Web
- Spring Data JPA
- H2 Database
- Flyway Migration
- MariaDB Driver
저장소 생성위치 지정
finish

test code 작성

임의로 TestController를 만들어 /test uri로 접근 시 “test!!”문자열을 반환하는 api를 작성해본다.

그림6

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @GetMapping("/test")
    public String test() {
        return "test!!";
    }
}