如何写好Flutter代码？(1)

最新推荐文章于 2024-04-27 09:30:00 发布

onghaha

最新推荐文章于 2024-04-27 09:30:00 发布

阅读量810

点赞数 15

分类专栏：程序员文章标签： flutter javascript 开发语言

本文链接：https://blog.csdn.net/onghaha/article/details/137432043

版权

程序员专栏收录该内容

185 篇文章 1 订阅

订阅专栏

变量/函数状态坚持最小化表达【annotate_overrides，prefer_const_declarations，prefer_final_fields】

一个变量或者方法如果重写了，请明确加上override注解。一个变量如果确定是const变量，请加上const关键字。一个变量如果没有再被赋值，请定义成final。坚持最小化表达，有如下几点收益：

最小化变量状态表达能精准刻画变量状态

最小化变量状态是指用最严格的属性描述变量。例如一个变量从之前的多处赋值，改为一处赋值。那么变量其实自带了final的隐形属性。最小化状态表达要求必须加上final关键字，而不是推断是final。因为一旦加上final关键字，后续在赋值就会报错。这能减少不必要的理解成本，最大限度避免变量状态的隐形改变。

提升代码性能

增加的final const关键字能让编译器做更多优化，提升代码的整体性能。

▐ 风格一致

多人开发的团队中，每个人都有自己的喜好。代码管理应该避免出现“破窗效应”。一个人把代码写烂了，后面的同学照着写都烂了。正所谓，无规矩不成方圆。基础代码的表达，不追求绝对的对与错，追求的是在风格上的尽可能统一。这里有太多典型例子：

命名规范大体遵循驼峰的方式【camel_case_types，non_constant_identifier_names，constant_identifier_names 】
控制流中尽量使用大括号【curly_braces_in_flow_control_structures】
import顺序按照先dart引用，再package引用，再相对引用方式分模块，模块内引用按字母表排序【directives_ordering】
required 关键字标识的变量请排到前面【always_put_required_named_parameters_first】
flutter布局中优先使用SizedBox而不是Container【sized_box_for_whitespace】
flutter颜色定义使用8位16进制整数标识颜色值【use_full_hex_values_for_flutter_colors】
flutter widget在构造函数中加入key参数【use_key_in_widget_constructors】

这里的每一条都不具有非这样不可的理由。但是在闲鱼写代码就必须遵循这个规范。不为别的就为了风格的统一，为了提升团队同学业务轮转的效率。

▐ 代码质量

Linter检查的另一个重要的目标是发现潜在的代码缺陷。这对代码管理来说就更为重要了，因为这直接关系到稳定性的大局。稳定性是开发人员的底线，再怎么小心也不为过。同样举几个典型的例子：

1.避免给void赋值【void_checks】

2.变量比较之前先判断类型【unrelated_type_equality_checks】

3.避免catch 空实现【empty_catches】

4.避免使用隐形类型传递【avoid_shadowing_type_parameters】

5.避免await 非future对象【await_only_futures】

6.集合的remove需要传递符合集合的类型的参数【list_remove_unrelated_type】

如果这些问题代码带到生产环境，轻者出现exception，重则功能不可用。防患于未然，在代码最开始编写阶段，就及时处理这些问题，代码才能更健壮。

▐ 维护成本

效率对一个团队固然很重要，但是追求一时的效率，而不顾及代码生命周期内整体的效率是非常短视的行为。我们今天越发关注代码在后期的维护成本。基于此，文档&注释的重要性正越发凸显出来。一个好的注释，能省下很多的答疑，很多的试错，很多的猜疑。不断引导大家写并维护文档及注释，是闲鱼代码规范明确的目标。举几个明确的例子：

1.Deprecated函数需要给出明确的注释[provide_deprecation_message]

2.注释中的变量引用，符合引用的约束[comment_references]

▐ 规则权威

闲鱼团队Liner规则的制定，不是一家之言。邀请了团队所有同学参与到规则的制定过程。一个规则的权威性来源于所有执行者发自内心的认同。举一个典型例子：

在讨论标准格式化的时候，团队同学集中讨论了一个规则：

【- lines_longer_than_80_chars # 争议规则，每行长度不超过80字符】

大家认同统一格式化代码风格的重要性。大家争议的焦点是：80字符在很多高分辨率显示器上太短了。这会导致很多不必要的换行，降低代码阅读体验。我们听取了开发同学反馈，把该条规范去掉了。改为统一android studio配置来执行。最终标准是12号字，一行最多160字符。

写在最后

当然仅仅做到上面的部分，仅仅是万里长征的第一步。基础代码规范这件事，我们并不追求规则的多，而是更在意规则实际的效率收益。规则制定的过程中，我们听取了开发同学真实的反馈，删除了很多并不必要的规则。简单，高效，并不为了规范而规范是我们核心的目标。当然最终确定的规则，要尽最大努力保证执行。目前我们正在积极建设更完善的CI体系，将规范规则化。通过持续快速检测，实时给使用者反馈，降低规范落地的成本。代码是研发团队的核心资产，需要我们共同守护。

附录

上面介绍的规则细节，如果有不清楚的，可以在下面的链接中找到更详细的解释。

linter-rules[7]