flutter-bloc-development
npx skills add https://github.com/abdelhakrazi/flutter-bloc-clean-architecture-skill --skill flutter-bloc-development
Agent 安装分布
Skill 文档
Flutter BLoC Development
This skill enforces BLoC state management, strict layer separation, and mandatory use of design system constants for all Flutter development in this codebase.
Decision Tree: Choosing Your Approach
User task â What are they building?
â
ââ New screen/feature â Full feature implementation:
â 1. Create feature folder (lib/[feature]/)
â 2. Define BLoC (bloc/[feature]_event.dart, _state.dart, _bloc.dart)
â 3. Create data layer (data/datasources/, data/repositories/, data/models/)
â 4. Build UI (view/[feature]_page.dart, view/widgets/)
â 5. Create barrel files ([feature].dart, data/data.dart, view/view.dart)
â
ââ New widget only â Presentation layer:
â 1. Feature-specific: feature/view/widgets/
â 2. Shared/reusable: shared/widgets/
â 3. Use design system constants (NO hardcoded values)
â 4. Connect to existing BLoC if needed
â
ââ Data integration â Data layer only:
â 1. Create datasource (feature/data/datasources/)
â 2. Create repository (feature/data/repositories/)
â 3. Wire up in existing or new BLoC
â
ââ Refactoring â Identify violations:
1. Check for hardcoded colors/spacing/typography
2. Check for business logic in UI
3. Check for direct SDK calls outside datasources
4. Check for missing Loading state before async operations
5. Check for missing Equatable on Events/States
6. Check for improper error handling (use SnackBar + AppColors.error)
Architecture at a Glance
Feature-first structure (official BLoC recommendation):
lib/
âââ [feature]/ # Feature folder (e.g., earnings/, auth/, trips/)
â âââ bloc/
â â âââ [feature]_bloc.dart
â â âââ [feature]_event.dart
â â âââ [feature]_state.dart
â âââ data/
â â âââ datasources/ # Feature-specific API calls
â â âââ repositories/ # Data orchestration
â â âââ models/ # Feature-specific DTOs
â â âââ data.dart # Data layer barrel file
â âââ view/
â â âââ [feature]_page.dart # Main screen
â â âââ widgets/ # Feature-specific widgets
â â âââ view.dart # View barrel file
â âââ [feature].dart # Feature barrel file
âââ shared/ # Cross-feature code
â âââ data/
â â âââ datasources/ # Shared API clients (ApiClient, UserDataSource)
â â âââ models/ # Shared models (User, ApiResponse)
â â âââ data.dart # Shared data barrel file
â âââ widgets/ # Reusable UI components
â âââ utils/ # Design system (colors, spacing, typography)
âââ app.dart # App entry point
When to Use Feature vs Shared Data
| Scenario | Location | Example |
|---|---|---|
| API endpoints used by ONE feature | feature/data/ |
EarningsDataSource â /api/earnings/... |
| API client/service used by MANY features | shared/data/ |
ApiClient, UserDataSource |
| Models used by ONE feature | feature/data/models/ |
EarningsSummary |
| Models used by MANY features | shared/data/models/ |
User, ApiResponse |
Barrel Files â Single import per layer:
// Feature barrel: earnings/earnings.dart
export 'bloc/earnings_bloc.dart';
export 'bloc/earnings_event.dart';
export 'bloc/earnings_state.dart';
export 'data/data.dart';
export 'view/view.dart';
// Data layer barrel: earnings/data/data.dart
export 'datasources/earnings_datasource.dart';
export 'repositories/earnings_repository.dart';
export 'models/earnings_summary.dart';
// Shared data barrel: shared/data/data.dart
export 'datasources/api_client.dart';
export 'datasources/user_datasource.dart';
export 'models/user.dart';
Key Rules:
- All state changes flow through BLoC
- No direct backend SDK calls outside datasources
- Zero hardcoded values (colors, spacing, typography)
- Repository pattern for all data access
- Feature-specific code stays in feature folder
- Shared code (used by 2+ features) goes in
shared/
BLoC Implementation
Event â State â BLoC (Three Files Per Feature)
Events â User actions and system triggers:
abstract class FeatureEvent extends Equatable {
const FeatureEvent();
List<Object?> get props => [];
}
class FeatureActionRequested extends FeatureEvent {
final String param;
const FeatureActionRequested({required this.param});
List<Object> get props => [param];
}
States â All possible UI states:
abstract class FeatureState extends Equatable {
const FeatureState();
List<Object?> get props => [];
}
class FeatureInitial extends FeatureState {}
class FeatureLoading extends FeatureState {}
class FeatureSuccess extends FeatureState {
final DataType data;
const FeatureSuccess(this.data);
List<Object> get props => [data];
}
class FeatureError extends FeatureState {
final String message;
const FeatureError(this.message);
List<Object> get props => [message];
}
BLoC â Event handlers with Loading â Success/Error pattern:
class FeatureBloc extends Bloc<FeatureEvent, FeatureState> {
final FeatureRepository _repository;
FeatureBloc({required FeatureRepository repository})
: _repository = repository,
super(FeatureInitial()) {
on<FeatureActionRequested>(_onActionRequested);
}
Future<void> _onActionRequested(
FeatureActionRequested event,
Emitter<FeatureState> emit,
) async {
emit(FeatureLoading());
try {
final result = await _repository.doSomething(event.param);
emit(FeatureSuccess(result));
} catch (e) {
emit(FeatureError(e.toString()));
}
}
}
CRITICAL: Always emit Loading before async work, then Success or Error. Never skip the loading state.
Data Layer
Data Flow:
UI Event â BLoC (emit Loading) â Repository â Datasource (SDK)
â
Response â Repository (map to entity) â BLoC (emit Success/Error) â UI
Datasource â Backend SDK calls only:
class FeatureDataSource {
final SupabaseClient _supabase;
FeatureDataSource(this._supabase);
Future<Map<String, dynamic>> fetch() async {
return await _supabase.from('table').select().single();
}
}
Repository â Orchestration and mapping:
class FeatureRepository {
final FeatureDataSource _dataSource;
FeatureRepository(this._dataSource);
Future<DomainEntity> fetchData() async {
final response = await _dataSource.fetch();
return DomainEntity.fromJson(response);
}
}
Design System (Non-Negotiable)
Colors
â
AppColors.primary, AppColors.error, AppColors.textPrimary
â Color(0xFF...), Colors.blue, inline hex values
Spacing
â
AppSpacing.xs (4), AppSpacing.sm (8), AppSpacing.md (16), AppSpacing.lg (24), AppSpacing.xl (32)
â
AppSpacing.screenHorizontal (24), AppSpacing.screenVertical (16)
â EdgeInsets.all(16.0), hardcoded padding values
Border Radius
â
AppRadius.sm (8), AppRadius.md (12), AppRadius.lg (16), AppRadius.xl (24)
â BorderRadius.circular(12), inline radius values
Typography
â
AppTypography.headlineLarge, AppTypography.bodyMedium, theme.textTheme.bodyMedium
â TextStyle(fontSize: 16), inline text styles
UI Patterns
Screen Template
GradientScaffold(
body: SafeArea(
child: Column(
children: [
Padding(
padding: const EdgeInsets.all(AppSpacing.screenHorizontal),
child: HeaderWidget(),
),
Expanded(
child: SingleChildScrollView(
padding: const EdgeInsets.symmetric(horizontal: AppSpacing.screenHorizontal),
child: ContentWidget(),
),
),
Padding(
padding: const EdgeInsets.all(AppSpacing.screenHorizontal),
child: ActionButton(
onPressed: () => context.read<FeatureBloc>().add(ActionEvent()),
),
),
],
),
),
)
BLoC Consumer Pattern
BlocConsumer<FeatureBloc, FeatureState>(
listener: (context, state) {
if (state is FeatureError) {
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(content: Text(state.message), backgroundColor: AppColors.error),
);
}
},
builder: (context, state) {
if (state is FeatureLoading) return const Center(child: CircularProgressIndicator());
if (state is FeatureSuccess) return SuccessWidget(data: state.data);
return const SizedBox.shrink();
},
)
Common Pitfalls
â Business logic in widgets â Move to BLoC
â Direct Supabase/Firebase calls in repository â Move to datasource
â Skipping loading state before async operations â Always emit Loading first
â Hardcoded colors like Color(0xFF4A90A4) â Use AppColors.primary
â Magic numbers like padding: 16 â Use AppSpacing.md
Quick Reference
| Action | Pattern |
|---|---|
| Dispatch event | context.read<Bloc>().add(Event()) |
| Watch state inline | context.watch<Bloc>().state |
| Listen + Build | BlocConsumer |
| Listen only | BlocListener |
| Build only | BlocBuilder |
Checklist Before Submitting
- Events/States/BLoC use
Equatable - All async: Loading â Success/Error
- No business logic in UI
- No SDK calls outside datasources
- Zero hardcoded colors/spacing/typography
- Error handling shows SnackBar with
AppColors.error - Code formatted with
dart format