Flutter：教你用CustomPaint画一个自定义的CircleProgressBar

注意：这其实是一篇CustomPaint的使用教程！！

源码地址：https://github.com/yumi0629/FlutterUI/tree/master/lib/circleprogressbar

在Flutter中，CustomPaint就像是Android中的Paint一样，可以用它绘制出各种各样的自定义图形。确实，Paint的使用比较复杂，我觉得直接讲API的话也太无聊了，要记住Paint的用法，还是自己动手画一个比较实在。
那为什么是画一个CircleProgressBar呢？其实这个控件本来是为了交作业的，之前在讲Hero的时候留了一个小练习，里面有一个页面，有一个很炫酷的圆形ProgressBar选择器，当时为了偷懒我就没写（不要打我），所以现在来补交了。在写这个CircleProgressBar的时候发现，CustomPaint中基本的API都使用到了，画圆、画弧线、画布旋转、Paint的各种属性的意义等等知识点都有涉及到。所以说，看完这篇文章，你绝对可以自己动手尝试画一些炫酷的UI控件来！
国际惯例，先上效果图：

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第1张图片

什么是CustomPaint

const CustomPaint({
    Key key,
    this.painter,
    this.foregroundPainter,
    this.size = Size.zero,
    this.isComplex = false,
    this.willChange = false,
    Widget child,
  })

CustomPaint是一个继承自SingleChildRenderObjectWidget的控件，所以注意，不能用setState的方式来刷新它！！painter就是我们的主绘制工具，它是一个CustomPainter；foregroundPainter是用来绘制前景的工具；size为画布大小，这个size会传递给Painter；isComplex和willChange 是告诉Flutter你的CustomPaint是否复杂到需要使用cache相关的功能；child属性我们一般不填，即使你是想要在你的CustomPaint上添加一些其他的布局，也不建议放在child属中性，因为你会发现你并不会得到你想要的结果。
所有的绘制都是发生在Painter里面的，绘制的代码写在我们的自定义CustomPainter中：

class ProgressPainter extends CustomPainter {
  @override
  void paint(Canvas canvas, Size size) {
      // 绘制代码
  }
  
  @override
  bool shouldRepaint(CustomPainter oldDelegate) {
    return true;
  }
}

我们需要重写paint()和shouldRepaint()这两个方法，一个是绘制流程，一个是在刷新布局的时候告诉Flutter是否需要重绘。注意下paint方法中的size参数，就是我们在CustomPaint中定义的size属性，它包含了基本的画布大小信息。
真正地绘制则是通过canvas和Paint来实现的，我们将定义好了的Paint画笔传递给canvas.drawXXX()方法，这个方法会告诉Flutter我们需要绘制一个什么东西，是一个圆呢、还是一条线呢？
一些常用的canvas绘制API：

// 绘制弧线
drawArc(Rect rect, double startAngle, double sweepAngle, bool useCenter, Paint paint)
// 绘制图片
drawImage(Image image, Offset p, Paint paint) 
// 绘制圆
drawCircle(Offset c, double radius, Paint paint) 
// 绘制线条
drawLine(Offset p1, Offset p2, Paint paint) 
// 绘制椭圆
drawOval(Rect rect, Paint paint)
// 绘制文字
drawParagraph(Paragraph paragraph, Offset offset)
// 绘制路径
drawPath(Path path, Paint paint) 
// 绘制点
drawPoints(PointMode pointMode, List points, Paint paint)
// 绘制Rect
drawRect(Rect rect, Paint paint) 
// 绘制阴影
drawShadow(Path path, Color color, double elevation, bool transparentOccluder)

一些常用的Paint属性：

color：画笔颜色
style：绘制模式，画线 or 充满
maskFilter：绘制完成，还没有被混合到布局上时，添加的遮罩效果，比如blur效果
strokeWidth：线条宽度
strokeCap：线条结束时的绘制样式
shader：着色器，一般用来绘制渐变效果或ImageShader

绘制步骤分析

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第2张图片

首先是静态进度条的绘制，我们先拆解这个CircleProgressBar为三部分：底部圆环、进度条和显示当前进度的小圆点。因为 Canvas的绘制顺序是按代码顺序一层一层往上叠加的，所以我们的绘制步骤应该是：绘制底部圆环——>绘制进度条——>绘制小圆点。
然后是手势拖动的实现，我们选用 GestureDetector来实现就可以了，在 onPanUpdate回调中实时刷新进度条与小圆点的位置，这里面需要注意的地方是可触摸区域的计算。

静态CircleProgressBar绘制

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第3张图片

绘制所需要的变量基本都标注在上图中了，圆心坐标就是整块画布的中心点，我们定义为(center,center)，其中center = size.width * 0.5。小圆点的半径定义为dotRadius。灰色实线部分为底部圆环，progressBar的宽度为红色虚线部分所示，其大小应该比底部圆环略大，至于大多少，你可以自己定义。在本次的例子中，我将灰色实线与红色虚线之间的部定义为radiusOffset = dotRadius * 0.4，这个值尽量不要写死，那么radiusOffset*2就是progressBar宽度比底部圆环大的值。innerRadius和outRadius分别为底部圆环的内/外半径，大小如图上所示（纯数学知识，不解释）。然后我们可以根据innerRadius和outRadius计算出progressBar宽度progressWith = outerRadius - innerRadius + radiusOffset。drawRadius是一个大小为画布宽度的一半减去小圆点半径的变量，这个变量在绘制progressBar和小圆点的时候很有用，用来确定progressBar和小圆点的位置。

Step 1 底部圆环绘制

底部圆环的绘制非常简单，实际上就是画一个圆。为什么说画圆环和画圆会是一样的呢？Paint是画笔，回想一下我们在写字的时候，写出来的字是不是有粗有细？同样地，Paint在画线的时候也是有宽度的，我们画一个有宽度的圆，不就是画一个圆环了吗？

final Offset offsetCenter = Offset(center, center);
final ringPaint = Paint()
      ..style = PaintingStyle.stroke
      ..color = ringColor
      ..strokeWidth = (outerRadius - innerRadius);
canvas.drawCircle(offsetCenter, drawRadius, ringPaint);

canvas.drawCircle(Offset c, double radius, Paint paint)这个方法就是绘制一个圆，其中c为圆心坐标点，这个offset偏移值是以画布原点（左上角）为坐标轴中心点来计算的，很明显大小为offsetCenter = Offset(center, center)；radius为圆环半径，大小其实就是图上标示的drawRadius；paint就是我们的画笔，这里要注意，绘制圆环需要设置style = PaintingStyle.stroke，否则画笔会默认充满内部，那么你绘制出来的就是一个圆了。

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第4张图片

Step 2 底部进度条

绘制进度条实际上就是绘制圆弧，我们使用canvas.drawArc(Rect rect, double startAngle, double sweepAngle, bool useCenter, Paint paint)。
rect参数就是圆弧所在的整圆的Rect，我们使用Rect.fromCircle来构造这个整圆的Rect：final Rect arcRect = Rect.fromCircle(center: offsetCenter, radius: drawRadius);；startAngle为起始弧度，sweepAngle为需要绘制的圆弧长度，这里要注意，这两个值都是 弧度制 的，canvas里面与角度有关的变量都是弧度制的，在计算的时候一定要注意；useCenter属性标示是否需要将圆弧与圆心相连；paint就是我们的画笔。
补充：弧度与角度的弧线转换：

num degToRad(num deg) => deg * (pi / 180.0);
num radToDeg(num rad) => rad * (180.0 / pi);

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第5张图片

 final angle = 360.0 * progress;
 final double radians = degToRad(angle);
 final Rect arcRect = Rect.fromCircle(center: offsetCenter, radius: drawRadius);
 final progressPaint = Paint()
          ..style = PaintingStyle.stroke
          ..strokeWidth = progressWidth;
canvas.drawArc(arcRect, 0.0, degToRad(angle), false, progressPaint);

假设当前进度为progress（范围为0.0～1.0），那么当前角度为angle = 360.0 * progress，当前弧度为radians = degToRad(angle)，上述代码可以绘制出一个基础的圆弧。但是我们会发现，圆弧的两端是平的，很影响美观，这时候就需要用到paint的strokeCap属性了。

我们将 paint设置为 StrokeCap.round，就能得到一个最基本的进度条了。

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第6张图片

接下来我们给进度条添加颜色，按照设计稿，我们需要添加一个渐变色。渐变色可以通过 paint的 shader属性来实现：

final Gradient gradient = new SweepGradient(
          endAngle: radians,
          colors: [
            Colors.white,
            currentDotColor,
          ],
        );
final progressPaint = Paint()
        ..style = PaintingStyle.stroke
        ..strokeCap = StrokeCap.round
        ..strokeWidth = progressWidth
        ..shader = gradient.createShader(arcRect);

Flutter提供了三种基础的用来绘制渐变效果的类：SweepGradient（扫描渐变）、LinearGradient（线性渐变）和RadialGradient（径向渐变）。

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第7张图片

很明显，我们需要用到的是 SweepGradient：

final Gradient gradient = new SweepGradient(
          endAngle: radians,
          colors: [
            Colors.white,
            currentDotColor,
          ],
        );

注意，这里有一个很大的坑，我们可以从上面的SweepGradient事例图上看到，默认情况下是从90°的地方作为起点的，这跟我们的要求明显是不符的。SweepGradient有一个startAngle属性，那么我们是否可以将其设置为degToRad(-90°)就可以解决问题了呢？答案是：不可以。这里怀疑是Flutter的一个bug，startAngle属性不生效，我们可以看一下这个issue：SweepGradient startAngle doesn't work as expected.

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第8张图片

那么怎么解决呢？我想了很久之后决定采用一个曲线救国的方法，那就是： 旋转画布！！。反正是一个圆弧嘛，那我把画布逆时针旋转90°不就行了嘛（这里还要注意，画布默认旋转中心为坐标轴原点，而且貌似不能更改，至少我没找到，所以需要旋转后再平移，对canvas的位置操作需要倒着写，所以实际代码是先写translate，再写rotate）：

canvas.save();
canvas.translate(0.0, size.width);
canvas.rotate(degToRad(-90.0));
······
canvas.drawArc(arcRect, 0.0, degToRad(angle), false, paint);
canvas.restore();

画到这里你是不是觉得已经很OK了呢？运行一下，啊嘞，怎么会这样纸？

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第9张图片

这是我们给stroke设置了StrokeCap.round导致的，因为Flutter在给线绘制圆角时，是在线长的外面加了一段圆角，导致实际长度会超过我们定义的长度。那怎么办呢？还是曲线救国，我们在drawArc的时候，将起始角度往后偏移一段不就可以了吗？我们将这段偏移弧度定义为offset，其大小为offset = asin(progressWidth * 0.5 / drawRadius)（怎么算出来的？数学问题，自己那张草稿纸画画就知道啦～）。
所以最终的绘制代码应该为：

canvas.drawArc(arcRect, offset, degToRad(angle) - offset, false, progressPaint);

那么到此为止，我们的进度条部分也绘制完成了。

Step 3 绘制小圆点

绘制小圆点就比较简单了，只要计算出小圆点的圆心位置就可以了，纯初中数学计算，自己拿纸画画就知道啦。绘制函数依然是canvas.drawCircle，因为是绘制圆，所以不需要更改PaintingStyle。

 final double dx = center + drawRadius * sin(radians);
 final double dy = center - drawRadius * cos(radians);
 final dotPaint = Paint()..color = currentDotColor;
 canvas.drawCircle(new Offset(dx, dy), dotRadius, dotPaint);
 dotPaint
      ..color = dotEdgeColor
      ..style = PaintingStyle.stroke
      ..strokeWidth = dotRadius * 0.3;
 canvas.drawCircle(new Offset(dx, dy), dotRadius, dotPaint);

Step 4 细节修饰：绘制底部圆环阴影和小圆点外圈

绘制圆环阴影

绘制阴影有两种方法，实现出来的效果也不太一样。
1）使用canvas.drawShadow()来绘制：
drawShadow(Path path, Color color, double elevation, bool transparentOccluder)，根据API要求，我们需要先计算出圆环的Path，Path的相关API只支持向path中添加圆、弧线、直线、点等属性，我们没法直接构建一个圆环对应的对象Path。换个角度思考一下，圆环的Path其实是外层圆与内层圆组合的结果，所以我们使用Path.combine()方法来获得圆环的路径，通过设置组合模式为PathOperation.difference可以获取内外两个圆的公共部分的Path，也就是圆环的Path：

Path path = Path.combine(PathOperation.difference,
    Path()..addOval(Rect.fromCircle(center: offsetCenter, radius: outerRadius)),
    Path()..addOval(Rect.fromCircle(center: offsetCenter, radius: innerRadius)));
canvas.drawShadow(path, shadowColor, 4.0, true);

2）使用paint的MaskFilter.blur()来绘制：
这个方法其实是用来绘制毛玻璃效果的，用来绘制阴影，听起来也有些曲线救国的意味，但是官方注释中有一句话：

Creates a mask filter that takes the shape being drawn and blurs it.
This is commonly used to approximate shadows.

所以这个真的也是可以用来绘制阴影的，而且Flutter在绘制一些Button控件的时候也是使用来blur的效果来实现的。MaskFilter.blur()其实就是将你绘制的东西变模糊，所以我们可以绘制一个圆环，然后将其进行高斯模糊，造成一种加了“阴影”的假象。

final shadowPaint = Paint()
      ..style = PaintingStyle.stroke
      ..color = shadowColor
      ..strokeWidth = shadowWidth
      ..maskFilter = MaskFilter.blur(BlurStyle.normal, shadowWidth);
canvas.drawCircle(offsetCenter, outerRadius, shadowPaint);
canvas.drawCircle(offsetCenter, innerRadius, shadowPaint);

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第10张图片

两者绘制结果的区别很明显，canvas.drawShadow()是将整个圆环作为一个整体，为其添加阴影；而MaskFilter.blur()其实就是绘制两个模糊的圆环，作为一种阴影的替代品。使用哪种方式绘制，还是取决于你需要什么样的效果。

小圆点外圈绘制

这个没什么难度的，就是在小圆点外面再绘制一个圆环而已：

 dotPaint
      ..color = dotEdgeColor
      ..style = PaintingStyle.stroke
      ..strokeWidth = dotRadius * 0.3;
canvas.drawCircle(new Offset(dx, dy), dotRadius, dotPaint);

到此为止，一个静态的CircleProgressBar就绘制完成了：

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第11张图片

添加手势控制

手势控制我们通过最简单的方式来实现，那就是在CircleProgressBar外面包裹一层GestureDetector，然后在onPanUpdate回调中刷新进度：

GestureDetector(
      onPanStart: _onPanStart,
      onPanUpdate: _onPanUpdate,
      onPanEnd: _onPanEnd,
      child: Container(
        alignment: FractionalOffset.center,
        child: CustomPaint(
          key: paintKey,
          size: size,
          painter: ProgressPainter(),
        ),
      ),
    )

进度的记录我们依然是使用AnimationController，因为我们可以使用controller.animateTo()方法，很方便得将进度条从当前位置平滑地移动到目标位置：

  AnimationController progressController;

  @override
  void initState() {
    super.initState();
    progressController =
        AnimationController(duration: Duration(milliseconds: 300), vsync: this);
    if (widget.progress != null) progressController.value = widget.progress;
    progressController.addListener(() {
      if (widget.progressChanged != null)
        widget.progressChanged(progressController.value);
      setState(() {});
    });
  }

接下来就是判断用户的触摸点是否在有效范围内，因为用户只有在触摸圆环的时候才应该触发手势，判断方法也很简单，那就是看系统反馈给我们的pointer位置收否位于圆环上。但是实际操作会有一个问题，那就是系统反馈的触摸点位置是一个全局的坐标点，坐标轴原点在屏幕的左上角，然后圆环在屏幕中的全局坐标我们无法知晓。好在Flutter为我们提供了一个全局坐标与局部坐标的转换方法：

void _onPanUpdate(DragUpdateDetails details) {
    RenderBox getBox = key.currentContext.findRenderObject();
    Offset local = getBox.globalToLocal(details.globalPosition);
}

拿到局部坐标后，通过计算触摸点与圆心的距离，是否在内、外半径范围内，就可以判断是否为有效触摸了（一般情况下触摸范围会比圆环更大一线，方便用户操作，所以我将validInnerRadius的值，设置地比widget.radius - widget.dotRadius更小一点）：

bool _checkValidTouch(Offset pointer) {
    final double validInnerRadius = widget.radius - widget.dotRadius * 3;
    final double dx = pointer.dx;
    final double dy = pointer.dy;
    final double distanceToCenter =
        sqrt(pow(dx - widget.radius, 2) + pow(dy - widget.radius, 2));
    if (distanceToCenter < validInnerRadius ||
        distanceToCenter > widget.radius) {
      return false;
    }
    return true;
  }

接下来就是计算触摸点所在的角度了，要注意根据边来计算角度时，位于不同的象限，要做不同的处理：

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第12张图片

  void _onPanUpdate(DragUpdateDetails details) {
    if (!isValidTouch) {
      return;
    }
    RenderBox getBox = paintKey.currentContext.findRenderObject();
    Offset local = getBox.globalToLocal(details.globalPosition);
    final double x = local.dx;
    final double y = local.dy;
    final double center = widget.radius;
    double radians = atan((x - center) / (center - y));
    if (y > center) {
      radians = radians + degToRad(180.0);
    } else if (x < center) {
      radians = radians + degToRad(360.0);
    }
    progressController.value = radians / degToRad(360.0);
  }

将触摸点所在的角度转化为进度，改变progressController.value的值，通过setState()的方式，通知界面刷新，一个跟随着用户手势而更改进度的CircleProgressBar就完成了。

一些其他的细节

在实际运行时，如果角度过小时，会出现下面的情况：

Flutter：教你用CustomPaint画一个自定义的CircleProgressBar_第13张图片

这是因为我们在绘制进度条的时候进行了偏移导致的，如果你想通过调整进度条的方式来修改，会比较麻烦，不妨换个角度，当角度很小的时候（radians < offset），进度条其实是被小圆点挡住了，看不到的，那么直接不绘制就可以了。

进度的监听可以通过暴露的回调progressChanged(double value)得到，范围是(0.0~1.0)。