# component-library

**Repository Path**: lidonghonglalala/component-library

## Basic Information

- **Project Name**: component-library
- **Description**: 简洁
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-31
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# component-library

一个可直接落地业务的 Flutter 模板工程，提供统一的工程分层、路由、网络、主题与本地化能力，适合中小型到中大型 App 的快速启动。

## 特性

- 分层清晰：`core + features` 结构，便于扩展与治理
- 路由方案：`fluro_router_generate` 注解生成，支持守卫
- 网络方案：`Dio + net_retrofit_dio`，声明式 API 与拦截器
- 状态管理：`GetX`，覆盖全局状态和页面状态
- UI 基建：`ScreenUtil`、`EasyLoading`、`SmartDialog`
- 本地化：支持 ARB + 自定义翻译流水线（见 `packages/as_localizations/tools`）

## 运行环境

- Flutter: 建议使用稳定版（`flutter --version`）
- Dart SDK: `>=3.0.0 <4.0.0`

## 快速开始

```bash
# 1) 安装依赖
flutter pub get

# 2) 运行（示例）
flutter run -d macos
# 或
flutter run -d chrome
```

## 项目结构

```text
lib/
├── main.dart                    # 应用入口与初始化
├── core/
│   ├── config/                  # 环境与配置
│   ├── controller/              # 全局控制器
│   ├── model/                   # 通用模型
│   ├── network/                 # 网络层
│   ├── resource/                # 全局资源
│   ├── routes/                  # 路由与守卫
│   ├── shared/                  # 初始化/日志/主题管理
│   ├── ui/                      # UI 基类与扩展
│   └── utils/                   # 工具类
├── features/                    # 业务模块（按功能拆分）
└── l10n/                        # 自定义本地化输出

assets/
└── translations/                # ARB 与源翻译数据

packages/
└── as_localizations/            # 本地化 SDK 与工具链
```

## 新增页面（推荐流程）

1. 在 `lib/core/routes/route_path/root_path.dart` 增加路由常量。
2. 在 `features/` 下创建页面并添加注解。
3. 执行路由代码生成。
4. 通过 `RouteConfig` 统一跳转。

```bash
dart run build_runner build
```

## 构建与生成

```bash
# 路由生成
dart run build_runner build
```

## 本地化工作流

本项目内置一套翻译自动化工具，支持 `diff -> translate -> update` 流程：

- 工具文档：`packages/as_localizations/tools/README.md`
- 快捷命令：`make -f Makefile.translation full`

## 环境配置

- 通过 `FLAVOR` 区分环境（如 `dev/test/prod`）
- API 与环境配置位于 `lib/core/config/`

## 开发约定

- 优先保持 `core` 稳定，业务逻辑进入 `features`
- 路由统一由 `RouteConfig` 管理，不在页面内散落导航规则
- 网络调用通过 `net_retrofit_dio` 生成层统一维护

## 常见问题

### 1) Python 翻译工具报依赖缺失

优先使用：

```bash
make -f Makefile.translation venv
```

## 贡献

欢迎提交 Issue / PR。建议在 PR 中包含：

- 变更背景与目标
- 关键实现说明
- 验证步骤（命令与结果）

## 许可证

仓库当前未包含顶层 `LICENSE` 文件。若计划对外开源，建议补充（如 MIT/Apache-2.0）。