怎样写好Flutter代码
缘起
代码规范作为一个研发团队的核心基因,怎样在团队中高效传承是一个挑战。Flutter作为移动端持续火热的新型框架,正吸引越来越多的研发同学进入这个领域。但是面对全新的技术框架和之前几乎很少接触的dart语言,怎样写好Flutter代码困扰了无数Flutter初学者。文本就着重分享一下闲鱼Flutter团队在基础代码规范方面所做的一些实践。
Flutter静态代码扫描
Native开发同学都知道Android/iOS都有配套的Linter检查机制。开发者可以通过Linter检查,统一代码风格,检查代码中的明显缺陷。Flutter同样具备这样的能力。通过Linter检查机制,是统一代码风格最简单高效的方式。
Flutter Linter机制
Flutter Linter检查的机制植根于Dart Linter检查,同时做了大量的功能拓展。Flutter的Linter规则记录在工程一级目录的analysis_options.yaml文件中。大家可以通过对该文件的定制来获得适合自己团队的代码规则。
Flutter Linter 规则都从属于三个主要的集合:
1.ERROR
规则标识的是代码中可能出现的错误
2.Style
规则标识的是代码风格的问题
3.Pub
规则标识的是Flutter包管理相关的问题
需要注意的是,考虑到实际开发场景中的稳定性。调整Linter规则的时候需要关注规则对应的成熟度。目前主要的成熟度等级包括:
Stable - 稳定
Experimental - 实验性规则,可能会不太稳定
Deprecated - 不再推荐使用的规则,建议废弃
常见的Linter规则集
1.effective_dart
effective_dart是dart语言配套的Linter 规则。规则来源于Effective Dart文档。该文档中有对Dart语言高效使用的各种规范。effective_dart[2] 规则比较老,目前已经废弃。
2.pedantic
google内部dart开发规范集合。目前也已经废弃。
3.flutter_lints
是Flutter团队推荐的Flutter相关规则集。推荐大家在Flutter apps, packages, and plugins中广泛使用。本身是dart recommended 规则集合的拓展版本。该规范会影响到发布到 pub.dev[5] 中 package的得分。
4.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关键字能让编译器做更多优化,提升代码的整体性能。
风格一致
多人开发的团队中,每个人都有自己的喜好。代码管理应该避免出现“破窗效应”。一个人把代码写烂了,后面的同学照着写都烂了。正所谓,无规矩不成方圆。基础代码的表达,不追求绝对的对与错,追求的是在风格上的尽可能统一。这里有太多典型例子:
命名规范大体遵循驼峰的方式【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]
闲鱼核心Liner规则
附上闲鱼的核心Liner规则,给大家一点参考。
命名
排序
格式化
评论
库使用
NULL
字符串
集合
函数
成员变量
构造函数
异常处理
Mixin
类型
参数
质量
Core集合融合部分
Recommended 集合融合部分
Flutter 集合融合部分
其他规则融合部分
References
[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
怎样写好Flutter代码相关推荐
- 打通前后端逻辑,客户端Flutter代码一天上线
一.前沿 随着闲鱼的业务快速增长,运营类的需求也越来越多,其中不乏有很多界面修改或运营坑位的需求.闲鱼的版本现在是每2周一个版本,如何快速迭代产品,跳过窗口期来满足这些需求?另外,闲鱼客户端的包体 ...
- UI2Code智能生成Flutter代码——机器生成代码
背景 在<UI2CODE--整体设计>篇中,我们提到UI2Code工程的整体流程.前步图片分析之后,我们可以得到对应的DSL布局描述.利用DSL的资讯,结合IntelliJ Plugin介 ...
- Flutter代码可插拨/解耦方案
github地址 原文地址:https://www.jianshu.com/p/18fb2bbb1a9f 背景 因为Flutter禁止了动态特性及反射,所以Flutter代码无法实现运行时分离,只能在 ...
- 宁愿写两遍代码,也不用C++跨iOS、Android平台开发?
作者丨赵钰莹.小智 Dropbox 最近宣布将放弃用 C++ 编写跨 iOS.Android 平台代码,转而使用各平台的原生框架(Swift/Kotlin),理由是代码共享相关的隐藏成本太高.有趣的是 ...
- 在Android studio里写一个Flutter程序
在Android studio里写一个Flutter程序 前言 前言 新建一个Flutter工程,选择Flutter Application 选择Flutter 同时配置Flutter sdk路径 n ...
- 写好 Python 代码的几条原则
程序设计的好与坏,早在我们青葱岁月时就接触过了,只是那是并不知道这竟如此重要.能够立即改善程序设计.写出"好"代码的知识有以下几点: •面向对象五个基本原则: •常见的三种架构: ...
- 要写好业务代码,也没这么简单!
欢迎关注方志朋的博客,回复"666"获面试宝典 来源:https://blog.csdn.net/new_com/article/details/108399421 为什么要写好业 ...
- 哈哈哈,这个教人写出烂代码的项目在 GitHub 上火了...
如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式和缩进.使用清晰的变量名和方法名.在必要时提供文档与注释.不要过度精简代码等等. 但是对于什么是烂代码,你有比较清晰的认识吗? 在 G ...
- 你只写了两行代码,为什么要花两天时间?
原文 | https://www.mrlacey.com 作者 | Matt Lacey 我花了两天时间,写了两行代码. 对于真正的程序员来看,这可能是一个合理的事情,但背后不理解程序员的人,往往会做 ...
最新文章
- C++ int与string的相互转换(含源码实现)
- RH5.4下安装samba服务器(1)
- window10电脑远程没有oracle,win10 不安装oracle plsql连接远程oracle
- 160 - 44 defiler.1.exe
- CSUOJ 1215: 稳定排序
- Linux命令常用的快捷键
- 【嵌入式实验】《嵌入式开发工具使用》
- .NET动态调用WebService
- .Net6种成员的可访问性
- Aibaba Dubbo 的前世今生以及黑历史 主程序员梁飞 阿里P9(2016年查看)
- 孔夫子旧书网接口:实现输入ISBN获取图书信息
- 计算机机房辐射大吗6,我的办公室离机房只有一墙之隔,请问对孕妇辐射大吗?我们单位10多个电脑的交换机。...
- 百度面试题--度度熊想去商场买一顶帽子,商场里有N顶帽子,有些帽子的价格可能相同,度度熊想买一顶价格第三便宜的帽子,问第三便宜的帽子价格是多少?
- PLSQL Developer几个可能的隐患
- 使用Visio画UML图(Java)
- 程序员返乡卖羊肉年销售1500万元,竟然是为了爱情?
- win7网络本地连接服务器未响应,Win7本地连接未识别无法连接网络如何解决
- Arduino网络编程实战-ADC数据可视化(仪表)
- 基于matlab的LFM脉冲压缩仿真
- 关于google眼镜的个人想法