# flutter_cheat_sheet

**Repository Path**: zj1208/flutter_cheat_sheet

## Basic Information

- **Project Name**: flutter_cheat_sheet
- **Description**: 这是一个从 2020年开始对Flutter 学习与实战参考的项目，按官方 API 分类整理文档与示例，并覆盖技术专项、三方库集成和常用业务页面案例。适合日常查阅、对照源码和快速验证写法。
此代码运行环境：dart：dk: ">=3.6.2 <4.0.0"
- **Primary Language**: Dart
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 1
- **Created**: 2021-06-17
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# flutter_cheat_sheet

一个 Flutter 学习与实战参考项目，按官方 API 分类整理文档与示例，并覆盖技术专项、三方库集成和常用业务页面案例。适合日常查阅、对照源码和快速验证写法。

## 简介

本项目将 Flutter 生态中的常见知识点集中在一个 App 里，方便边跑边看：

- **系统框架**：Widgets、Material、Cupertino、Painting、Services 等官方 API，附带中文文档说明与可运行示例
- **技术专项**：路由导航、网络请求、状态管理、国际化、扫码定位等专题演示
- **三方库与平台**：Dio、CachedNetworkImage、高德地图、相机相册等常用库的接入与用法
- **实战案例**：登录、首页、个人中心及若干业务页面，包含真实网络请求与数据模型示例
- **自研组件**：二次封装的通用 UI 与工具库（位于 `lib/container`）

项目会持续补充和完善，欢迎作为个人 Cheat Sheet 使用。

## 主要模块

| Tab | 说明 |
| --- | --- |
| 首页 | 业务首页示例，含下拉刷新、动态入口与接口数据展示 |
| 专项 | 官方技术文档 + 自定义技术专题（路由、网络、缓存等） |
| 系统框架 | dart:core / dart:ui / widgets / material 等分类文档与 Demo |
| 三方 | 开源库示例 + 三方平台 SDK（地图、定位等） |
| 我的 | 个人中心与设置相关页面 |

## 环境要求

- Flutter 3.27+（Dart SDK `>=3.6.2 <4.0.0`）
- Android：minSdk 26，compileSdk 36
- iOS 12+

## 快速开始

```bash
# 克隆项目
git clone <your-repo-url>
cd flutter_cheat_sheet

# 安装依赖
flutter pub get

# 运行（示例）
flutter run
```

如需生成 JSON 序列化代码：

```bash
dart run build_runner build --delete-conflicting-outputs
```

## 项目结构（简要）

```
lib/
├── app/              # 应用入口、主题、初始化
├── biz/              # 业务页面（API 示例、专项、三方库、实战案例）
├── container/        # 自研通用组件与工具
├── common/           # 公共模型、事件总线等
├── routes/           # go_router 路由配置
└── generated/        # json_serializable 生成代码

assets/
├── document/         # 各 API 中文文档（txt）
└── images/           # 图片资源
```

## 截图预览

### 1. 官方文档与示例

![系统控件 widget](assets/images/1.png) ![系统控件 MaterialUI](assets/images/2.png)
![文档+例子页面](assets/images/3.png) ![文档页面](assets/images/4.png)
![输入图片说明](assets/images/4.5.png) ![例子页面](assets/images/5.png)
![苹果 UI 页面](assets/images/6.png)
![Dialog](assets/images/7.png) ![Dialog](assets/images/7.5.png)

### 2. 技术专项

![专项](assets/images/8.png)

### 3. 首页与实战案例

![首页](assets/images/9.png)

### 4. 三方库与三方平台

![三方库](assets/images/10.png)
![三方平台](assets/images/11.png)

## 说明

- Android / iOS 应用 ID 当前仍为 `com.zxm.startupName`，与包名 `flutter_cheat_sheet` 独立，不影响日常开发调试
- 部分三方 SDK（友盟、高德等）需配置对应 Key 后才能在真机完整体验

## License

仅供学习参考使用。