Android原始碼分析--CircleImageView 原始碼詳解

原始碼地址為 https://github.com/hdodenhof/CircleImageView

實際上就是一個圓形的imageview 的自定義控制元件。程式碼寫的很優雅，實現效果也很好，

特此分析。原始碼其實不難 主要就是一個類，可以把我的這個加了註釋的原始碼放到你自己的工程裡直接替換

然後run，這樣效果更佳。

package de.hdodenhof.circleimageview;

import android.content.Context;
import android.content.res.TypedArray;
import android.graphics.Bitmap;
import android.graphics.BitmapShader;
import android.graphics.Canvas;
import android.graphics.Color;
import android.graphics.ColorFilter;
import android.graphics.Matrix;
import android.graphics.Paint;
import android.graphics.RectF;
import android.graphics.Shader;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.ColorDrawable;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.support.annotation.ColorRes;
import android.support.annotation.DrawableRes;
import android.util.AttributeSet;
import android.util.Log;
import android.widget.ImageView;

/**
 * 實際上整體思路還是比較簡單的，利用BitmapShader 來把imageview裡的圖片分割成圓形
 * 畫出圓形來以後 再畫描邊。
 * 這個開源控制元件做的比較出色的地方是updateShaderMatrix 函式會幫忙做圖片修正，使切割出來的圖片損失度最小.
 * 此外就是各種情況考慮的比較多，流程控制的比較嚴謹，其中主要是多次呼叫setup函式 來完成imageview的及時重新整理
 */
public class CircleImageView extends ImageView {

    private static final ScaleType SCALE_TYPE = ScaleType.CENTER_CROP;

    private static final Bitmap.Config BITMAP_CONFIG = Bitmap.Config.ARGB_8888;
    private static final int COLORDRAWABLE_DIMENSION = 2;

    private static final int DEFAULT_BORDER_WIDTH = 0;
    private static final int DEFAULT_BORDER_COLOR = Color.BLACK;
    private static final boolean DEFAULT_BORDER_OVERLAY = false;

    private final RectF mDrawableRect = new RectF();
    private final RectF mBorderRect = new RectF();

    private final Matrix mShaderMatrix = new Matrix();
    //這個畫筆最重要的是關聯了mBitmapShader 使canvas在執行的時候可以切割原圖片(mBitmapShader是關聯了原圖的bitmap的)
    private final Paint mBitmapPaint = new Paint();
    //這個描邊，則與本身的原圖bitmap沒有任何關聯，
    private final Paint mBorderPaint = new Paint();

    //這裡定義了 圓形邊緣的預設寬度和顏色
    private int mBorderColor = DEFAULT_BORDER_COLOR;
    private int mBorderWidth = DEFAULT_BORDER_WIDTH;

    private Bitmap mBitmap;
    private BitmapShader mBitmapShader;
    private int mBitmapWidth;
    private int mBitmapHeight;

    private float mDrawableRadius;
    private float mBorderRadius;

    private ColorFilter mColorFilter;

    /**
     * 初始值都為false
     */
    private boolean mReady;
    private boolean mSetupPending;
    private boolean mBorderOverlay;

    public CircleImageView(Context context) {
        super(context);

        init();
    }

    public CircleImageView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public CircleImageView(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        Log.v("CircleImageView", "gou zao han shu");
        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CircleImageView, defStyle, 0);

        //取得我們在xml裡定義的引數值
        mBorderWidth = a.getDimensionPixelSize(R.styleable.CircleImageView_border_width, DEFAULT_BORDER_WIDTH);
        mBorderColor = a.getColor(R.styleable.CircleImageView_border_color, DEFAULT_BORDER_COLOR);
        mBorderOverlay = a.getBoolean(R.styleable.CircleImageView_border_overlay, DEFAULT_BORDER_OVERLAY);

        a.recycle();

        init();
    }

    /**
     * 這個函式 只在建構函式裡面呼叫 他的作用就是 保證setup函式裡的流程一定要在
     * 建構函式執行完畢的時候去呼叫 mReady為true setup函式裡的程式碼才能向下執行
     */
    private void init() {
        Log.v("CircleImageView", "init()");
        super.setScaleType(SCALE_TYPE);
        mReady = true;

        if (mSetupPending) {
            setup();
            mSetupPending = false;
        }
    }

    @Override
    public ScaleType getScaleType() {
        return SCALE_TYPE;
    }

    /**
     * 這裡明確指出 此種imageview 只支援CENTER_CROP 這一種屬性
     *
     * @param scaleType
     */
    @Override
    public void setScaleType(ScaleType scaleType) {
        if (scaleType != SCALE_TYPE) {
            throw new IllegalArgumentException(String.format("ScaleType %s not supported.", scaleType));
        }
    }

    @Override
    public void setAdjustViewBounds(boolean adjustViewBounds) {
        if (adjustViewBounds) {
            throw new IllegalArgumentException("adjustViewBounds not supported.");
        }
    }

    @Override
    protected void onDraw(Canvas canvas) {
        Log.v("CircleImageView", "onDraw");
        if (getDrawable() == null) {
            return;
        }

        //這行程式碼就是把imageview 切割成最終的圓形
        canvas.drawCircle(getWidth() / 2, getHeight() / 2, mDrawableRadius, mBitmapPaint);
        //如果圓形邊緣的寬度不為0 我們還要繼續畫這個描邊
        if (mBorderWidth != 0) {
            canvas.drawCircle(getWidth() / 2, getHeight() / 2, mBorderRadius, mBorderPaint);
        }
    }

    @Override
    protected void onSizeChanged(int w, int h, int oldw, int oldh) {
        super.onSizeChanged(w, h, oldw, oldh);
        setup();
    }

    public int getBorderColor() {
        return mBorderColor;
    }

    public void setBorderColor(int borderColor) {
        if (borderColor == mBorderColor) {
            return;
        }

        mBorderColor = borderColor;
        mBorderPaint.setColor(mBorderColor);
        invalidate();
    }

    public void setBorderColorResource(@ColorRes int borderColorRes) {
        setBorderColor(getContext().getResources().getColor(borderColorRes));
    }

    public int getBorderWidth() {
        return mBorderWidth;
    }

    public void setBorderWidth(int borderWidth) {
        if (borderWidth == mBorderWidth) {
            return;
        }

        mBorderWidth = borderWidth;
        setup();
    }

    public boolean isBorderOverlay() {
        return mBorderOverlay;
    }

    public void setBorderOverlay(boolean borderOverlay) {
        if (borderOverlay == mBorderOverlay) {
            return;
        }

        mBorderOverlay = borderOverlay;
        setup();
    }

    @Override
    public void setImageBitmap(Bitmap bm) {
        super.setImageBitmap(bm);
        mBitmap = bm;
        setup();
    }


    /**
     * 注意這個函式 是在我們的建構函式呼叫之前就呼叫了
     *
     * @param drawable
     */
    @Override
    public void setImageDrawable(Drawable drawable) {
        Log.v("CircleImageView", "setImageDrawable Drawable");
        super.setImageDrawable(drawable);
        mBitmap = getBitmapFromDrawable(drawable);
        setup();
    }

    @Override
    public void setImageResource(@DrawableRes int resId) {
        super.setImageResource(resId);
        mBitmap = getBitmapFromDrawable(getDrawable());
        setup();
    }

    @Override
    public void setImageURI(Uri uri) {
        super.setImageURI(uri);
        mBitmap = getBitmapFromDrawable(getDrawable());
        setup();
    }

    @Override
    public void setColorFilter(ColorFilter cf) {
        if (cf == mColorFilter) {
            return;
        }

        mColorFilter = cf;
        mBitmapPaint.setColorFilter(mColorFilter);
        invalidate();
    }

    private Bitmap getBitmapFromDrawable(Drawable drawable) {
        Log.v("CircleImageView", "getBitmapFromDrawable");
        if (drawable == null) {
            Log.v("CircleImageView", "drawable==null");
            //這種情況一般不會發生
            return null;
        }

        if (drawable instanceof BitmapDrawable) {
            Log.v("CircleImageView", "drawable instanceof BitmapDrawable");
            //通常來說 我們的程式碼就是執行到這裡就返回了。返回的就是我們最原始的bitmap
            return ((BitmapDrawable) drawable).getBitmap();
        }
        Log.v("CircleImageView", "drawable is not instanceof BitmapDrawable");

        try {
            Bitmap bitmap;

            if (drawable instanceof ColorDrawable) {
                Log.v("CircleImageView", "drawable  instanceof ColorDrawable");
                bitmap = Bitmap.createBitmap(COLORDRAWABLE_DIMENSION, COLORDRAWABLE_DIMENSION, BITMAP_CONFIG);
            } else {
                Log.v("CircleImageView", "drawable  is not instanceof ColorDrawable");
                bitmap = Bitmap.createBitmap(drawable.getIntrinsicWidth(), drawable.getIntrinsicHeight(), BITMAP_CONFIG);
            }

            Canvas canvas = new Canvas(bitmap);
            drawable.setBounds(0, 0, canvas.getWidth(), canvas.getHeight());
            drawable.draw(canvas);
            return bitmap;
        } catch (OutOfMemoryError e) {
            return null;
        }
    }

    /**
     * 這個函式比較關鍵，就是在進行一些重繪引數的初始化
     */
    private void setup() {
        Log.v("CircleImageView", "setup()");
        Log.v("CircleImageView", "mReady==" + mReady + "   mSetupPending==" + mSetupPending);
        //這個地方要注意mReady的預設值為false,也就是說第一次進這個函式的時候 因為為false 所以直接進入括號
        //體內然後返回，後面的程式碼並沒有執行。 同時也能知道，mReady的值更改成true 是在init函式裡面做的
        if (!mReady) {
            mSetupPending = true;
            return;
        }

        //防止空指標異常
        if (mBitmap == null) {
            return;
        }

        //引數值就代表 如果圖片太小的話 就直接拉伸，repeat引數代表 圖片大小的話就重複放圖片 mirror就是映象對著放圖片的意思 跟大家設定pc 屏保時候其實是一樣的
        mBitmapShader = new BitmapShader(mBitmap, Shader.TileMode.CLAMP, Shader.TileMode.CLAMP);

        mBitmapPaint.setAntiAlias(true);
        mBitmapPaint.setShader(mBitmapShader);


        mBorderPaint.setStyle(Paint.Style.STROKE);
        mBorderPaint.setAntiAlias(true);
        mBorderPaint.setColor(mBorderColor);
        mBorderPaint.setStrokeWidth(mBorderWidth);

        //這個地方是取的原圖片的大小
        mBitmapHeight = mBitmap.getHeight();
        mBitmapWidth = mBitmap.getWidth();

        //注意這個地方取的是imageview的實際大小，也就是說這個地方畫了一個和imageview實際大小一致的方形圖
        mBorderRect.set(0, 0, getWidth(), getHeight());
        Log.v("CircleImageView", "mBitmapHeight==" + mBitmapHeight + "  mBitmapWidth==" + mBitmapWidth);
        Log.v("CircleImageView", "getWidth()" + getWidth() + "  getHeight()==" + getHeight());
        //這個地方就是算最小半徑的，注意是要減去邊緣寬度的 因為這裡計算的是 圓形邊緣部分的最小半徑
        mBorderRadius = Math.min((mBorderRect.height() - mBorderWidth) / 2, (mBorderRect.width() - mBorderWidth) / 2);

        mDrawableRect.set(mBorderRect);
        if (!mBorderOverlay) {
            mDrawableRect.inset(mBorderWidth, mBorderWidth);
        }
        //這裡計算的是圓形內部的最小半徑，其實很好理解，因為這個自定義控制元件提供了設定圓形邊緣寬度的屬性方法，所以在這裡對於一個圓形邊緣有寬度的圖形來說
        //半徑就是有2個，一個是外部半徑，一個內部半徑，上面的mBorderRadius就是內部半徑 而這裡是外部半徑 一般來說 mDrawableRadius>=mBorderRadius
        mDrawableRadius = Math.min(mDrawableRect.height() / 2, mDrawableRect.width() / 2);
        updateShaderMatrix();
        //手動觸發ondraw()函式 完成最終的繪製
        invalidate();
    }

    /**
     * 這個函式很好理解，就是做平移變換 放大或者縮小圖片 所使用的，儘量保證 我們切割出來的圖片 損失度最小。‘
     * <p/>
     * 這裡面的演算法可以好好研讀一下 此方法能保證你每次切割出來的圖片都是 原始圖片正中央的那一部分
     */
    private void updateShaderMatrix() {
        Log.v("CircleImageView", "updateShaderMatrix()");
        float scale;
        float dx = 0;
        float dy = 0;

        mShaderMatrix.set(null);

        if (mBitmapWidth * mDrawableRect.height() > mDrawableRect.width() * mBitmapHeight) {

            //此縮放策略就是y軸縮放 x軸平移
            scale = mDrawableRect.height() / (float) mBitmapHeight;
            dx = (mDrawableRect.width() - mBitmapWidth * scale) * 0.5f;
        } else {
            //此縮放策略是 x軸縮放 y軸平移
            scale = mDrawableRect.width() / (float) mBitmapWidth;
            dy = (mDrawableRect.height() - mBitmapHeight * scale) * 0.5f;
        }

        mShaderMatrix.setScale(scale, scale);
        mShaderMatrix.postTranslate((int) (dx + 0.5f) + mDrawableRect.left, (int) (dy + 0.5f) + mDrawableRect.top);

        mBitmapShader.setLocalMatrix(mShaderMatrix);
    }

}