Flutter Architecture Guide

Code Convention

1. SpringBoot Code Convention
2. Flutter Code Convention
3. Flutter Architecture Guide

목록보기

에셋 폴더

• assets/
  앱에서 사용하는 모든 에셋 파일을 정리합니다. 예: 폰트, 이미지, 아이콘, JSON 파일 등
  • font/ : 커스텀 폰트 파일(ttf, otf 등)
  • icon/ : 앱에서 사용하는 아이콘 파일(svg, png 등)
  • image/ : 일반 이미지 리소스(jpg, png 등)

flutter: 
  ... 
  assets: 
    - assets/font/example.txt 
    - assets/icon/example.txt 

코어 폴더: lib/

1. main.dart

• Flutter 앱의 진입점(Entry Point)입니다. runApp(MyApp())을 호출하여 앱을 실행합니다.
• MultiProvider 설정이 필요 없으며, ProviderScope로 Riverpod 상태를 감쌉니다.

2. models/

• 데이터 모델을 정의하는 폴더입니다.
• 예: UserModel, ProductModel 등
• 주로 JSON 직렬화/역직렬화, 데이터 클래스, 엔티티를 정의합니다.

3. providers/

• Riverpod 패턴을 활용해 상태 관리 로직을 담당합니다.
• ChangeNotifier 대신 StateNotifier + StateNotifierProvider를 사용해 상태를 관리합니다.
• 예: UserProvider, AuthProvider, ThemeProvider 등

4. screens/

• 앱의 UI 화면(Page, Screen)을 담당합니다.
• 예: HomeScreen, LoginScreen, ProfileScreen 등
• 각 스크린에서 ConsumerWidget 또는 Consumer를 사용해 Riverpod 상태를 구독하고 UI를 업데이트합니다.

5. services/

• 비즈니스 로직, API 통신, 데이터베이스 접근 등 핵심 로직을 처리합니다.
• 예: ApiService, AuthService, LocalStorageService 등
• Riverpod의 ref.read(...)를 사용해 서비스 로직과 상호작용할 수 있습니다.

6. utils/

• 재사용 가능한 유틸리티 코드(함수, 상수, 포맷터 등)를 보관합니다.
• 예: constants.dart(상수), validators.dart(입력값 검증), date_formatter.dart(날짜 포맷) 등
• 특정 화면이나 로직에 국한되지 않고, 전역적으로 사용할 수 있는 헬퍼 코드가 들어갑니다.