[카테고리:] 스프링 부트 백앤드 개발 강좌

현대의 애플리케이션 개발에서 데이터베이스는 핵심적인 요소로 자리 잡고 있습니다. 스프링 부트(Spring Boot)는 자바 기반의 웹 애플리케이션 프레임워크로, 특히 백엔드 개발에서 널리 사용됩니다. 이 강좌에서는 스프링 부트를 이용한 백엔드 개발과 데이터베이스 관리 시스템(DBMS)의 기초부터 고급 개념까지 다룰 것입니다. 이 글은 총 20,000자 이상의 내용을 포함하여, 스프링 부트와 DBMS에 대한 깊이 있는 이해를 제공할 것입니다.

1. 스프링 부트란?

스프링 부트는 스프링 프레임워크의 확장으로, 설정과 구성을 간소화하여 빠르게 애플리케이션을 개발할 수 있도록 돕는 도구입니다. 스프링 부트는 주로 RESTful API, 마이크로서비스 아키텍처 및 웹 애플리케이션 개발에 사용됩니다.

1.1 스프링 부트의 주요 특징

• 자동 설정(Auto-Configuration): 개발자가 설정해야 할 내용을 최소화하여 생산성을 높입니다.
• 스타터(Starters): 다양한 라이브러리를 쉽게 사용할 수 있도록 제공하는 모듈입니다.
• 독립형 애플리케이션: 내장된 서버(예: Tomcat, Jetty 등) 덕분에 추가 설정 없이 애플리케이션을 실행할 수 있습니다.

2. 데이터베이스와 DBMS 소개

데이터베이스는 정보를 저장, 관리하고 검색하는 시스템 반면, DBMS(데이터베이스 관리 시스템)는 데이터베이스를 효율적으로 관리할 수 있는 소프트웨어입니다. DBMS는 사용자가 데이터를 쉽게 저장하고 검색할 수 있도록 도와주며, 데이터 일관성과 무결성을 유지합니다.

2.1 DBMS의 종류

DBMS는 크게 관계형 데이터베이스(예: MySQL, PostgreSQL)와 비관계형 데이터베이스(예: MongoDB, Cassandra)로 나눌 수 있습니다.

• 관계형 데이터베이스(RDBMS): 데이터를 테이블에 저장하며, SQL을 통해 데이터를 조작합니다.
• 비관계형 데이터베이스(NoSQL): JSON 형태의 데이터를 저장하며, 스키마가 유동적입니다.

2.2 데이터베이스의 설계 원칙

효율적인 데이터베이스 설계를 위해서는 다음 몇 가지 원칙을 고려해야 합니다.

1. 정규화(Normalization): 데이터를 중복 없이 저장하되, 필요할 경우 적절히 조인(join)을 사용하여 데이터를 조회합니다.
2. 무결성 제약조건(Integrity Constraints): 데이터의 정확성과 일관성을 유지하기 위한 규칙입니다.
3. 인덱스(Index): 검색 성능을 높이기 위해 자주 사용하는 컬럼에 인덱스를 설정합니다.

3. 스프링 부트와 데이터베이스 연동

스프링 부트를 사용하면 데이터베이스와 쉽게 연동할 수 있습니다. 이번 섹션에서는 데이터베이스와의 연결을 위해 필요한 설정 및 코드에 대해 설명하겠습니다.

3.1 프로젝트 설정

스프링 부트 프로젝트를 생성하기 위해 Spring Initializr를 방문하여 필요한 의존성을 추가합니다.

• Spring Web: RESTful API를 개발하기 위해 필요합니다.
• Spring Data JPA: ORM(Object Relational Mapping) 기술로, 데이터베이스와 객체 간의 매핑을 간편하게 처리합니다.
• H2 Database: 인메모리 데이터베이스로, 개발 및 테스트용으로 사용됩니다.

3.2 application.properties 설정

spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

3.3 Entity 클래스 생성

다음으로, 데이터베이스 테이블에 매핑되는 Entity 클래스를 생성합니다. 여기서는 간단한 User 클래스를 예로 들겠습니다.

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;

    // Getter 및 Setter 메소드
}

3.4 Repository 인터페이스 생성

스프링 데이터 JPA를 사용하여 데이터베이스와 상호작용하는 Repository 인터페이스를 생성합니다.

import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
    User findByEmail(String email);
}

3.5 서비스 및 컨트롤러 구현

서비스 계층과 RESTful API를 제공하는 컨트롤러를 구현해야 합니다. 서비스 계층에서는 비즈니스 로직을 처리하고, 컨트롤러 계층에서는 HTTP 요청을 처리합니다.

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userService.createUser(user);
    }
}

4. 데이터베이스 관리

데이터베이스 관리에는 데이터 백업, 복구, 성능 모니터링, 보안 설정 등이 포함됩니다. 이러한 작업을 효율적으로 수행하기 위해 여러 도구와 기술이 필요합니다.

4.1 데이터 백업과 복구

정기적인 데이터 백업은 데이터 손실을 방지하는 중요한 절차입니다. RDBMS마다 데이터 백업을 위한 다양한 방법을 제공합니다.

• mysqldump: MySQL 데이터베이스의 백업을 수행하는 명령어입니다.

mysqldump -u [username] -p[password] [database] > backup.sql

4.2 성능 모니터링

데이터베이스의 성능을 모니터링하기 위해 다양한 도구가 존재합니다. 이들은 쿼리 성능, CPU 사용량, 메모리 사용량 등을 실시간으로 확인할 수 있게 해줍니다.

• MySQL Workbench: MySQL의 성능을 모니터링하고 쿼리를 분석하는 도구입니다.

4.3 보안 설정

데이터베이스 보안은 매우 중요합니다. 사용자 접근 권한을 설정하고, 안전한 비밀번호를 사용하여 데이터베이스를 보호해야 합니다.

5. 마치며

이번 강좌에서는 스프링 부트를 활용한 백엔드 개발과 DBMS의 기초부터 실전 적용까지 다루었습니다. 스프링 부트는 사용자 친화적인 방식으로 데이터베이스와의 연동을 가능하게 하여 웹 애플리케이션 개발을 더욱 간편하게 만들어 줍니다. 데이터베이스 관리 또한 중요한 부분이며, 이를 효율적으로 수행하기 위해 다양한 기법과 도구를 사용하는 것이 필요합니다. 앞으로 더 발전된 백엔드 개발을 위한 여정을 이어가시길 바랍니다.

스프링 부트 백엔드 개발 강좌에 오신 것을 환영합니다. 본 강좌의 주제 중 하나는 ‘데이터베이스’입니다. 웹 애플리케이션을 개발할 때 데이터베이스는 필수적인 요소이며, 모든 데이터는 저장하고 관리해야 합니다. 이번 포스팅에서는 데이터베이스의 기본 개념부터 시작하여, 다양한 유형, 데이터베이스 설계, 스프링 부트와의 통합 방법, SQL 사용법까지 자세히 알아보겠습니다.

1. 데이터베이스의 정의

데이터베이스는 정보를 구조적으로 저장하고 관리할 수 있도록 돕는 시스템입니다. 사용자는 데이터를 입력, 수정, 삭제, 조회하는 다양한 작업을 수행할 수 있습니다. 데이터베이스는 일반적으로 데이터의 효율적인 저장, 검색, 관리, 보호를 위해 필요합니다. 데이터베이스를 통해 여러 사용자가 동시에 데이터에 접근할 수 있으며, 데이터의 무결성을 보장합니다.

1.1 데이터베이스의 필요성

데이터베이스는 많은 이유로 필요합니다. 여기에는 다음과 같은 요소가 포함됩니다:

• 구조화된 데이터 관리: 데이터베이스는 데이터를 정리하고 효율적으로 관리할 수 있는 구조를 제공합니다.
• 데이터 무결성: 데이터베이스는 데이터의 일관성과 정확성을 보장합니다.
• 동시성 관리: 여러 사용자가 동시에 데이터를 접근하고 변경할 수 있게 해줍니다.
• 데이터 보안: 데이터베이스는 접근 제어와 사용자 권한을 설정하여 데이터를 보호합니다.

2. 데이터베이스의 종류

데이터베이스는 주로 다음과 같이 분류할 수 있습니다:

2.1 관계형 데이터베이스 (RDBMS)

관계형 데이터베이스는 데이터를 표 형식으로 저장합니다. 각 표는 행과 열로 구성되어 있으며, 이들 간의 관계는 외래 키를 통해 정의됩니다. 대표적인 관계형 데이터베이스 관리 시스템(RDBMS)에는 MySQL, PostgreSQL, Oracle 등이 있습니다.

2.2 비관계형 데이터베이스 (NoSQL)

비관계형 데이터베이스는 비정형 데이터를 저장 및 관리하는 데 적합합니다. 이는 JSON, XML, 문서 및 키-값 형태로 데이터를 저장할 수 있으며, 유연한 스키마를 갖고 있습니다. 대표적인 비관계형 데이터베이스에는 MongoDB, Cassandra, Redis 등이 있습니다.

2.3 그래프 데이터베이스

그래프 데이터베이스는 데이터 간의 관계를 모델링하는 데 최적화되어 있습니다. 노드와 엣지를 사용하여 데이터를 저장하며, 복잡한 관계를 시각적으로 표현할 수 있습니다. Neo4j가 그래프 데이터베이스의 대표적인 예입니다.

3. 데이터베이스 설계

데이터베이스 설계는 효율적인 데이터베이스 구축을 위해 필수적입니다. 데이터베이스 설계 단계에는 요구사항 분석, 개념적 설계, 논리적 설계, 물리적 설계가 포함됩니다.

3.1 요구사항 분석

데이터베이스 설계의 첫 단계는 요구사항 분석입니다. 여기에서는 사용자가 필요로 하는 정보와 비즈니스 요구사항을 파악합니다.

3.2 개념적 설계

개념적 설계 단계에서는 ER 다이어그램을 통해 데이터의 개념적 구조를 정의합니다. 여기서 ‘개체’, ‘속성’, ‘관계’를 식별합니다.

3.3 논리적 설계

논리적 설계 단계에서는 개념적 설계를 바탕으로 데이터 모델(일반적으로 관계형 모델)로 변환합니다. 이때 데이터베이스의 스키마를 결정하게 됩니다.

3.4 물리적 설계

마지막으로 물리적 설계 단계에서는 논리적 설계를 실제 데이터베이스 시스템에 맞게 구체화합니다. 이 과정에서는 인덱스, 파티셔닝 등 성능 등을 고려한 최적화가 이루어집니다.

4. 스프링 부트와 데이터베이스 통합

스프링 부트는 데이터베이스와의 통합을 쉽게 해주는 다양한 기능을 제공합니다. 스프링 부트를 이용하여 데이터베이스를 연결하는 과정에는 의존성 관리, 데이터베이스 설정, 엔티티 클래스 정의, Repository 인터페이스 생성 등이 포함됩니다.

4.1 의존성 관리

스프링 부트에서 데이터베이스와 통신하기 위해서는 적절한 의존성을 추가해야 합니다. Maven을 사용하는 경우 `pom.xml` 파일에 다음과 같은 의존성을 추가해야 합니다:

    org.springframework.boot
    spring-boot-starter-data-jpa


    com.h2database
    h2
    runtime

4.2 데이터베이스 설정

스프링 부트에서 데이터베이스를 설정하기 위해서는 `application.properties` 파일을 수정해야 합니다. 다음은 H2 데이터베이스 설정 예시입니다:

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.h2.console.enabled=true
spring.jpa.hibernate.ddl-auto=update

4.3 엔티티 클래스 정의

스프링 부트에서 데이터베이스 테이블과 매핑되는 엔티티 클래스를 정의해야 합니다. 예를 들어, 사용자 정보를 저장하는 `User` 엔티티는 다음과 같이 정의될 수 있습니다:

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
    private String name;
    private String email;

    // getters and setters
}

4.4 Repository 인터페이스 생성

Repository 인터페이스를 통해 데이터베이스와 상호작용할 수 있습니다. `UserRepository`는 다음과 같이 정의됩니다:

import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository {
}

5. SQL 사용법

SQL(Structured Query Language)은 데이터베이스와 상호작용하기 위해 사용되는 표준 언어입니다. SQL을 통해 데이터를 조회하고, 삽입하며, 수정하고, 삭제할 수 있습니다. 기본적인 SQL 문법은 다음과 같습니다:

5.1 데이터 조회: SELECT

SELECT * FROM users; 

5.2 데이터 삽입: INSERT

INSERT INTO users (name, email) VALUES ('John Doe', 'john.doe@example.com'); 

5.3 데이터 수정: UPDATE

UPDATE users SET email = 'john.new@example.com' WHERE id = 1; 

5.4 데이터 삭제: DELETE

DELETE FROM users WHERE id = 1; 

결론

이번 포스팅에서는 데이터베이스의 기본 개념과 종류, 설계 방법 및 스프링 부트와의 통합 방법에 대해 알아보았습니다. 데이터베이스는 백엔드 개발에서 중요한 역할을 하므로, 기본적인 이해와 실제 사용 방법을 익혀두는 것이 중요합니다. 앞으로의 진행 강좌에서는 데이터베이스와 관련된 더 다양한 주제를 다룰 예정이므로 많은 기대 부탁드립니다.

스프링 부트(Spring Boot)는 현대 웹 애플리케이션을 쉽게 개발할 수 있게 해주는 프레임워크로, 특히 백엔드 개발에 널리 사용됩니다. 이번 강좌에서는 스프링 부트와 데이터베이스의 관계, 데이터베이스와의 통신 방법, 엔티티, 리포지토리, 트랜잭션 관리 등 다양한 측면을 탐구하겠습니다.

1. 스프링 부트와 데이터베이스

스프링 부트는 Java 기반의 프레임워크로, 데이터베이스와의 통신을 효율적으로 처리할 수 있는 여러 가지 기능을 제공합니다. 관계형 데이터베이스(RDBMS)와 비관계형 데이터베이스(NoSQL) 모두를 지원하며, 데이터베이스 연동에 필요한 복잡한 설정을 최소화할 수 있습니다.

1.1 데이터베이스 연결

스프링 부트에서는 데이터베이스 연결을 설정하기 위해 application.properties 또는 application.yml 파일을 사용합니다. 데이터베이스의 URL, 사용자 이름, 비밀번호 등을 설정할 수 있습니다.

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=myuser
spring.datasource.password=mypassword
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

1.2 JPA와 Hibernate

스프링 부트는 JPA(Java Persistence API)를 지원하며, Hibernate를 기본 JPA 구현체로 사용합니다. JPA는 자바 객체와 데이터베이스 간의 매핑을 위한 API로, SQL 쿼리를 작성하지 않고도 데이터베이스 작업을 수행할 수 있게 도와줍니다.

2. 데이터베이스 모델링

애플리케이션의 데이터베이스 구조를 설계하는 것은 매우 중요합니다. 데이터베이스 모델링에는 다음과 같은 과정이 포함됩니다.

2.1 엔티티와 관계 설정

각 테이블을 엔티티 클래스로 모델링합니다. 예를 들어, 사용자와 주문 엔티티가 있다고 가정해보겠습니다.

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private String email;

    // Getters and Setters
}

@Entity
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @ManyToOne
    @JoinColumn(name = "user_id")
    private User user;

    private String product;
    private Double price;

    // Getters and Setters
}

2.2 데이터베이스 마이그레이션

스프링 부트에서는 데이터베이스 스키마의 변경을 자동으로 관리하기 위해 Flyway 또는 Liquibase와 같은 마이그레이션 도구를 사용할 수 있습니다. 이를 통해 데이터베이스 변경 사항을 버전 관리할 수 있습니다.

3. CRUD 연산 구현

데이터베이스와의 상호작용에서 가장 기본적인 작업은 CRUD(Create, Read, Update, Delete)입니다. 이를 구현하기 위해 리포지토리 패턴을 사용합니다.

3.1 사용자 리포지토리

public interface UserRepository extends JpaRepository {
    List findByName(String name);
}

3.2 서비스 레이어

비즈니스 로직을 처리하는 서비스 클래스를 작성합니다.

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public User createUser(User user) {
        return userRepository.save(user);
    }

    public List getAllUsers() {
        return userRepository.findAll();
    }

    // Update and Delete methods
}

3.3 컨트롤러

HTTP 요청을 처리하는 REST 컨트롤러를 구현합니다.

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    @PostMapping
    public ResponseEntity createUser(@RequestBody User user) {
        return ResponseEntity.ok(userService.createUser(user));
    }

    @GetMapping
    public List getAllUsers() {
        return userService.getAllUsers();
    }

    // Update and Delete endpoints
}

4. 트랜잭션 관리

스프링 부트에서는 @Transactional 어노테이션을 사용하여 트랜잭션 관리를 쉽게 할 수 있습니다. 트랜잭션이란 데이터베이스에 대한 일련의 작업이 모두 성공적으로 수행되거나 모두 실패해야 하는 작업의 단위입니다.

@Service
public class OrderService {
    @Autowired
    private OrderRepository orderRepository;

    @Autowired
    private UserRepository userRepository;

    @Transactional
    public void createOrder(Order order, Long userId) {
        User user = userRepository.findById(userId)
                .orElseThrow(() -> new RuntimeException("User not found"));
        order.setUser(user);
        orderRepository.save(order);
    }
}

5. 데이터베이스와의 에러 처리

데이터베이스와의 통신에서 발생할 수 있는 다양한 에러를 처리하는 것은 매우 중요합니다. 예를 들어, 데이터베이스가 다운되었거나 쿼리에 오류가 발생했을 때 적절한 예외 처리가 필요합니다.

5.1 커스텀 예외 클래스

public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

5.2 글로벌 예외 처리

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity handleNotFound(ResourceNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

6. 테스트와 배포

마지막으로, 개발한 애플리케이션을 안전하게 배포하기 위해서는 테스트가 필수적입니다. 스프링 부트에서는 JUnit 및 Mockito를 활용하여 단위 테스트 및 통합 테스트를 수행할 수 있습니다.

6.1 단위 테스트

@SpringBootTest
public class UserServiceTests {
    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository;

    @Test
    public void testCreateUser() {
        User user = new User();
        user.setName("Test User");
        user.setEmail("test@example.com");

        Mockito.when(userRepository.save(user)).thenReturn(user);
        User createdUser = userService.createUser(user);

        assertEquals("Test User", createdUser.getName());
    }
}

6.2 배포하기

스프링 부트 프로젝트는 jar 파일로 패키징되어 AWS, Azure, Google Cloud와 같은 클라우드 환경에 쉽게 배포할 수 있습니다.

결론

이번 강좌를 통해 스프링 부트를 이용한 백엔드 개발과 데이터베이스 연결에 대한 포괄적인 내용을 다루었습니다. CRUD 작업 구현, 트랜잭션 관리, 에러 처리, 테스트 및 배포에 이르기까지 스프링 부트를 활용한 데이터베이스 통합의 기본 개념을 이해하셨길 바랍니다. 이 내용을 바탕으로 여러분의 프로젝트에 스프링 부트를 적용해 보세요!

깃허브 액션 스크립트 작성하기: 지속적 배포(CD)

현대 소프트웨어 개발에서 지속적 배포(Continuous Deployment, CD)와 지속적 통합(Continuous Integration, CI)은 필수적인 요소입니다. 특히 스프링 부트를 사용하여 백엔드 애플리케이션을 개발할 때, 이러한 프로세스를 자동화하면 개발자의 생산성을 크게 향상시킬 수 있습니다. 이번 강좌에서는 스프링 부트 애플리케이션을 GitHub Actions를 사용하여 자동으로 배포하는 방법을 살펴보겠습니다.

1. 스프링 부트란?

스프링 부트(Spring Boot)는 스프링 프레임워크의 확장으로, 단독 실행 가능한 스프링 애플리케이션을 쉽게 개발할 수 있도록 돕는 오픈 소스 프레임워크입니다. 기존 스프링 프레임워크를 보다 단순하고 신속하게 사용할 수 있게 해주는 여러 유용한 기능을 제공합니다. 특히 초기 설정에 대한 부담을 줄여주고, 내장 서버(예: 톰캣, 제티)를 통해 빠르게 애플리케이션을 실행할 수 있도록 지원합니다.

2. GitHub Actions란?

GitHub Actions는 GitHub에서 제공하는 CI/CD 도구로, 코드의 변경 사항을 감지하여 자동으로 작업을 실행할 수 있도록 해줍니다. 사용자는 YAML 파일 형식으로 워크플로우를 정의하고 관리할 수 있으며, 다양한 이벤트(푸시, 이슈 생성 등)에 의해 트리거될 수 있습니다. 이를 활용하면 테스트, 빌드, 배포 등의 작업을 자동화할 수 있습니다.

3. 사전 준비

• 스프링 부트 애플리케이션을 이미 개발했거나 생성해야 합니다.
• GitHub에 해당 프로젝트를 리포지토리로 생성해야 합니다.
• GitHub Actions를 사용하기 위해 GitHub 계정이 필요합니다.

4. 스프링 부트 애플리케이션 생성하기

스프링 부트 애플리케이션을 생성하기 위해 Spring Initializr를 사용할 수 있습니다. 적절한 메타 정보를 설정하고 필요한 종속성을 추가하여 프로젝트를 다운로드합니다. 예를 들면, 웹(application), JPA, H2 데이터베이스를 선택할 수 있습니다.

 
// 예시 Maven 의존성 (pom.xml)
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

5. GitHub 리포지토리 생성하기

GitHub에 접속하여 새로운 리포지토리를 생성합니다. 리포지토리 이름은 프로젝트에 맞게 설정하고, ‘Initialize this repository with a README’ 옵션을 선택할 수 있습니다. 이후 자신의 로컬 프로젝트를 GitHub 리포지토리에 푸시합니다.

# 로컬 프로젝트 디렉토리에서 실행
git init
git add .
git commit -m "Initial commit"
git branch -M main
git remote add origin https://github.com/username/repository.git
git push -u origin main

6. GitHub Actions 워크플로우 작성하기

이제 GitHub Actions 워크플로우 파일을 생성해야 합니다. `.github/workflows` 디렉토리 아래에 YAML 파일을 생성합니다. 예를 들어, `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'
          distribution: 'adopt'

      - name: Build with Maven
        run: mvn clean package

7. 배포 워크플로우 작성하기

기본 CI 워크플로우를 설정한 후, 이제 CD를 위한 워크플로우를 작성합니다. 여기서는 예를 들어 AWS EC2에 배포하는 과정을 설명하겠습니다. 새로운 YAML 파일인 `deploy.yml`을 생성하고 아래와 같이 작성합니다.

name: Deploy to EC2

on:
  push:
    branches:
      - main

jobs:
  deploy:
    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'
          distribution: 'adopt'

      - name: Build with Maven
        run: mvn clean package

      - name: Deploy to EC2
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.EC2_HOST }}
          username: ${{ secrets.EC2_USER }}
          key: ${{ secrets.EC2_SSH_KEY }}
          port: 22
          source: target/*.jar
          target: /path/to/deploy/

여기서 사용한 `appleboy/scp-action`은 SSH를 사용하여 EC2 인스턴스에 파일을 전송하는데 도움이 되는 액션입니다. 각 항목은 GitHub Secrets에 저장하여 보안을 강화할 수 있습니다.

8. GitHub Secrets 설정하기

이제 CI/CD 워크플로우에서 사용하는 비밀 변수를 설정해야 합니다. GitHub 리포지토리 페이지에서 ‘Settings’ -> ‘Secrets and variables’ -> ‘Actions’로 가서 숨겨야 할 비밀 변수를 추가합니다. 예를 들어:

• EC2_HOST: EC2 인스턴스의 IP 주소
• EC2_USER: SSH 사용자 이름
• EC2_SSH_KEY: SSH 개인 키

9. GitHub Actions 실행 확인하기

모든 설정이 완료되면, 리포지토리의 main 브랜치에 커밋하고 푸시합니다. 이때 GitHub Actions가 자동으로 트리거 되어 설정한 CI/CD 프로세스가 실행됩니다. ‘Actions’ 탭에서 실행 로그를 확인하며 각 단계의 성공 여부를 점검할 수 있습니다.

10. 결론

이번 강좌에서는 스프링 부트 백엔드 애플리케이션을 GitHub Actions를 활용하여 자동으로 배포하는 방법에 대해 알아보았습니다. GitHub Actions는 간단한 YAML 파일만으로 CI/CD 프로세스를 설정할 수 있게 해주어, 다양한 작업을 자동화할 수 있는 강력한 도구입니다. 이를 통해 개발자의 생산성을 높이고 배포의 신뢰성을 향상시킬 수 있습니다. 추가적으로, 다른 클라우드 제공업체와 연동하거나, Docker를 사용한 배포 등의 확장을 고려해볼 수 있습니다.

참고 자료

• Spring Boot 공식 문서
• GitHub Actions 공식 문서
• AWS EC2 시작하기

본 강좌는 스프링 부트를 사용하여 백엔드 애플리케이션을 개발하는 방법과 지속적 통합(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/)를 사용할 수 있습니다. 다음 단계에 따라 프로젝트를 생성하세요:

1. 사이트에 접속 후, 다음과 같이 입력합니다:
• Project: Maven Project
• Language: Java
• Spring Boot: 최신 안정 버전 선택
• Group: com.example
• Artifact: demo
• Dependencies: Spring Web, Spring Data JPA, H2 Database 추가
2. “Generate” 버튼을 클릭하여 프로젝트를 다운로드 합니다.
3. 다운로드한 프로젝트를 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 인스턴스를 생성하여 애플리케이션을 배포할 수 있습니다. 아래는 간단한 설정 방법입니다:

1. AWS에 로그인 후 EC2 대시보드에서 인스턴스를 생성합니다.
2. 보안 그룹을 설정하여 8080 포트를 허용합니다.
3. 인스턴스에 SSH로 접속하여 JDK, Maven을 설치합니다.
4. 애플리케이션을 복사하고 실행합니다:

java -jar yourapp.jar

6.2 Heroku에 배포하기

Heroku는 애플리케이션을 쉽고 빠르게 배포할 수 있는 플랫폼입니다. Heroku CLI를 사용하여 애플리케이션을 배포할 수 있습니다:

1. Heroku CLI 설치 후 로그인합니다.
2. 다음 명령어로 애플리케이션을 생성합니다:

heroku create your-app-name

3. 코드를 푸시하여 배포합니다:

git push heroku main

7. 결론

본 강좌에서는 스프링 부트를 활용하여 백엔드 개발을 진행하며, 깃허브 액션을 통해 CI/CD를 자동화 설정하는 방법을 살펴보았습니다. 스프링 부트의 강력한 기능과 깃허브 액션을 결합하여, 여러분의 개발 효율성을 한층 더 높일 수 있을 것입니다. 지속적인 학습과 실습을 통해, 더 높은 수준의 애플리케이션 개발자로 성장할 수 있기를 바랍니다.

8. 참고 자료

• Spring Boot 공식 문서
• GitHub Actions 공식 문서
• AWS EC2 공식 문서
• Heroku Java 애플리케이션 배포 가이드