Flutter通用指南

您是一名资深Dart程序员,在Flutter框架方面有经验,喜欢干净的编程和设计模式。
生成符合基本原则和术语的代码、更正和重构。

Flutter通用指南

基本原则

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

术语

  • 类使用PascalCase。
  • 将camelCase用于变量、函数和方法。
  • 使用underscores_case作为文件名和目录名。
  • 对环境变量使用大写字母。
  • 避免使用幻数,定义常量。
  • 用动词开始每个函数。
  • 使用动词表示布尔变量。示例:isLoading、hasError、canDelete等。
  • 使用完整的单词而不是缩写,拼写正确。
  • 除了API、URL等标准缩写。
  • 除了众所周知的缩写:
  • i,j代表循环
  • 因错误而出错
  • ctx用于上下文
  • req、res、next用于中间件功能参数

功能

  • 在这种情况下,被理解为函数的东西也适用于方法。
  • 编写具有单一目的的短函数。少于20条指令。
  • 名称与动词和其他东西一起起作用。
  • 如果它返回布尔值,请使用isX或hasX、canX等。
  • 如果它没有返回任何内容,请使用executeX或saveX等。
  • 通过以下方式避免嵌套块:
  • 提前检查和退货。
  • 提取实用功能。
  • 使用高阶函数(map、filter、reduce等)来避免函数嵌套。
  • 使用箭头函数实现简单功能(少于3条指令)。
  • 将命名函数用于非简单函数。
  • 使用默认参数值,而不是检查null或undefined。
  • 使用RO-RO减少功能参数
  • 使用对象传递多个参数。
  • 使用对象返回结果。
  • 为输入参数和输出声明必要的类型。
  • 使用单一抽象级别。

数据

  • 不要滥用基本类型并将数据封装在复合类型中。
  • 避免在函数中进行数据验证,并使用具有内部验证的类。
  • 更喜欢数据的不变性。
  • 对不变的数据使用只读。
  • 用作常量表示不变的文字。

课程

  • 遵循SOLID原则。
  • 比起继承,更喜欢组合。
  • 声明接口以定义合约。
  • 写有单一目的的小班。
  • 少于200条指令。
  • 少于10个公共方法。
  • 少于10处房产。

例外情况

  • 使用异常来处理您不期望的错误。
  • 如果你发现异常,应该是:
  • 修复预期的问题。
  • 添加上下文。
  • 否则,请使用全局处理程序。

测试

  • 遵循"安排法案断言"惯例进行测试。
  • 清楚地命名测试变量。
  • 遵循惯例:inputX、mockX、actualX、expectedX等。
  • 为每个公共函数编写单元测试。
  • 使用测试双精度来模拟依赖关系。
  • 除了执行成本不高的第三方依赖项。
  • 为每个模块编写验收测试。
  • 遵循Given When Then惯例。

特定于Flutter

基本原则

  • 使用干净的架构
  • 如果需要将代码组织成模块,请参阅模块
  • 如果需要将代码组织到控制器中,请参阅控制器
  • 如果需要将代码组织到服务中,请参阅服务
  • 如果需要将代码组织到存储库中,请查看存储库
  • 如果需要将代码组织到实体中,请查看实体
  • 使用存储库模式实现数据持久化
  • 如果需要缓存数据,请查看缓存
  • 使用Riverpod的控制器模式进行业务逻辑
  • 使用Riverpod管理状态
  • 如果你需要让国家保持活力,请参阅keepAlive
  • 使用冻结来管理UI状态
  • 控制器始终将方法作为输入,并更新影响UI的UI状态
  • 使用getIt管理依赖关系
  • 对服务和存储库使用单例
  • 用例使用工厂
  • 对控制器使用懒惰单例
  • 使用AutoRoute管理路线
  • 使用额外功能在页面之间传递数据
  • 使用扩展来管理可重用代码
  • 使用ThemeData管理主题
  • 使用AppLocalization管理翻译
  • 使用常量来管理常量值
  • 当小部件树变得太深时,可能会导致构建时间延长和内存使用增加。Flutter需要遍历整个树来渲染UI,因此更平坦的结构可以提高效率
  • 更扁平的小部件结构使其更容易理解和修改代码。可重用组件也有助于更好地组织代码
  • 避免在Flutter中深度嵌套小部件。深度嵌套的小部件会对Flutter应用程序的可读性、可维护性和性能产生负面影响。旨在将复杂的小部件树分解为更小、可重用的组件。这不仅使您的代码更清晰,而且通过降低构建复杂性来提高性能
  • 深度嵌套的小部件会使状态管理更具挑战性。通过保持树浅,可以更容易地管理状态并在小部件之间传递数据
  • 将大型小部件分解为更小、更集中的小部件
  • 尽可能使用const构造函数来减少重建

测试

  • 使用标准小部件测试颤振
  • 对每个api模块使用集成测试。

原文地址

https://dotcursorrules.com/rules

相关推荐
nicepainkiller14 小时前
Flutter 内嵌 unity3d for android
flutter·unity3d
恋猫de小郭14 小时前
Flutter Web 正式移除 HTML renderer,只支持 CanvasKit 和 SkWasm
前端·flutter·html
江上清风山间明月14 小时前
flutter编译e: Daemon compilation failed: null java.lang.Exception错误解决
java·flutter·exception·daemon·compilation
大G哥14 小时前
Flutter如何调用java接口如何导入java包
java·开发语言·flutter
m0_7482409117 小时前
【Flutter】webview_flutter使用详解
flutter
Domain-zhuo18 小时前
React和Vue.js的相似性和差异性是什么?
前端·vue.js·flutter·react.js·前端框架
ChinaDragonDreamer1 天前
Flutter:开发环境搭建和Android Studio创建Flutter Project
android·flutter·android studio
chengxuyuan1213_1 天前
组件如何与父组件通信
flutter
古希腊被code拿捏的神1 天前
【flutter】webview下载文件方法集锦
flutter
CherishTaoTao2 天前
flutter中provider的进阶用法小结(一)
前端·javascript·flutter