Android自定義View實現亂數驗證碼

2022-06-30 18:05:38

前言

本文面向自定義 view 新手，但是希望你最好有一定的理論知識，或基礎概念，有的地方可能會一筆帶過並不會細講，細講篇幅就太長了。

本文仿寫自鴻洋的自定義View (一)，儘管過去了將近快 7 年之久，我覺得依然有學習價值。

效果

自定義 View 分類

簡單介紹一下自定義 View 分類：

組合控制元件，繼承自已有的 layout ，比如 LinearLayout，然後通過 LayoutInflater 引入佈局，然後處理相關事件，這種方式的好處在於，不需要過度關注 view 內部的繪製機制，而且擴充套件性也很強。
繼承自現有的系統控制元件，修改或擴充套件某些屬性或方法即可，比如 AppCompatTextView
繼承自 view 或 viewgroup ，這種相對要複雜一些，因為我們要自己控制繪製流程，但是相對的，也有更大的想象空間。

步驟

先分析一下上圖中的效果：

帶顏色的矩形背景
居中的文字

比較簡單，老手稍微想一下就已經有思路了：

1.自定義屬性
2.新增構造方法
3.在構造裡獲取自定義樣式
4.重寫 onDraw 計算座標繪製
5.重寫 onMeasure 測量寬高
6.設定點選事件

先分析效果圖，然後構思，隨後不斷的調整優化。

1.自定義屬性

這一步也不一定非要寫在前面，可能有些人覺得不一定就能事先知道會用到哪些屬性，由於例子比較簡單，暫且放在前面吧，看個人習慣。

在 res/values/ 下建立一個 attrs.xml 檔案，在裡面定義我們的屬性和宣告我們的整個樣式

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <attr name="randomText" format="string"/>
    <attr name="randomTextColor" format="color"/>
    <attr name="randomTextSize" format="dimension"/>

    <declare-styleable name="RandomTextView" >
        <attr name="randomText"/>
        <attr name="randomTextColor"/>
        <attr name="randomTextSize"/>
    </declare-styleable>

</resources>

format 是值該屬性的取值型別:一共有：string，color，demension，integer，enum，reference，float，boolean，fraction，flag

在 xml 佈局中的參照：

 <com.yechaoa.customviews.randomtext.RandomTextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:padding="20dp"
        app:randomText="1234"
        app:randomTextColor="@color/colorAccent"
        app:randomTextSize="50sp" />

注意引入名稱空間：

xmlns:app="http://schemas.android.com/apk/res-auto"

2.新增構造方法

新建一個 RandomTextView 類，繼承 View ，並新增3個構造方法

class RandomTextView : View {

    //文字
    private var mRandomText: String

    //文字顏色
    private var mRandomTextColor: Int = 0

    //文字字型大小
    private var mRandomTextSize: Int = 0

    private var paint = Paint()
    private var bounds = Rect()

    //呼叫兩個引數的構造
    constructor(context: Context) : this(context, null)

    //xml預設呼叫兩個引數的構造，再呼叫三個引數的構造，在三個引數構造裡獲取自定義屬性
    constructor(context: Context, attributeSet: AttributeSet?) : this(context, attributeSet, 0)

    constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int) : super(context, attributeSet, defStyle) {
        ...
    }
    ...
}

這裡要注意的是，所有的構造方法，都指向的是第三個構造方法，前兩個構造的繼承是 this ，而不是 super 。

第一個構造比如我們可以是 new 建立的，第二個是 xml 中預設呼叫的，我們在第三個構造中去獲取自定義屬性。

3.在構造裡獲取自定義樣式

  constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int) : super(context, attributeSet, defStyle) {
        //獲取自定義屬性
        val typedArray = context.theme.obtainStyledAttributes(
            attributeSet,
            R.styleable.RandomTextView,
            defStyle,
            0
        )

        mRandomText = typedArray.getString(R.styleable.RandomTextView_randomText).toString()
        mRandomTextColor = typedArray.getColor(R.styleable.RandomTextView_randomTextColor, Color.BLACK)//預設黑色
        mRandomTextSize = typedArray.getDimensionPixelSize(
            R.styleable.RandomTextView_randomTextSize,
            TypedValue.applyDimension( TypedValue.COMPLEX_UNIT_SP, 16F, resources.displayMetrics ).toInt()
        )

        //獲取完回收
        typedArray.recycle()

        paint.textSize = mRandomTextSize.toFloat()

        //返回文字邊界，即包含文字的最小矩形，沒有所謂「留白」，返回比measureText()更精確的text寬高，資料儲存在bounds裡
        paint.getTextBounds(mRandomText, 0, mRandomText.length, bounds)
    }

通過 obtainStyledAttributes 獲取自定義屬性，返回一個 TypedArray ，這裡用到了我們在 attrs.xml 檔案中宣告的樣式（R.styleable.RandomTextView），返回的 TypedArray 即包含了這裡面的屬性。

拿到自定義 view 屬性集合，然後賦值，賦值之後就可以用 paint 去畫了。

然後用到了 paint 的 getTextBounds 方法：

paint.getTextBounds(mRandomText, 0, mRandomText.length, bounds)

簡單理解就是，把文字放在一個矩形裡，通過矩形的寬高即可知道文字的寬高，所以寬高會儲存在 bounds 裡，bounds 是一個矩形 Rect ，為什麼要這麼做呢，因為後面我們要計算文字居中的時候會用到。

ok，接下來開始畫布局。

4.重寫 onDraw 計算座標繪製

 @SuppressLint("DrawAllocation")
    override fun onDraw(canvas: Canvas?) {
        super.onDraw(canvas)

        /**
         * 自定義View時，需要我們自己在onDraw中處理padding，否則是不生效的
         * 自定義ViewGroup時，子view的padding放在onMeasure中處理
         */

        /**
         * 矩形背景
         */
        paint.color = Color.YELLOW
        //計算座標，因為原點是在文字的左下角，左邊要是延伸出去就還要往左邊去，所以是減，右邊和下邊是正，所以是加
        canvas?.drawRect(
            (0 - paddingLeft).toFloat(),
            (0 - paddingTop).toFloat(),
            (measuredWidth + paddingRight).toFloat(),
            (measuredHeight + paddingBottom).toFloat(),
            paint
        )

        /**
         * 文字
         */
        paint.color = mRandomTextColor
        //注意這裡的座標xy不是左上角，而是左下角，所以高度是相加的，在自定義view中，座標軸右下為正
        //getWidth 等於 measuredWidth
        canvas?.drawText(
            mRandomText,
            (width / 2 - bounds.width() / 2).toFloat(),
            (height / 2 + bounds.height() / 2).toFloat(),
            paint
        )
    }

上面的程式碼就是在 onDraw 裡面顯示繪製了一個 YELLOW 顏色的矩形背景，然後繪製了一個自定義屬性顏色的居中的文字。

這裡要注意我們計算位置時的座標，在自定義 view 中，原點是 view 的左上角，而在數學座標系中，原點（0,0）是在中間的，二者是有區別的。

其次，假如 xml 佈局中有 padding ，或者預判會使用到 padding，在重寫 onDraw 的時候也要把 padding 的資料加上，否則 padding 是不生效的。如果是繼承 ViewGroup 時， 子view 的 padding 放在 onMeasure 中處理。

來看此時的效果：

此時是不是有疑惑，xml 裡面的寬高明明是 wrap_content ，為什麼會充滿父佈局呢？

這就涉及到 onMeasure 的知識點了，往下看。

5.重寫 onMeasure 測量寬高

我們在 xml 設定 view 寬高有 3 種方式：

match_parent
wrap_content
具體資料，比如 100dp

onMeasure 中 MeasureSpec 的 mode 也有 3 種模式：

EXACTLY：一般是設定了明確的值或者是 MATCH_PARENT
AT_MOST：表示子佈局限制在一個最大值內，一般為 WARP_CONTENT
UNSPECIFIED：表示子佈局想要多大就多大，很少使用

由於我們 xml 用的是 wrap_content ，也就是對應 AT_MOST ，所以效果就是會佔滿父佈局中的 可用空間 ，而父佈局是填充螢幕，所以我們自定義的 view 也會佔滿全螢幕。

而我們實際想要的效果是 view 包裹自己，而不是鋪滿全螢幕，所以我們需要在 onMeasure 中進行處理

  override fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int) {
        super.onMeasure(widthMeasureSpec, heightMeasureSpec)

        /**
         * EXACTLY：一般是設定了明確的值或者是MATCH_PARENT
         * AT_MOST：表示子佈局限制在一個最大值內，一般為WARP_CONTENT
         * UNSPECIFIED：表示子佈局想要多大就多大，很少使用
         */
        val widthMode = MeasureSpec.getMode(widthMeasureSpec)
        val widthSize = MeasureSpec.getSize(widthMeasureSpec)

        val heightMode = MeasureSpec.getMode(heightMeasureSpec)
        val heightSize = MeasureSpec.getSize(heightMeasureSpec)

        var width = 0
        var height = 0

        //如果指定了寬度，或不限制寬度，用可用寬度即可，如果是WARP_CONTENT，則用文字寬度，再加上左右padding
        when (widthMode) {
            MeasureSpec.UNSPECIFIED,
            MeasureSpec.EXACTLY -> {
                width = widthSize + paddingLeft + paddingRight
            }
            MeasureSpec.AT_MOST -> {
                width = bounds.width() + paddingLeft + paddingRight
            }
        }

        //如果指定了高度，或不限制高度，用可用高度即可，如果是WARP_CONTENT，則用文字高度，再加上上下padding
        when (heightMode) {
            MeasureSpec.UNSPECIFIED,
            MeasureSpec.EXACTLY -> {
                height = heightSize + paddingTop + paddingBottom
            }
            MeasureSpec.AT_MOST -> {
                height = bounds.height() + paddingTop + paddingBottom
            }
        }

        //儲存測量的寬高
        setMeasuredDimension(width, height)
    }

上面的程式碼呢，主要做了兩件事：

獲取 view 寬高的模式
針對不同的模式，對寬高進行重新測量

最後別忘記呼叫 setMeasuredDimension 儲存新測量的寬高，否則沒用哦。

此時再看效果就是效果圖中的樣子了。

6.設定點選事件

ok，到這，view 已經繪製完成了，但是還沒有事件，我們在構造中加一個點選事件

constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int) : super(context, attributeSet, defStyle) {
        ...
        /**
         * 新增點選事件
         */
        this.setOnClickListener {
            mRandomText = randomText()
            //更新
            postInvalidate()
        }
    }

randomText 方法：

 /**
     * 根據文字長度 隨意數位
     */
    private fun randomText(): String {
        val list = mutableListOf<Int>()
        for (index in mRandomText.indices) {
            list.add(Random.nextInt(10))
        }
        val stringBuffer = StringBuffer()
        for (i in list) {
            stringBuffer.append("" + i)
        }
        return stringBuffer.toString()
    }

觸發事件之後，文字更新，然後 view 重繪 更新 頁面即可。

關於資料獲取，也就是變化後的數位，可以寫個 onTextChanged 介面，也可以寫個開放 方法 獲取。