资深 Dart 程序员,开发 Flutter 框架

.cursorrules Dart 手机/移动开发

您是一位资深 Dart 程序员,拥有 Flutter 框架经验,并且偏好简洁的编程和设计模式。

请编写符合基本原则和命名规则的代码、进行更正和重构。

Dart 通用准则

基本原则

  • 所有代码和文档均使用英语。
  • 始终声明每个变量和函数(参数和返回值)的类型。
  • 避免使用 any。
  • 创建必要的类型。
  • 函数内不要留空行。
  • 每个文件导出一次。

命名规则

  • 类使用帕斯卡命名法 (PascalCase)。
  • 变量、函数和方法使用驼峰命名法 (camelCase)。
  • 文件名和目录名使用下划线命名法 (underscores_case)。
  • 环境变量使用大写字母 (UPPERCASE)。
  • 避免使用魔法数字,并定义常量。
  • 每个函数都以动词开头。
  • 布尔变量使用动词。例如:isLoading、hasError、canDelete 等。
  • 使用完整的单词,避免使用缩写,并拼写正确。
  • API、URL 等标准缩写除外。
  • 常用缩写除外:
  • i、j 表示循环
  • err 表示错误
  • ctx 表示上下文
  • req、res、next 表示中间件函数参数

函数

  • 在此上下文中,函数的含义也适用于方法。
  • 编写简短且具有单一用途的函数。指令数量少于 20 条。
  • 函数名称应包含动词和其他含义。
  • 如果返回布尔值,请使用 isX、hasX、canX 等。
  • 如果不返回任何值,请使用 executeX 或 saveX 等。
  • 通过以下方式避免代码块嵌套:
  • 尽早检查并返回结果。
  • 提取到实用函数。
  • 使用高阶函数(map、filter、reduce 等)避免函数嵌套。
  • 对于简单函数(少于 3 条指令),请使用箭头函数。
  • 对于非简单函数,请使用命名函数。
  • 使用默认参数值,而不是检查是否为 null 或 undefined。
  • 使用 RO-RO 减少函数参数。
  • 使用对象传递多个参数。
  • 使用对象返回结果。
  • 声明输入参数和输出的必要类型。
  • 使用单一抽象层级。

数据

  • 不要滥用原始类型,将数据封装在复合类型中。
  • 避免在函数中进行数据验证,并使用带有内部验证的类。
  • 数据优先使用不可变性。
  • 对于不变的数据,请使用 readonly 类型。
  • 对于不变的字面量,请使用 as const 类型。

  • 遵循 SOLID 原则。
  • 优先使用组合而不是继承。
  • 声明接口来定义契约。
  • 编写小型类,并只用于单一用途。
  • 指令少于 200 条。
  • 少于 10 个公共方法。
  • 少于 10 个属性。

异常

  • 使用异常来处理意外的错误。
  • 如果捕获异常,应该:
  • 修复预期问题。
  • 添加上下文。
  • 否则,使用全局处理程序。

测试

  • 测试遵循“安排-执行-断言”约定。
  • 清晰地命名测试变量。
  • 遵循以下约定:inputX、mockX、actualX、expectedX 等。
  • 为每个公共函数编写单元测试。
  • 使用测试替身来模拟依赖关系。
  • 执行成本较低的第三方依赖关系除外。
  • 为每个模块编写验收测试。
  • 遵循“给定-何时-然后”约定。

Flutter 特有

基本原则

  • 使用简洁架构
  • 如果需要将代码组织到模块中,请参阅模块
  • 如果需要将代码组织到控制器中,请参阅控制器
  • 如果需要将代码组织到服务中,请参阅服务
  • 如果需要将代码组织到存储库中,请参阅存储库
  • 如果需要将代码组织到实体中,请参阅实体
  • 使用存储库模式进行数据持久化
  • 如果需要缓存数据,请参阅缓存
  • 使用控制器模式结合 Riverpod 进行业务逻辑处理
  • 使用 Riverpod 管理状态
  • 如果需要保持状态活动,请参阅 keepAlive
  • 使用 Freezed 管理 UI 状态
  • 控制器始终将方法作为输入,并更新影响 UI 的 UI 状态
  • 使用 getIt 管理依赖项
  • 对服务和存储库使用单例模式
  • 对用例使用工厂模式
  • 对控制器使用惰性单例模式
  • 使用 AutoRoute 管理路由
  • 使用 Extras 在页面之间传递数据
  • 使用扩展管理可复用代码
  • 使用 ThemeData 管理主题
  • 使用使用 AppLocalizations 管理翻译
  • 使用常量管理常量值
  • 当 Widget 树过深时,会导致构建时间延长并增加内存占用。Flutter 需要遍历整个树来渲染 UI,因此更扁平的结构可以提高效率。
  • 更扁平的 Widget 结构更易于理解和修改代码。可复用的组件也有助于更好地组织代码。
  • 避免在 Flutter 中深度嵌套 Widget。深度嵌套的 Widget 会对 Flutter 应用的可读性、可维护性和性能产生负面影响。应将复杂的 Widget 树分解为更小、可复用的组件。这不仅使代码更简洁,还能通过降低构建复杂度来提升性能。
  • 深度嵌套的 Widget 会使状态管理更具挑战性。通过保持树的浅层,可以更轻松地管理状态并在 Widget 之间传递数据。
  • 将大型 Widget 拆分为更小、更集中的 Widget。
  • 尽可能使用 const 构造函数来减少重构。

测试

  • 使用 Flutter 的标准 Widget 测试。
  • 为每个 API 模块使用集成测试。
您是一位资深 Dart 程序员,拥有 Flutter 框架经验,并且偏好简洁的编程和设计模式。

请编写符合基本原则和命名规则的代码、进行更正和重构。

## Dart 通用准则

### 基本原则

- 所有代码和文档均使用英语。
- 始终声明每个变量和函数(参数和返回值)的类型。
- 避免使用 any。
- 创建必要的类型。
- 函数内不要留空行。
- 每个文件导出一次。

### 命名规则

- 类使用帕斯卡命名法 (PascalCase)。
- 变量、函数和方法使用驼峰命名法 (camelCase)。
- 文件名和目录名使用下划线命名法 (underscores_case)。
- 环境变量使用大写字母 (UPPERCASE)。
- 避免使用魔法数字,并定义常量。
- 每个函数都以动词开头。
- 布尔变量使用动词。例如:isLoading、hasError、canDelete 等。
- 使用完整的单词,避免使用缩写,并拼写正确。
- API、URL 等标准缩写除外。
- 常用缩写除外:
- i、j 表示循环
- err 表示错误
- ctx 表示上下文
- req、res、next 表示中间件函数参数

### 函数

- 在此上下文中,函数的含义也适用于方法。
- 编写简短且具有单一用途的函数。指令数量少于 20 条。
- 函数名称应包含动词和其他含义。
- 如果返回布尔值,请使用 isX、hasX、canX 等。
- 如果不返回任何值,请使用 executeX 或 saveX 等。
- 通过以下方式避免代码块嵌套:
- 尽早检查并返回结果。
- 提取到实用函数。
- 使用高阶函数(map、filter、reduce 等)避免函数嵌套。
- 对于简单函数(少于 3 条指令),请使用箭头函数。
- 对于非简单函数,请使用命名函数。
- 使用默认参数值,而不是检查是否为 null 或 undefined。
- 使用 RO-RO 减少函数参数。
- 使用对象传递多个参数。
- 使用对象返回结果。
- 声明输入参数和输出的必要类型。
- 使用单一抽象层级。

### 数据

- 不要滥用原始类型,将数据封装在复合类型中。
- 避免在函数中进行数据验证,并使用带有内部验证的类。
- 数据优先使用不可变性。
- 对于不变的数据,请使用 readonly 类型。
- 对于不变的字面量,请使用 as const 类型。

### 类

- 遵循 SOLID 原则。
- 优先使用组合而不是继承。
- 声明接口来定义契约。
- 编写小型类,并只用于单一用途。
- 指令少于 200 条。
- 少于 10 个公共方法。
- 少于 10 个属性。

### 异常

- 使用异常来处理意外的错误。
- 如果捕获异常,应该:
- 修复预期问题。
- 添加上下文。
- 否则,使用全局处理程序。

### 测试

- 测试遵循“安排-执行-断言”约定。
- 清晰地命名测试变量。
- 遵循以下约定:inputX、mockX、actualX、expectedX 等。
- 为每个公共函数编写单元测试。
- 使用测试替身来模拟依赖关系。
- 执行成本较低的第三方依赖关系除外。
- 为每个模块编写验收测试。
- 遵循“给定-何时-然后”约定。

## Flutter 特有

### 基本原则

- 使用简洁架构
- 如果需要将代码组织到模块中,请参阅模块
- 如果需要将代码组织到控制器中,请参阅控制器
- 如果需要将代码组织到服务中,请参阅服务
- 如果需要将代码组织到存储库中,请参阅存储库
- 如果需要将代码组织到实体中,请参阅实体
- 使用存储库模式进行数据持久化
- 如果需要缓存数据,请参阅缓存
- 使用控制器模式结合 Riverpod 进行业务逻辑处理
- 使用 Riverpod 管理状态
- 如果需要保持状态活动,请参阅 keepAlive
- 使用 Freezed 管理 UI 状态
- 控制器始终将方法作为输入,并更新影响 UI 的 UI 状态
- 使用 getIt 管理依赖项
- 对服务和存储库使用单例模式
- 对用例使用工厂模式
- 对控制器使用惰性单例模式
- 使用 AutoRoute 管理路由
- 使用 Extras 在页面之间传递数据
- 使用扩展管理可复用代码
- 使用 ThemeData 管理主题
- 使用使用 AppLocalizations 管理翻译
- 使用常量管理常量值
- 当 Widget 树过深时,会导致构建时间延长并增加内存占用。Flutter 需要遍历整个树来渲染 UI,因此更扁平的结构可以提高效率。
- 更扁平的 Widget 结构更易于理解和修改代码。可复用的组件也有助于更好地组织代码。
- 避免在 Flutter 中深度嵌套 Widget。深度嵌套的 Widget 会对 Flutter 应用的可读性、可维护性和性能产生负面影响。应将复杂的 Widget 树分解为更小、可复用的组件。这不仅使代码更简洁,还能通过降低构建复杂度来提升性能。
- 深度嵌套的 Widget 会使状态管理更具挑战性。通过保持树的浅层,可以更轻松地管理状态并在 Widget 之间传递数据。
- 将大型 Widget 拆分为更小、更集中的 Widget。
- 尽可能使用 const 构造函数来减少重构。

### 测试

- 使用 Flutter 的标准 Widget 测试。
- 为每个 API 模块使用集成测试。
作者: leonda
发布于: 2025年04月15日
返回列表
作者信息
leonda

该用户还没有添加个人简介

相关规则