如何写好Flutter代码？

小灰灰 2022-09-13 05:20 286阅读 0赞

![d4d73cf83f38eb4edbd658dd1a248979.gif][]

本文着重分享闲鱼Flutter团队在基础代码规范方面所做的一些实践。

缘起

####     ####

代码规范作为一个研发团队的核心基因，怎样在团队中高效传承是一个挑战。Flutter作为移动端持续火热的新型框架，正吸引越来越多的研发同学进入这个领域。但是面对全新的技术框架和之前几乎很少接触的dart语言，怎样写好Flutter代码困扰了无数Flutter初学者。文本就着重分享一下闲鱼Flutter团队在基础代码规范方面所做的一些实践。

Flutter 静态代码扫描

####     ####

## Native开发同学都知道Android/iOS都有配套的Linter检查机制。开发者可以通过Linter检查，统一代码风格，检查代码中的明显缺陷。Flutter同样具备这样的能力。通过Linter检查机制，是统一代码风格最简单高效的方式。    ##

#### **▐** **lutter Linter机制** ####

Flutter Linter检查的机制植根于Dart Linter检查，同时做了大量的功能拓展。Flutter的Linter规则记录在工程一级目录的analysis\_options.yaml文件中。大家可以通过对该文件的定制来获得适合自己团队的代码规则。

Flutter Linter 规则都从属于三个主要的集合：

*  ERROR

规则标识的是代码中可能出现的错误

*  Style

规则标识的是代码风格的问题

*  Pub

规则标识的是Flutter包管理相关的问题

需要注意的是，考虑到实际开发场景中的稳定性。调整Linter规则的时候需要关注规则对应的成熟度。目前主要的成熟度等级包括：

*  Stable - 稳定
 *  Experimental - 实验性规则，可能会不太稳定  
    
 *  Deprecated - 不再推荐使用的规则，建议废弃

#### **▐** **常见的Linter规则集** ####

*  effective\_dart

effective\_dart是dart语言配套的Linter 规则。规则来源于Effective Dart文档。该文档中有对Dart语言高效使用的各种规范。effective\_dart\[2\] 规则比较老，目前已经废弃。

*  pedantic

google内部dart开发规范集合。目前也已经废弃。

*  flutter\_lints

是Flutter团队推荐的Flutter相关规则集。推荐大家在Flutter apps, packages, and plugins中广泛使用。本身是dart recommended 规则集合的拓展版本。该规范会影响到发布到 pub.dev\[5\] 中 package的得分。

*  lints\[6\]

Dart团队推荐使用的规则集。核心包括两个子集：core & recommended。

静态代码扫描闲鱼规范的取舍

####     ####

在众多Liner规则中，选择符合团队需要的规则是一个很大的挑战。闲鱼在做的过程中，遵循了一些基本原则。

#### **▐** **表达简洁** ####

在语义等效的情况下，充分利用dart语言的各种高级语法来降低表达的复杂度。简洁表达不仅能提升编码效率，同时也可以提升代码的阅读效率。举几个典型例子：

*  去除冗余new关键字【unnecessary\_new】

闲鱼代码库中有大量的代码都是使用new关键字来进行类初始化的。这一方面是因为闲鱼切入Flutter比较早，有历史包袱；另一方面也是因为客户端同学将其他语言（例如java）的编码习惯带到了Flutter。虽然要修改的地方有很多，但是为了表达简洁，我们依然坚定的加入这条规则。

*  高效null处理【prefer\_conditional\_assignment， prefer\_null\_aware\_operators】

dart语法中有很多null处理的语法糖，能大幅提升判空的效率，提升代码的健壮性。这里包括？的判断，??的判空，以及null safety。需要不断引导团队同学更多使用这样的语法来提升效率，而不是继续使用if else的冗杂表达。

#### **▐** **减少歧义** ####

代码表达需要准确，同学之间的理解尽可能一致。减少代码之外的“以为”，增加字里行间上的“确定”。典型列子如下：

*  显式变量类型【always\_specify\_types】

是否要明确变量类型，团队内部不同技术栈背景的同学有比较大的分歧。前端背景的同学倾向于通过推断的方式进行变量命名，好处是表达简洁。客户端背景同学倾向于直接明确定义，好处是直观，减少不必要的推断。最终经过激烈讨论，大家还是决定采用明确变量类型的方案。从实践角度出发，直接明确变量类型虽然从表达上略冗杂，但是歧义确实更少。

*  变量/函数状态坚持最小化表达 【annotate\_overrides，prefer\_const\_declarations，prefer\_final\_fields】

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

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

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

*  提升代码性能

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

#### **▐** **风格一致** ####

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

1.  命名规范大体遵循驼峰的方式【camel\_case\_types，non\_constant\_identifier\_names，constant\_identifier\_names 】
2.  控制流中尽量使用大括号【curly\_braces\_in\_flow\_control\_structures】
3.  import顺序按照先dart引用，再package引用，再相对引用方式分模块，模块内引用按字母表排序【directives\_ordering】
4.  required 关键字标识的变量请排到前面 【always\_put\_required\_named\_parameters\_first】
5.  flutter布局中优先使用SizedBox而不是Container【sized\_box\_for\_whitespace】
6.  flutter颜色定义使用8位16进制整数标识颜色值【use\_full\_hex\_values\_for\_flutter\_colors】
7.  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\]**

#### **▐** **闲鱼核心Liner规则** ####

####     ####

附上闲鱼的核心Liner规则，给大家一点参考。

命名

![ee969a01b9ed9c7a508a08d405d97b85.png][]

排序

![eba32ab18334cb9e2ed4b6b47933bbce.png][]

格式化

![1aa24dfc1feef182dc28e168ae7e4b9a.png][]

![3bd60d3a19b3b0cb54d9ba4ff9bcf92d.png][]

库使用

![22f4ee3d5ce12cba6482fa70079c5949.png][]

NULL

![9162b0092cdb69aff6ae26868a4b0030.png][]

字符串

![5c56522735fbd43e4f27c07eaf46add6.png][]

集合

![6443b0318a252e87b3a517b58bf81e9f.png][]

函数

![18c681410d44f78d061c0c815c131c21.png][]

成员变量

![7a14cb68f86eab25cd18164baa8b0b0f.png][]

构造函数

![cb1afdf43744eb5039c08d60333ff0c0.png][]

异常处理

![d70c1b3293ee2f13ba448b2ffbcd23f9.png][]

Mixin

![b343d73c1455c8d74d8905600d937298.png][]

类型

![aa3d1fd118d73c0ef3ecd39cf579b6ef.png][]

参数

![361fbb5d5e13ac8f325993c5924f849c.png][]

质量

![6c40e4da8b329aafb041e41538b8d5db.png][]

Core集合融合部分

![b3e8b9db7b4e3b6db56f0f000c3c25ae.png][]

Recommended 集合融合部分

![f2d4246e0dc6bcc2907bbc31600534ae.png][]

Flutter 集合融合部分

![b5b7bab5234778a5dece9c88bb3ec839.png][]

其他规则融合部分

![b930b21837365de118c1cc145795abd0.png][]

Reference

####     ####

\[1\] effective\_dart: https://pub.dev/packages/effective\_dart  
\[2\] effective\_dart: https://pub.dev/packages/effective\_dart  
\[3\] pedantic: https://pub.dev/packages/pedantic  
\[4\] flutter\_lints: https://pub.dev/packages/flutter\_lints  
\[5\] pub.dev: https://pub.dev/  
\[6\] lints: https://pub.dev/packages/lints  
\[7\] linter-rules: https://dart.dev/tools/linter-rules\#lints

✿ **拓展阅读**

[![1b3ae88f3bedaccd4b69e0930d8662eb.png][]][1b3ae88f3bedaccd4b69e0930d8662eb.png 1]

[![8b1ef63eb11b9dbda89a9f811658bc54.png][]][8b1ef63eb11b9dbda89a9f811658bc54.png 1]

**作者|**意境

**编辑|**橙子君

**出品|**阿里巴巴新零售淘系技术

![4ec99525cdd63ae1295fde4e53f94fb4.png][]

![3c3bbee8d6976942ca970161410b1d1f.png][]

[d4d73cf83f38eb4edbd658dd1a248979.gif]: /images/20220828/c791d03b4f2f4597b4cef8ec0aa5269a.png
[ee969a01b9ed9c7a508a08d405d97b85.png]: /images/20220828/2df47d7849ba40ebb7569cb997e985a1.png
[eba32ab18334cb9e2ed4b6b47933bbce.png]: /images/20220828/dff055b0054445938cbec8120d8b01ba.png
[1aa24dfc1feef182dc28e168ae7e4b9a.png]: /images/20220828/f1e426e5657e4e87a87c308f286db1d8.png
[3bd60d3a19b3b0cb54d9ba4ff9bcf92d.png]: /images/20220828/056f574f186c4fecae3de24038d46670.png
[22f4ee3d5ce12cba6482fa70079c5949.png]: /images/20220828/e8926148dd5549aa883352937266012f.png
[9162b0092cdb69aff6ae26868a4b0030.png]: /images/20220828/9cc8f42a664f4e9eb7e8af12ec3bd252.png
[5c56522735fbd43e4f27c07eaf46add6.png]: /images/20220828/45310aabf5ff4dbd97e5e0b3256e2ad0.png
[6443b0318a252e87b3a517b58bf81e9f.png]: /images/20220828/d9b24054722345cd825bf56980ccdc3d.png
[18c681410d44f78d061c0c815c131c21.png]: /images/20220828/3db05d11015d4da9bcb70de1da71214b.png
[7a14cb68f86eab25cd18164baa8b0b0f.png]: /images/20220828/9ba14c98e9ab42bda50de5b239ec68c7.png
[cb1afdf43744eb5039c08d60333ff0c0.png]: /images/20220828/82bc85321d844e989d6b957b18e10544.png
[d70c1b3293ee2f13ba448b2ffbcd23f9.png]: /images/20220828/4742fa051a8f48f5ac8329ceeccb3261.png
[b343d73c1455c8d74d8905600d937298.png]: /images/20220828/ee2d80132b12401b835bdc735a372fd5.png
[aa3d1fd118d73c0ef3ecd39cf579b6ef.png]: /images/20220828/d657492b500140359b0f0540b4be3e92.png
[361fbb5d5e13ac8f325993c5924f849c.png]: /images/20220828/dbf9da0d680b4e90972f681ec3a2e2d3.png
[6c40e4da8b329aafb041e41538b8d5db.png]: /images/20220828/fe20e79dfb6d474a888c13e578015bc1.png
[b3e8b9db7b4e3b6db56f0f000c3c25ae.png]: /images/20220828/59a11c3c9dd743b493086def82c9b08f.png
[f2d4246e0dc6bcc2907bbc31600534ae.png]: /images/20220828/efa5a68b8dd04aa190fbd35329ba13fe.png
[b5b7bab5234778a5dece9c88bb3ec839.png]: /images/20220828/ec2156a6a64345dcb03113b869847b69.png
[b930b21837365de118c1cc145795abd0.png]: /images/20220828/f23bd87113864cbdafa7492df85c4ca3.png
[1b3ae88f3bedaccd4b69e0930d8662eb.png]: /images/20220828/d99d63fd1b7d48d9bc902e2380eb289d.png
[1b3ae88f3bedaccd4b69e0930d8662eb.png 1]: http://mp.weixin.qq.com/s?__biz=MzAxNDEwNjk5OQ==&mid=2650433337&idx=1&sn=d5cf990d3478110e6f378ac303600e14&chksm=8396af21b4e1263765eb5f7b48bff3939cd091f0a5b878c30be67ff5f26f656ea230d668c0d2&scene=21#wechat_redirect
[8b1ef63eb11b9dbda89a9f811658bc54.png]: /images/20220828/35b1a23dfc5040e9a7b1cffbe3005a35.png
[8b1ef63eb11b9dbda89a9f811658bc54.png 1]: http://mp.weixin.qq.com/s?__biz=MzAxNDEwNjk5OQ==&mid=2650432277&idx=1&sn=3f1ec46156ff58d9a6a264170e81d851&chksm=8396ab0db4e1221bcfdc0cce9a09724b71e1e03a3ce607681cb2326957ddac4edf25571d6861&scene=21#wechat_redirect
[4ec99525cdd63ae1295fde4e53f94fb4.png]: /images/20220828/1c4df8dcc8b4407ea14305f27c714193.png
[3c3bbee8d6976942ca970161410b1d1f.png]: /images/20220828/41d39ef9837b4c348735205ee83a248a.png