[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,126 +2,152 @@
|
||||
id: wiki-2026-0508-sprout-method-스프라우트-메서드
|
||||
title: Sprout Method (스프라우트 메서드)
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
aliases: [Sprout Method, 스프라우트 메서드]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [uncategorized]
|
||||
confidence_score: 0.9
|
||||
verification_status: applied
|
||||
tags: [refactoring, legacy-code, michael-feathers]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-08
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: java
|
||||
framework: junit
|
||||
---
|
||||
|
||||
# [[Sprout Method (스프라우트 메서드)]]
|
||||
# Sprout Method (스프라우트 메서드)
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
스프라우트 메서드(Sprout Method)는 테스트가 없는 거대한 레거시 코드에 새로운 기능을 추가할 때, 기존 코드를 직접 수정하는 대신 새로운 로직을 별도의 검증된 함수로 분리하여 작성하는 기법입니다 [1-3]. 격리된 새로운 코드에 대해서만 단위 테스트(Unit Test)를 작성한 뒤, 기존 코드의 적절한 삽입 지점(Insertion point)에서 이를 호출하여 수정에 따른 위험을 최소화합니다 [2]. 이 기법은 시간이 부족하여 기존 코드를 전면적으로 리팩토링하거나 테스트를 작성하기 어려울 때 유용하게 활용됩니다 [1].
|
||||
## 매 한 줄
|
||||
> **"매 untestable 한 method 의 옆에 매 새 method 의 sprout — 매 새 logic 의 isolation, 매 test 의 가능"**. Michael Feathers 의 *Working Effectively with Legacy Code* (2004) 의 핵심 technique. 매 legacy code 의 modification 시 매 직접 수정 X — 매 옆에 새 method 의 grow.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **도입 배경:** 거대한 코드 덩어리(Big lumps of code)는 중력을 가진 것처럼 더 많은 코드를 끌어당기는 성질이 있어, 이미 2,000줄이 넘는 클래스에 단순히 `if` 문 몇 개를 추가하는 방식으로 작업하면 유지보수가 매우 어려워집니다 [1]. 스프라우트 메서드는 테스트 코드를 작성할 시간이 없는 긴박한 상황에서 이러한 레거시 코드의 악순환을 끊기 위해 사용됩니다 [1].
|
||||
* **실행 단계:**
|
||||
1. **새로운 코드 격리 및 생성:** 추가해야 할 신규 비즈니스 로직을 기존 레거시 코드 밖의 완전히 새로운 위치(다른 메서드 등)에 작성합니다 [2].
|
||||
2. **단위 테스트 작성:** 새로 분리된 코드는 기존의 엉킨 의존성과 분리되어 있으므로 쉽게 단위 테스트를 작성할 수 있습니다 [2].
|
||||
3. **삽입 지점 식별:** 기존 레거시 코드 내에서 새로운 코드가 호출되어야 할 정확한 위치(Insertion point)를 찾습니다 [2].
|
||||
4. **호출 연결:** 기존 코드의 삽입 지점에서 새로 작성한 격리된 메서드를 호출하여 최소한의 변경만으로 로직을 통합합니다 [2].
|
||||
* **적용 범위:** 단일 메서드(Sprout Method) 수준뿐만 아니라 전체 클래스(Sprout Class), 혹은 새로운 코드를 격리할 수 있는 그 어떤 단위로도 확장하여 적용할 수 있습니다 [2, 4]. 기존의 거대한 메서드를 직접 건드리는 대신 호출만 추가하므로 위험을 최소화할 수 있습니다 [3].
|
||||
## 매 핵심
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
이 기법은 이상적인 해결책은 아니며 몇 가지 함정(pitfalls)을 내포하고 있습니다 [5]. 스프라우트 메서드를 사용하면 새로 추가된 코드의 안정성은 보장할 수 있지만, 기존의 테스트되지 않은 레거시 코드는 여전히 복잡한 상태 그대로 남게 됩니다 [5]. 즉, 근본적인 기술 부채를 상환하는 전면적인 리팩토링이라기보다는, 테스트가 없고 복잡한 레거시 코드를 제한된 시간 내에 다루기 위해 사용하는 실용적이고 우회적인 도구(Workaround)에 가깝습니다 [3, 5, 6].
|
||||
### 매 motivation
|
||||
- **Legacy method**: 매 too long, too coupled, 매 test 의 X.
|
||||
- **새 feature 의 add 필요**: 매 직접 수정 → 매 risk 의 폭발.
|
||||
- **Sprout**: 매 new logic 의 separate method, 매 test 의 first, 매 caller 의 단순 call.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
### 매 절차
|
||||
1. **Identify** 매 change point.
|
||||
2. **Write** 매 새 method (with tests) — empty 매 body, 매 signature first.
|
||||
3. **Test-drive** 매 새 method 의 구현.
|
||||
4. **Call** 매 새 method 의 from legacy code (one line).
|
||||
5. 매 legacy code 의 거의 untouched.
|
||||
|
||||
#### [레거시 코드 처리 기법]
|
||||
- [[Wrap Method (랩 메서드)]]
|
||||
- 연결 이유: 스프라우트 메서드와 함께 레거시 코드에 시간을 들이지 않고 안전하게 새로운 코드를 추가하기 위해 사용되는 대표적인 동반 기법입니다 [1, 7].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 새로운 로직이 기존 로직의 실행 전이나 후에 들어가야 할 때, 기존 메서드 자체를 감싸는(Wrap) 방식으로 테스트 가능한 Seam(접점)을 만드는 접근법을 배울 수 있습니다 [7].
|
||||
### 매 응용
|
||||
1. Bug fix 의 add — 매 새 validation 의 sprout.
|
||||
2. Feature flag 의 add — 매 새 conditional 의 sprout.
|
||||
3. Logging 의 add — 매 새 logger call 의 sprout.
|
||||
|
||||
#### [테스트 및 구조 분리]
|
||||
- [[Seam (접점)]]
|
||||
- 연결 이유: 레거시 코드 내에서 소스 코드를 직접 수정하지 않고도 프로그램의 동작을 바꿀 수 있는 지점으로, 스프라우트 메서드 및 랩 메서드의 근간이 되는 개념입니다 [5, 8, 9].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 객체지향 언어 등에서 테스트를 위해 기존 코드의 의존성을 깨뜨리고 새로운 동작을 주입하거나 격리하는 원리를 파악할 수 있습니다 [8, 9].
|
||||
- [[Unit Test (단위 테스트)]]
|
||||
- 연결 이유: 스프라우트 메서드의 핵심 중 하나는 새로 분리해 낸 로직에 대해서 빠르고 고립된 형태의 단위 테스트를 작성하는 것입니다 [2, 10].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 단위 테스트가 어떻게 레거시 코드의 회귀(Regression) 방지를 위한 가장 빠르고 신뢰할 수 있는 피드백 루프 역할을 하는지 이해할 수 있습니다 [10, 11].
|
||||
- [[Legacy Code (레거시 코드)]]
|
||||
- 연결 이유: 마이클 페더스(Michael Feathers)는 레거시 코드를 "테스트가 없는 코드"로 정의했으며, 스프라우트 메서드는 전적으로 이 레거시 코드를 다루기 위해 고안되었습니다 [6, 9].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 테스트가 부재할 때 발생하는 변경의 위험성과, 이를 극복하기 위한 전체 알고리즘(의존성 깨기 -> 테스트 작성 -> 기능 변경 -> 리팩토링)을 포괄적으로 이해할 수 있습니다 [3, 12].
|
||||
## 💻 패턴
|
||||
|
||||
### Deeper Research Questions
|
||||
- 스프라우트 메서드(Sprout Method)와 랩 메서드(Wrap Method) 중 어느 것을 선택해야 하는지 결정하는 구체적인 코드 구조적 기준과 트레이드오프는 무엇인가?
|
||||
- 레거시 시스템에서 스프라우트 메서드를 과도하게 남용할 경우 발생하는 클래스나 메서드의 파편화(Fragmentation) 문제를 방지할 수 있는 설계적 가이드라인은 무엇인가?
|
||||
- 스프라우트 클래스(Sprout Class)를 적용할 때, 기존 레거시 클래스와의 데이터 의존성을 어떻게 최소화하면서 상태를 주고받을 수 있는가?
|
||||
- 객체 지향 언어가 아닌 절차적 프로그래밍(Procedural Programming) 환경에서 스프라우트 메서드를 적용할 때 삽입 지점을 확보하는 방식은 어떻게 달라지는가?
|
||||
- 스프라우트 메서드 적용을 통해 단위 테스트 커버리지를 확보한 이후, 궁극적인 전체 리팩토링으로 넘어가기 위한 효과적인 전략은 무엇인가?
|
||||
|
||||
### Practical Application Contexts
|
||||
- **Implementation:** 거대하고 테스트가 불가능한 레거시 메서드 내부에 새로운 비즈니스 조건 처리를 끼워 넣어야 할 때, 신규 조건 로직을 독립된 함수로 구현하여 테스트하고 기존 메서드에서는 단 한 줄의 함수 호출만 추가한다 [2, 3].
|
||||
- **System Design:** 레거시 영역과 신규 개발 영역을 과도기적으로 분리하는 시스템 아키텍처 환경에서, 기존 코드를 크게 손상시키지 않고 신규 로직의 모듈화와 테스트 커버리지를 강제할 수 있다 [1, 2].
|
||||
- **Operation / Maintenance:** 운영 환경에서 긴급한 패치나 버그 픽스가 필요하지만 전체 시스템의 회귀 테스트를 작성할 시간이 없을 때, 부수 효과(Side effect)를 통제하며 안전하게 수정 사항을 배포하기 위한 임시 방편으로 사용한다 [1].
|
||||
- **Learning Path:** 마이클 페더스의 레거시 대처법을 학습할 때, '레거시 코드 파악' -> '접점(Seam) 식별' -> '스프라우트/랩 기법 적용을 통한 부분적 테스트 확보' -> '안전한 점진적 리팩토링'의 순서로 이어지는 실무 전략을 체득하는 경로로 활용된다 [3, 12].
|
||||
- **My Project Relevance:** 시간이 매우 부족하고 테스트 커버리지가 낮은 현재 레거시 유지보수 프로젝트 환경에서, 무리하게 기존 코드를 뜯어고치는 대신 당장의 요구사항을 안전하게 반영하기 위한 실용적 타협안으로 즉시 적용할 수 있다 [1, 3].
|
||||
|
||||
### Adjacent Topics
|
||||
- [[Strangler Pattern (교살자 패턴)]]
|
||||
- 확장 방향: 스프라우트 메서드가 함수나 클래스 레벨의 부분적인 로직 격리라면, 교살자 패턴은 아키텍처 레벨에서 레거시 시스템 전체를 서서히 새로운 시스템으로 점령하고 대체해 나가는 거시적 전략으로 그 이해를 확장할 수 있습니다 [3].
|
||||
- [[Approval Testing (승인 테스트)]]
|
||||
- 확장 방향: 기존 레거시 코드가 내부적으로 어떻게 동작하는지 정확히 모를 때, 결과물만을 기록하여 보호하는 테스트 방식으로, 스프라우트 기법을 적용하기 전후의 회귀(Regression)를 방지하기 위해 함께 연계하여 조사할 가치가 있습니다 [3, 13].
|
||||
|
||||
---
|
||||
*Last updated: 2026-05-03*
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
### Before sprout
|
||||
```java
|
||||
public class OrderProcessor {
|
||||
public void process(Order order) {
|
||||
// 100+ lines of untested legacy logic
|
||||
repository.save(order);
|
||||
emailService.send(order.getCustomer(), "thanks");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Sprout method 의 적용
|
||||
```java
|
||||
public class OrderProcessor {
|
||||
public void process(Order order) {
|
||||
// 100+ lines untouched
|
||||
repository.save(order);
|
||||
sendOrderConfirmation(order); // sprouted
|
||||
}
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
// New method — fully tested
|
||||
void sendOrderConfirmation(Order order) {
|
||||
var template = order.isPriority()
|
||||
? "priority-thanks"
|
||||
: "thanks";
|
||||
emailService.send(order.getCustomer(), template);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Test 의 새 method (JUnit 5)
|
||||
```java
|
||||
@Test
|
||||
void priorityOrder_usesPriorityTemplate() {
|
||||
var order = new Order(customer, true);
|
||||
var sut = new OrderProcessor(repo, emailMock);
|
||||
sut.sendOrderConfirmation(order);
|
||||
verify(emailMock).send(customer, "priority-thanks");
|
||||
}
|
||||
```
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
### Sprout function (procedural)
|
||||
```python
|
||||
def process_order(order):
|
||||
# Legacy logic untouched
|
||||
db.save(order)
|
||||
notify_customer(order) # sprouted free function
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
def notify_customer(order):
|
||||
# New, tested logic
|
||||
template = "priority" if order.priority else "standard"
|
||||
email.send(order.customer, template)
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### Sprout 의 static helper
|
||||
```java
|
||||
class LegacyService {
|
||||
void run() {
|
||||
var data = fetch();
|
||||
var clean = LegacyService.normalize(data); // sprouted static
|
||||
write(clean);
|
||||
}
|
||||
static String normalize(String s) { return s.strip().toLowerCase(); }
|
||||
}
|
||||
```
|
||||
|
||||
### Visibility 의 package-private (testability)
|
||||
```java
|
||||
// package-private for test access
|
||||
void sendOrderConfirmation(Order order) { ... }
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| Legacy method 의 too risky to refactor | Sprout method |
|
||||
| 매 새 logic 의 self-contained | Sprout method |
|
||||
| 매 변경 의 cross-cutting | Sprout class 의 사용 |
|
||||
| 매 method 의 caller 의 wrapping 필요 | Wrap method (sibling technique) |
|
||||
| 매 ample test coverage 의 존재 | 매 직접 refactor |
|
||||
|
||||
**기본값**: 매 legacy code change → sprout method first. 매 직접 수정 X.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Working Effectively with Legacy Code]] · [[Refactoring]]
|
||||
- 변형: [[Sprout & Wrap Techniques (스프라우트 & 랩 기법)]] · [[Sprout Class]]
|
||||
- 응용: [[Legacy Code Modernization]] · [[Test-Driven Development]]
|
||||
- Adjacent: [[Strangler Fig Pattern]] · [[Characterization Tests]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 legacy codebase 의 small additive change, 매 surrounding code 의 untested.
|
||||
**언제 X**: 매 greenfield code (그냥 inline), 매 logic 의 deeply intertwined (Wrap 의 사용).
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Sprout 의 then leave**: 매 sprouted method 의 grow 의 indefinite — 매 결국 same problem.
|
||||
- **No tests for sprout**: 매 point 의 lost — 매 sprout 의 핵심 value 의 testability.
|
||||
- **Sprout into same class**: 매 class 의 already God class → sprout class 의 사용.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Feathers, *WELC* ch.6, 2004; Fowler refactoring catalog).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — full sprout method spec with Java/Python patterns |
|
||||
|
||||
Reference in New Issue
Block a user