S03L04 - 데이터베이스에 시드 데이터 추가

html


데이터베이스에 시드 데이터 추가: 종합 가이드
목차

소개............................................................................1
시드 데이터 이해하기..........................................3

2.1 시드 데이터란?
2.2 시드 데이터의 중요성
2.3 시드 데이터를 사용하는 시기와 장소


Spring Boot에서 시드 데이터 구현............6

3.1 SeedData 클래스 설정
3.2 CommandLineRunner 활용하기
3.3 서비스 자동 주입
3.4 시드 데이터에 대한 조건부 로직 추가
3.5 Post 인스턴스 생성 및 저장


프로그램 코드 분석............................................12

4.1 SeedData.java 설명
4.2 PostService 통합
4.3 데이터베이스 기록 처리


시드 데이터 실행 및 검증................18

5.1 애플리케이션 실행
5.2 데이터베이스 콘솔 접근
5.3 시드 데이터 입력 검증


결론..............................................................................22


소개
Spring Boot를 사용하여 데이터베이스에 시드 데이터 추가에 대한 종합 가이드에 오신 것을 환영합니다. 백엔드 개발의 세계에 첫발을 디디는 초보자이든, 기술을 정교화하려는 숙련된 개발자이든, 데이터베이스를 효과적으로 시드하는 방법을 이해하는 것은 매우 중요합니다. 이 가이드는 시드 데이터 개념을 깊이 있게 탐구하며, Spring Boot 애플리케이션 내에서 이를 원활하게 구현하는 방법을 설명합니다.
개요

시드 데이터: 애플리케이션이 실행될 때 데이터베이스를 초기화하는 사전 채워진 데이터로, 필수 정보가 애플리케이션 실행 시 사용 가능하도록 보장합니다.
목적: 표준화된 데이터 세트를 제공하여 테스트 및 개발을 용이하게 하고, 다양한 환경 간의 일관성을 보장합니다.

중요성과 목적
데이터베이스를 시드하는 것은 단순히 초기 데이터를 추가하는 것 이상의 의미가 있습니다; 이는 애플리케이션의 기능성을 위한 기반을 설정합니다. 데이터를 사전에 로드함으로써:

일관성: 모든 환경(개발, 테스트, 생산)이 일관된 데이터 세트를 가지도록 보장합니다.
효율성: 개발 또는 테스트 단계에서 데이터를 수동으로 입력할 필요를 없애 시간을 절약합니다.
테스트: 알려진 데이터 상태를 제공하여 신뢰할 수 있는 테스트 시나리오를 가능하게 합니다.

장점과 단점
장점


이점
설명


일관된 데이터
다양한 환경 간의 균일성을 보장합니다.


개발 속도 향상
준비된 데이터를 제공하여 개발 과정을 가속화합니다.


테스트 용이성
사전 정의된 데이터 조건을 제공하여 테스트를 단순화합니다.


수동 입력 감소
반복적인 데이터 입력 작업의 필요성을 최소화합니다.


단점


단점
설명


초기 설정 시간
시드 데이터 스크립트를 구성하고 구현하는 데 시간이 필요합니다.


유지보수 오버헤드
애플리케이션이 발전함에 따라 시드 데이터를 업데이트해야 할 수 있습니다.


잠재적인 보안 위험
시드 스크립트에 민감한 데이터가 포함되면 적절히 관리되지 않을 경우 보안 취약점이 될 수 있습니다.


시드 데이터를 사용하는 시기와 장소

개발 단계: 기능을 구축하고 테스트하기 위해 개발자에게 일관된 데이터 세트를 제공합니다.
테스트 환경: 자동화된 테스트가 알려진 데이터 상태에서 실행되도록 보장합니다.
초기 생산 설정: 애플리케이션이 배포될 때 올바르게 작동하는 데 필요한 필수 데이터를 채웁니다.


시드 데이터 이해하기
2.1 시드 데이터란?
시드 데이터는 애플리케이션이 처음 배포될 때 데이터베이스에 로드되는 초기 데이터 세트를 말합니다. 이는 애플리케이션이 올바르게 작동하는 데 의존하는 기본 데이터 세트 역할을 합니다.
예시: 블로깅 플랫폼에서 시드 데이터는 초기 블로그 게시물, 사용자 계정 및 카테고리를 포함할 수 있습니다.
2.2 시드 데이터의 중요성
시드 데이터는 다음과 같은 중요한 역할을 합니다:

일관성: 애플리케이션의 모든 인스턴스가 동일한 데이터로 시작되도록 보장하여 디버깅 및 테스트를 용이하게 합니다.
효율성: 개발 또는 설정 중에 데이터를 수동으로 입력하는 데 소요되는 시간을 줄여줍니다.
신뢰성: 자동화된 테스트를 위한 알려진 상태를 제공하여 테스트의 신뢰성과 효율성을 향상시킵니다.

2.3 시드 데이터를 사용하는 시기와 장소
시드 데이터는 다음과 같은 시나리오에서 특히 유용합니다:

로컬 개발: 개발자가 데이터를 처음부터 생성할 필요 없이 사전 채워진 데이터 세트를 사용하여 작업할 수 있습니다.
자동화된 테스트: 예측 가능한 데이터 세트에서 테스트가 실행되어 일관된 결과를 보장합니다.
초기 배포: 애플리케이션이 작동하는 데 필요한 필수 정보를 데이터베이스에 채웁니다.


Spring Boot에서 시드 데이터 구현
Spring Boot 애플리케이션에서 시드 데이터를 구현하는 것은 애플리케이션 시작 시 미리 정의된 데이터로 데이터베이스를 초기화하는 전용 클래스를 만드는 것을 포함합니다.
3.1 SeedData 클래스 설정

이점	설명
일관된 데이터	다양한 환경 간의 균일성을 보장합니다.
개발 속도 향상	준비된 데이터를 제공하여 개발 과정을 가속화합니다.
테스트 용이성	사전 정의된 데이터 조건을 제공하여 테스트를 단순화합니다.
수동 입력 감소	반복적인 데이터 입력 작업의 필요성을 최소화합니다.

단점	설명
초기 설정 시간	시드 데이터 스크립트를 구성하고 구현하는 데 시간이 필요합니다.
유지보수 오버헤드	애플리케이션이 발전함에 따라 시드 데이터를 업데이트해야 할 수 있습니다.
잠재적인 보안 위험	시드 스크립트에 민감한 데이터가 포함되면 적절히 관리되지 않을 경우 보안 취약점이 될 수 있습니다.

먼저, SeedData라는 새 Java 클래스를 config 패키지 내에 생성합니다. 이 클래스는 데이터베이스에 초기 데이터를 추가하는 역할을 담당합니다.






		
		
			
			
Java
			
			package org.studyeasy.SpringStarter.config;

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringStarter.services.PostService;

@Component
public class SeedData implements CommandLineRunner {

    private final PostService service;

    public SeedData(PostService service) {
        this.service = service;
    }

    @Override
    public void run(String... args) throws Exception {
        // Seed data logic goes here
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
				
						package org.studyeasy.SpringStarter.config;
 
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringStarter.services.PostService;
 
@Component
public class SeedData implements CommandLineRunner {
 
    private final PostService service;
 
    public SeedData(PostService service) {
        this.service = service;
    }
 
    @Override
    public void run(String... args) throws Exception {
        // Seed data logic goes here
    }
}
 
					
				
			
		


3.2 CommandLineRunner 활용하기

SeedData 클래스는 CommandLineRunner 인터페이스를 구현하여 Spring Boot 애플리케이션이 시작된 후 특정 코드를 실행할 수 있게 합니다. 이 인터페이스 내의 run 메서드는 시드 데이터 작업의 진입점입니다.


3.3 서비스 자동 주입

데이터베이스와 상호 작용하기 위해 PostService가 SeedData 클래스에 자동 주입됩니다. 이 서비스는 기존 게시물을 검색하고 새 게시물을 저장하는 등의 작업을 용이하게 합니다.






		
		
			
			
Java
			
			@Autowired
private PostService service;

			
				
					
				
					1
2
3
				
						@Autowired
private PostService service;
 
					
				
			
		


3.4 시드 데이터에 대한 조건부 로직 추가
시드 데이터를 추가하기 전에 데이터베이스에 이미 항목이 있는지 확인하는 것이 중요합니다. 이는 중복을 방지하고 필요한 경우에만 시드 데이터가 추가되도록 보장합니다.




		
		
			
			
Java
			
			@Override
public void run(String... args) throws Exception {
    List<Post> posts = service.getAll();
    if (posts.size() == 0) {
        // Add seed data
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
				
						@Override
public void run(String... args) throws Exception {
    List<Post> posts = service.getAll();
    if (posts.size() == 0) {
        // Add seed data
    }
}
 
					
				
			
		


3.5 Post 인스턴스 생성 및 저장

데이터베이스가 비어 있는 경우, 새로운 Post 인스턴스가 생성되고 데이터로 채워진 후 PostService를 사용하여 저장됩니다.






		
		
			
			
Java
			
			if (posts.size() == 0) {
    Post post1 = new Post();
    post1.setTitle("Post 1");
    post1.setBody("This is the first seed post.");
    service.save(post1);

    Post post2 = new Post();
    post2.setTitle("Post 2");
    post2.setBody("This is the second seed post.");
    service.save(post2);
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
				
						if (posts.size() == 0) {
    Post post1 = new Post();
    post1.setTitle("Post 1");
    post1.setBody("This is the first seed post.");
    service.save(post1);
 
    Post post2 = new Post();
    post2.setTitle("Post 2");
    post2.setBody("This is the second seed post.");
    service.save(post2);
}
 
					
				
			
		



프로그램 코드 분석

더 깊이 있는 이해를 위해 SeedData.java 파일과 관련된 서비스의 필수 구성 요소를 분해해보겠습니다.


4.1 SeedData.java 설명




		
		
			
			
Java
			
			package org.studyeasy.SpringStarter.config;

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringStarter.services.PostService;
import org.studyeasy.SpringStarter.models.Post;

import java.util.List;

@Component
public class SeedData implements CommandLineRunner {

    private final PostService service;

    public SeedData(PostService service) {
        this.service = service;
    }

    @Override
    public void run(String... args) throws Exception {
        List<Post> posts = service.getAll();
        if (posts.size() == 0) {
            Post post1 = new Post();
            post1.setTitle("Post 1");
            post1.setBody("This is the first seed post.");
            service.save(post1);

            Post post2 = new Post();
            post2.setTitle("Post 2");
            post2.setBody("This is the second seed post.");
            service.save(post2);
        }
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
				
						package org.studyeasy.SpringStarter.config;
 
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringStarter.services.PostService;
import org.studyeasy.SpringStarter.models.Post;
 
import java.util.List;
 
@Component
public class SeedData implements CommandLineRunner {
 
    private final PostService service;
 
    public SeedData(PostService service) {
        this.service = service;
    }
 
    @Override
    public void run(String... args) throws Exception {
        List<Post> posts = service.getAll();
        if (posts.size() == 0) {
            Post post1 = new Post();
            post1.setTitle("Post 1");
            post1.setBody("This is the first seed post.");
            service.save(post1);
 
            Post post2 = new Post();
            post2.setTitle("Post 2");
            post2.setBody("This is the second seed post.");
            service.save(post2);
        }
    }
}
 
					
				
			
		


주요 구성 요소:

@Component: 클래스를 Spring 컴포넌트로 표시하여 컴포넌트 스캔 중에 감지될 수 있게 합니다.
CommandLineRunner: 애플리케이션 컨텍스트가 로드된 후 특정 코드를 실행해야 함을 나타내는 인터페이스입니다.
PostService: 기존 게시물을 검색하고 새로운 게시물을 저장하는 등의 Post 엔티티 관련 작업을 처리하는 서비스 클래스입니다.

작업 흐름:

의존성 주입: PostService가 생성자를 통해 SeedData 클래스에 주입됩니다.

Run 메서드 실행: 애플리케이션 시작 시 run 메서드가 실행됩니다.

데이터 확인: 모든 기존 게시물을 검색합니다. 게시물이 없는 경우(posts.size() == 0) 시드 데이터를 추가합니다.

게시물 생성: 새로운 Post 객체를 인스턴스화하고 제목과 본문을 설정한 후 PostService를 사용하여 저장합니다.


4.2 PostService 통합

PostService는 Post 엔티티 관리를 위해 필수적입니다. 주요 기능은 다음과 같습니다:



모든 게시물 검색: 데이터베이스에서 모든 기존 게시물을 가져옵니다.
게시물 저장: 새로운 Post 인스턴스를 데이터베이스에 저장합니다.

PostService 구현 예시:




		
		
			
			
Java
			
			package org.studyeasy.SpringStarter.services;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringStarter.models.Post;
import org.studyeasy.SpringStarter.repositories.PostRepository;

import java.util.List;

@Service
public class PostService {

    @Autowired
    private PostRepository postRepository;

    public List<Post> getAll() {
        return postRepository.findAll();
    }

    public void save(Post post) {
        postRepository.save(post);
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
				
						package org.studyeasy.SpringStarter.services;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringStarter.models.Post;
import org.studyeasy.SpringStarter.repositories.PostRepository;
 
import java.util.List;
 
@Service
public class PostService {
 
    @Autowired
    private PostRepository postRepository;
 
    public List<Post> getAll() {
        return postRepository.findAll();
    }
 
    public void save(Post post) {
        postRepository.save(post);
    }
}
 
					
				
			
		


4.3 데이터베이스 기록 처리

Post 모델은 데이터베이스에 저장된 데이터의 구조를 나타냅니다. id, title, body, createdAt 등의 필드를 포함합니다.


Post.java:




		
		
			
			
Java
			
			package org.studyeasy.SpringStarter.models;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;
import java.util.Date;

@Entity
public class Post {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Getter @Setter
    private String title;

    @Getter @Setter
    private String body;

    @Getter
    private Date createdAt;

    @PrePersist
    protected void onCreate() {
        createdAt = new Date();
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
				
						package org.studyeasy.SpringStarter.models;
 
import lombok.Getter;
import lombok.Setter;
 
import javax.persistence.*;
import java.util.Date;
 
@Entity
public class Post {
 
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
 
    @Getter @Setter
    private String title;
 
    @Getter @Setter
    private String body;
 
    @Getter
    private Date createdAt;
 
    @PrePersist
    protected void onCreate() {
        createdAt = new Date();
    }
}
 
					
				
			
		


주요 애너테이션:


@Entity: 클래스가 엔티티임을 지정하고 데이터베이스 테이블에 매핑됩니다.
@Id 및 @GeneratedValue: 기본 키와 그 생성 전략을 나타냅니다.
@Getter 및 @Setter: Lombok 애너테이션으로 자동으로 getter 및 setter 메서드를 생성합니다.

@PrePersist: 영속되기 전에 createdAt 타임스탬프를 설정하는 라이프사이클 콜백입니다.



시드 데이터 실행 및 검증
시드 데이터 로직을 구현한 후에는 애플리케이션을 실행하여 시드 데이터가 데이터베이스에 올바르게 추가되었는지 검증하는 것이 중요합니다.
5.1 애플리케이션 실행

Spring Boot 애플리케이션을 시작합니다. 시작 시 SeedData 클래스가 실행되어 데이터베이스를 확인하고 필요한 경우 시드 데이터를 추가합니다.






		
		
			
			
Java
			
			./mvnw spring-boot:run

			
				
					
				
					1
2
				
						./mvnw spring-boot:run
 
					
				
			
		


5.2 데이터베이스 콘솔 접근
데이터베이스 콘솔로 이동합니다. 일반적으로 http://localhost:8080/h2-console에서 접근 가능하며, H2 데이터베이스를 사용하는 경우 데이터베이스 자격 증명을 사용하여 로그인합니다.
5.3 시드 데이터 입력 검증
데이터베이스 콘솔로 이동한 후:

데이터베이스 연결: application.properties 파일에 지정된 JDBC URL, 사용자 이름 및 비밀번호를 입력합니다.


쿼리 실행: 모든 게시물을 조회하는 SQL 쿼리를 실행합니다.






		
		
			
			
Java
			
			SELECT * FROM POST;

			
				
					
				
					1
2
				
						SELECT * FROM POST;
 
					
				
			
		


샘플 출력:


ID
TITLE
BODY
CREATED_AT


1
Post 1
This is the first seed post.
2023-10-01 10:00:00


2
Post 2
This is the second seed post.
2023-10-01 10:00:05



결론
이 가이드에서는 시드 데이터의 개념과 Spring Boot 애플리케이션 내에서의 구현 방법을 살펴보았습니다. 시드 데이터는 애플리케이션 개발 및 배포의 다양한 단계에서 일관성, 효율성 및 신뢰성을 보장하는 데 필수적입니다.
주요 요점

시드 데이터: 미리 정의된 데이터로 데이터베이스를 초기화하는 데 필수적입니다.
Spring Boot 통합: CommandLineRunner 및 서비스를 활용하여 시드 데이터를 원활하게 구현합니다.
모범 사례: 시드 데이터를 추가하기 전에 기존 데이터를 확인하여 중복을 방지하고 데이터 무결성을 보장합니다.
검증: 데이터베이스 콘솔 또는 관련 도구를 사용하여 시드 데이터 입력의 정확성을 항상 검증합니다.

프로젝트에 시드 데이터를 통합함으로써 개발 프로세스를 간소화하고, 테스트를 용이하게 하며, 다양한 환경 간의 일관성을 유지할 수 있습니다.
참고: 이 기사는 AI에 의해 생성되었습니다.

ID	TITLE	BODY	CREATED_AT
1	Post 1	This is the first seed post.	2023-10-01 10:00:00
2	Post 2	This is the second seed post.	2023-10-01 10:00:05