类型说明示例StatelessWidget不可变,props 决定 UIText, Icon, ContainerStatefulWidget可变,通过 State 管理变化Checkbox, TextField, Scaffold
dart
class MyWidget extends StatefulWidget {
@override
State<MyWidget> createState() => _MyWidgetState();
}
class _MyWidgetState extends State<MyWidget> {
int _counter = 0;
void _increment() {
setState(() { _counter++; }); // 触发重建
}
}
每个 Widget 的 build() 方法接收 BuildContext。Context 包含:
Theme.of(context)、 MediaQuery.of(context)InheritedWidget"Constraints go down. Sizes go up. Parent sets position."
父 widget 向下传递约束;子 widget 向上报告尺寸;父 widget 决定子 widget 的位置。
类型说明场景Tightmax == min,固定尺寸SizedBox(width: 100)Loosemin == 0,尺寸可变Container() 默认Unboundedmax == double.infinityScrollable、Flex 延伸方向
Widget用途Container通用盒子SizedBox固定尺寸盒子ConstrainedBox施加额外约束Padding内边距Row / Column线性布局(Flex)Expanded填充剩余空间Flexible类似 Expanded,可控制策略Stack绝对定位布局PositionedStack 中定位LayoutBuilder布局阶段获取约束
dart
// ❌ Expanded 在 Stack 中无效 → 用 Positioned 或 Align
// ❌ 在 unbounded 约束中 Expanded 无效 → 用 Slivers
// ✅ ConstrainedBox 在 Loose 约束内
ConstrainedBox(
constraints: BoxConstraints(minWidth: 100, maxWidth: 200),
child: Text('Hello'),
)
详细参考: layout-constraints.md
dart
MaterialApp(
theme: ThemeData(useMaterial3: true),
);
M2M3background``surface``primarySwatch``ColorScheme.fromSeed()``ButtonTheme``FilledButtonTheme``MaterialState``WidgetState``FlatButton``FilledButton
dart
ColorScheme.fromSeed(seedColor: Colors.blue)
详细参考: material-3.md
dart
// 页面 A 和 B
Hero(
tag: 'photo',
child: Image.asset('photo.jpg'),
)
dart
// 一个控制器驱动多个 Interval 动画
Animation<double> get _opacity => Tween(begin: 0.0, end: 1.0).animate(
CurvedAnimation(parent: _controller, curve: Interval(0.0, 0.5)),
);
Animation<double> get _scale => Tween(begin: 0.0, end: 1.0).animate(
CurvedAnimation(parent: _controller, curve: Interval(0.5, 1.0)),
);
详细参考: hero-animations.md | staggered-animations.md
dart
// ChangeNotifier
class CounterModel extends ChangeNotifier {
int _count = 0;
int get count => _count;
void increment() { _count++; notifyListeners(); }
}
// 注册
runApp(ChangeNotifierProvider(
create: (_) => CounterModel(),
child: MyApp(),
));
// 重建 UI
Consumer<CounterModel>(
builder: (context, model, child) => Text('${model.count}'),
);
// 读取(不重建)
final count = context.read<CounterModel>().count;
dart
// 纯 Dart,无 context 依赖
final counterProvider = StateNotifierProvider<CounterNotifier, int>((ref) {
return CounterNotifier();
});
class CounterNotifier extends StateNotifier<int> {
CounterNotifier() : super(0);
void increment() => state++;
}
// 使用
Widget build(BuildContext context, WidgetRef ref) {
final count = ref.watch(counterProvider);
return Text('$count');
}
// ref.watch vs ref.read
// watch: 重建 UI(监听变化)
// read: 不重建,仅读取当前值(事件处理中常用)
// 强制刷新 Provider
ref.invalidate(counterProvider); // 重置状态,重新执行 Provider 回调
// 或者基于现有状态刷新
ref.invalidate(myProvider); // 下次访问时重新创建
// Family Provider(带参数)
final userProvider = Provider.family<User, String>((ref, id) {
return User(id: id, name: 'User $id');
});
// 使用
final user = ref.watch(userProvider('abc'));
dart
// ✅ 顶层 Provider:全局单例
final prefsProvider = Provider<SharedPreferences>((ref) {
return SharedPreferences.getInstance() as SharedPreferences;
});
// ✅ 作用域 Provider:仅在子树内有效
ProviderScope(
overrides: [counterProvider.overrideWith(() => MockCounter())],
child: MyApp(),
);
// ✅ Child Provider:可读取父 Provider
final userProvider = Provider((ref) {
final prefs = ref.watch(prefsProvider); // 依赖父 Provider
return UserRepo(prefs: prefs);
});
dart
class CounterBloc extends Bloc<CounterEvent, int> {
CounterBloc() : super(0) {
on<Increment>((event, emit) => emit(state + 1));
}
}
BlocBuilder<CounterBloc, int>(
builder: (context, count) => Text('$count'),
)
方案复杂度适用场景setState低简单 widgetProvider中中小型应用Riverpod中高生产推荐BLoC高团队协作/大型项目
dart
final prefs = await SharedPreferences.getInstance();
await prefs.setString('username', 'yhong');
await prefs.setInt('counter', 42);
final name = prefs.getString('username') ?? '';
await prefs.remove('counter');
dart
final db = await openDatabase('myapp.db', version: 1,
onCreate: (db, version) async {
await db.execute(
'CREATE TABLE tasks(id INTEGER PRIMARY KEY, title TEXT)');
});
await db.insert('tasks', {'title': 'Finish report'});
final maps = await db.query('tasks', where: 'id = ?', whereArgs: [1]);
// 批量事务
await db.transaction((txn) async {
for (final task in tasks) await txn.insert('tasks', task);
});
dart
Hive.registerAdapter(TaskAdapter());
final box = await Hive.openBox<Task>('tasks');
box.put('task1', Task(title: 'Hello'));
final task = box.get('task1');
dart
final dio = Dio(BaseOptions(
baseUrl: 'https://api.example.com',
connectTimeout: Duration(seconds: 10),
headers: {'Content-Type': 'application/json'},
));
// 全局拦截器:Token 自动附加
dio.interceptors.add(InterceptorsWrapper(
onRequest: (options, handler) {
final token = getToken(); // 从安全存储读取
if (token != null) {
options.headers['Authorization'] = 'Bearer $token';
}
handler.next(options);
},
onError: (error, handler) {
// Token 过期自动刷新重试
if (error.response?.statusCode == 401) {
refreshToken().then((newToken) {
// 重试原请求
final opts = error.requestOptions;
opts.headers['Authorization'] = 'Bearer $newToken';
dio.fetch(opts).then(
(r) => handler.resolve(r),
(e) => handler.reject(e),
);
}).catchError((e) => handler.reject(error));
} else {
handler.next(error);
}
},
));
// GET / POST
final resp = await dio.get('/users', queryParameters: {'page': 1});
final resp = await dio.post('/users', data: {'name': 'yhong'});
dart
// 常见后端响应格式:{ code, data, message }
class ApiResp<T> {
final int code;
final T? data;
final String? message;
bool get ok => code == 0;
}
// Dio 响应拦截器统一解析
dio.interceptors.add(InterceptorsWrapper(
onResponse: (resp, handler) {
final body = resp.data;
if (body is Map && body.containsKey('code')) {
if (body['code'] != 0) {
// 业务错误,转为异常
handler.reject(
DioException(
requestOptions: resp.requestOptions,
error: body['message'] ?? 'Unknown error',
type: DioExceptionType.badResponse,
),
);
return;
}
// 替换为 data 部分
resp.data = body['data'];
}
handler.next(resp);
},
));
// 使用时直接取 data
final List users = await dio.get('/users').then((r) => r.data);
dart
try {
final resp = await dio.get('/users');
} on DioException catch (e) {
switch (e.type) {
case DioExceptionType.connectionTimeout:
// 网络超时
case DioExceptionType.badResponse:
final statusCode = e.response?.statusCode;
if (statusCode == 401) { /* 未授权 */ }
if (statusCode == 403) { /* 禁止 */ }
if (statusCode == 404) { /* 资源不存在 */ }
if (statusCode != null && statusCode >= 500) { /* 服务器错误 */ }
case DioExceptionType.cancel:
// 请求被取消
default:
// 网络不可达等
}
}
dart
@JsonSerializable()
class User {
final String name;
final int age;
factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}
dart
// ✅ Selector 精确重建(替代 Consumer)
Selector<Model, String>(
selector: (_, m) => m.title,
builder: (_, title, __) => Text(title),
);
// ✅ const 构造
const Text('Hello');
const Padding(padding: EdgeInsets.all(16));
// ❌ build 中创建新对象
Widget build(BuildContext context) {
return SomeWidget(items: List.generate(100, (i) => Item(i))); // 每次重建
}
// ✅ initState 中初始化
final items = List.generate(100, (i) => Item(i));
dart
// ✅ ListView.builder 懒加载
ListView.builder(
itemCount: items.length,
itemBuilder: (context, index) => ListTile(title: Text(items[index])),
);
// ✅ cacheExtent
ListView.builder(cacheExtent: 200, itemBuilder: ...);
// ✅ RepaintBoundary 隔离重绘
RepaintBoundary(child: MyComplexWidget());
dart
class AdaptiveScaffold extends StatelessWidget {
@override
Widget build(BuildContext context) {
final width = MediaQuery.of(context).size.width;
if (width < 600) {
return Scaffold(
body: body,
bottomNavigationBar: NavigationBar(
selectedIndex: currentIndex,
onDestinationSelected: onIndexChanged,
destinations: _destinations,
),
);
}
return Scaffold(
body: Row(
children: [
NavigationRail(
selectedIndex: currentIndex,
onDestinationSelected: onIndexChanged,
labelType: width > 840
? NavigationRailLabelType.all
: NavigationRailLabelType.selected,
destinations: _destinations
.map((d) => NavigationRailDestination(
icon: d.icon,
label: d.label,
))
.toList(),
),
const VerticalDivider(thickness: 1, width: 1),
Expanded(child: body),
],
),
);
}
}
dart
LayoutBuilder(
builder: (context, constraints) {
final cols = constraints.maxWidth > 900 ? 3
: constraints.maxWidth > 600 ? 2
: 1;
return GridView.count(
crossAxisCount: cols,
childAspectRatio: 1.5,
children: items.map((item) => Card(child: item)).toList(),
);
},
);
详细参考: adaptive-responsive.md | large-screens.md
dart
final idiom = MediaQuery.of(context).size.shortestSide >= 600 ? 'tablet' : 'phone';
final platform = Theme.of(context).platform;
dart
Shortcuts(
shortcuts: {
LogicalKeySet(LogicalKeyboardKey.control, LogicalKeyboardKey.keyS): SaveIntent(),
},
child: Actions(
actions: { SaveIntent: CallbackAction(onInvoke: (_) => _save()) },
child: focusNode,
),
)
dart
MouseRegion(
onEnter: (_) => setState(() => _isHovered = true),
onExit: (_) => setState(() => _isHovered = false),
child: MyWidget(),
)
详细参考: platform-idioms.md
错误正确❌ 在 build() 中调用 setState()✅ 在回调中调用❌ initState() 中直接使用 context✅ didChangeDependencies()❌ 大型对象放 State✅ const 构造函数
错误正确❌ Expanded 在 Stack 中✅ Positioned/ Align❌ 硬编码尺寸✅ MediaQuery/ LayoutBuilder
错误正确❌ ButtonTheme✅ FilledButtonTheme❌ background/ onBackground✅ surface/ onSurface❌ MaterialState✅ WidgetState
操作效果R (Hot Reload)保持 State,仅重建 Widget 树Shift+R (Hot Restart)State 丢失,重新执行 main()
dart
EdgeInsets.all(16.0)
EdgeInsets.symmetric(v: 8)
EdgeInsets.only(left: 16)
EdgeInsets.fromLTRB(4,8,4,8)
dart
_controller = AnimationController(
duration: Duration(milliseconds: 300),
vsync: this,
);
@override
void dispose() {
_controller.dispose();
super.dispose();
}
按钮导航容器FilledButton``AppBar``Card``FilledButton.tonal``NavigationBar``Dialog``OutlinedButton``NavigationRail``SnackBar``TextButton``NavigationDrawer``BottomSheet
详细参考: buttons-input.md | navigation-components.md | display-components.md
文档版本:Flutter 3.x + Material 3 URL: https://flutter.cn/docs 抓取时间:2026-04-24
文件行数覆盖内容material-3.md767Material 3 迁移完整指南layout-constraints.md368布局约束与约束传递机制overview-getting-started.md376Flutter 入门与平台能力buttons-input.md424按钮与输入组件adaptive-responsive.md298自适应响应式布局platform-idioms.md358平台适配与设备类型large-screens.md264大屏幕与折叠屏支持navigation-components.md350导航组件display-components.md300展示组件hero-animations.md239Hero 动画staggered-animations.md354交错动画testing.md121测试指南(单元/Widget/集成/Mock)dependency-injection.md81依赖注入(get_it/Riverpod/injectable)
| testing.md | 参考文档:测试指南 |
详见 testing.md(flutter_test / widget / integration / Mock)
dart
class CounterModel extends ChangeNotifier {
int _count = 0;
int get count => _count;
void increment() { _count++; notifyListeners(); }
}
test('CounterModel increments correctly', () {
final model = CounterModel();
expect(model.count, 0);
model.increment();
expect(model.count, 1);
});
dart
testWidgets('CounterWidget displays count and increments', (tester) async {
await tester.pumpWidget(MaterialApp(home: CounterWidget()));
expect(find.text('0'), findsOneWidget);
await tester.tap(find.byIcon(Icons.add));
await tester.pump();
expect(find.text('1'), findsOneWidget);
});
dart
testProvider('counterProvider increments', (override) async {
await runProviderScope((ref) async {
final counter = ref.watch(counterProvider);
expect(counter, 0);
ref.read(counterProvider.notifier).increment();
expect(ref.watch(counterProvider), 1);
}, overrides: []);
});
dart
setUpAll(() async { await FlutterDriver.connect(); });
test('app loads and shows home', () async {
final driver = await FlutterDriver.connect();
await driver.waitFor(find.byType('MyHomePage'));
expect(find.text('Home'), findsOneWidget);
});
dart
@GenerateMocks([UserRepository])
void main() {
late MockUserRepository mockRepo;
setUp(() { mockRepo = MockUserRepository(); });
test('loads user data', () async {
when(mockRepo.getUser('123'))
.thenAnswer((_) async => User(id: '123', name: 'Alice'));
final user = await mockRepo.getUser('123');
expect(user.name, 'Alice');
verify(mockRepo.getUser('123')).called(1);
});
}
详见 dependency-injection.md(get_it / injectable / DI 陷阱)
dart
import 'package:get_it/get_it.dart';
final getIt = GetIt.instance;
void setupDependencies() {
getIt.registerLazySingleton<Dio>(() => Dio());
getIt.registerFactory<UserRepository>(
() => UserRepository(dio: getIt<Dio>()),
);
getIt.registerSingleton<SharedPreferences>(prefs);
}
final repo = getIt<UserRepository>();
dart
final dioProvider = Provider<Dio>((ref) => getIt<Dio>());
final userRepoProvider = Provider<UserRepository>(
(ref) => UserRepository(dio: ref.watch(dioProvider)),
);
dart
@injectable
class AuthRepository {
final Dio dio;
AuthRepository({required this.dio});
}
// configureDependencies(); // 自动生成
错误正确❌ 在 build() 中 GetIt.instance<Dio>()✅ 顶层 setupDependencies() 中注册❌ 单例中引用非单例✅ 确保生命周期一致❌ 直接 Dio() 硬编码✅ 通过 getIt<Dio>() 注入