elex/spring-boot-examples
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

2025-04-08T19:56:24

Browse Source
This commit is contained in:
Elex
2025-04-08 19:56:24 +09:00
parent a75a1dbd0f
commit eef061c1c9
100 changed files with 18639 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

432
docs/caching.md Normal file
View File

@@ -0,0 +1,432 @@
### 스프링 부트의 캐싱에 대한 설명
스프링 부트에서 캐싱(Caching)은 애플리케이션 성능을 개선하기 위해 자주 사용되는 데이터나 계산 결과를 메모리에 저장하여 반복적인 처리 비용을 줄이는 메커니즘입니다. 스프링은 캐싱 추상화(Cache Abstraction)를 제공하며, 이를 통해 다양한 캐시 구현체(EhCache, Caffeine, Redis 등)를 쉽게 통합할 수 있습니다. 스프링 부트는 기본적으로 캐싱을 활성화하고 설정하기 위한 어노테이션과 클래스를 제공하며, 최소한의 설정으로 캐싱을 적용할 수 있습니다.
#### 1. 캐싱의 기본 동작
- **캐시 히트(Cache Hit)**: 요청된 데이터가 캐시에 존재하면 캐시에서 반환.
- **캐시 미스(Cache Miss)**: 캐시에 없으면 원본 데이터 소스(DB 등)에서 조회 후 캐시에 저장.
- **캐시 관리**: 캐시 데이터의 추가, 갱신, 삭제를 어노테이션으로 제어.
#### 2. 캐싱 활성화
스프링 부트에서 캐싱을 사용하려면 `@EnableCaching` 어노테이션을 설정 클래스에 추가합니다.
```java
@Configuration
@EnableCaching
public class CacheConfig {
}
```
#### 3. 캐시 구현체
스프링 부트는 기본적으로 `ConcurrentMapCacheManager`를 사용하지만, 의존성을 추가해 다른 캐시 구현체를 사용할 수 있습니다:
- **EhCache**: `spring-boot-starter-cache` + `ehcache.xml`.
- **Caffeine**: `com.github.ben-manes.caffeine:caffeine`.
- **Redis**: `spring-boot-starter-data-redis`.
#### 4. 설정 예시 (`application.yaml`)
```yaml
spring:
cache:
type: caffeine # 캐시 구현체 지정
caffeine:
spec: maximumSize=500,expireAfterWrite=600s # Caffeine 설정
```
---
### 캐싱 관련 어노테이션 표
| **어노테이션** | **설명** | **사용 예시** |
|-----------------------|-------------------------------------------------------------------------------------------|------------------------------------------------|
| `@EnableCaching` | 애플리케이션에서 캐싱 기능을 활성화 | `@EnableCaching` (설정 클래스에 추가) |
| `@Cacheable` | 메서드 결과를 캐시에 저장하고, 동일한 요청 시 캐시에서 반환 | `@Cacheable("users")` |
| `@CachePut` | 메서드 실행 결과를 캐시에 갱신 (캐시를 항상 업데이트) | `@CachePut(value = "users", key = "#userId")` |
| `@CacheEvict` | 캐시에서 특정 데이터를 제거 | `@CacheEvict(value = "users", key = "#userId")`|
| `@Caching` | 여러 캐싱 어노테이션(`@Cacheable`, `@CachePut`, `@CacheEvict`)을 조합 | `@Caching(evict = {@CacheEvict("users")})` |
| `@CacheConfig` | 클래스 수준에서 캐시 설정(캐시 이름 등)을 공통으로 정의 | `@CacheConfig(cacheNames = {"users"})` |
- **참고**:
- `@Cacheable`: 캐시가 없으면 메서드 실행 후 캐시에 저장, 있으면 캐시 반환.
- `@CachePut`: 항상 메서드를 실행하고 결과를 캐시에 반영 (업데이트용).
- `@CacheEvict`: 캐시를 지워 데이터 최신성을 유지.
---
### 캐싱 관련 주요 클래스 표
| **클래스** | **설명** | **주요 사용처** |
|--------------------------|-------------------------------------------------------------------------------------------|-----------------------------------------------|
| `CacheManager` | 캐시를 관리하는 인터페이스, 캐시 생성 및 조회 | 캐시 구현체 설정 (예: `CaffeineCacheManager`) |
| `Cache` | 개별 캐시 인스턴스를 나타내며, 데이터 저장/조회/삭제 제공 | `CacheManager.getCache()`로 획득 |
| `ConcurrentMapCacheManager` | 기본 캐시 매니저, `ConcurrentHashMap`을 기반으로 메모리 캐싱 | 기본 캐싱 설정 |
| `CaffeineCacheManager` | Caffeine 캐시를 사용하는 캐시 매니저 | 고성능 메모리 캐싱 |
| `RedisCacheManager` | Redis를 캐시 저장소로 사용하는 캐시 매니저 | 분산 캐싱 |
| `EhCacheCacheManager` | EhCache를 사용하는 캐시 매니저 | 복잡한 캐시 설정 |
| `SimpleCacheManager` | 사용자 정의 캐시를 직접 설정할 수 있는 간단한 캐시 매니저 | 테스트용 |
| `CacheResolver` | 캐시 이름을 동적으로 결정하는 인터페이스 | 커스텀 캐시 선택 |
| `KeyGenerator` | 캐시 키를 생성하는 인터페이스 | 커스텀 키 생성 로직 |
---
### 캐싱 사용 예시
#### 1. 기본 캐싱 적용
```java
@Service
@CacheConfig(cacheNames = {"users"})
public class UserService {
@Cacheable(key = "#userId") // userId를 키로 캐싱
public User getUser(Long userId) {
// DB 조회 (캐시 미스 시 실행)
return userRepository.findById(userId).orElse(null);
}
@CachePut(key = "#user.id") // 캐시 갱신
public User updateUser(User user) {
return userRepository.save(user);
}
@CacheEvict(key = "#userId") // 캐시 삭제
public void deleteUser(Long userId) {
userRepository.deleteById(userId);
}
}
```
- **동작**:
- `getUser(1)` 호출 시 캐시에 없으면 DB 조회 후 캐시에 저장.
- 동일한 `userId`로 다시 호출 시 캐시에서 바로 반환.
- `updateUser()` 호출 시 캐시 갱신.
- `deleteUser()` 호출 시 캐시 제거.
#### 2. Caffeine 캐시 설정
```java
@Configuration
@EnableCaching
public class CacheConfig {
@Bean
public CacheManager cacheManager() {
CaffeineCacheManager cacheManager = new CaffeineCacheManager("users");
cacheManager.setCaffeine(Caffeine.newBuilder()
.expireAfterWrite(10, TimeUnit.MINUTES) // 10분 후 만료
.maximumSize(1000)); // 최대 1000개 항목
return cacheManager;
}
}
```
#### 3. Redis 캐시 설정
```yaml
spring:
cache:
type: redis
redis:
host: localhost
port: 6379
```
```java
@Configuration
@EnableCaching
public class RedisCacheConfig {
@Bean
public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory) {
return RedisCacheManager.create(connectionFactory);
}
}
```
---
### 추가 설명 및 팁
- **캐시 키(Key)**: `@Cacheable(key = "#파라미터명")`으로 메서드 파라미터를 키로 사용하거나, 커스텀 `KeyGenerator`로 복잡한 키 생성 가능.
- **조건적 캐싱**: `@Cacheable(condition = "#result != null")`로 결과가 `null`이 아닌 경우에만 캐싱.
- **동기화**: `@Cacheable(sync = true)`로 동시 요청 시 메서드 실행을 동기화.
- **캐시 구현체 선택**: 메모리 사용량이 적으면 `Caffeine`, 분산 환경이면 `Redis` 추천.
---
### 결론
스프링 부트의 캐싱은 `@EnableCaching`으로 활성화하고, `@Cacheable`, `@CachePut`, `@CacheEvict` 등의 어노테이션으로 간단히 적용할 수 있습니다. `CacheManager`와 같은 클래스를 활용해 캐시 저장소를 커스터마이징하며, Caffeine, Redis 등 다양한 구현체로 성능과 확장성을 높일 수 있습니다. 이를 통해 데이터베이스 부하를 줄이고 응답 속도를 개선할 수 있는 강력한 도구입니다. 추가 질문이 있다면 언제든 물어보세요!
---
스프링 부트에서 캐싱과 관련된 `application.yaml` 설정 예시를 제공하고, 주요 옵션을 표로 정리하겠습니다. 스프링 부트는 캐싱 추상화를 통해 다양한 캐시 구현체(예: Caffeine, Redis, EhCache 등)를 지원하며, `application.yaml` 파일에서 캐시 종류와 세부 설정을 정의할 수 있습니다.
---
### `application.yaml` 예시
아래는 Caffeine과 Redis 캐시를 각각 개발 환경과 프로덕션 환경에서 사용하는 설정 예시입니다.
```yaml
# 공통 캐시 설정
spring:
cache:
cache-names: users, products # 사용할 캐시 이름 목록
# 개발 환경 (Caffeine 캐시)
---
spring:
config:
activate:
on-profile: dev
cache:
type: caffeine # Caffeine 캐시 사용
caffeine:
spec: maximumSize=500,expireAfterWrite=600s # 최대 500개, 10분 후 만료
# 프로덕션 환경 (Redis 캐시)
---
spring:
config:
activate:
on-profile: prod
cache:
type: redis # Redis 캐시 사용
redis:
time-to-live: 3600000 # 캐시 항목의 기본 TTL (1시간, 밀리초 단위)
cache-null-values: false # null 값 캐싱 여부
use-key-prefix: true # 캐시 키에 접두사 사용 여부
key-prefix: myapp: # 커스텀 키 접두사
redis:
host: localhost # Redis 서버 호스트
port: 6379 # Redis 서버 포트
password: mypassword # Redis 인증 비밀번호 (선택)
```
#### 실행 방법
- 개발 환경: `java -jar myapp.jar -Dspring.profiles.active=dev`
- 프로덕션 환경: `java -jar myapp.jar -Dspring.profiles.active=prod`
---
### 캐시 설정 옵션 표
#### 1. 공통 캐시 설정
| **옵션** | **설명** | **예시 값** |
|---------------------------|-------------------------------------------------------------------------------------------|-----------------------|
| `spring.cache.type` | 사용할 캐시 구현체 지정 (`caffeine`, `redis`, `ehcache`, `concurrentMap`, `none` 등) | `caffeine` |
| `spring.cache.cache-names`| 애플리케이션에서 사용할 캐시 이름 목록 (미리 정의 시 성능 최적화 가능) | `users, products` |
#### 2. Caffeine 캐시 설정
| **옵션** | **설명** | **예시 값** |
|---------------------------|-------------------------------------------------------------------------------------------|-----------------------|
| `spring.cache.caffeine.spec` | Caffeine 캐시의 세부 설정 (최대 크기, 만료 시간 등, Caffeine Spec 형식) | `maximumSize=500,expireAfterWrite=600s` |
- **Caffeine Spec 세부 옵션**:
- `maximumSize`: 캐시 항목 최대 개수.
- `expireAfterWrite`: 쓰기 후 만료 시간 (초 단위, `s` 접미사).
- `expireAfterAccess`: 마지막 접근 후 만료 시간.
- 예: `maximumSize=1000,expireAfterWrite=300s` (최대 1000개, 5분 후 만료).
#### 3. Redis 캐시 설정
| **옵션** | **설명** | **예시 값** |
|---------------------------|-------------------------------------------------------------------------------------------|-----------------------|
| `spring.cache.redis.time-to-live` | 캐시 항목의 기본 TTL(Time To Live, 밀리초 단위) | `3600000` (1시간) |
| `spring.cache.redis.cache-null-values` | `null` 값을 캐싱할지 여부 (기본값: `true`) | `false` |
| `spring.cache.redis.use-key-prefix` | 캐시 키에 접두사를 사용할지 여부 (기본값: `true`) | `true` |
| `spring.cache.redis.key-prefix` | 캐시 키에 적용할 커스텀 접두사 (기본값은 캐시 이름) | `myapp:` |
#### 4. Redis 연결 설정 (캐시와 별개로 Redis 서버 연결에 필요)
| **옵션** | **설명** | **예시 값** |
|---------------------------|-------------------------------------------------------------------------------------------|-----------------------|
| `spring.redis.host` | Redis 서버 호스트 주소 | `localhost` |
| `spring.redis.port` | Redis 서버 포트 번호 | `6379` |
| `spring.redis.password` | Redis 서버 접속 비밀번호 (선택 사항) | `mypassword` |
| `spring.redis.database` | 사용할 Redis 데이터베이스 인덱스 (기본값: `0`) | `1` |
---
### 옵션 설명 및 사용 팁
1. **`spring.cache.type`**
- **설명**: 캐시 구현체를 지정합니다. 기본값은 `concurrentMap`이며, 별도 의존성 없이 메모리 기반 캐싱을 제공합니다.
- **팁**: 개발 환경에서는 `caffeine`, 분산 환경에서는 `redis` 추천.
2. **`spring.cache.caffeine.spec`**
- **설명**: Caffeine 캐시의 동작을 제어합니다. 단일 문자열로 여러 속성을 조합하며, 콤마(`,`)로 구분합니다.
- **예시**: `maximumSize=500,expireAfterWrite=600s`는 최대 500개 항목을 10분 동안 유지.
3. **`spring.cache.redis.time-to-live`**
- **설명**: Redis 캐시 항목의 기본 만료 시간을 설정합니다. 개별 캐시에 `@Cacheable`로 별도 TTL을 지정할 수도 있습니다.
- **팁**: 밀리초 단위로 설정하므로, 초 단위로 계산 후 변환 (예: 1시간 = `3600000`).
4. **`spring.cache.redis.key-prefix`**
- **설명**: Redis 키 충돌을 방지하기 위해 접두사를 추가합니다. 예를 들어, `myapp:users:1`처럼 저장됨.
- **팁**: 여러 애플리케이션이 동일한 Redis를 사용할 경우 필수.
---
### 의존성 추가
- **Caffeine**:
```xml
<dependency>
<groupId>com.github.ben-manes.caffeine</groupId>
<artifactId>caffeine</artifactId>
</dependency>
```
- **Redis**:
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
```
---
### 추가 참고
- **캐시 이름**: `spring.cache.cache-names`로 미리 정의하면 캐시 초기화 시 성능이 개선됩니다.
- **프로파일 활용**: 위 예시처럼 `dev`와 `prod` 프로파일로 캐시 구현체를 다르게 설정 가능.
- **커스텀 설정**: 더 복잡한 요구사항은 `CacheManager` 빈을 직접 정의해 제어할 수 있습니다:
```java
@Bean
public CacheManager cacheManager() {
CaffeineCacheManager cacheManager = new CaffeineCacheManager("users");
cacheManager.setCaffeine(Caffeine.newBuilder().maximumSize(1000));
return cacheManager;
}
```
---
### 결론
`application.yaml`을 사용하면 캐시 구현체와 세부 설정을 간단히 정의할 수 있으며, 프로파일을 통해 환경별로 유연하게 적용 가능합니다. Caffeine은 메모리 기반 고성능 캐싱에 적합하고, Redis는 분산 환경에서 유용합니다. 위 표와 예시를 참고해 애플리케이션 요구사항에 맞는 캐싱 전략을 구성해보세요! 추가 질문이 있으면 언제든 말씀해주세요.
---
스프링 부트에서 사용 가능한 주요 캐시 구현체들을 비교해보겠습니다. 스프링의 캐싱 추상화는 다양한 캐시 제공자를 지원하며, 각 구현체는 성능, 사용 사례, 설정 복잡도 등에서 차이가 있습니다. 여기서는 대표적인 캐시 구현체인 **ConcurrentMap**, **Caffeine**, **EhCache**, **Redis**를 중심으로 비교하고, 표와 설명을 통해 차이점을 정리하겠습니다.
---
### 캐시 구현체 비교 표
| **구현체** | **ConcurrentMap** | **Caffeine** | **EhCache** | **Redis** |
|-------------------|------------------------------------|----------------------------------|----------------------------------|----------------------------------|
| **설명** | 기본 메모리 기반 캐시 (`ConcurrentHashMap` 사용) | 고성능 메모리 캐시, Guava 캐시 대체 | 오프-힙 메모리 지원, 복잡한 캐싱 전략 | 분산 환경 지원, 영구 저장 가능 |
| **의존성** | 추가 의존성 필요 없음 (스프링 부트 기본 제공) | `com.github.ben-manes.caffeine` | `org.ehcache:ehcache` | `spring-boot-starter-data-redis` |
| **성능** | 중간 (단순 메모리 기반) | 매우 높음 (최적화된 알고리즘) | 높음 (오프-힙 사용 시 더 효율적) | 높음 (네트워크 지연 고려 필요) |
| **메모리 사용** | JVM 힙 메모리 사용 | JVM 힙 메모리 사용 | 힙 + 오프-힙 메모리 사용 가능 | 독립적인 Redis 서버 메모리 사용 |
| **분산 지원** | 없음 (단일 JVM 내에서만 동작) | 없음 (단일 JVM 내에서만 동작) | 제한적 (클러스터링 지원) | 있음 (분산 캐싱에 최적화) |
| **영속성** | 없음 (애플리케이션 종료 시 소멸) | 없음 (애플리케이션 종료 시 소멸) | 있음 (디스크 저장 옵션 제공) | 있음 (Redis 설정에 따라 영구 저장) |
| **설정 복잡도** | 매우 낮음 (기본 설정으로 충분) | 낮음 (`application.yaml`로 간단 설정) | 중간 (`ehcache.xml` 필요) | 높음 (Redis 서버 설정 필요) |
| **만료 정책** | 없음 (수동 관리 필요) | 유연함 (시간 기반, 크기 기반) | 유연함 (복잡한 정책 지원) | 유연함 (TTL 설정 가능) |
| **사용 사례** | 간단한 테스트, 소규모 애플리케이션 | 고성능 요구되는 단일 서버 애플리케이션 | 대규모 메모리 관리, 영속성 필요 시 | 분산 시스템, 대규모 트래픽 처리 |
| **스프링 설정** | `spring.cache.type: concurrentMap` | `spring.cache.type: caffeine` | `spring.cache.type: ehcache` | `spring.cache.type: redis` |
---
### 구현체별 상세 비교
#### 1. ConcurrentMap
- **특징**: 스프링 부트의 기본 캐시 매니저(`ConcurrentMapCacheManager`)로, `ConcurrentHashMap`을 사용해 메모리에 데이터를 저장합니다.
- **장점**:
- 별도 의존성 없이 즉시 사용 가능.
- 설정이 간단하고 가볍습니다.
- **단점**:
- 만료 정책(TTL)이나 크기 제한이 없어 수동으로 관리해야 함.
- 분산 환경 지원 불가, JVM 종료 시 데이터 소실.
- **사용 예시**:
```yaml
spring:
cache:
type: concurrentMap
```
- 소규모 애플리케이션이나 개발 초기 테스트에 적합.
#### 2. Caffeine
- **특징**: Guava 캐시의 대체재로, 최신 알고리즘(Window TinyLFU)을 사용해 높은 성능을 제공하는 메모리 기반 캐시입니다.
- **장점**:
- 빠른 읽기/쓰기 성능.
- 최대 크기, 만료 시간 등 유연한 설정 가능.
- **단점**:
- 분산 환경 지원 안 함.
- 메모리만 사용하므로 애플리케이션 재시작 시 데이터 소실.
- **사용 예시**:
```yaml
spring:
cache:
type: caffeine
caffeine:
spec: maximumSize=500,expireAfterWrite=600s
```
- 단일 서버에서 높은 캐시 히트율이 필요한 경우 추천.
#### 3. EhCache
- **특징**: 오픈소스 캐시 라이브러리로, 메모리와 디스크를 활용한 캐싱을 지원하며 복잡한 캐시 정책을 설정할 수 있습니다.
- **장점**:
- 오프-힙 메모리와 디스크 저장으로 대규모 데이터 처리 가능.
- TTL, 캐시 계층화 등 고급 기능 제공.
- **단점**:
- 설정 파일(`ehcache.xml`)이 필요해 초기 설정이 복잡.
- 분산 환경에서는 추가 클러스터링 설정 필요.
- **사용 예시**:
```yaml
spring:
cache:
type: ehcache
```
```xml
<!-- ehcache.xml -->
<cache name="users" maxEntriesLocalHeap="1000" timeToLiveSeconds="3600"/>
```
- 메모리와 영속성을 동시에 고려해야 할 때 적합.
#### 4. Redis
- **특징**: 인메모리 데이터 저장소로, 분산 환경에서 캐싱과 데이터 공유를 지원합니다.
- **장점**:
- 분산 시스템에서 여러 서버 간 캐시 공유 가능.
- TTL 설정 및 영구 저장 옵션 제공.
- **단점**:
- 별도의 Redis 서버 운영 필요 (네트워크 지연 발생 가능).
- 설정 및 유지보수가 상대적으로 복잡.
- **사용 예시**:
```yaml
spring:
cache:
type: redis
redis:
time-to-live: 3600000
redis:
host: localhost
port: 6379
```
- 대규모 트래픽과 분산 애플리케이션에 적합.
---
### 비교 요약 및 선택 가이드
1. **ConcurrentMap**
- **선택 시기**: 간단한 테스트나 프로토타입 개발 단계.
- **제한**: 기능이 단순해 실제 운영 환경에서는 부족.
2. **Caffeine**
- **선택 시기**: 단일 서버에서 고성능 메모리 캐싱이 필요할 때.
- **제한**: 분산 환경이나 영속성이 필요하면 부적합.
3. **EhCache**
- **선택 시기**: 대규모 데이터와 영속성이 필요한 단일 서버 애플리케이션.
- **제한**: 설정이 복잡하고, 분산 지원이 약함.
4. **Redis**
- **선택 시기**: 여러 서버가 캐시를 공유해야 하는 분산 시스템, 대규모 트래픽 처리.
- **제한**: 추가 인프라 관리 비용 발생.
---
### 결론
캐시 구현체 선택은 애플리케이션의 규모, 성능 요구사항, 분산 여부에 따라 달라집니다. 소규모라면 `ConcurrentMap`이나 `Caffeine`으로 시작하고, 대규모 또는 분산 환경에서는 `Redis`를, 복잡한 캐싱 전략과 영속성이 필요하면 `EhCache`를 고려하세요. 각 구현체의 특성을 이해하고 환경에 맞게 설정하면 최적의 캐싱 전략을 구현할 수 있습니다. 추가 질문이 있다면 말씀해주세요!