[Spring Boot Project] Visual Studio Code Editor IDE 구축하기

SpringBoot + Vue.js/SpringBoot in VSC

[Spring Boot Project] Visual Studio Code Editor IDE 구축하기

코드주운 2021. 4. 30. 18:25

저번주부터 VSC 에디터로 Spring Boot 프로젝트 개발환경(IDE)을 만들기 위해 작업하였다.

필자는 IDE 환경을 만들기 위해 하나의 폴더(TP_Inplace) 안에 java, maven, VSC, workspace 폴더를 생성하였다.

#주요 폴더 설명

● Java

- Java SE 11 (openJDK) 설치 경로 [C:\TP_Inplace\java\jdk-11.0.2]

● Maven

- Maven 3.8.1 설치 경로 [C:\TP_Inplace\maven\apache-maven-3.8.1]

- Maven Repository 경로 [C:\TP_Inplace\maven\repository]

- Repository 경로를 로컬 경로로 맞추기 위해서는 다음과 같이 setting.xml 을 생성 및 수정 해줘야한다.

(C:\TP_Inplace\maven\settings_inplace.xml)

- localRepository 태그를 설정하게되면 설정한 경로에 Maven Dependencies 의 jar 파일들이 다운로드 된다.

● VSC

만약 내가 구축한 IDE 폴더를 제 2의 사용자가 받아서 VSC를 실행시켰을 때 개발에 필요한 설정값이나, Extensions 설치 파일들이 없어져서 새롭게 다시 설정 및 설치를 해야한다면 좋은 IDE는 아니다. (ft.min10)

VSC의 설정값과 설치 파일들은 기본적으로

- C:\Users\사용자아이디\.vscode\extensions

- C:\Users\사용자아이디\AppData\Roaming\Code

해당 경로로 고정되어있다.

위에 고정된 경로들을 필자가 구축할 TP_Inplace 폴더안에 설치되도록 설정 해주어야한다.

다음은 경로를 변경하기위한 구체적인 방법이다.

1. VSC 설치하게 되면 Microsoft VS Code 폴더가 생성된다. 해당 폴더를 복사하여 VSC 폴더에 붙여넣어준다.

2. Microsoft VS Code 폴더에 Code.exe 바로 가기 파일을 생성하여 Visual Studio Code로 이름을 바꿔준다.

3. 바로가기로 만든 파일을 Visual Studio Code로 이름을 변경한 뒤 해당경로로 옮겨준다.

속성 버튼을 클릭하여 로컬 경로를 지정해준다.

4. 해당 바로가기 아이콘의 속성이서 대상에 경로를 새롭게 지정해준다.

"C:\TP_Inplace\VSC\Microsoft VS Code\Code.exe"

--extensions-dir="C:\TP_Inplace\VSC\Microsoft VS Code\extensions"

--user-data-dir="C:\TP_Inplace\VSC\Microsoft VS Code\Code"

이제 VSC를 실행시키기 위한 사전준비가 끝났다.

============================================================================

이제 설정이 끝난 VSC 에디터를 실행시킨다.

Spring Boot 프로젝트를 생성하기 위해서 Java, Spring boot 확장팩을 설치받아야한다.

1. Java Extension Pack

2. Spring Boot Extension Pack

설치를 받게 되면 오른쪽 하단에 여러가지 제안들이 나오게 되는데 전부다 Yes, Allow 를 눌러준다.

그 다음 settings.json(User) 파일, settings.json(Workspace) 파일 환경설정을 진행한다.

1. [Ctrl + ,] 단축키를 누르고 java.home 을 검색한다.

2. 다음과 같은 창이 나오게 되고 탭 부분에 User / Workspace 탭으로 나눠져 있는것을 확인할 수 있다.

Workspace 탭에서 Edit in settings.json 을 클릭하여 json 파일을 연다.

다음 설정파일을 적어준다.

{

"java.home": "C:\\TP_Inplace\\java\\jdk-11.0.2",

"spring-boot.ls.java.home": "C:\\TP_Inplace\\java\\jdk-11.0.2",

"java.configuration.maven.userSettings": "C:\\TP_Inplace\\maven\\apache-maven-3.8.1\\conf\\settings.xml",

"java.configuration.updateBuildConfiguration": "automatic"

}

설정파일 설명

"java.home"

- 환경변수에 설정한 jdk 버전이 아닌 해당 경로에 설치한 JDK 버전을 java.home 경로 설정

"spring-boot.ls.java.home"

- Spring boot 실행 시 사용할 java.home 경로 설정

"java.configuration.maven.userSettings"

- maven repository settings.xml 설정 경로

java.home 설정값을 저장하게 되면 Restart 여부를 물어보는데 Yes를 권장한다.

3. User 용 settings.json 파일을 연다

다음 설정파일을 적어준다.

{

"editor.suggestSelection": "first",

"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",

"java.project.importOnFirstTimeStartup": "automatic",

"files.exclude": {

"**/.classpath": true,

"**/.project": true,

"**/.settings": true,

"**/.factorypath": true

"redhat.telemetry.enabled": true,

"window.zoomLevel": 0,

"java.configuration.maven.userSettings": "C:\\TP_Inplace\\maven\\apache-maven-3.8.1\\conf\\settings.xml",

"maven.executable.path": "C:\\TP_Inplace\\maven\\apache-maven-3.8.1\\bin\\mvn.cmd",

"maven.executable.preferMavenWrapper": false,

"maven.terminal.useJavaHome": true

}

설정파일 설명

"maven.executable.path"

- 사용할 mvc.cmd 파일 경로 지정

"maven.terminal.useJavaHome"

- maven 빌드 시 사용자가 지정한 java.home 버전을 그대로 사용할 지 선택하는 설정 값

============================================================================

settings.json 도 설정이 끝났으니 Spring Boot Project를 생성해보자.

1. VSC 에서 단축키 Ctrl + Shift + p 를 누르게되면 다음과 같은 검색창이 나오게 된다.

해당 검색창에 Spring Initializr: Create a Maven Project 검색하여 선택한다.

2. 버전선택

3. 개발 언어 선택 (Java)

4. Group Id 지정

5. 프로젝트 명 지정

6. 패키징 타입 지정

7. Java Version 지정 (설치한 자바 버전과 동일해야함)

8. Spring Dependencies 지정

프로젝트를 생성하고 추후에 추가할 수 있으니 기본적인 의존성만 추가하면 된다.

필자는 Sptring Boot DevTools, Spring Web, Lombok, Spring Web을 추가하였다.

9. workspace 지정

workspace 지정을 끝으로 project는 생성이 되며, 바로 Open을 할것인지, workspace에 추가할 것인지 물어보는데 Open 하실것을 권장한다.

★프로젝트를 생성 후 Open 후에 pom.xml에 maven-compiler-plugin 설정을 추가해줘야한다. (ft.min10)

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-compiler-plugin</artifactId>

<version>3.8.0</version>

<configuration>

<source>${java.version}</source>

<target>${java.version}</target>

<fork>true</fork>

<executable>C:\\TP_Inplace\\java\\jdk-11.0.2\\bin\\javac</executable>

<compilerVersion>${java.version}</compilerVersion>

</configuration>

</plugin>

해당 코드를 추가해준 후 프로젝트를 다시 Reload한다. (다시 프로젝트 오픈)

10. 프로젝트를 오픈하게되면 왼쪽 하단에 Spring Boot를 실행하기 위한 작업(설치)을 VSC에서 시작하게된다.

11. Spring Boot를 실행하기위한 설치가 끝이 나면 내가 설정한 값들이 잘 적용되었는지 확인한다.

[Java JDK 버전 및 경로 확인]

[Maven Dependencies 다운로드 경로 확인]

경로가 제대로 잡혀있지 않다면, .m2~~폴더에 다운로드가 될 것이다.

[Maven Plugin 확인 ft.min10]

해당 plugin에 목록이 나오지 않고 JVM 에러가 나온다면, 경로문제 이거나 jdk 버전이 프로젝트에 설정되지 않아서이다.

12. 설치 완료 후 빌드 단축키 F5를 누르게되면 어떤 언어로 프로젝트를 실행할 것인지 물어본다.

13. JAVA를 선택 후 시간이 지나면 Spring Boot로 프로젝트를 실행한 것을 확인할 수 있다.

localhost:8080에 접속하게되면 에러 메세지가 있는 페이지를 확인할 수 있다.

환경설정 끝...!

끝으로,,

jdk가 잘 먹지 않거나, 시스템 환경변수의 java 버전과 로컬 폴더에 설치한 java 버전이 충돌이 나는 경우가 많았다.

해결하는 추천방법은 처음부터 경로 설정 ~ 프로젝트 설정까지 다시 진행하는 것을 추천한다. 본인도 한참을 해메다가

"maven.executable.path" 설정의 경로를 잘못잡은 것을 확인할 수 있었다.

이상 Spring Boot Project in VSC IDE 파일 만들기 블로그 작성을 끝낸다...!

저작자표시 비영리 변경금지