스프링 부트 백엔드 개발 강좌, 데이터베이스

스프링 부트(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

깃허브 액션 스크립트 작성하기: 지속적 배포(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를 사용한 배포 등의 확장을 고려해볼 수 있습니다.

참고 자료

스프링 부트 백엔드 개발 강좌, 깃허브 액션 스크립트 작성하기, CI

본 강좌는 스프링 부트를 사용하여 백엔드 애플리케이션을 개발하는 방법과 지속적 통합(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. 애플리케이션을 복사하고 실행합니다:
  5. java -jar yourapp.jar
    

6.2 Heroku에 배포하기

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

  1. Heroku CLI 설치 후 로그인합니다.
  2. 다음 명령어로 애플리케이션을 생성합니다:
  3. heroku create your-app-name
    
  4. 코드를 푸시하여 배포합니다:
  5. git push heroku main
    

7. 결론

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

8. 참고 자료

스프링 부트 백엔드 개발 강좌, 데이터베이스, 그림으로 이해하는 프로젝트

안녕하세요! 오늘은 스프링 부트를 활용한 백엔드 개발 강좌를 진행하겠습니다. 이 강좌에서는 스프링 부트의 기본 개념부터 시작하여 데이터베이스 연동, REST API 개발, 그리고 마지막으로 그림을 통해 프로젝트 구조를 이해하는 방법까지 자세히 살펴보겠습니다.

1. 스프링 부트란?

스프링 부트(Spring Boot)는 자바 기반의 스프링 프레임워크를 더욱 간편하게 사용할 수 있도록 돕는 프레임워크입니다. 개발자가 애플리케이션을 신속하게 구축할 수 있도록 지원하며, 복잡한 설정 없이도 실행 가능한 Spring 어플리케이션을 만들 수 있게 해줍니다.

스프링 부트의 주요 특징은 다음과 같습니다:

  • 자동 설정: Spring 설정을 자동으로 구성합니다.
  • 독립 실행형 애플리케이션: JAR 파일로 패키징하여 쉽게 배포하고 실행할 수 있습니다.
  • 생산 준비 완료: 외부 설정 기능과 모니터링 메트릭스를 제공합니다.
  • 스타터 의존성: 필요한 의존성을 간편하게 추가할 수 있도록 도와줍니다.

2. 개발 환경 설정

스프링 부트를 사용하기 위해서는 Java Development Kit (JDK)를 설치하고, IDE(통합 개발 환경)를 선택해야 합니다. 본 강좌에서는 IntelliJ IDEA를 사용하겠습니다.

2.1 JDK 설치

JDK는 Oracle 공식 웹사이트나 OpenJDK를 통해 다운로드할 수 있습니다. 설치 후에는 PATH 환경 변수를 설정하여 JDK를 사용할 수 있도록 해야 합니다.

2.2 IntelliJ IDEA 설치

IntelliJ IDEA는 JetBrains에서 제공하는 IDE입니다. Community Edition은 무료로 제공되며, 스프링 부트 개발에 적합합니다. 공식 웹사이트에서 다운로드 후 설치합니다.

3. 스프링 부트 프로젝트 생성

이제 새로운 스프링 부트 프로젝트를 생성해봅시다. IntelliJ IDEA에서 “New Project”를 클릭하고, “Spring Initializr”를 선택합니다.

3.1 프로젝트 설정

다음과 같은 정보를 입력합니다:

  • Group: com.example
  • Artifact: demo
  • Name: demo
  • Description: Demo project for Spring Boot
  • Package name: com.example.demo
  • Packaging: Jar
  • Java: 11

그 다음, “Dependencies”에서 “Spring Web”, “Spring Data JPA”, “H2 Database”를 추가합니다.

4. 데이터베이스와의 연동

스프링 부트는 다양한 데이터베이스와 쉽게 연동할 수 있도록 지원합니다. 본 강좌에서는 H2 데이터베이스를 사용하여 간단한 CRUD 애플리케이션을 만들어보겠습니다.

4.1 H2 데이터베이스 설정

H2 데이터베이스는 인메모리 데이터베이스로, 프로젝트의 src/main/resources/application.properties 파일에 다음을 추가하여 설정합니다:

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.h2.console.enabled=true

4.2 Entity 클래스 생성

이제 데이터베이스와 매핑할 Entity 클래스를 생성합니다. “model” 패키지를 만들고, 예를 들어 User 클래스를 아래와 같이 작성합니다:

package com.example.demo.model;

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;

    // Getters and Setters
}

4.3 Repository 인터페이스 생성

스프링 데이터 JPA를 사용하여 데이터베이스와 상호작용하기 위해 Repository 인터페이스를 생성합니다. ‘repository’ 패키지를 만들고 다음과 같이 인터페이스를 작성합니다:

package com.example.demo.repository;

import com.example.demo.model.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository {
}

4.4 Service 클래스 생성

비즈니스 로직을 처리하기 위해 Service 클래스를 생성합니다. ‘service’ 패키지를 만들고 UserService 클래스를 아래와 같이 작성합니다:

package com.example.demo.service;

import com.example.demo.model.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

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

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

4.5 Controller 클래스 생성

HTTP 요청을 처리하기 위해 Controller 클래스를 만듭니다. ‘controller’ 패키지를 만들고 UserController 클래스를 작성합니다:

package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

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

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

5. RESTful API의 이해

이제 스프링 부트를 이용한 RESTful API를 이해해보겠습니다. REST는 Representational State Transfer의 약자로, 웹 기반의 아키텍처 스타일입니다. RESTful API는 HTTP 요청을 통해 자원을 생성, 읽기, 수정 및 삭제하는 방식으로 작동합니다.

5.1 HTTP 메소드

RESTful API는 다음과 같은 HTTP 메소드를 사용합니다:

  • GET: 자원의 조회
  • POST: 자원의 생성
  • PUT: 자원의 수정
  • DELETE: 자원의 삭제

5.2 JSON 데이터

RESTful API에서 데이터를 전송하기 위해 일반적으로 JSON(JavaScript Object Notation) 형식을 사용합니다. JSON은 가볍고 사람이 읽기 쉬운 데이터 포맷으로, 웹 애플리케이션에서 널리 사용됩니다.

6. 그림으로 이해하는 프로젝트 구조

이제까지의 내용을 바탕으로 프로젝트 구조를 그려보도록 하겠습니다. 다음은 전반적인 프로젝트 구조입니다:

demo
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com.example.demo
│   │   │       ├── controller
│   │   │       │   └── UserController.java
│   │   │       ├── model
│   │   │       │   └── User.java
│   │   │       ├── repository
│   │   │       │   └── UserRepository.java
│   │   │       └── service
│   │   │           └── UserService.java
│   │   └── resources
│   │       └── application.properties
└── pom.xml

7. 결론

이번 강좌에서는 스프링 부트를 사용한 백엔드 개발의 기초를 배우고, 데이터베이스와 연동하여 간단한 RESTful API를 구현하는 방법을 알아보았습니다. 스프링 부트는 강력한 기능을 가진 프레임워크이므로, 추가적인 학습을 통해 더 다양한 기능을 활용해 보시길 권장합니다.

여기서 멈추지 말고, 다양한 프로젝트에 도전해보세요! 여러분의 개발 여정을 응원합니다!

스프링 부트 백엔드 개발 강좌, 깃허브 리포지터리 생성하고 코드 푸시하기

스프링 부트(Spring Boot)는 자바 기반의 웹 애플리케이션을 쉽게 개발할 수 있도록 도와주는 프레임 워크입니다. 이번 강좌에서는 스프링 부트를 활용하여 간단한 백엔드 애플리케이션을 구축하고, 이를 깃허브(GitHub)에 저장하는 방법에 대해 자세히 설명하겠습니다. 우리는 애플리케이션을 개발한 후, 깃허브 리포지터리를 생성하고, 코드를 푸시하는 과정까지 안내할 것입니다.

목차

  • 1. 스프링 부트 소개
  • 2. 개발 환경 설정
  • 3. 간단한 스프링 부트 애플리케이션 만들기
  • 4. 깃허브 리포지터리 생성하기
  • 5. 코드 푸시하기
  • 6. 마무리 및 추가 자료

1. 스프링 부트 소개

스프링 부트는 스프링 프레임워크를 기반으로 하여 빠르고 안정적으로 애플리케이션을 구축할 수 있도록 제공되는 도구입니다. 스프링 부트는 설정을 간소화하고, 자동 구성을 통해 개발자가 최소한의 작업으로 애플리케이션을 실행할 수 있도록 돕습니다.

스프링 부트의 주요 특징은 다음과 같습니다.

  • 자동 설정 : 스프링 부트는 프로젝트에 필요한 기본 설정을 자동으로 처리합니다.
  • 스타터 의존성 : 다양한 기능을 쉽게 추가할 수 있는 스타터 의존성이 제공됩니다.
  • 내장 웹 서버 : 톰캣(Tomcat), 제티(Jetty)와 같은 서버를 내장하여 별도의 설치 없이 애플리케이션을 실행할 수 있습니다.
  • 운영 환경에서의 모니터링 및 관리 : 스프링 부트는 운영 환경에서 애플리케이션을 모니터링하고 관리할 수 있는 다양한 기능을 제공합니다.

2. 개발 환경 설정

필수 도구 설치

안정적인 개발 환경을 구성하기 위해서는 다음 도구들이 필요합니다.

  • Java Development Kit (JDK): 스프링 부트를 실행하기 위해서는 JDK가 필요합니다. JDK 8 이상 버전을 설치해야 합니다.
  • IntelliJ IDEA 또는 Eclipse: 스프링 부트 애플리케이션을 개발하기 위한 IDE입니다. IntelliJ IDEA는 무료와 유료 모두 제공되며, Eclipse는 모든 플랫폼에서 사용할 수 있는 무료 IDE입니다.
  • Git: 버전 관리를 위한 도구입니다. Git을 사용하여 코드 변경 사항을 추적하고, 변경 사항을 리모트 저장소에 푸시할 수 있습니다.
  • 깃허브 계정: 코드 저장을 위한 깃허브 리포지터리를 만들기 위해 깃허브 계정이 필요합니다. 여기에서 가입할 수 있습니다.

개발 환경 설치 절차

각 도구를 설치하는 방법은 다음과 같습니다.

1. JDK 설치

JDK는 오라클 웹사이트에서 다운로드할 수 있습니다. 운영 체제에 맞는 버전을 선택하여 설치합니다.

2. IDE 설치

IntelliJ IDEA는 JetBrains의 공식 웹사이트에서 다운로드할 수 있으며, Eclipse는 오르그의 웹사이트에서 다운로드 가능합니다. IDE를 설치한 후, JDK 경로를 IDE에 설정합니다.

3. Git 설치

Git은 공식 웹사이트에서 다운로드하여 설치할 수 있습니다. 설치 후, Command Line 또는 Terminal에서 git --version 명령어를 실행하여 설치가 완료되었는지 확인합니다.

3. 간단한 스프링 부트 애플리케이션 만들기

이제 실제로 스프링 부트 애플리케이션을 만들어 보겠습니다. 다음 단계를 통해 애플리케이션을 생성할 수 있습니다.

Step 1: 스프링 초기화

스프링 부트 프로젝트를 초기화하기 위해 Spring Initializr를 사용합니다.

  • Project: 선택합니다. (‘Maven Project’ 또는 ‘Gradle Project’)
  • Language: ‘Java’를 선택합니다.
  • Spring Boot: 최신 스프링 부트 버전을 선택합니다.
  • Group: 예를 들어, com.example로 입력합니다.
  • Artifact: 원하는 프로젝트 이름을 입력합니다. 예를 들어, my-spring-boot-app로 설정합니다.
  • Dependencies: Spring Web를 선택합니다. 필요에 따라 다른 종속성을 추가할 수 있습니다.

설정을 마친 후, Generate 버튼을 클릭하여 ZIP 파일로 프로젝트를 다운로드합니다.

Step 2: IDE에서 프로젝트 불러오기

다운로드한 ZIP 파일을 IDE에서 불러옵니다. 이를 위해 IDE를 열고, File -> Open을 선택하여 ZIP 파일을 열거나, 압축을 푼 후 해당 폴더를 열 수 있습니다.

Step 3: 기본 코드 작성하기

프로젝트 구조가 설정되면 src/main/java/com/example/myspringbootapp/MySpringBootApp.java 파일을 열어 다음과 같은 코드로 업데이트합니다:

package com.example.myspringbootapp;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MySpringBootApp {

    public static void main(String[] args) {
        SpringApplication.run(MySpringBootApp.class, args);
    }
}

간단한 스프링 부트 애플리케이션의 시작점입니다. 이제 간단한 REST API를 만들어 보겠습니다.

Step 4: REST 컨트롤러 작성하기

먼저, 새로운 클래스 파일 GreetingController.java를 생성합니다. 다음과 같이 작성합니다:

package com.example.myspringbootapp;

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

@RestController
public class GreetingController {
    
    @GetMapping("/greeting")
    public String greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
        return String.format("Hello, %s!", name);
    }
}

위 코드는 /greeting API 엔드포인트를 생성하며, 쿼리 매개변수로 이름을 전달받아 인사 메시지를 반환합니다.

Step 5: 애플리케이션 실행하기

IDE에서 메인 클래스(MySpringBootApp)를 실행하거나, 터미널에서 다음 명령어를 실행하여 애플리케이션을 시작할 수 있습니다:

./mvnw spring-boot:run

브라우저에 http://localhost:8080/greeting를 입력하여 API를 호출할 수 있습니다. 만약 http://localhost:8080/greeting?name=Alice를 입력하면 “Hello, Alice!”라는 메시지를 받게 됩니다.

4. 깃허브 리포지터리 생성하기

이제 스프링 부트 애플리케이션을 깃허브에 저장할 차례입니다. 그동안 만든 코드를 깃허브에 올리기 위해서는 먼저 깃허브 리포지터리를 생성해야 합니다.

Step 1: 깃허브에 로그인하기

먼저, 깃허브에 로그인합니다. 계정이 없다면 회원가입을 해야 합니다.

Step 2: 새로운 리포지터리 생성하기

로그인 후 오른쪽 상단의 “+” 버튼을 클릭하여 “New repository”를 선택합니다. 리포지터리 이름과 설명을 입력하고, Public이나 Private 옵션을 선택한 후 Create repository 버튼을 클릭합니다.

5. 코드 푸시하기

이제 로컬에서 작성한 코드를 깃허브 리포지터리에 푸시하는 과정에 대해 알아보겠습니다.

Step 1: Git 초기화

프로젝트 폴더로 이동하여 Git을 초기화합니다. 터미널에서 다음 명령어를 실행합니다:

git init

Step 2: 깃허브 리모트 리포지터리 추가하기

계속해서 깃허브에서 생성한 리포지터리의 주소를 추가합니다. 리포지터리의 주소는 깃허브 상단의 URL 표시줄에서 복사할 수 있습니다:

git remote add origin https://github.com/USERNAME/REPOSITORY_NAME.git

여기서 USERNAME은 깃허브 사용자 이름이고, REPOSITORY_NAME은 생성한 리포지터리 이름입니다.

Step 3: 변경 사항 추가 및 커밋하기

변경 사항을 커밋하기 위해 다음 명령어를 실행합니다:

git add .
git commit -m "Initial commit"

Step 4: 코드 푸시하기

마지막으로, 로컬 변경 사항을 깃허브에 푸시합니다:

git push -u origin master

6. 마무리 및 추가 자료

축하합니다! 이제 간단한 스프링 부트 애플리케이션을 만들고, 깃허브 리포지터리에 코드를 푸시하는 방법까지 익혔습니다. 이 과정은 백엔드 개발의 기초를 다지는 중요한 단계입니다.

추가적인 자료와 참고문헌은 다음 링크를 통해 확인할 수 있습니다:

이 강좌가 도움이 되었길 바랍니다. 더 나아가고 싶은 분들은 스프링 부트와 Git을 활용하여 다양한 프로젝트에 도전해 보세요!