본 강좌는 스프링 부트를 사용하여 백엔드 애플리케이션을 개발하는 방법과 지속적 통합(CI) 파이프라인을 구축하기 위해 깃허브 액션 스크립트를 작성하는 데 중점을 두고 있습니다. 이 글을 끝까지 읽으시면 스프링 부트를 이용한 웹 애플리케이션 구축과 CI/CD 프로세스를 설정하는 데 필요한 기술을 익힐 수 있습니다.
1. 스프링 부트란?
스프링 부트(Sprint Boot)는 스프링 프레임워크 기반의 애플리케이션을 쉽고 빠르게 개발할 수 있도록 도와주는 프레임워크입니다. 이는 자동 구성, 임베디드 서버, 손쉬운 배포 기능을 제공하여 개발자가 필요한 기능을 간편하게 추가할 수 있게 해줍니다.
- 자동 구성: 스프링 부트는 애플리케이션의 설정을 자동으로 구성하여, 개발자가 최소한의 설정만으로도 프로젝트를 시작할 수 있게 합니다.
- 임베디드 서버: Tomcat, Jetty, Undertow와 같은 서버를 내장하여 별도의 서버 설정 없이도 애플리케이션을 실행할 수 있습니다.
- 모듈화: 스프링 부트는 다양한 스타터 스타터를 제공하여, 필요한 라이브러리를 간편하게 추가할 수 있도록 설계되어 있습니다.
2. 스프링 부트 개발 환경 설정
스프링 부트를 시작하기 위해 필요한 환경 설정 단계를 살펴보겠습니다. 여기에는 JDK 설치, IDE 설정 및 스프링 부트 프로젝트 생성이 포함됩니다.
2.1 JDK 설치
스프링 부트를 개발하기 위해 Java Development Kit(JDK)가 필요합니다. JDK 버전 11 이상을 설치하세요. JDK 설치는 [Oracle 공식 웹사이트](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) 또는 [OpenJDK](https://jdk.java.net/)에서 가능합니다.
2.2 IDE 설치
스프링 부트 개발을 위해 가장 많이 사용되는 IDE는 IntelliJ IDEA와 Eclipse입니다. IntelliJ IDEA의 Community Edition은 무료로 사용할 수 있으며, 강력한 기능을 제공합니다. [IntelliJ IDEA 다운로드](https://www.jetbrains.com/idea/download/)하여 설치하세요.
2.3 스프링 부트 프로젝트 생성
스프링 부트 프로젝트를 생성하기 위해 [Spring Initializr](https://start.spring.io/)를 사용할 수 있습니다. 다음 단계에 따라 프로젝트를 생성하세요:
- 사이트에 접속 후, 다음과 같이 입력합니다:
- Project: Maven Project
- Language: Java
- Spring Boot: 최신 안정 버전 선택
- Group: com.example
- Artifact: demo
- Dependencies: Spring Web, Spring Data JPA, H2 Database 추가
- “Generate” 버튼을 클릭하여 프로젝트를 다운로드 합니다.
- 다운로드한 프로젝트를 IDE에서 열고 빌드를 실행합니다.
3. 간단한 REST API 만들기
이제 간단한 REST API를 만들어보겠습니다. 기본적인 CRUD(Create, Read, Update, Delete) 기능을 구현할 것입니다.
3.1 엔티티 클래스 작성
먼저, 데이터베이스 테이블과 매핑될 엔티티 클래스를 작성합니다. 여기에 사용될 클래스는 다음과 같습니다:
package com.example.demo.model;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
@Entity
public class Item {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String name;
private double price;
// Getters and setters
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public double getPrice() {
return price;
}
public void setPrice(double price) {
this.price = price;
}
}
3.2 레포지토리 작성
데이터베이스와 상호작용하기 위해 JPA 레포지토리를 작성합니다:
package com.example.demo.repository;
import com.example.demo.model.Item;
import org.springframework.data.jpa.repository.JpaRepository;
public interface ItemRepository extends JpaRepository<Item, Long> {
}
3.3 서비스 클래스 작성
비즈니스 로직을 처리할 서비스 클래스를 추가합니다:
package com.example.demo.service;
import com.example.demo.model.Item;
import com.example.demo.repository.ItemRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class ItemService {
@Autowired
private ItemRepository itemRepository;
public List- findAll() {
return itemRepository.findAll();
}
public Item save(Item item) {
return itemRepository.save(item);
}
public Item update(Long id, Item item) {
item.setId(id);
return itemRepository.save(item);
}
public void delete(Long id) {
itemRepository.deleteById(id);
}
}
3.4 컨트롤러 작성
마지막으로 REST API 엔드포인트를 제공하는 컨트롤러를 만듭니다:
package com.example.demo.controller;
import com.example.demo.model.Item;
import com.example.demo.service.ItemService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/api/items")
public class ItemController {
@Autowired
private ItemService itemService;
@GetMapping
public List<Item> getAllItems() {
return itemService.findAll();
}
@PostMapping
public Item createItem(@RequestBody Item item) {
return itemService.save(item);
}
@PutMapping("/{id}")
public Item updateItem(@PathVariable Long id, @RequestBody Item item) {
return itemService.update(id, item);
}
@DeleteMapping("/{id}")
public void deleteItem(@PathVariable Long id) {
itemService.delete(id);
}
}
4. 깃허브 액션 소개
깃허브 액션(GitHub Actions)은 소프트웨어 개발에서 CI/CD(지속적 통합 및 전달) 작업을 자동화하는 도구입니다. 이를 통해 개발자는 빌드, 테스트, 배포 과정을 자동으로 실행하도록 설정할 수 있습니다.
4.1 깃허브 액션 사용 이유
- 자동화된 CI/CD 구축: 코드 변경 시마다 자동으로 빌드 및 배포가 가능합니다.
- 협업 증진: 여러 팀원이 동시에 작업해도 충돌을 최소화할 수 있습니다.
- 위치에 구애받지 않음: 클라우드 기반으로 운영되므로 서버 설정이 필요 없습니다.
5. 깃허브 액션 설정하기
이제 스프링 부트 애플리케이션을 위한 깃허브 액션 워크플로우 파일을 만들어보겠습니다.
5.1 GitHub Repository 생성
먼저 GitHub에 새로운 레포지토리를 생성하여 스프링 부트 프로젝트를 커밋하세요.
5.2 워크플로우 파일 생성
프로젝트 루트 디렉터리에 “.github/workflows” 폴더를 생성하고, 그 안에 “ci.yml” 파일을 만듭니다.
name: CI
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v2
with:
java-version: '11'
- name: Build with Maven
run: mvn clean install
- name: Run tests
run: mvn test
위 코드는 깃허브 액션이 `main` 브랜치에 코드가 푸시될 때마다 실행됩니다. 각 단계는 다음과 같은 작업을 수행합니다:
- 코드를 체크아웃합니다.
- JDK 11을 설정합니다.
- Maven을 사용하여 프로젝트를 빌드합니다.
- 테스트를 실행합니다.
5.3 깃허브 액션 실행 확인
코드를 푸시한 후, GitHub의 ‘Actions’ 탭에서 워크플로우가 성공적으로 실행되는지 확인할 수 있습니다. 문제가 발생하면 로그를 통해 오류를 확인하고 수정할 수 있습니다.
6. 지속적 배포(CD)
이번 섹션에서는 배포 자동화를 위한 추가적인 설정에 대해 살펴보겠습니다. 언급할 내용은 AWS, Heroku 또는 기타 클라우드 호스팅 서비스를 활용한 배포 방법입니다.
6.1 AWS EC2에 배포하기
AWS EC2 인스턴스를 생성하여 애플리케이션을 배포할 수 있습니다. 아래는 간단한 설정 방법입니다:
- AWS에 로그인 후 EC2 대시보드에서 인스턴스를 생성합니다.
- 보안 그룹을 설정하여 8080 포트를 허용합니다.
- 인스턴스에 SSH로 접속하여 JDK, Maven을 설치합니다.
- 애플리케이션을 복사하고 실행합니다:
java -jar yourapp.jar
6.2 Heroku에 배포하기
Heroku는 애플리케이션을 쉽고 빠르게 배포할 수 있는 플랫폼입니다. Heroku CLI를 사용하여 애플리케이션을 배포할 수 있습니다:
- Heroku CLI 설치 후 로그인합니다.
- 다음 명령어로 애플리케이션을 생성합니다:
- 코드를 푸시하여 배포합니다:
heroku create your-app-name
git push heroku main
7. 결론
본 강좌에서는 스프링 부트를 활용하여 백엔드 개발을 진행하며, 깃허브 액션을 통해 CI/CD를 자동화 설정하는 방법을 살펴보았습니다. 스프링 부트의 강력한 기능과 깃허브 액션을 결합하여, 여러분의 개발 효율성을 한층 더 높일 수 있을 것입니다. 지속적인 학습과 실습을 통해, 더 높은 수준의 애플리케이션 개발자로 성장할 수 있기를 바랍니다.
