Flutter CustomPaint自定义控件 时钟

时钟效果
时钟效果

我们将用 CustomPaint 来绘制我们的时钟。CustomPaint 的重要参数 paintersizepainter 是一个继承了CustomPainter 的对象,主要实现了绘画控件的功能。size 指定了控件的大小,如果 CustomPaintchild 不为空,size 的值就是 child 控件的大小,指定 size 的值则无效;如果 child 为空,所指定的 size 的值,就是画布的大小。

ClockPainter 继承了 CustomPainter,实现了其中两个重要方法:paintshouldRepaintpaint 当自定义控件需要重画时被调用。shouldRepaint 则决定当条件变化时是否需要重画。

首先先时钟的边框,代码如下,只需 drawCircle 就可以实现边框的绘制。

时钟边框
时钟边框

canvas 的起始点是画布的左上角坐标点为起点,即 x,y 都为零。drawCircle 画一个指定了半径的圆。圆的形状和样式由 Paint 对象指定。style 决定了是画圆盘(PaintingStyle.fill)还是圆环(PaintingStyle.stroke)。当 style 设定为PaintingStyle.stroke 时,strokeWidth 就是指定了圆环的宽度。

其次,可以画时钟刻度和数字了。

刻度
刻度

时钟的刻度占整个圆弧的 360/60=6 度,运用数学公式每个刻度点的坐标,然后用 drawPoints 画出每一个刻度点。

数字
数字

canvas.save() 保存当前画布,以便画完数字恢复。
canvas.translate(radius, radius) 把画布的起始点移到画布的中心。
再次保存画布后,再把起始点移到正上方位置,这里是把起始点数字 12 的位置。
TextPainter用来画文字。
canvas.rotate(-angle.toDouble() * i); 以当前画布起始点旋转一个角度,这是为了保证每个数字在下面旋转到对应的位置后保持竖直显示。
canvas.restore() 重置画布,即把画布的起始点定位到控件的中心位置。
canvas.rotate(angle.toDouble()) 以控件中心为原点旋转一个角度,即把数字旋转到对应的位置。数字 12 旋转角度为零,数字 1 旋转角度为 30 度。
所有的数字都画完并旋转到对应的位置后即可恢复起始点到控件的左上角。

最后,我们接着画时针,分针,秒针。

完整时钟
完整时钟

一个小时占时钟角度为 30 度,利用三角函数算出时针的两个点,用 drawLine 画出带宽度的时针。
每一分钟每一秒中所占的角度为 6 度,同样利用三角函数算出各自对应的两点,再画直线就可以得到分针,秒针。

完整的代码如下:

使用的代码如下:

参考链接


Flutter CustomPaint自定义控件 时钟

百度地图Poi检索、距离计算、调起百度地图

  • 百度API的简单应用——PoiSearch
  1. 创建POI检索实例

    在SDK组件初始化之后使用下列代码即可:

  2. 创建POI检索监听器

    在同一个Activity中编写以下代码:

    其中onGetPoiResult是主要的回调函数,所以涉及到搜索结果的操作基本都放在这个函数中进行,在我的源码中,我把MainActivity当作一个OnGetPoiSearchResultListener,这样有利于简化代码

  3. 设置检索监听器

  4. 设置PoiCitySearchOption,发起检索请求

    在我的源码中,使用的是周边检索,应用的接口应该是:

  5. 释放检索实例

    重要的声明周期管理:

  • 百度地图的简单应用——距离计算

两点距离计算
根据用户指定的两个坐标点,计算这两个点之间的直线实际地理距离。
返回值类型:double
返回值单位:米
核心代码如下:

其中p1和p2都是LatLng的对象

  • 百度地图的简单应用——调起百度地图

由于不可能设计的APP面向的需求是寻找附近的一个可供娱乐的地方,所以导航的功能可以直接使用现成的百度地图来提供

我们使用的是步行导航:

以上的代码即可完全地调起百度地图并直接进行步行导航

  • 综合教程——摇一摇地图
  1. 制作百度地图的API的综合运用——显示定位、POI检索、距离计算、调起百度地图

    关键代码:
    权限:

    显示定位:

    POI检索:

    调起百度地图:

  2. 制作摇一摇

    初始化

    监听Handler:

    编写监听函数:

    编写动画:

  3. 使用摇一摇调用POI检索,使用recyclerView调起百度地图

    摇一摇中onSensorChanged函数中在开始摇晃时加入POI检索函数:searchPoiNearBy
    recyclerView的每个holder加入调起百度地图的监听器;

参考链接


中级实训Android学习记录——Poi检索、距离计算、调起百度地图

Flutter 倒计时功能

参考链接


Flutter : LateInitializationError: Field ‘data’ has not been initialized

You don’t want a late variable, you want a nullable one. If you need to check if something is initialized, you should be using a nullable variable instead and your code is already set up to check for null

just change

to

E.g.

change to

参考链接


Flutter : LateInitializationError: Field ‘data’ has not been initialized, got error

Flutter画圆/虚线圆/渐变圆/进度圆

同一颜色的圆

例子样式:

废话不多说 直接上代码,注释清楚!

1.调用该方法 如果只要一个圆,赋值completeColor, completeWidth, completePercent就可以,剩下的不用赋值 就是一个圆
2.如果需要俩圆的话直接调用赋值就行
3.如果只需要一个虚线圆的话,赋值isDividerRound = true; ,lineColor, width, 剩下的不用写,completeWidth 不得大于0
这是一个全圆就是比例是百分之百的圆,可以自行修改

实践示例

我们用 Flutter 新建项目的例子代码来演示,如下:

渐变色的圆

代码看看就会了

实践示例

我们用 Flutter 新建项目的例子代码来演示,如下:

参考链接


Flutter全屏效果实现

在切换横竖屏/全屏模式时用到 SystemChrome,它作为一个全局属性,很像 AndroidApplication,功能很强大。注意,这个SystemChrome 里面的 Chrome 实质上指的是 ChromeOS 不是 Chrome 浏览器,这些 API 最早在 ChromeOS 上实现,因此才这样命名。

setPreferredOrientations

1. 单方向

2. 多方向

Tips:

  1. portraitDown 属性请注意,多方向时一般不会有效果,系统默认不会颠倒;
  2. 多方向设置时初始方向分两种情况,第一种:当前重力感应方向不在设置多方向列表中,初始方向为列表第一个设置方法;第二种:当前重力感应方向在设置多方向列表中,无论顺序第几位,默认均展示当前重力感应方向(非 portraitDown)。

setEnabledSystemUIOverlays

1. SystemUiOverlay.top

2. SystemUiOverlay.bottom

3. 两者皆有

setSystemUIOverlayStyle

1. systemNavigationBarColor

2. systemNavigationBarDividerColor

3. systemNavigationBarIconBrightness

4. statusBarColor

5. statusBarIconBrightness

6. statusBarBrightness

setApplicationSwitcherDescription

实践示例

上面都是对于 API 的介绍,但是在实际项目开发中,上述的代码究竟应该添加到何处呢?我们用 Flutter 新建项目的例子代码来演示,如下:

全屏模式简介

Flutter 定义了五种全屏模式,其实就是 Android/iOS 系统的全屏模式的映射,定义如下:

下面我们简单介绍一下这几种模式的区别:

1.  leanBack : 向后倾斜模式适用于用户不会与屏幕进行大量互动的全屏体验,例如在观看视频时。
当用户希望调出系统栏时,只需点按屏幕上的任意位置即可。

2. immersive : 沉浸模式适用于用户将与屏幕进行大量互动的应用。 示例包括游戏、查看图库中的图片或者阅读分页内容,如图书或演示文稿中的幻灯片。
当用户需要调出系统栏时,他们可从隐藏系统栏的任一边滑动。要求使用这种这种意图更强的手势是为了确保用户与您应用的互动不会因意外轻触和滑动而中断。

3. immersiveSticky : 在普通的沉浸模式中,只要用户从边缘滑动,系统就会负责显示系统栏,您的应用甚至不会知道发生了该手势。因此,如果用户实际上可能是出于主要的应用体验而需要从屏幕边缘滑动,例如在玩需要大量滑动的游戏或使用绘图应用时,您应改为启用“粘性”沉浸模式。
在粘性沉浸模式下,如果用户从隐藏了系统栏的边缘滑动,系统栏会显示出来,但它们是半透明的,并且轻触手势会传递给应用,因此应用也会响应该手势。
例如,在使用这种方法的绘图应用中,如果用户想绘制从屏幕最边缘开始的线条,则从这个边缘滑动会显示系统栏,同时还会开始绘制从最边缘开始的线条。无互动几秒钟后,或者用户在系统栏之外的任何位置轻触或做手势时,系统栏会自动消失。

4. edgeToEdge : 实现从边到边的全面屏体验后,系统栏会覆盖在应用内容前方。应用也得以通过更大幅面的内容为用户带来更具有冲击力的体验。

5.  manual : 手动配置,可以独立配置状态栏,导航栏的显示与隐藏。如果选择状态栏,导航栏都隐藏,那么行为与向后倾斜模式相同。

适配安卓刘海、水滴屏显示全屏

上面的配置在刘海、水滴屏幕上会在顶部出现一道黑色的背景,比如 Honor 30 。解决方法就是 将 shortEdges 放到 style 标签内。如下:

找到 android/app/src/main/res/目录,新建 values-v27 目录(这个APIAndroid API 27 才开始支持),并在目录下创建 styles.xml ,内容从原来的 values/styles.xml 中拷贝出来,将 shortEdges 放到 style 标签内,如下:

  • LaunchTheme 指的是启动页的主题,也就是我们常说的 Splash 页面。如果需要启动页全屏就放在里面。
  • NormalTheme 代表正常页面的主题。

同样需要修改暗黑主题相关的风格文件,如下:

创建 android/app/src/main/res/values-night-v27 目录,新建 styles.xml ,将 shortEdges 放到 style 标签内 (这个APIAndroid API 27 才开始支持),如下:

参考链接


不同版本的TLS在Android/iOS中的支持情况

本文要解决的两类问题:
  • 在Android4.1-Android5.0的系统上启用TLSv1.1和TLSv1.2
  • java.lang.IllegalArgumentException: protocol TLSv1.1 is not supported

这两个问题比较具有代表性,在群里面讨论的时候见过的次数也是最多的,因此有些人遇到的问题也许协议名称不一样,但是本质都是类似的。

问题原因和解决思路分析

Android5.0 行为变更 可以看到 Android 5.0 开始默认启用了 TLSv1.1TLSv1.2,但是从 Android 4.1 开始 TLSv1.1TLSv1.2 其实就被支持了,只是默认没有启用而已。

我们最常用到的几种协议是SSLv3TLSv1TLSv1.1TLSv1.2,解决上面两个问题要搞清楚的是这几个协议在Android 系统中被支持的情况和被启用的情况,然后我们结合 minSdkVersiontargetSdkVersion 来选择协议即可,不同版本的 Android 系统对上述协议的支持情况:

客户端(SSLSocket)的支持情况:

协议 被支持(Api级别) 被启用(Api级别)
SSLv3 1–25 1–22
TLSv1 1+ 1+
TLSv1.1 16+ 20+
TLSv1.2 16+ 20+

服务端(SSLServerSocket)的支持情况:

协议 被支持(Api级别) 被启用(Api级别)
SSLv3 1–25 1–22
TLSv1 1+ 1+
TLSv1.1 16+ 16+
TLSv1.2 16+ 16+

数据来源:https://developer.android.com/reference/javax/net/ssl/SSLSocket

注意:这里说的客户端和服务端不是指Android端和JavaEE端/PHP端(还有Python、.NET等等),是指的在Android开发中的客户端Socket(SSLSocket)和服务端Socket(SSLServerSocket)。

到这里其实已经知道本文开始处的问题的原因了,TLSv1.1和TLSv1.2从Android4.1(Api级别16)开始才被支持,从Android4.4 Wear(Api级别20)才被启用(手机是Android5.0,Api级别21),因此在不同版本的Android系统中会出现需要被启用和启用时报不被支持的问题。

我们可以写一个TLS协议通用的兼容类,在所有的Android中强制启用已经被支持的所有协议,总结一下就是Android8.0及以上系统可以强制启用TLSv1、TLSv1.1和TLSv1.2协议,Android4.1-Android7.1.1系统可以强制启用SSLv3、TLSv1、TLSv1.1和TLSv1.2协议,其它版本系统可以强制启用SSLv3和TLSv1协议。

综上所述,如果开发者使用SSLv3协议,那么minSdkVersion不限制,targetSdkVersion不高于25,并且需要尽快更新为TLSv1.1协议或者TLS1.2协议;如果开发者使用TLSv1.1协议或者TLSv1.2协议,那么minSdkVersion应该不低于16,targetSdkVersion不限制;如果开发者使用TLSv1协议,那么目前不受限制。

代码实现

我们需要让SSLSocket启用对应的协议,代码对应的方法是:

因此我们需要先在不同版本的Android系统中生成不同的协议数组:

SSLSocket是由SSLSocketFactory负责生成的,我们再写一个SSLSocketFactory的包装类,主要代码如下:

iOS客户端支持情况

iOS 客户端(SSLSocket)的支持情况:

TLS 1.2 从 iOS 5 开始支持(TLS 1.2 was first added to iOS in iOS 5

另外 对于在 2020 年 9 月 1 日格林尼治标准时间/世界标准时间 00:00 或之后颁发的 TLS 服务器证书,其有效期不得超过 398 天

参考链接


macOS Big Sur(11.6.7/Intel CPU)编译Android/iOS/macOS版本的RocksDB 6.29.5

RocksDB 7.0 开始,RocksDB 要求编译的 C++ 必须支持 C++ 17 ,( Dropping some compiler support in 7.0#9388)但是目前的Android/iOS版本显然暂时还不能大范围的适配 C++ 17,因此我们目前只能使用 6.x 版本。

Android:

iOS/macOS ARM:

macOS x86:

参考链接


Android官方推荐: DialogFragment创建对话框

最近在使用官方的 Android Jetpack 库的时候,发现 Activity/Fragment 都有对应的 lifecycle(生命周期) 组件,比如ViewModel。唯独 Dialog 没有对应的组件,感觉非常奇怪。

搜索了一通,发现官方推荐 DialogFragment 替代直接使用 DialogDialogFragmentAndroid 3.0 时被引入,是一种特殊的 Fragment ,用于在 Activity 的内容之上展示一个模态的对话框。典型的用于:展示警告框,输入框,确认框等等。

DialogFragment 产生之前,我们创建对话框:一般采用 AlertDialogDialog注意:官方不推荐直接使用Dialog创建对话框。

另外, 更常见的在 logcat 中经常看到输出由于 Dialog 引起的 WindowLeaked 日志,这个日志产生的原因就是 Dialog 显示所依赖的 Activity 被销毁/重建的时候没有关闭显示在上层的 Dialog 。但是很多时候我们不方便在 ActivityonDestroy() 中查找全部的 Dialog 来逐个关闭,尤其是依赖的 Activity 是第三方的 SDK 创建的情况下。这种情况下,DialogFragment 不失为一个好的替代选项。

好处与用法

使用DialogFragment来管理对话框,当旋转屏幕和按下后退键时可以更好的管理其声明周期,它和Fragment有着基本一致的生命周期。且DialogFragment也允许开发者把Dialog作为内嵌的组件进行重用,类似Fragment(可以在大屏幕和小屏幕显示出不同的效果)。下面会通过例子展示这些好处~

使用DialogFragment至少需要实现onCreateView或者onCreateDIalog方法。onCreateView即使用定义的xml布局文件展示Dialog。onCreateDialog即利用AlertDialog或者Dialog创建出Dialog。

重写onCreateView创建Dialog

a)布局文件,我们创建一个设置名称的布局文件:

b)继承DialogFragment,重写onCreateView方法

c)测试运行:
Main方法中调用:

效果图:

可以看到,对话框成功创建并显示出来,不过默认对话框有个讨厌的标题,我们怎么去掉呢:可以在onCreateView中调用getDialog().requestWindowFeature(Window.FEATURE_NO_TITLE);即可去掉。即:

效果图:

很完美的去掉了讨厌的标题。

重写onCreateDialog创建Dialog

onCreateDialog 中一般可以使用 AlertDialog 或者 Dialog 创建对话框,不过既然  Google 不推荐直接使用 Dialog,我们就使用 AlertDialog 来创建一个登录的对话框。
a)布局文件

b)继承 DialogFragment 重写 onCreateDialog 方法

c)调用

效果图:

可以看到通过重写 onCreateDialog 同样可以实现创建对话框,效果还是很nice的。

传递数据给Activity

从dialog传递数据给Activity,可以使用“fragment interface pattern”的方式,下面通过一个改造上面的登录框来展示这种模式。

改动比较小,直接贴代码了:

拿到username和password的引用,在点击登录的时候,把activity强转为我们自定义的接口:LoginInputListener,然后将用户输入的数据返回。
MainActivity中需要实现我们的接口LoginInputListener,实现我们的方法,就可以实现当用户点击登陆时,获得我们的帐号密码了:

效果:

DialogFragment做屏幕适配

我们希望,一个对话框在大屏幕上以对话框的形式展示,而小屏幕上则直接嵌入当前的Actvity中。这种效果的对话框,只能通过重写onCreateView实现。下面我们利用上面的EditNameDialogFragment来显示。

EditNameDialogFragment我们已经编写好了,直接在MainActivity中写调用

可以看到,我们通过读取R.bool.large_layout,然后根据得到的布尔值,如果是大屏幕则直接以对话框显示,如果是小屏幕则嵌入我们的Activity布局中
这个R.bool.large_layout是我们定义的资源文件:

在默认的values下新建一个bools.xml

然后在res下新建一个values-large,在values-large下再新建一个bools.xml

最后测试:

左边为模拟器,右边为我的手机~~~~~

屏幕旋转

当用户输入帐号密码时,忽然旋转了一下屏幕,帐号密码不见了~~~是不是会抓狂

传统的 new AlertDialog 在屏幕旋转时,第一不会保存用户输入的值,第二还会报异常,因为 Activity 销毁前不允许对话框未关闭。而通过 DialogFragment 实现的对话框则可以完全不必考虑旋转的问题。

我们直接把上面登录使用 AlertDialog 创建的登录框,拷贝到 MainActivity 中直接调用:

下面我分别点击两种方式创建的登录框,看效果图:

可以看到,传统的Dialog旋转屏幕时就消失了,且后台log会报异常~~~使用DialogFragment则不受影响。

参考链接


Flutter的ViewModel实现(状态管理)

2019 Google I/O 大会,Flutter 团队在“Pragmatic State Management in Flutter ”演讲上正式介绍了 Provider。自此,Provider 代替 Provide 成为官方推荐的状态管理方式之一。

一、为什么需要状态管理

如果我们的应用足够简单,Flutter 作为一个声明式框架,你或许只需要将数据映射成视图就可以了。你可能并不需要状态管理,就像下面这样。

但是随着功能的增加,你的应用程序将会有几十个甚至上百个状态。这个时候你的应用可能会是这样。

随着你的应用需要共享多处统一状态时,我们很难再清楚的测试维护我们的状态,因为它看上去实在是太复杂了!而且还会有多个页面共享同一个状态,例如当你进入一个文章点赞,退出到外部缩略展示的时候,外部也需要显示点赞数,这时候就需要同步这两个状态。

Flutter 实际上在一开始就为我们提供了一种状态管理方式 — StatefulWidget。然而我们发现它仅适合用于在单个 Widget 内部维护其状态。当我们需要使用跨组件的状态时,StatefulWidget 将不再是一个好的选择。

State 属于某一个特定的 StatefulWidget,在多个 Widget 之间进行交流的时候,虽然你可以使用 callback 解决,但是当嵌套足够深的话,很容易就增大代码耦合度。

这时候,我们便迫切的需要一个架构来帮助我们理清这些关系,状态管理框架应运而生。

二、什么是 Provider

那么我们该如何解决上面这种糟糕的情况呢。在上手了 Provider 之后,我可以说这个库是一个相当不错的解决方案。我们先来简单说一下 Provider 的基本作用。

Provider 从名字上就很容易理解,它用来提供数据,而它的优秀之处在于无论是在单个页面还是在整个 app 都有相应的解决方案,我们可以很方便的管理状态,并在合适的时机释放资源。可以说,Provider 的目标就是完全替代 StatefulWidget。

说了很多还是很抽象,我们先一起做一个最简单的例子。

三、创建一个简单计数器 app

这里我们用这个 Counter App 为例,给大家介绍如何在两个独立的页面中共享计数器(counter)的状态应该怎么做,具体会像下面这样。

  • 两个页面中心字体共用了同一个字体大小。
  • 第二个页面的按钮将会让数字增加(第一个页面的数字将会同步增加。)
3.1 第一步:添加依赖

在 pubspec.yaml 中添加 Provider 的依赖。

3.2 第二步:创建数据 Model

这里的 Model 实际上就是我们的状态,它不仅储存了我们的数据模型,而且还包含了更改数据的方法,并暴露出它想要暴露出的数据。

这个类意图很清晰,数据就是一个 int 类型的 _count,下划线代表私有。通过 get value 把 _count 值暴露出来。并提供 increment 方法用于更改数据。

这里使用了 mixin 混入了 ChangeNotifier,这个类能够帮助我们自动管理所有听众。

当调用 notifyListeners() 时,它会通知所有听众进行刷新。

3.3 第三步:创建顶层共享数据

我们在 main 方法中初始化全局数据:刚才编写的 CounterModel 以及 textSize。为了要在不同页面共享这个数据,我们就需要将其放入顶层节点(MaterialApp 之上)进行保存。

通过 Provider<T>.value 能够管理一个恒定的数据,并提供给子孙节点使用。我们只需要将数据在其 value 属性中声明即可。在这里我们将textSize 传入。

而 ChangeNotifierProvider<T>.value 不仅能够提供数据供子孙节点使用,还可以在数据改变的时候通知所有听众刷新。(通过之前我们说过的 notifyListeners)

此处的 <T> 泛型可省略。但是我建议大家还是进行声明,这会使你的应用更加健壮。

除上述几个属性之外 Provider<T>.value 还提供 UpdateShouldNotify Function,用于控制刷新时机。

typedef UpdateShouldNotify<T> = bool Function(T previous, T current);

我们可以在这里传入一个方法 (T previous, T current){...},并获得前后两个 Model 的实例,然后通过比较两个 Model 以自定义刷新规则,这个方法将返回 bool 表示是听众否需要刷新。(默认为 previous != current 则刷新。)

为了让各位思维连贯,我还是在这里放上这个平淡无奇的 MyApp Widget 代码。

3.4 第四步:在子页面中获取状态

在这里我们有两个页面,FirstScreen 和 SecondScreen。我们先来看 FirstScreen 的代码。

3.4.1 Provider.of<T>(context)

获取顶层数据最简单的方法就是 Provider.of<T>(context);

这里的泛型 <T> 指定了获取 FirstScreen 向上寻找最近的储存了 T 的祖先节点的数据。我们通过这个方法获取了顶层的 CounterModel 及 textSize。并在 Text 组件中进行使用。

在 Provider.of(context) 中还有一个 bool 类型的 listen 参数,它代表了是否监听数据变化,默认为 true。

floatingActionButton 用来点击跳转到 SecondScreen 页面,和我们的主题无关,你可以忽略这部分代码。

3.4.2 Consumer

看到这里你可能会想,两个页面都是获取顶层状态,代码不都一样吗。别忙着跳到下一节,我们来看另外一种获取状态的方式,使用它能够改善应用程序性能。

这里我们要介绍的是第二种方式,使用 Consumer 获取祖先节点中的数据。

在这个页面中,我们有两处使用到了公共 Model。

  • 应用中心的文字:使用 CounterModel 在 Text 中展示文字,以及通过 textSize 定义自身的大小。使用到了两个 Model 中的数据。
  • 浮动按钮:使用 CounterModel 的 increment 方法触发计数器的值增加。使用到了一个 Model。

(1) Single Model Consumer

我们先看 floatingActionButton,使用了一个 Consumer 的情况。

Consumer 使用了 Builder 模式,收到更新通知就会通过 builder 重新构建。Consumer<T> 代表了它要获取哪一个祖先中的 Model。

Consumer 的 builder 实际上就是一个 Function,它接收三个参数(BuildContext context, T model, Widget child)

  • context: context 就是 build 方法传进来的 BuildContext。
  • T:T也很简单,就是获取到的最近一个祖先节点中的数据模型。
  • child:它用来构建那些与 Model 无关的部分,在多次运行 builder 中,child 不会进行重建。

然后它会返回一个通过这三个参数映射的 Widget 用于构建自身。

在这个浮动按钮的例子中,我们通过 Consumer 获取到了顶层的CounterModel 实例。并在浮动按钮 onPressed 的 callback 中调用其increment 方法。

而且我们成功抽离出 Consumer 中不变的部分,也就是浮动按钮中心的Icon 并将其作为 child 参数传入 builder 方法中。

(2)Consumer2

现在我们再来看中心的文字部分。这时候你可能会有疑惑了,刚才我们讲的 Consumer 获取的只有一个 Model,而现在 Text 组件不仅需要 CounterModel 用以显示计数器,而且还需要获得 textSize 以调整字体大小,该怎么做呢?

遇到这种情况你可以使用 Consumer2<A,B>。使用方式基本上和 Consumer<T> 一致,只不过泛型改为了两个,并且 builder 方法也变成了Function(BuildContext context, A value, B value2, Widget child)

从源码里面可以看到,这样的帮助类最多的是 Consumer6。如果还有个更多的需求,可以直接按照源码定制你的 Consumer。(感觉并不是很优雅)

(3)Provider.of<T>(context) 与 Consumer 的区别

那么,二者到底有什么差别呢?我们来看 Consumer 的内部实现。

可以发现,Consumer 就是通过 Provider.of<T>(context) 来实现的。但是从实现来讲 Provider.of<T>(context) 比 Consumer 简单好用太多,为什么我要使用更加复杂的 Consumer?

实际上 Consumer 非常有用,它的经典之处在于能够在复杂项目中,极大地缩小你的控件刷新范围Provider.of<T>(context) 将会把调用了该方法的 context 作为听众,并在 notifyListeners 的时候通知其刷新。

举个例子来说,我们的 FirstScreen 使用了 Provider.of<T>(context) 来获取数据,SecondScreen 则没有。

  • 你在 FirstScreen 中的 build 方法中添加一个 print('first screen rebuild');
  • 然后在 SecondScreen 中的 build 方法中添加一个 print('second screen rebuild');
  • 点击第二个页面的浮动按钮,那么你会在控制台看到这句输出。
3.5 First screen rebuild

首先这证明了 Provider.of<T>(context) 会导致调用的 context 页面范围的刷新。

那么第二个页面刷新没有呢? 刷新了,但是只刷新了 Consumer 的部分,甚至连浮动按钮中的 Icon 的不刷新我们都给控制了。你可以在Consumer 的 builder 方法中验证,这里不再啰嗦。

假如你在你的应用的 页面级别 的 Widget 中,使用了 Provider.of<T>(context)。会导致什么后果已经显而易见了,每当其状态改变的时候,你都会重新刷新整个页面。虽然你有 Flutter 的自动优化算法给你撑腰,但你肯定无法获得最好的性能

所以在这里我建议各位尽量使用 Consumer 而不是 Provider.of<T>(context) 获取顶层数据。

以上便是一个最简单的使用 Provider 的例子。

四、你还需要知道的

4.1 合理选择使用 Provider 的构造方法

在上面这个例子中,我们选择了使用 Provider<T>.value 的构造方法来创建祖先节点中的提供者。除了这种方式,我们还可以使用默认构造方法。

常规的 key/child 属性我们不在这里展开讲解了。先来看这个看上去相对教复杂一点的 builder。

4.1.1 ValueBuilder

相比起 .value 构造方式中直接传入一个 value 就 ok,这里的 builder 要求我们传入一个 ValueBuilder。这是什么东西呢?

通过源码可以看到,ValueBuilder 其实很简单,就是传入一个 Function 返回一个数据而已。在上面这个例子中,你可以替换成这样。

由于是 Builder 模式,这里默认需要传入 context,实际上我们的 Model(textSize)与 context 并没有关系,所以你完全可以这样写。

4.1.2 Disposer

现在我们知道了 builder,那这个 dispose 方法又用来做什么的呢。实际上这才是 Provider 的点睛之笔。

dispose 属性需要一个 Disposer<T>,而这个其实也是一个回调。

如果你之前使用过 BLoC 的话,相信你肯定遇到过一个头疼的问题。我应该在什么时候释放资源呢? BloC 使用了观察者模式,它旨在替代 StatefulWidget。然而大量的流使用完毕之后必须 close 掉,以释放资源。

然而 Stateless Widget 并没有给我们类似于 dispose 之类的方法,这便是 BLoC 的硬伤。你不得不为了释放资源而使用 StatefulWidget,这与我们的本意相违。而 Provider 则为我们解决了这一点。

当 Provider 所在节点被移除的时候,它就会启动 Disposer<T>,然后我们便可以在这里释放资源。

举个例子,假如我们有这样一个 BLoC。

这时候我们想要在某个页面提供这个 BLoC 但是又不想使用 StatefulWidget。这时候我们可以在页面顶层套上这个 Provider。

我们在 dispose 回调中关闭不再使用的流,这样就完美解决了数据释放的问题!

现在我们可以放心的结合 BLoC 一起使用了,很赞有没有。但是现在你可能又有疑问了,在使用 Provider 的时候,我应该选择哪种构造方法呢。

我的推荐是,简单模型就选择 Provider<T>.value,好处是可以精确控制刷新时机。而需要对资源进行释放处理等复杂模型的时候,Provider()默认构造方式绝对是你的最佳选择。

其他几种 Provider 也遵循该模式,需要的时候可以自行查看源码。

4.2 我该使用哪种 Provider

如果你在 Provider 中提供了可监听对象(Listenable 或者 Stream)及其子类的话,那么你会得到下面这个异常警告。

你可以将本文中所使用到的 CounterModel 放入 Provider 进行提供(记得 hot restart 而不是 hot reload),那么你就能看到上面这个 FlutterError 了。

你也可以在 main 方法中通过下面这行代码来禁用此提示。
Provider.debugCheckInvalidValueType = null;

这是由于 Provider 只能提供恒定的数据,不能通知依赖它的子部件刷新。提示也说的很清楚了,假如你想使用一个会发生 change 的 Provider,请使用下面的 Provider。

  • ListenableProvider
  • ChangeNotifierProvider
  • ValueListenableProvider
  • StreamProvider
4.2.1 ListenableProvider / ChangeNotifierProvider

你可能会在这里产生一个疑问,不是说(Listenable 或者 Stream)才不行吗,为什么我们的 CounterModel 混入的是 ChangeNotifier 但是还是出现了这个 FlutterError 呢。

我们再来看上面的这几个 Provider 有什么异同。先关注ListenableProvider / ChangeNotifierProvider 这两个类。

ListenableProvider 提供(provide)的对象是继承了 Listenable 抽象类的子类。由于无法混入,所以通过继承来获得 Listenable 的能力,同时必须实现其 addListener / removeListener 方法,手动管理收听者。显然,这样太过复杂,我们通常都不需要这样做。

而混入了 ChangeNotifier 的类自动帮我们实现了听众管理,所以 ListenableProvider 同样也可以接收混入了 ChangeNotifier 的类。

ChangeNotifierProvider 则更为简单,它能够对子节点提供一个 继承/混入/实现 了 ChangeNotifier 的类。通常我们只需要在 Model 中 with ChangeNotifier ,然后在需要刷新状态的时候调用 notifyListeners 即可。

那么 ChangeNotifierProvider 和 ListenableProvider 究竟区别在哪呢,ListenableProvider 不是也可以提供(provide)混入了 ChangeNotifier 的 Model 吗。

还是那个你需要思考的问题。你在这里的 Model 究竟是一个简单模型还是复杂模型。这是因为 ChangeNotifierProvider 会在你需要的时候,自动调用其 _disposer 方法。

我们可以在 Model 中重写 ChangeNotifier 的 dispose 方法,来释放其资源。这对于复杂 Model 的情况下十分有用。

4.2.2 ValueListenableProvider

现在你应该已经十分清楚 ListenableProvider / ChangeNotifierProvider 的区别了。下面我们来看 ValueListenableProvider。

ValueListenableProvider 用于提供实现了 继承/混入/实现 了 ValueListenable 的 Model。它实际上是专门用于处理只有一个单一变化数据的 ChangeNotifier。

通过 ValueListenable 处理的类不再需要数据更新的时候调用notifyListeners

好了,终于只剩下最后一个StreamProvider 了。

4.2.3 StreamProvider

StreamProvider 专门用作提供(provide)一条 Single Stream。我在这里仅对其核心属性进行讲解。

  • T initialData:你可以通过这个属性声明这条流的初始值。
  • ErrorBuilder catchError:这个属性用来捕获流中的 error。在这条流 addError 了之后,你会能够通过 T Function(BuildContext context, Object error) 回调来处理这个异常数据。实际开发中它非常有用。
  • updateShouldNotify:和之前的回调一样,这里不再赘述。

除了这三个构造方法都有的属性以外,StreamProvider 还有三种不同的构造方法。

  • StreamProvider(…):默认构造方法用作创建一个 Stream 并收听它。
  • StreamProvider.controller(…):通过 builder 方式创建一个StreamController。并且在 StreamProvider 被移除时,自动释放 StreamController。
  • StreamProvider.value(…):监听一个已有的 Stream 并将其 value 提供给子孙节点。

除了上面这五种已经提到过的 Provider,还有一种 FutureProvider,它提供了一个 Future 给其子孙节点,并在 Future 完成时,通知依赖的子孙节点进行刷新,这里不再详细介绍,需要的话自行查看 api 文档。

4.3 优雅地处理多个 Provider

在我们之前的例子中,我们使用了嵌套的方式来组合多个 Provider,但是这样看上去有些傻。这时候我们就可以使用一个非常 sweet 的组件 —— MultiProvider

这时候我们刚才那个例子就可以改成这样。

可以看到我们的代码意图清晰很多,而且与刚才的嵌套做法完全等价。

4.4 单元测试

直接执行原来的测试用例,一般会报错如下:

修改后的测试用例如下:

五、Tips

5.1 保证 build 方法无副作用

Build 无副作用也通常被人叫做,build 保持 pure,二者是同一个意思。

通常我们经常会看到,为了获取顶层数据我们会在 build 方法中调用 XXX.of(context) 方法。你必须非常小心,你的 build 函数不应该产生任何副作用,包括新的对象(Widget 以外),请求网络,或作出一个映射视图以外的操作等。

这是因为,你的根本无法控制什么时候你的 build 函数将会被调用。(我可以说随时)每当你的 build 函数被调用,那么都会产生一个副作用。这将会发生非常恐怖的事情。

我这样说你肯定会感到比较抽象,我们来举一个例子。

假如你有一个 ArticleModel 这个 Model 的作用是 通过网络 获取一页 List 数据,并用 ListView 显示在页面上。

这时候,我们假设你在 build 函数中做了下面这些事情。

我们在 build 函数中获得了祖先节点中的 articleModel,随后调用了 getPage 方法来获取第一页的数据。

这时候会发生什么事情呢?当我们请求成功获得了结果的时候,根据之前我们已经介绍过的,调用了 Provider.of<T>(context); 之后数据更改会重新运行其 build。这样 getPage 就又被执行了一次。

而你的 Model 中每次请求 getPage 都会导致 Model 中保存的当前请求页自增(第一次请求第一页的数据,第二次请求第二页的数据以此类推),那么每次 build 都会导致新的一次数据请求,并在新的数据 get 的时候请求下一页的数据。你的服务器挂掉那是迟早的事情。

所以你应该严格遵守这项原则,否则会导致一系列糟糕的后果。

那么怎么解决数据初始化这个问题呢,请看 Q&A 部分。

5.2 不要所有状态都放在全局

第二个小贴士是不要把你的所有状态都放在顶层。开发者为了图方便省事,再接触了状态管理之后经常喜欢把所有东西都放在顶层 MaterialApp 之上。这样看上去就很方便共享数据了,我要数据就直接去获取。

不要这么做。严格区分你的全局数据与局部数据,资源不用了就要释放!否则将会一定程度上影响你的应用性能。

5.3 尽量在 Model 中使用私有变量“_”

这可能是我们每个人在新手阶段都会出现的疑问。为什么要用私有变量呢,我在任何地方都能够操作成员不是很方便吗。

一个应用需要大量开发人员参与,你写的代码也许在几个月之后被另外一个开发看到了,这时候假如你的变量没有被保护的话,也许同样是让 count++,他会用 countController.sink.add(++_count) 这种原始方法,而不是调用你已经封装好了的 increment 方法。

虽然两种方式的效果完全一样,但是第一种方式将会让我们的业务逻辑零散的混入其他代码中。久而久之项目中就会大量充斥着这些垃圾代码增加项目代码耦合程度,非常不利于代码的维护以及阅读。

所以,请务必使用私有变量保护你的 Model。

5.4 控制你的刷新范围

在 Flutter 中,组合大于继承的特性随处可见。常见的 Widget 实际上都是由更小的 Widget 组合而成,直到基本组件为止。为了使我们的应用拥有更高的性能,控制 Widget 的刷新范围便显得至关重要。

我们已经通过前面的介绍了解到了,在 Provider 中获取 Model 的方式会影响刷新范围。所有,请尽量使用 Consumer 来获取祖先 Model,以维持最小刷新范围。

在不需要时刻监听状态变化的类中可以通过 Provider<T>.of(context, listen: false); 取消监听, 也是提升刷新效率的方式之一。

六、Q&A

在这里对一些大家可能会有疑问的常见问题做一个回答,如果你还有这之外的疑问的话,欢迎在下方评论区一起讨论。

6.1 Provider 是如何做到状态共享的

这个问题实际上得分两步。

6.1.1 获取顶层数据

实际上在祖先节点中共享数据都是通过系统的 InheritedWidget 进行实现的。

Provider 也不例外,在所有 Provider 的 build 方法中,返回了一个 InheritedProvider。

Flutter 通过在每个 Element 上维护一个 InheritedWidget 哈希表来向下传递 Element 树中的信息。通常情况下,多个
Element 引用相同的哈希表,并且该表仅在 Element 引入新的InheritedWidget 时改变。

所以寻找祖先节点的时间复杂度为 O(1) !

6.1.2 通知刷新

通知刷新这一步实际上在讲各种 Provider 的时候已经讲过了,其实就是使用了 Listener 模式。Model 中维护了一堆听众,每次调用Provider.of(context)的时候会进行注册 ,然后 notifiedListener 通知所有听众刷新。

6.2 为什么全局状态需要放在顶层 MaterialApp 之上

这个问题需要结合 Navigator 以及 BuildContext 来回答。由于 Flutter 本质上是一个单页面应用程序,所以必须放在 Navigator 的 Element 之上才能够在全局共享数据。

6.3 我应该在哪里进行数据初始化

对于数据初始化这个问题,我简单将其分为全局数据初始化与单页面数据初始化两种情况。

6.3.1 全局数据

当我们需要获取全局顶层数据(就像之前 CounterApp 例子一样)并需要做一些会产生额外结果的时候,main 函数是一个很好的选择。

我们可以在 main 方法中创建 Model 并进行初始化的工作,这样就只会执行一次。

6.3.2 单页面

如果我们的数据只是在这个页面中需要使用,那么你有这两种方式可以选择。

(1)StatefulWidget

第一种是页面级别还是使用 StatefulWidget,然后在其 State 的 didChangeDependence 生命周期中,做这些会产生额外结果的动作的事。由于 State 是长声明周期对象,在其存在期间,didChangeDependence 只会在创建的时候执行一次。

(2)cascade

你也可以在使用 dart 的级连语法 ..do() 直接在页面的 StatelessWidget 成员变量声明时进行初始化。

使用这种方式需要注意,当这个 StatelessWidget 重新运行 build 的时候,状态会丢失。这种情况在 TabBarView 中的子页面切换过程中就可能会出现。

所以建议还是使用第一种,在 State 中初始化数据。

6.4 我需要担心性能问题吗

是的,你需要随时注意应用性能是否会因为一些不当操作而降低。虽然 Flutter 可以在不做大量优化的情况下媲美原生应用的体验。然而当我们不遵守其行为规范的时候,会出现这样的情况。性能会因为你的各种不当操作而变得很糟糕。

然而 Provider 仅仅是对 InheritedWidget 的一个升级,你不必担心引入 Provider 会对应用造成性能问题。但是在使用过程中我有下面三个建议,以避免进入性能陷阱:

  • 控制 Widget 刷新范围;
  • 保持 build 方法 pure;
  • 必要时,通过重写 UpdateShouldNotify 进行性能优化。

6.5 为什么选择 Provider

Provider 不仅做到了提供数据,而且它拥有着一套完整的解决方案,覆盖了你会遇到的绝大多数情况。就连 BLoC 未解决的那个棘手的 dispose 问题,和 ScopedModel 的侵入性问题,它也都解决了。

然而它就是完美的吗,并不是,至少现在来说。Flutter Widget 构建模式很容易在 UI 层面上组件化,但是仅仅使用 Provider,Model 和 View 之间还是容易产生依赖。我们只有通过手动将 Model 转化为 ViewModel 这样才能消除掉依赖关系,所以假如各位有组件化的需求,还需要另外处理。

不过对于大多数情况来说,Provider 足以优秀,它能够让你开发出 简单高性能层次清晰、高可扩展性 的应用。

6.6 我应该如何选择状态管理

介绍了这么多状态管理,你可能会发现,一些状态管理之间职责并不冲突。例如 BLoC 可以结合 RxDart 库变得很强大,很好用。而 BLoC 也可以结合 Provider / ScopedModel 一起使用。那我应该选择哪种状态管理方式呢。

我的看法是,没有最好的,只有最合适的。根据你的业务来选择最合适的状态管理方式,面对不同复杂度的业务,往往会得出完全不同的结论。

我建议遵守以下几点:

1. 使用状态管理的目的是为了让编写代码变得更简单,任何会增加你的应用复杂度的状态管理,统统都不要用。

2. 选择自己能够 hold 住的,BLoC / Rxdart / Redux / Fish-Redux 这些状态管理方式都有一定上手难度,不要选自己无法理解的状态管理方式。

3. 在做最终决定之前,敲一敲 demo,真正感受各个状态管理方式给你带来的 好处/坏处 然后再做你的决定。

希望能够帮助到你。

七、源码浅析

7.1 Flutter 中的 Builder 模式

在 Provider 中,各种 Provider 的原始构造方法都有一个 builder 参数,这里一般就用 (_) => XXXModel() 就行了。感觉有点多此一举,为什么不能像 .value() 构造方法那样简洁呢。

实际上,Provider 为了帮我们管理 Model,使用到了 delegation pattern。

builder 声明的 ValueBuilder 最终被传入代理类 BuilderStateDelegate /SingleValueDelegate。 然后通过代理类才实现的 Model 声明周期管理。

这里就仅放 BuilderStateDelegate,其余的请自行查看源码。

7.2 如何实现 MultiProvider

MultiProvider 实际上就是通过每一个 provider 都实现了的 cloneWithChild 方法,用循环把自己一层一层包裹起来。

等价于:

以上,是本人在状态管理方面遇到的心得的总结,希望能够给各位提供参考。

参考链接