IntelliJ Dev Containers로 개발하기

HOSEON YOO·2024년 2월 25일

개요

IntelliJ IDEA 2023.3.5 (Ultimate Edition)
Docker v4.25.2

국비학원에서 최종 프로젝트를 진행하면서 총 3대의 PC(학원, 집, 카페)를 사용하다 보니, 개발환경을 구축하는데 어려움을 겪었었다. 이런 문제를 해결하기 위해 도커를 도입하였지만, 결국에는 리액트나 스프링을 개발하기 위해서는 내 PC에 jdk나 node를 설치해야 했었다.

개인적으로 내 PC에 이것저것 설치하는 거를 선호하지 않는 나였기에... ＇도커로 개발환경을 구축하면 되지 않을까?＇ 라는 생각이 들어 구글링을 해보다가 마이크로소프가 제안한 개발환경 컨테이너인 Dev Containers를 알게 되었다.

최종 프로젝트에서 Dev Containers를 적용했던 내용에 대해 기록해보고자 한다. 필자는 IntelliJ Ultimate에서 지원해주는 Dev Containers를 사용하였다. 시작하기에 앞서 Dev Containers를 사용하기 위해서는 반드시 도커를 먼저 설치해야 한다.

Dev Containers 생성하기

Spring Initializr로 스프링 부트 프로젝트 생성
IntelliJ Dev Containers 공식문서를 참고하여 Dev Containers 구성 파일 생성
Dev Containers 구성 파일 속성 공식문서를 참고하여 구성 파일 설정
Dev Containers 생성
4.1 Create Dev Container and Clone Sources : 깃허브 원격 저장소에서 소스 코드를 가져와서 생성
4.2 Create Dev Container and Mount Sources : 로컬 소스 코드를 마운트해서 생성

처음에는 Mount로 생성하고 깃허브 원격 저장소에 Dev Containers 구성 파일도 같이 올려놓으면 다른 PC에서는 Clone으로 생성하면 되기 때문에 개발환경을 빠르게 구축할 수 있다.

Dev Containers 구성 파일 속성에 image 또는 Dockerfile과 Docker Compose를 지원하기 때문에 필자는 Docker Compose를 사용했고 내용은 아래와 같다.

devcontainer.json

{
  dockerComposeFile: [
    "../docker-compose.yaml"
  ],
  service: "application",
  remoteUser: "root",
  workspaceFolder: "/workspaces/${localWorkspaceFolderBasename}"
}

docker-compose.yaml

services:
  web:
    container_name: nginx
    image: hsyoodev/gplayus-dev-nginx:1.0
    ports:
      - 80:80
    volumes:
      - nginx:/etc/nginx
    depends_on:
      - application
  application:
    container_name: spring-boot
    image: hsyoodev/gplayus-dev-spring-boot:1.0
    ports:
      - 35729:35729
    expose:
      - 8080
    depends_on:
      - database
  database:
    container_name: mysql
    image: hsyoodev/gplayus-dev-mysql:1.0
    environment:
      MYSQL_ROOT_PASSWORD: 1234
      MYSQL_DATABASE: gplayus
    volumes:
      - mysql:/var/lib/mysql
    expose:
      - 3306
      - 33060
volumes:
  nginx:
  mysql: