Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ dependencies {
implementation 'software.amazon.awssdk:s3:2.20.89'
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'
implementation 'org.springframework.boot:spring-boot-starter-actuator'
implementation 'org.flywaydb:flyway-core'
implementation 'org.flywaydb:flyway-mysql'


compileOnly 'org.projectlombok:lombok'
Expand Down
268 changes: 268 additions & 0 deletions docs/FLYWAY_MIGRATION_TEST_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,268 @@

# Flyway ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ๋ฆฌํŒฉํ† ๋ง ๊ฐ€์ด๋“œ

## ๐Ÿ“‹ ๋ชฉ์ฐจ
1. [๋ณ€๊ฒฝ ์‚ฌํ•ญ ๊ฐœ์š”](#๋ณ€๊ฒฝ-์‚ฌํ•ญ-๊ฐœ์š”)
2. [์ฃผ์š” ๋ณ€๊ฒฝ ๋‚ด์šฉ](#์ฃผ์š”-๋ณ€๊ฒฝ-๋‚ด์šฉ)
3. [๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ณ€๊ฒฝ ๋ฐฉ๋ฒ•](#๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค-๋ณ€๊ฒฝ-๋ฐฉ๋ฒ•)
5. [ํ™˜๊ฒฝ๋ณ„ ์„ค์ •](#ํ™˜๊ฒฝ๋ณ„-์„ค์ •)

---

## ๋ณ€๊ฒฝ ์‚ฌํ•ญ ๊ฐœ์š”

### ๋ชฉ์ 
- **ํ”„๋กœ๋•์…˜ ์•ˆ์ •์„ฑ ํ–ฅ์ƒ**: JPA์˜ `ddl-auto: update`๋ฅผ ์ œ๊ฑฐํ•˜๊ณ  Flyway๋กœ ์Šคํ‚ค๋งˆ ๋ฒ„์ „ ๊ด€๋ฆฌ
- **์Šคํ‚ค๋งˆ ๋ฒ„์ „ ๊ด€๋ฆฌ**: ๋ชจ๋“  DDL/DML ๋ณ€๊ฒฝ์„ SQL ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ๋กœ ๊ด€๋ฆฌ
- **ํ™˜๊ฒฝ ๋ถ„๋ฆฌ**: ๊ฐœ๋ฐœ ํ™˜๊ฒฝ๊ณผ ์šด์˜ ํ™˜๊ฒฝ์˜ ๋ฐ์ดํ„ฐ๋ฅผ ๋ช…ํ™•ํžˆ ๋ถ„๋ฆฌ

### ๋ณ€๊ฒฝ ์ „ํ›„ ๋น„๊ต

| ํ•ญ๋ชฉ | ๋ณ€๊ฒฝ ์ „ | ๋ณ€๊ฒฝ ํ›„ |
|------|---------|---------|
| ์Šคํ‚ค๋งˆ ๊ด€๋ฆฌ | JPA `ddl-auto: update` | Flyway SQL ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ |
| ์ดˆ๊ธฐ ๋ฐ์ดํ„ฐ | Java `DataInitializer`, `CountryInitializer` | SQL `V2__insert_basic_data.sql`, `V3__insert_countries.sql` |
| ํ…Œ์ŠคํŠธ ๋ฐ์ดํ„ฐ | Java ์ฝ”๋“œ | SQL `V4__test_user.sql` (๊ฐœ๋ฐœ ์ „์šฉ) |
| ์Šคํ‚ค๋งˆ ๊ฒ€์ฆ | ์ž๋™ ์ƒ์„ฑ | `ddl-auto: validate` + Flyway ๊ฒ€์ฆ |

---

## ์ฃผ์š” ๋ณ€๊ฒฝ ๋‚ด์šฉ

### 1. ์˜์กด์„ฑ ์ถ”๊ฐ€ (`build.gradle`)

```gradle
dependencies {
implementation 'org.flywaydb:flyway-core'
runtimeOnly 'org.flywaydb:flyway-mysql'
}
```

### 2. JPA ์„ค์ • ๋ณ€๊ฒฝ (`application.yml`)

**๋ณ€๊ฒฝ ์ „:**
```yaml
jpa:
hibernate:
ddl-auto: update # ์ž๋™ ์Šคํ‚ค๋งˆ ์ƒ์„ฑ
```

**๋ณ€๊ฒฝ ํ›„:**
```yaml
jpa:
hibernate:
ddl-auto: validate # ์Šคํ‚ค๋งˆ ๊ฒ€์ฆ๋งŒ ์ˆ˜ํ–‰
properties:
hibernate:
physical_naming_strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

flyway:
enabled: true
baseline-on-migrate: false
validate-on-migrate: true
locations:
- classpath:db/migration
- classpath:db/migration-dev # ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ์ „์šฉ
```

### 3. Flyway ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ ๊ตฌ์กฐ

```
src/main/resources/db/
โ”œโ”€โ”€ migration/ # ํ”„๋กœ๋•์…˜ + ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๊ณตํ†ต
โ”‚ โ”œโ”€โ”€ V1__init.sql # DDL (ํ…Œ์ด๋ธ” ์ƒ์„ฑ)
โ”‚ โ”œโ”€โ”€ V2__insert_basic_data.sql # ๊ธฐ์ดˆ ๋ฐ์ดํ„ฐ (ํ…Œ๋งˆ, ๊ฐ์ •, ๋‚ ์”จ ๋“ฑ)
โ”‚ โ””โ”€โ”€ V3__insert_countries.sql # ๊ตญ๊ฐ€ ๋ฐ์ดํ„ฐ (245๊ฐœ)
โ””โ”€โ”€ migration-dev/ # ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ์ „์šฉ
โ””โ”€โ”€ V4__test_user.sql # ํ…Œ์ŠคํŠธ ์‚ฌ์šฉ์ž ๋ฐ์ดํ„ฐ
```

### 4. ์—”ํ‹ฐํ‹ฐ ๋งคํ•‘ ๋ช…์‹œํ™”

๋ชจ๋“  ์—”ํ‹ฐํ‹ฐ์— ๋ช…์‹œ์  ๋งคํ•‘ ์ถ”๊ฐ€:

```java
@Entity
@Table(name = "Diary") // ํ…Œ์ด๋ธ”๋ช… ๋ช…์‹œ
public class Diary {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY) // ID ์ƒ์„ฑ ์ „๋žต ๋ช…์‹œ
@Column(name = "diaryId") // ์ปฌ๋Ÿผ๋ช… ๋ช…์‹œ (camelCase)
private Long id;

@Lob
@Column(name = "content", nullable = false, length = 88)
private String content; // TINYTEXT๋กœ ๋งคํ•‘
}
```

**๋ณ€๊ฒฝ๋œ ์—”ํ‹ฐํ‹ฐ ๋ชฉ๋ก:**
- `User`, `Trip`, `Diary`, `DiaryImage`
- `TripTheme`, `BoardTheme`, `Emotion`, `Weather`
- `Country`, `VisitedCountry`, `Setting`
- `Board`, `BoardStickerMap`, `AlarmHistory`
- `Sticker`

### 5. ๋ฐ์ดํ„ฐ ์ดˆ๊ธฐํ™” ํด๋ž˜์Šค ๋น„ํ™œ์„ฑํ™”

**๋ณ€๊ฒฝ ์ „:**
```java
@Component // ์ž๋™ ์‹คํ–‰
public class DataInitializer implements CommandLineRunner {
// ...
}
```

**๋ณ€๊ฒฝ ํ›„:**
```java
// @Component - ๋น„ํ™œ์„ฑํ™”: Flyway ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜์œผ๋กœ ๋Œ€์ฒด๋จ
public class DataInitializer implements CommandLineRunner {
// ...
}
```

**๋น„ํ™œ์„ฑํ™”๋œ ํด๋ž˜์Šค:**
- `DataInitializer.java`
- `CountryInitializer.java`

### 6. ์ปฌ๋Ÿผ๋ช… ๋ฐ ํ…Œ์ด๋ธ”๋ช… ํ†ต์ผ

- **์ปฌ๋Ÿผ๋ช…**: ๋ชจ๋“  ์ปฌ๋Ÿผ์„ `camelCase`๋กœ ํ†ต์ผ (์˜ˆ: `userId`, `createdAt`)
- **ํ…Œ์ด๋ธ”๋ช…**: ์—”ํ‹ฐํ‹ฐ ํด๋ž˜์Šค๋ช…๊ณผ ์ผ์น˜ํ•˜๋„๋ก ๋ณ€๊ฒฝ (์˜ˆ: `User`, `Diary`, `TripTheme`)

---

## ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ณ€๊ฒฝ ๋ฐฉ๋ฒ•

### ์ƒˆ๋กœ์šด ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ ์ƒ์„ฑ

1. **ํŒŒ์ผ๋ช… ๊ทœ์น™**: `V{๋ฒ„์ „}__{์„ค๋ช…}.sql`
- ์˜ˆ: `V5__add_user_email_column.sql`
- ๋ฒ„์ „์€ ์ˆœ์ฐจ์ ์œผ๋กœ ์ฆ๊ฐ€ (V1, V2, V3...)

2. **ํŒŒ์ผ ์œ„์น˜:**
- ํ”„๋กœ๋•์…˜ ํฌํ•จ: `src/main/resources/db/migration/`
- ๊ฐœ๋ฐœ ์ „์šฉ: `src/main/resources/db/migration-dev/`

3. **๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ์ž‘์„ฑ ์˜ˆ์‹œ:**

```sql
-- V5__add_user_email_column.sql
ALTER TABLE `User`
ADD COLUMN `email` VARCHAR(255) AFTER `kakaoId`;

-- ์ธ๋ฑ์Šค ์ถ”๊ฐ€
CREATE INDEX `idx_user_email` ON `User` (`email`);
```

### ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ์‹คํ–‰

**์ž๋™ ์‹คํ–‰:**
- ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์‹œ์ž‘ ์‹œ Flyway๊ฐ€ ์ž๋™์œผ๋กœ ๋ฏธ์ ์šฉ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ์‹คํ–‰

**์ˆ˜๋™ ์‹คํ–‰ (์„ ํƒ์‚ฌํ•ญ):**
```bash
./gradlew flywayMigrate
```

### ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ๋กค๋ฐฑ

โš ๏ธ **์ฃผ์˜**: Flyway๋Š” ๊ธฐ๋ณธ์ ์œผ๋กœ ๋กค๋ฐฑ์„ ์ง€์›ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

**๋กค๋ฐฑ์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ:**
1. ์ƒˆ๋กœ์šด ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ๋กœ ๋กค๋ฐฑ SQL ์ž‘์„ฑ
```sql
-- V6__rollback_email_column.sql
ALTER TABLE `User` DROP COLUMN `email`;
```

2. ๋˜๋Š” ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค๋ฅผ ์ด์ „ ์ƒํƒœ๋กœ ๋ณต์› (๋ฐฑ์—… ํ•„์š”)

### ์ด๋ฏธ ์ ์šฉ๋œ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ์ˆ˜์ • ๊ธˆ์ง€

โŒ **์ ˆ๋Œ€ ํ•˜์ง€ ๋ง ๊ฒƒ:**
- ์ด๋ฏธ ์ ์šฉ๋œ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ(V1, V2, V3...) ์ˆ˜์ •
- Checksum ๋ถˆ์ผ์น˜๋กœ ์ธํ•œ ์˜ค๋ฅ˜ ๋ฐœ์ƒ

โœ… **์˜ฌ๋ฐ”๋ฅธ ๋ฐฉ๋ฒ•:**
- ์ƒˆ๋กœ์šด ๋ฒ„์ „์˜ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ๋กœ ๋ณ€๊ฒฝ์‚ฌํ•ญ ์ถ”๊ฐ€

---

## ํ™˜๊ฒฝ๋ณ„ ์„ค์ •

### ๊ฐœ๋ฐœ ํ™˜๊ฒฝ (`application.yml`)

```yaml
spring:
flyway:
enabled: true
baseline-on-migrate: false
validate-on-migrate: true
locations:
- classpath:db/migration # ๊ณตํ†ต ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜
- classpath:db/migration-dev # ๊ฐœ๋ฐœ ์ „์šฉ (ํ…Œ์ŠคํŠธ ๋ฐ์ดํ„ฐ)
```

**ํฌํ•จ๋˜๋Š” ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜:**
- V1: DDL (ํ…Œ์ด๋ธ” ์ƒ์„ฑ)
- V2: ๊ธฐ์ดˆ ๋ฐ์ดํ„ฐ
- V3: ๊ตญ๊ฐ€ ๋ฐ์ดํ„ฐ
- V4: ํ…Œ์ŠคํŠธ ์‚ฌ์šฉ์ž (๊ฐœ๋ฐœ ์ „์šฉ)

### ์šด์˜ ํ™˜๊ฒฝ (`application-prod.yml`)

```yaml
spring:
config:
activate:
on-profile: prod

flyway:
enabled: true
baseline-on-migrate: true # ๊ธฐ์กด DB์— Flyway ์ ์šฉ ์‹œ ํ•„์š”
validate-on-migrate: true
locations: classpath:db/migration # ๊ฐœ๋ฐœ ์ „์šฉ ์ œ์™ธ
```

**ํฌํ•จ๋˜๋Š” ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜:**
- V1: DDL (ํ…Œ์ด๋ธ” ์ƒ์„ฑ)
- V2: ๊ธฐ์ดˆ ๋ฐ์ดํ„ฐ
- V3: ๊ตญ๊ฐ€ ๋ฐ์ดํ„ฐ
- โŒ V4: ํ…Œ์ŠคํŠธ ์‚ฌ์šฉ์ž (์ œ์™ธ๋จ)

### ํ”„๋กœํŒŒ์ผ ํ™œ์„ฑํ™”

**๋กœ์ปฌ ๊ฐœ๋ฐœ:**
```bash
# ๊ธฐ๋ณธ ํ”„๋กœํŒŒ์ผ (application.yml ์‚ฌ์šฉ)
./gradlew bootRun
```

**์šด์˜ ๋ฐฐํฌ:**
```bash
# prod ํ”„๋กœํŒŒ์ผ ํ™œ์„ฑํ™”
java -jar app.jar --spring.profiles.active=prod
```

---

## ์ฒดํฌ๋ฆฌ์ŠคํŠธ

### ์ƒˆ๋กœ์šด ์Šคํ‚ค๋งˆ ๋ณ€๊ฒฝ ์‹œ

- [ ] ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํŒŒ์ผ๋ช…์ด `V{๋ฒ„์ „}__{์„ค๋ช…}.sql` ํ˜•์‹์ธ๊ฐ€?
- [ ] ๋ฒ„์ „ ๋ฒˆํ˜ธ๊ฐ€ ๊ธฐ์กด ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜๋ณด๋‹ค ํฐ๊ฐ€?
- [ ] ๊ฐœ๋ฐœ ์ „์šฉ ๋ฐ์ดํ„ฐ์ธ๊ฐ€? โ†’ `migration-dev/` ์‚ฌ์šฉ
- [ ] ์—”ํ‹ฐํ‹ฐ์— `@Table`, `@Column` ๋งคํ•‘์ด ๋ช…์‹œ๋˜์–ด ์žˆ๋Š”๊ฐ€?
- [ ] `@GeneratedValue(strategy = GenerationType.IDENTITY)` ์„ค์ •๋˜์–ด ์žˆ๋Š”๊ฐ€?
- [ ] ๋กœ์ปฌ์—์„œ ํ…Œ์ŠคํŠธ ํ›„ ์ปค๋ฐ‹ํ–ˆ๋Š”๊ฐ€?

### ๋ฐฐํฌ ์ „ ํ™•์ธ

- [ ] `application-prod.yml`์— `baseline-on-migrate: true` ์„ค์ •๋˜์–ด ์žˆ๋Š”๊ฐ€?
- [ ] ์šด์˜ ํ™˜๊ฒฝ์—์„œ ํ…Œ์ŠคํŠธ ๋ฐ์ดํ„ฐ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜์ด ์ œ์™ธ๋˜๋Š”๊ฐ€?
- [ ] ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ฐฑ์—…์„ ์ˆ˜ํ–‰ํ–ˆ๋Š”๊ฐ€?


**๋งˆ์ง€๋ง‰ ์—…๋ฐ์ดํŠธ**: 2026-02-03
2 changes: 0 additions & 2 deletions src/main/java/zim/tave/memory/controller/AlarmController.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@
import org.springframework.web.bind.annotation.RestController;
import zim.tave.memory.config.swagger.ApiErrorCodeExamples;
import zim.tave.memory.domain.AlarmType;
import zim.tave.memory.domain.User;
import zim.tave.memory.dto.response.AlarmSendResponseDto;
import zim.tave.memory.global.common.ApiResponseDto;
import zim.tave.memory.global.common.ResponseCode;
import zim.tave.memory.global.common.exception.ErrorCode;
import zim.tave.memory.service.AlarmService;

import java.util.Map;

@RestController
@RequiredArgsConstructor
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/zim/tave/memory/domain/AlarmHistory.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,28 @@ public class AlarmHistory {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "alarm_history_id")
@Column(name = "alarmHistoryId")
private Long id;

// ์•Œ๋ฆผ์„ ๋ฐ›์„ ์‚ฌ์šฉ์ž
@Column(nullable = false)
@Column(name = "userId", nullable = false)
private Long userId;

// ์–ด๋–ค ์—ฌํ–‰์— ๋Œ€ํ•œ ์•Œ๋ฆผ์ธ์ง€
@Column(nullable = false)
@Column(name = "tripId", nullable = false)
private Long tripId;

// ์•Œ๋ฆผ ์ข…๋ฅ˜
@Enumerated(EnumType.STRING)
@Column(nullable = false, length = 50)
@Column(name = "alarmType", nullable = false, length = 50)
private AlarmType alarmType;

// ์‹ค์ œ ๋ฐœ์†ก ์‹œ๊ฐ
@Column(nullable = false)
@Column(name = "sentAt", nullable = false)
private LocalDateTime sentAt;

// ์ผ ๋‹จ์œ„ ์กฐํšŒ ์ตœ์ ํ™”๋ฅผ ์œ„ํ•œ ํ•„๋“œ (์บก ๊ณ„์‚ฐ์šฉ)
@Column(nullable = false)
@Column(name = "sentDate", nullable = false)
private LocalDate sentDate;

public static AlarmHistory create(
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/zim/tave/memory/domain/Board.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,16 @@ public class Board {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "boardId")
private Long boardId;

@Column(nullable = false, length = 100)
@Column(name = "title", nullable = false, length = 100)
private String title;

@Column(nullable = false, updatable = false)
@Column(name = "createdAt", nullable = false, updatable = false)
private OffsetDateTime createdAt;

@Column(name = "updatedAt")
private OffsetDateTime updatedAt;

@ManyToOne(fetch = FetchType.LAZY)
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/zim/tave/memory/domain/BoardStickerMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public class BoardStickerMap {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "boardStickerId")
private Long boardStickerId;

@ManyToOne(fetch = FetchType.LAZY)
Expand All @@ -24,12 +25,12 @@ public class BoardStickerMap {
@JoinColumn(name = "stickerId", nullable = false)
private Sticker sticker;

@Column(nullable = false)
@Column(name = "posX", nullable = false)
private BigDecimal posX;

@Column(nullable = false)
@Column(name = "posY", nullable = false)
private BigDecimal posY;

@Column(nullable = false)
@Column(name = "rotation", nullable = false)
private BigDecimal rotation;
}
7 changes: 4 additions & 3 deletions src/main/java/zim/tave/memory/domain/BoardTheme.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ public class BoardTheme {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "boardThemeId")
private Long boardThemeId;

@Column(nullable = false, length = 100)
@Column(name = "themeName", nullable = false, length = 100)
private String themeName;

@Column(nullable = false, length = 255)
@Column(name = "thumbnailUrl", nullable = false, length = 255)
private String thumbnailUrl;

@Column(nullable = false, length = 255)
@Column(name = "cardUrl", nullable = false, length = 255)
private String cardUrl;
}
Loading
Loading