기능별 vs 계층별 폴더 구조

Flutter 프로젝트를 시작할 때 가장 중요한 결정 중 하나는 코드를 어떻게 구성할 것인지 결정하는 것입니다. 적절한 프로젝트 구조는 코드의 가독성을 높이고, 확장성을 향상시키며, 팀 협업을 원활하게 합니다. 이 문서에서는 두 가지 주요 프로젝트 구조 접근 방식인 ‘기능별 구조’와 ‘계층별 구조’에 대해 살펴보고, 각각의 장단점 및 적합한 사용 사례를 분석합니다.

프로젝트 구조의 중요성

좋은 프로젝트 구조는 다음과 같은 이점을 제공합니다:

새로운 개발자의 온보딩 시간 단축: 직관적인 구조는 새로운 팀원이 프로젝트를 더 빠르게 이해하도록 돕습니다.
코드 충돌 감소: 잘 정의된 구조는 여러 개발자가 동시에 작업할 때 충돌을 줄입니다.
기능 구현 시간 단축: 관련 코드를 쉽게 찾고 수정할 수 있습니다.
테스트 용이성: 모듈화된 구조는 테스트를 더 쉽게 작성하고 실행할 수 있게 합니다.
코드 재사용 촉진: 잘 구성된 구조는 코드 재사용을 장려하고 중복을 줄입니다.

계층별 폴더 구조

계층별 폴더 구조(Layer-based Structure)는 코드를 기술적 관심사 또는 아키텍처 계층에 따라 구성하는 방식입니다.

계층별 구조의 기본 예시

Directorylib/
- Directorymodels/ # 데이터 모델 클래스
  - user.dart
  - product.dart
  - order.dart
- Directoryviews/ # UI 컴포넌트 및 화면
  - home_screen.dart
  - product_screen.dart
  - profile_screen.dart
- Directorycontrollers/ # 비즈니스 로직 및 상태 관리
  - auth_controller.dart
  - product_controller.dart
  - order_controller.dart
- Directoryservices/ # 외부 서비스 통신 (API, 데이터베이스 등)
  - api_service.dart
  - storage_service.dart
  - analytics_service.dart
- Directoryutils/ # 유틸리티 함수 및 상수
  - constants.dart
  - extensions.dart
  - helpers.dart
- main.dart

계층별 구조의 변형: MVVM 패턴

Directorylib/
- Directorydata/
  - Directorymodels/ # 데이터 모델
    …
  - Directoryrepositories/ # 데이터 액세스 계층
    …
  - Directorydata_sources/ # 로컬/원격 데이터 소스
    …
- Directorydomain/
  - Directoryentities/ # 비즈니스 모델
    …
  - Directoryrepositories/ # 리포지토리 인터페이스
    …
  - Directoryusecases/ # 비즈니스 규칙 및 로직
    …
- Directorypresentation/
  - Directorypages/ # 화면
    …
  - Directorywidgets/ # 재사용 가능한 UI 컴포넌트
    …
  - Directoryviewmodels/ # 뷰 모델 (상태 관리)
    …
- Directorycore/
  - Directoryutils/ # 유틸리티 함수
    …
  - Directoryconstants/ # 상수
    …
  - Directorytheme/ # 앱 테마
    …
- main.dart

계층별 구조의 장점

기술적 관심사 분리: 코드를 역할에 따라 명확하게 구분합니다.
구조 이해 용이성: 새로운 개발자가 아키텍처를 쉽게 이해할 수 있습니다.
역할 기반 작업 분담: 프론트엔드/백엔드 개발자가 각자 담당 영역에 집중할 수 있습니다.
유사한 코드 패턴: 같은 계층에 있는 코드는 유사한 패턴을 따르기 쉽습니다.
기술 스택 변경 용이성: 특정 계층의 기술을 교체할 때 영향 범위가 제한적입니다.

계층별 구조의 단점

관련 코드 분산: 하나의 기능을 구현하기 위해 여러 폴더를 탐색해야 합니다.
파일 수 증가에 따른 복잡성: 프로젝트가 커지면 각 폴더의 파일 수가 많아져 찾기 어려워집니다.
기능 추가 시 여러 폴더 수정: 새 기능 추가 시 여러 폴더에 걸쳐 파일을 생성/수정해야 합니다.
관련 코드의 결합도 파악 어려움: 서로 다른 폴더에 있는 관련 코드 간의 관계를 파악하기 어렵습니다.
코드 재사용 저해: 특정 기능에 특화된 코드를 식별하고 재사용하기 어려울 수 있습니다.

기능별 폴더 구조

기능별 폴더 구조(Feature-based Structure)는 코드를 비즈니스 기능이나 앱의 주요 기능에 따라 구성하는 방식입니다.

기능별 구조의 기본 예시

Directorylib/
- Directoryfeatures/
  - Directoryauth/ # 인증 관련 기능
    Directorydata/
    Directoryrepositories/
    …
    Directorymodels/
    …
    Directorydomain/
    Directoryusecases/
    …
    Directorypresentation/
    Directorypages/
    login_page.dart
    signup_page.dart
    Directorywidgets/
    …
    Directoryproviders/
    …
  - Directoryproducts/ # 제품 관련 기능
    Directorydata/
    …
    Directorydomain/
    …
    Directorypresentation/
    Directorypages/
    product_list_page.dart
    product_detail_page.dart
    Directorywidgets/
    …
    Directoryproviders/
    …
  - Directoryprofile/ # 프로필 관련 기능
    Directorydata/
    …
    Directorydomain/
    …
    Directorypresentation/
    …
- Directorycore/ # 공통 기능
  - Directorynetwork/
    …
  - Directorystorage/
    …
  - Directorytheme/
    …
  - Directoryutils/
    …
- main.dart

기능별 구조의 변형: DDD(Domain-Driven Design) 적용

Directorylib/
- Directoryapplication/ # 애플리케이션 서비스 (UseCase)
  - Directoryauth/
    …
  - Directoryproducts/
    …
  - Directoryprofile/
    …
- Directorydomain/ # 도메인 모델 및 규칙
  - Directoryauth/
    …
  - Directoryproducts/
    …
  - Directoryprofile/
    …
- Directoryinfrastructure/ # 인프라 계층 (리포지토리 구현, 데이터 소스)
  - Directoryauth/
    …
  - Directoryproducts/
    …
  - Directoryprofile/
    …
- Directorypresentation/ # UI 계층
  - Directoryauth/
    …
  - Directoryproducts/
    …
  - Directoryprofile/
    …
- Directoryshared/ # 공통 기능
  - Directoryconstants/
    …
  - Directoryextensions/
    …
  - Directorywidgets/
    …
- main.dart

기능별 구조의 장점

관련 코드 근접성: 하나의 기능과 관련된 모든 코드가 같은 폴더에 위치합니다.
독립적인 기능 개발: 각 기능을 독립적으로 개발하고 테스트할 수 있습니다.
기능 단위의 캡슐화: 각 기능은 자체 모델, 뷰, 로직을 포함하여 자율적입니다.
기능별 작업 분담: 팀원이 특정 기능에 집중하여 작업할 수 있습니다.
확장성: 새로운 기능을 추가할 때 기존 코드를 변경할 필요가 적습니다.
코드 재사용: 기능별로 특화된 코드를 쉽게 식별하고 재사용할 수 있습니다.

기능별 구조의 단점

중복 코드 가능성: 여러 기능 간에 유사한 코드가 중복될 수 있습니다.
일관성 유지 어려움: 각 기능별로 다른 패턴이 적용될 수 있습니다.
기능 간 경계 설정 어려움: 어떤 코드가 어느 기능에 속하는지 결정하기 어려울 수 있습니다.
공통 코드 관리: 여러 기능에서 사용하는 공통 코드의 위치를 결정하기 어려울 수 있습니다.
아키텍처 이해의 어려움: 전체 아키텍처를 한눈에 파악하기 어려울 수 있습니다.

실제 프로젝트 구조 예시: Riverpod + GoRouter

계층별 구조 예시

Directorylib/
- Directorymodels/ # 데이터 모델
  - user.dart
  - product.dart
  - order.dart
- Directoryproviders/ # Riverpod 프로바이더
  - auth_provider.dart
  - product_provider.dart
  - cart_provider.dart
- Directoryrepositories/ # 데이터 액세스 계층
  - auth_repository.dart
  - product_repository.dart
  - order_repository.dart
- Directoryscreens/ # 화면 위젯
  - Directoryauth/
    login_screen.dart
    signup_screen.dart
  - Directoryproducts/
    product_list_screen.dart
    product_detail_screen.dart
  - Directoryprofile/
    profile_screen.dart
- Directorywidgets/ # 재사용 위젯
  - product_card.dart
  - custom_button.dart
  - loading_indicator.dart
- Directoryrouter/ # GoRouter 설정
  - router.dart
- Directoryutils/ # 유틸리티
  - constants.dart
  - extensions.dart
- main.dart

기능별 구조 예시

Directorylib/
- Directoryfeatures/
  - Directoryauth/
    Directorymodels/
    user.dart
    Directoryrepositories/
    auth_repository.dart
    Directoryproviders/
    auth_provider.dart
    Directoryscreens/
    login_screen.dart
    signup_screen.dart
    Directorywidgets/
    login_form.dart
    social_login_buttons.dart
  - Directoryproducts/
    Directorymodels/
    product.dart
    Directoryrepositories/
    product_repository.dart
    Directoryproviders/
    product_provider.dart
    Directoryscreens/
    product_list_screen.dart
    product_detail_screen.dart
    Directorywidgets/
    product_card.dart
  - Directorycart/
    Directorymodels/
    cart_item.dart
    Directoryrepositories/
    cart_repository.dart
    Directoryproviders/
    cart_provider.dart
    Directoryscreens/
    cart_screen.dart
    checkout_screen.dart
    Directorywidgets/
    cart_item_widget.dart
- Directorycore/
  - Directoryrouter/
    router.dart
  - Directorytheme/
    app_theme.dart
  - Directorywidgets/
    custom_button.dart
    loading_indicator.dart
  - Directoryutils/
    constants.dart
    extensions.dart
- main.dart

하이브리드 접근 방식

많은 실제 프로젝트에서는 두 가지 접근 방식을 혼합하여 사용합니다. 다음은 하이브리드 구조의 예시입니다:

Directorylib/
- Directoryfeatures/ # 주요 기능별 구성
  - Directoryauth/
    …
  - Directoryproducts/
    …
  - Directorycart/
    …
- Directoryshared/ # 공유 컴포넌트
  - Directorymodels/ # 공통 모델
    …
  - Directorywidgets/ # 공통 위젯
    …
  - Directoryservices/ # 공통 서비스
    …
  - Directoryutils/ # 유틸리티
    …
- Directorycore/ # 핵심 인프라
  - Directorynetwork/ # 네트워크 관련
    …
  - Directorystorage/ # 로컬 스토리지
    …
  - Directorydi/ # 의존성 주입
    …
  - Directoryrouter/ # 라우팅
    …
- main.dart

이 접근 방식은 다음과 같은 이점을 제공합니다:

주요 기능의 독립성: 핵심 기능은 독립적으로 구성
공통 코드 관리: 여러 기능에서 공유하는 코드는 중앙에서 관리
핵심 인프라 분리: 앱의 기반이 되는 인프라 코드를 명확하게 분리
유연성: 프로젝트 요구사항에 맞게 구조를 조정할 수 있음

Riverpod과 함께 사용하는 패턴

Riverpod을 사용할 때는 프로바이더를 어떻게 구성할지도 중요한 고려 사항입니다:

계층별 구조에서의 Riverpod 패턴

1
final productRepositoryProvider = Provider<ProductRepository>((ref) {
2
  return ProductRepositoryImpl(ref.read(apiServiceProvider));
3
});
4

5
final productsProvider = FutureProvider<List<Product>>((ref) async {
6
  final repository = ref.watch(productRepositoryProvider);
7
  return repository.getProducts();
8
});
9

10
final productDetailsProvider = FutureProvider.family<Product, String>((ref, id) async {
11
  final repository = ref.watch(productRepositoryProvider);
12
  return repository.getProductById(id);
13
});

기능별 구조에서의 Riverpod 패턴

1
final productRepositoryProvider = Provider<ProductRepository>((ref) {
2
  return ProductRepositoryImpl(ref.read(apiServiceProvider));
3
});
4

5
final productsProvider = FutureProvider<List<Product>>((ref) async {
6
  final repository = ref.watch(productRepositoryProvider);
7
  return repository.getProducts();
8
});
9

10
final productDetailsProvider = FutureProvider.family<Product, String>((ref, id) async {
11
  final repository = ref.watch(productRepositoryProvider);
12
  return repository.getProductById(id);
13
});

추천 패턴: 계층적 프로바이더 구성

1
// 1. 데이터 소스 프로바이더 (최하위 계층)
2
@riverpod
3
ProductDataSource productDataSource(ProductDataSourceRef ref) {
4
  final apiClient = ref.watch(apiClientProvider);
5
  return ProductDataSourceImpl(apiClient);
6
}
7

8
// 2. 리포지토리 프로바이더
9
@riverpod
10
ProductRepository productRepository(ProductRepositoryRef ref) {
11
  final dataSource = ref.watch(productDataSourceProvider);
12
  return ProductRepositoryImpl(dataSource);
13
}
14

15
// 3. 유스케이스 프로바이더 (선택적)
16
@riverpod
17
GetProductsUseCase getProductsUseCase(GetProductsUseCaseRef ref) {
18
  final repository = ref.watch(productRepositoryProvider);
19
  return GetProductsUseCase(repository);
20
}
21

22
// 4. 상태 프로바이더
23
@riverpod
24
class ProductsNotifier extends _$ProductsNotifier {
25
  @override
26
  FutureOr<List<Product>> build() async {
27
    return _fetchProducts();
28
  }
29

30
  Future<List<Product>> _fetchProducts() {
31
    final useCase = ref.watch(getProductsUseCaseProvider);
32
    return useCase.execute();
33
  }
34

35
  Future<void> refresh() async {
36
    state = const AsyncValue.loading();
37
    state = await AsyncValue.guard(_fetchProducts);
38
  }
39
}

어떤 구조를 선택해야 할까?

프로젝트 구조 선택 시 고려해야 할 요소:

계층별 구조가 적합한 경우

소규모 프로젝트: 기능이 적고 단순한 앱
명확한 기술적 분리: 프론트엔드/백엔드 개발자 역할이 명확히 구분된 팀
아키텍처 패턴 중시: MVC, MVVM과 같은 아키텍처 패턴을 엄격히 따르고자 할 때
초보 개발자 팀: 명확한 폴더 구조가 필요한 경우

기능별 구조가 적합한 경우

중대형 프로젝트: 다양한 기능이 있는 복잡한 앱
수직적 팀 구조: 팀원이 특정 기능을 전담하는 경우
마이크로서비스 지향: 각 기능을 독립적으로 개발/테스트하고자 할 때
기능 단위 배포: 기능별로 점진적 배포를 계획하는 경우
도메인 중심 설계: DDD(Domain-Driven Design) 원칙을 따르는 경우

실제 업계 사례

대형 Flutter 앱들의 구조를 살펴보면 다음과 같은 패턴을 볼 수 있습니다:

Google의 Flutter 샘플 앱: 기능별 구조를 선호 (Flutter Gallery, Flutter Samples)
Alibaba의 Flutter 앱: 하이브리드 구조 채택 (일부 공통 모듈은 계층별, 주요 기능은 기능별)
중소규모 앱: 초기에는 계층별 구조로 시작하여 점차 기능별 또는 하이브리드 구조로 전환하는 경향

결론

프로젝트 구조는 정답이 없는 주제입니다. 중요한 것은 팀과 프로젝트 특성에 맞는 구조를 선택하고, 일관성 있게 유지하는 것입니다.

소규모/단순 앱: 계층별 구조가 직관적이고 빠르게 구성 가능
중대형/복잡한 앱: 기능별 구조 또는 하이브리드 구조가 유지보수와 확장성에 유리
성장 예상 앱: 처음부터 기능별 구조 또는 하이브리드 구조로 시작하는 것이 장기적으로 유리

어떤 구조를 선택하든, 코드 가독성, 유지보수성, 확장성, 팀 협업 용이성이라는 핵심 목표를 기억하며 구조를 설계해야 합니다. 또한 프로젝트가 발전함에 따라 구조를 재평가하고 필요에 따라 조정하는 유연성을 유지하는 것이 중요합니다.