创建自定义绘图

试用 Compose 方式
Jetpack Compose 是推荐用于 Android 的界面工具包。了解如何在 Compose 中使用布局。

自定义视图最重要的部分是外观。自定义绘制可能简单,也可能很复杂,具体取决于应用的需求。本文档介绍了一些最常见的操作。

如需了解详情,请参阅可绘制对象概览

替换 onDraw()

绘制自定义视图最重要的一步是替换 onDraw() 方法。onDraw() 的参数是一个 Canvas 对象,视图可以使用它来绘制自身。Canvas 类定义了绘制文本、线条、位图和许多其他图形基元的方法。您可以在 onDraw() 中使用这些方法创建自定义界面 (UI)。

首先创建一个 Paint 对象。下一节将详细介绍 Paint

创建绘图对象

android.graphics 框架将绘制分为两个方面:

  • 绘制内容,由 Canvas 处理。
  • 如何绘制,由 Paint 处理。

例如,Canvas 提供了绘制线条的方法,Paint 提供了定义该线条颜色的方法。Canvas 具有绘制矩形的方法,Paint 则用于定义是用颜色填充该矩形还是将其留空。Canvas 定义您可以在屏幕上绘制的形状,Paint 定义您绘制的每个形状的颜色、样式和字体等。

在绘制任何内容之前,请先创建一个或多个 Paint 对象。以下示例在名为 init 的方法中执行此操作。此方法是从 Java 的构造函数调用的,但可以在 Kotlin 中以内嵌方式初始化。

Kotlin

@ColorInt
private var textColor    // Obtained from style attributes.

@Dimension
private var textHeight   // Obtained from style attributes.

private val textPaint = Paint(ANTI_ALIAS_FLAG).apply {
    color = textColor
    if (textHeight == 0f) {
        textHeight = textSize
    } else {
        textSize = textHeight
    }
}

private val piePaint = Paint(Paint.ANTI_ALIAS_FLAG).apply {
    style = Paint.Style.FILL
    textSize = textHeight
}

private val shadowPaint = Paint(0).apply {
    color = 0x101010
    maskFilter = BlurMaskFilter(8f, BlurMaskFilter.Blur.NORMAL)
}

Java

private Paint textPaint;
private Paint piePaint;
private Paint shadowPaint;

@ColorInt
private int textColor;       // Obtained from style attributes.

@Dimension
private float textHeight;    // Obtained from style attributes.

private void init() {
   textPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
   textPaint.setColor(textColor);
   if (textHeight == 0) {
       textHeight = textPaint.getTextSize();
   } else {
       textPaint.setTextSize(textHeight);
   }

   piePaint = new Paint(Paint.ANTI_ALIAS_FLAG);
   piePaint.setStyle(Paint.Style.FILL);
   piePaint.setTextSize(textHeight);

   shadowPaint = new Paint(0);
   shadowPaint.setColor(0xff101010);
   shadowPaint.setMaskFilter(new BlurMaskFilter(8, BlurMaskFilter.Blur.NORMAL));
   ...
}

提前创建对象是一项重要的优化措施。视图会频繁重新绘制,并且许多绘制对象需要进行成本高昂的初始化。在 onDraw() 方法中创建绘制对象会显著降低性能并使界面运行缓慢。

处理布局事件

为了正确绘制自定义视图,请先确定它的大小。复杂的自定义视图通常需要执行多次布局计算,具体取决于它们在屏幕上所占区域的大小和形状。切勿对视图在屏幕上的大小做假设。即使只有一个应用使用您的视图,该应用也需要在竖屏和横屏模式下处理不同的屏幕尺寸、多种屏幕密度和各种宽高比。

虽然 View 有许多处理测量方法,但其中大多数方法都不需要替换。如果您的视图不需要对其大小进行特殊控制,只需替换一个方法:onSizeChanged()

首次为视图分配大小时,系统会调用 onSizeChanged(),如果视图大小因任何原因发生变化,系统会再次调用该方法。您可以在 onSizeChanged() 中计算位置、尺寸以及其他与视图大小相关的值,而不是在每次绘制时都重新计算。在以下示例中,视图在 onSizeChanged() 中计算图表的边界矩形以及文本标签和其他视觉元素的相对位置。

为视图分配尺寸后,布局管理器会假定该尺寸包含视图的内边距。在计算视图的大小时处理内边距值。以下是 onSizeChanged() 中的一段代码,展示了如何执行此操作:

Kotlin

private val showText    // Obtained from styled attributes.
private val textWidth   // Obtained from styled attributes.

override fun onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int) {
    super.onSizeChanged(w, h, oldw, oldh)
    // Account for padding.
    var xpad = (paddingLeft + paddingRight).toFloat()
    val ypad = (paddingTop + paddingBottom).toFloat()

    // Account for the label.
    if (showText) xpad += textWidth.toFloat()
    val ww = w.toFloat() - xpad
    val hh = h.toFloat() - ypad

    // Figure out how big you can make the pie.
    val diameter = Math.min(ww, hh)
}

Java

private Boolean showText;    // Obtained from styled attributes.
private int textWidth;       // Obtained from styled attributes.

@Override
protected void onSizeChanged(int w, int h, int oldw, int oldh) {
    super.onSizeChanged(w, h, oldw, oldh);
    // Account for padding.
    float xpad = (float)(getPaddingLeft() + getPaddingRight());
    float ypad = (float)(getPaddingTop() + getPaddingBottom());

    // Account for the label.
    if (showText) xpad += textWidth;

    float ww = (float)w - xpad;
    float hh = (float)h - ypad;

    // Figure out how big you can make the pie.
    float diameter = Math.min(ww, hh);
}

如果您需要更精细地控制视图的布局参数,请实现 onMeasure()。此方法的参数是 View.MeasureSpec 值,用于告诉您视图的父级希望您的视图有多大,以及该大小是硬性最大值还是只是建议值。为了进行优化,这些值会存储为打包的整数,您可以使用 View.MeasureSpec 的静态方法解压缩每个整数中存储的信息。

下面是 onMeasure() 的实现示例。在此实现中,它会尝试使面积足够大,以使图表与其标签一样大:

Kotlin

override fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int) {
    // Try for a width based on your minimum.
    val minw: Int = paddingLeft + paddingRight + suggestedMinimumWidth
    val w: Int = View.resolveSizeAndState(minw, widthMeasureSpec, 1)

    // Whatever the width is, ask for a height that lets the pie get as big as
    // it can.
    val minh: Int = View.MeasureSpec.getSize(w) - textWidth.toInt() + paddingBottom + paddingTop
    val h: Int = View.resolveSizeAndState(minh, heightMeasureSpec, 0)

    setMeasuredDimension(w, h)
}

Java

@Override
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
   // Try for a width based on your minimum.
   int minw = getPaddingLeft() + getPaddingRight() + getSuggestedMinimumWidth();
   int w = resolveSizeAndState(minw, widthMeasureSpec, 1);

   // Whatever the width is, ask for a height that lets the pie get as big as it
   // can.
   int minh = MeasureSpec.getSize(w) - (int)textWidth + getPaddingBottom() + getPaddingTop();
   int h = resolveSizeAndState(minh, heightMeasureSpec, 0);

   setMeasuredDimension(w, h);
}

在此代码中,有三点需要注意:

  • 计算时会考虑视图的内边距。如前所述,这是视图负责的。
  • 辅助方法 resolveSizeAndState() 用于创建最终的宽度和高度值。此帮助程序通过将视图所需的大小与传入 onMeasure() 的值进行比较,返回合适的 View.MeasureSpec 值。
  • onMeasure() 没有返回值。而是通过调用 setMeasuredDimension() 来传达其结果。 必须调用此方法。如果省略此调用,View 类会抛出运行时异常。

绘制

定义对象创建和测量代码后,您可以实现 onDraw()。每个视图以不同的方式实现 onDraw(),但大多数视图共享一些常见的操作:

  • 使用 drawText() 绘制文本。 通过调用 setTypeface() 指定字体,并通过调用 setColor() 指定文本颜色。
  • 使用 drawRect()drawOval()drawArc() 绘制基元形状。 通过调用 setStyle(),更改形状是填充和/或有轮廓。
  • 使用 Path 类绘制更复杂的形状。通过向 Path 对象添加线条和曲线来定义形状,然后使用 drawPath() 绘制形状。 与基元形状一样,路径可以只描绘轮廓和/或被填充,具体取决于 setStyle()
  • 通过创建 LinearGradient 对象定义渐变填充。调用 setShader() 可对填充的形状使用 LinearGradient
  • 使用 drawBitmap() 绘制位图。

以下代码用于绘制文本、线条和形状的组合:

Kotlin

private val data = mutableListOf<Item>() // A list of items that are displayed.

private var shadowBounds = RectF()       // Calculated in onSizeChanged.
private var pointerRadius: Float = 2f    // Obtained from styled attributes.
private var pointerX: Float = 0f         // Calculated in onSizeChanged.
private var pointerY: Float = 0f         // Calculated in onSizeChanged.
private var textX: Float = 0f            // Calculated in onSizeChanged.
private var textY: Float = 0f            // Calculated in onSizeChanged.
private var bounds = RectF()             // Calculated in onSizeChanged.
private var currentItem: Int = 0         // The index of the currently selected item.

override fun onDraw(canvas: Canvas) {
    super.onDraw(canvas)

    canvas.apply {
        // Draw the shadow.
        drawOval(shadowBounds, shadowPaint)

        // Draw the label text.
        drawText(data[currentItem].label, textX, textY, textPaint)

        // Draw the pie slices.
        data.forEach {item ->
            piePaint.shader = item.shader
            drawArc(
                bounds,
                360 - item.endAngle,
                item.endAngle - item.startAngle,
                true,
                piePaint
            )
        }

        // Draw the pointer.
        drawLine(textX, pointerY, pointerX, pointerY, textPaint)
        drawCircle(pointerX, pointerY, pointerRadius, textPaint)
    }
}

// Maintains the state for a data item.
private data class Item(
    var label: String,      
    var value: Float = 0f,

    @ColorInt
    var color: Int = 0,

    // Computed values.
    var startAngle: Float = 0f,
    var endAngle: Float = 0f,

    var shader: Shader
)

Java

private List<Item> data = new ArrayList<Item>();  // A list of items that are displayed.

private RectF shadowBounds;                       // Calculated in onSizeChanged.
private float pointerRadius;                      // Obtained from styled attributes.
private float pointerX;                           // Calculated in onSizeChanged.
private float pointerY;                           // Calculated in onSizeChanged.
private float textX;                              // Calculated in onSizeChanged.
private float textY;                              // Calculated in onSizeChanged.
private RectF bounds;                             // Calculated in onSizeChanged.
private int currentItem = 0;                      // The index of the currently selected item.

protected void onDraw(Canvas canvas) {
    super.onDraw(canvas);

    // Draw the shadow.
    canvas.drawOval(
            shadowBounds,
            shadowPaint
    );

    // Draw the label text.
    canvas.drawText(data.get(currentItem).label, textX, textY, textPaint);

    // Draw the pie slices.
    for (int i = 0; i < data.size(); ++i) {
        Item it = data.get(i);
        piePaint.setShader(it.shader);
        canvas.drawArc(
                bounds,
                360 - it.endAngle,
                it.endAngle - it.startAngle,
                true, 
                piePaint
        );
    }

    // Draw the pointer.
    canvas.drawLine(textX, pointerY, pointerX, pointerY, textPaint);
    canvas.drawCircle(pointerX, pointerY, pointerRadius, textPaint);
}

// Maintains the state for a data item.
private class Item {
    public String label;
    public float value;
    @ColorInt
    public int color;

    // Computed values.
    public int startAngle;
    public int endAngle;

    public Shader shader;
}    

应用图形效果

Android 12(API 级别 31)添加了 RenderEffect 类,该类将常见的图形效果(如模糊处理、色彩滤镜、Android 着色器效果等)应用于 View 对象和渲染层次结构。您可以将各种效果组合成链式效果,这些效果由内外层效果或混合效果组成。对此功能的支持因设备的处理能力而异。

此外,您还可以通过调用 View.setRenderEffect(RenderEffect) 将效果应用于 View 的底层 RenderNode

如需实现 RenderEffect 对象,请执行以下操作:

view.setRenderEffect(RenderEffect.createBlurEffect(radiusX, radiusY, SHADER_TILE_MODE))

您可以通过编程方式创建视图或从 XML 布局中膨胀视图,然后使用视图绑定findViewById() 检索视图。