安卓圆形imageview笔记

自定圆形图片CircleImageView总是用到，可是却没有仔细看过它的代码，所以今天就看下代码并做好注解，以备能理解其具体的工作原理。

首先是自定义view中方法的调用顺序：setImageDrawable()-->initializeBitmap()-->setup()-->构造方法-->init()--setup()-->updateShaderMatrix()-->invalidate()-->onDraw().所以按照步骤一步一步来看它的工作进程：

setImageDrawable()和initializeBitmap():这两个方法就是用来加载图片资源的；

setup()代码如下：

 private void setup() {
    Log.i("TGA", "setup()方法");
    if (!mReady) {
          mSetupPending = true;
            return;
        }
    }

第一的调用该方法会发现，它的mReady默认是false的，所以会在第一个if语句中跳出，只是将mSetupPending的值设置成了true，为什么这么设置，这需要与后面的代码相联系起来看。

构造方法：这里它会调用含有三个参数的构造方法，在这里，还会解析与该自定义view相配套的一个自定义属性的xml资源文件，地址为在res/values/attrs.xml：

//创建一个TypeArray数组，用于读取控件的自定义属性值,这里读取的是边框宽度，颜色,边框是否覆盖图片，还有填充色，注意recycle()掉，不然对后续再使用该自定义view会有影响。

TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CircleImageView, defStyle, 0);
        mBorderWidth = a.getDimensionPixelSize(R.styleable.CircleImageView_civ_border_width, DEFAULT_BORDER_WIDTH);
        mBorderColor = a.getColor(R.styleable.CircleImageView_civ_border_color, DEFAULT_BORDER_COLOR);
        mBorderOverlay = a.getBoolean(R.styleable.CircleImageView_civ_border_overlay, DEFAULT_BORDER_OVERLAY);
        mFillColor = a.getColor(R.styleable.CircleImageView_civ_fill_color, DEFAULT_FILL_COLOR);
        a.recycle();

init():

  private void init() {
    Log.i("TGA", "init方法");
      super.setScaleType(SCALE_TYPE);
      mReady = true;
        if (mSetupPending) {
            setup();
            mSetupPending = false;
        }
    }

用来设置图片填充样式，他这边默认为center_crop的样式，还有将mReady改为true,对mSetupPending进行判断，但由于之前setup()中将其设为了true,所以就相当于再调用一遍setup()方法，这是的调用就会跳过setup()方法中的第一个if判断了，至此，mReady和mSetupPending的作用算是结束了，至于为何要设置成这样的工作流程呢，原因是就是自定义属性的关系了，因为想要获取自定义属性，就最好放在构造方法获取中，因为其中有上下文对象，当然我们也可以将上下文对象放入全局变量中，但是这样就会造成内存的消耗，所以还是放在构造方法中获取是有利于内存优化的。

setup();这回调用该方法就是要动真格了

首先注意的是该类是通过bitmap渲染器来进行图形的绘制填充的。

//通过图片渲染器来填充绘制区域
        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);


        //设置成实心，默认透明
        mFillPaint.setStyle(Paint.Style.FILL);
        mFillPaint.setAntiAlias(true);
        mFillPaint.setColor(mFillColor);
        //图形宽高
        mBitmapHeight = mBitmap.getHeight();
        mBitmapWidth = mBitmap.getWidth();
        //设置边框的半径
        mBorderRect.set(calculateBounds());
        mBorderRadius = Math.min((mBorderRect.height() - mBorderWidth) / 2.0f, (mBorderRect.width() - mBorderWidth) / 2.0f);
        //初始图片显示区域
        mDrawableRect.set(mBorderRect);
        if (!mBorderOverlay && mBorderWidth > 0) {
            mDrawableRect.inset(mBorderWidth - 1.0f, mBorderWidth - 1.0f);
        }
        mDrawableRadius = Math.min(mDrawableRect.height() / 2.0f, mDrawableRect.width() / 2.0f);
        applyColorFilter();
        
        //设置渲染器的变化矩阵
        updateShaderMatrix();
        
        //手动触发onDraw()方法
        invalidate();

updateShadeMatrix()：用来确定图片的压缩比，采用最大压缩比，并将图片进行平移，是图片居中

onDraw():到此，因为之前的操作差不多都完成了，这里只需要进行canvas的draw()操作尽可以了，需要注意的是：如果没有设置边框，就可以直接绘制图形，如果设置了边框，还得再调一次draw()来绘制边框。

整个圆形imageview的工作流程就完成了。

附上attrs.xml文件：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="CircleImageView">
        <attr name="civ_border_width" format="dimension" />
        <attr name="civ_border_color" format="color" />
        <attr name="civ_border_overlay" format="boolean" />
        <attr name="civ_fill_color" format="color" />
    </declare-styleable>
</resources>

CircleImageView完整代码：

/*
 * Copyright 2014 - 2016 Henning Dodenhof
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.lym.bmob.app.ui;


import com.lym.bmob.app.activity.R;


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.util.AttributeSet;
import android.util.Log;
import android.widget.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 int DEFAULT_FILL_COLOR = Color.TRANSPARENT;
    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();
    private final Paint mBitmapPaint = new Paint();
    private final Paint mBorderPaint = new Paint();
    private final Paint mFillPaint = new Paint();


    private int mBorderColor = DEFAULT_BORDER_COLOR;
    private int mBorderWidth = DEFAULT_BORDER_WIDTH;
    private int mFillColor = DEFAULT_FILL_COLOR;


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


    private float mDrawableRadius;
    private float mBorderRadius;


    private ColorFilter mColorFilter;


    private boolean mReady;
    private boolean mSetupPending;
    private boolean mBorderOverlay;
    private boolean mDisableCircularTransformation;//默认为false


    public CircleImageView(Context context) {
        super(context);
        Log.i("TGA", "单个参数的构造方法");
        init();
    }


    public CircleImageView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
        Log.i("TGA", "两个参数的构造方法");
    }


    public CircleImageView(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        Log.i("TGA", "三个参数的构造方法");
        //
        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CircleImageView, defStyle, 0);


        mBorderWidth = a.getDimensionPixelSize(R.styleable.CircleImageView_civ_border_width, DEFAULT_BORDER_WIDTH);
        mBorderColor = a.getColor(R.styleable.CircleImageView_civ_border_color, DEFAULT_BORDER_COLOR);
        mBorderOverlay = a.getBoolean(R.styleable.CircleImageView_civ_border_overlay, DEFAULT_BORDER_OVERLAY);
        mFillColor = a.getColor(R.styleable.CircleImageView_civ_fill_color, DEFAULT_FILL_COLOR);
        
        a.recycle();


        init();
    }


    private void init() {
    Log.i("TGA", "init方法");
        super.setScaleType(SCALE_TYPE);
        mReady = true;


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


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


    @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.i("TGA", "onDraw");
        if (mDisableCircularTransformation) {
            super.onDraw(canvas);
            return;
        }


        if (mBitmap == null) {
            return;
        }


        if (mFillColor != Color.TRANSPARENT) {
            canvas.drawCircle(mDrawableRect.centerX(), mDrawableRect.centerY(), mDrawableRadius, mFillPaint);
        }
        canvas.drawCircle(mDrawableRect.centerX(), mDrawableRect.centerY(), mDrawableRadius, mBitmapPaint);
        if (mBorderWidth > 0) {
            canvas.drawCircle(mBorderRect.centerX(), mBorderRect.centerY(), mBorderRadius, mBorderPaint);
        }
    }


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


    @Override
    public void setPadding(int left, int top, int right, int bottom) {
        super.setPadding(left, top, right, bottom);
        Log.i("TGA", "setPadding");
        setup();
    }


    @Override
    public void setPaddingRelative(int start, int top, int end, int bottom) {
        super.setPaddingRelative(start, top, end, bottom);
        Log.i("TGA", "setPaddingRelative");
        setup();
    }


    public int getBorderColor() {
        return mBorderColor;
    }


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


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


    /**
     * @deprecated Use {@link #setBorderColor(int)} instead
     */
    @Deprecated
    public void setBorderColorResource(int borderColorRes) {
        setBorderColor(getContext().getResources().getColor(borderColorRes));
    }


    /**
     * Return the color drawn behind the circle-shaped drawable.
     *
     * @return The color drawn behind the drawable
     *
     * @deprecated Fill color support is going to be removed in the future
     */
    @Deprecated
    public int getFillColor() {
        return mFillColor;
    }


    /**
     * Set a color to be drawn behind the circle-shaped drawable. Note that
     * this has no effect if the drawable is opaque or no drawable is set.
     *
     * @param fillColor The color to be drawn behind the drawable
     *
     * @deprecated Fill color support is going to be removed in the future
     */
    @Deprecated
    public void setFillColor(int fillColor) {
        if (fillColor == mFillColor) {
            return;
        }


        mFillColor = fillColor;
        mFillPaint.setColor(fillColor);
        invalidate();
    }


    /**
     * Set a color to be drawn behind the circle-shaped drawable. Note that
     * this has no effect if the drawable is opaque or no drawable is set.
     *
     * @param fillColorRes The color resource to be resolved to a color and
     *                     drawn behind the drawable
     *
     * @deprecated Fill color support is going to be removed in the future
     */
    @Deprecated
    public void setFillColorResource(int fillColorRes) {
        setFillColor(getContext().getResources().getColor(fillColorRes));
    }


    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();
    }


    public boolean isDisableCircularTransformation() {
        return mDisableCircularTransformation;
    }


    public void setDisableCircularTransformation(boolean disableCircularTransformation) {
        if (mDisableCircularTransformation == disableCircularTransformation) {
            return;
        }


        mDisableCircularTransformation = disableCircularTransformation;
        initializeBitmap();
    }


    @Override
    public void setImageBitmap(Bitmap bm) {
        super.setImageBitmap(bm);
        initializeBitmap();
    }


    @Override
    public void setImageDrawable(Drawable drawable) {
        super.setImageDrawable(drawable);
        Log.i("TGA", "setImageDrawable");
        initializeBitmap();
    }


    @Override
    public void setImageResource(int resId) {
        super.setImageResource(resId);
        Log.i("TGA", "setImageResource");
        initializeBitmap();
    }


    @Override
    public void setImageURI(Uri uri) {
        super.setImageURI(uri);
        initializeBitmap();
    }


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


        mColorFilter = cf;
        applyColorFilter();
        invalidate();
    }


    @Override
    public ColorFilter getColorFilter() {
        return mColorFilter;
    }


    private void applyColorFilter() {
        if (mBitmapPaint != null) {
            mBitmapPaint.setColorFilter(mColorFilter);
        }
    }


    private Bitmap getBitmapFromDrawable(Drawable drawable) {
        if (drawable == null) {
            return null;
        }


        if (drawable instanceof BitmapDrawable) {
            return ((BitmapDrawable) drawable).getBitmap();
        }


        try {
            Bitmap bitmap;


            if (drawable instanceof ColorDrawable) {
                bitmap = Bitmap.createBitmap(COLORDRAWABLE_DIMENSION, COLORDRAWABLE_DIMENSION, BITMAP_CONFIG);
            } else {
                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 (Exception e) {
            e.printStackTrace();
            return null;
        }
    }


    private void initializeBitmap() {
    Log.i("TGA", "initializeBitmap()方法");
        if (mDisableCircularTransformation) {
            mBitmap = null;
        } else {
            mBitmap = getBitmapFromDrawable(getDrawable());
        }
        setup();
    }


    private void setup() {
    Log.i("TGA", "setup()方法");
        if (!mReady) {
            mSetupPending = true;
            return;
        }


        if (getWidth() == 0 && getHeight() == 0) {
            return;
        }


        if (mBitmap == null) {
            invalidate();
            return;
        }
        //通过图片渲染器来填充绘制区域
        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);


        //设置成实心，默认透明
        mFillPaint.setStyle(Paint.Style.FILL);
        mFillPaint.setAntiAlias(true);
        mFillPaint.setColor(mFillColor);
        //图形宽高
        mBitmapHeight = mBitmap.getHeight();
        mBitmapWidth = mBitmap.getWidth();
        //设置边框的半径
        mBorderRect.set(calculateBounds());
        mBorderRadius = Math.min((mBorderRect.height() - mBorderWidth) / 2.0f, (mBorderRect.width() - mBorderWidth) / 2.0f);
        //初始图片显示区域
        mDrawableRect.set(mBorderRect);
        if (!mBorderOverlay && mBorderWidth > 0) {
            mDrawableRect.inset(mBorderWidth - 1.0f, mBorderWidth - 1.0f);
        }
        mDrawableRadius = Math.min(mDrawableRect.height() / 2.0f, mDrawableRect.width() / 2.0f);


        applyColorFilter();
        
        //设置渲染器的变化矩阵
        updateShaderMatrix();
        
        //手动触发onDraw()方法
        invalidate();
    }


    private RectF calculateBounds() {
        int availableWidth  = getWidth() - getPaddingLeft() - getPaddingRight();
        int availableHeight = getHeight() - getPaddingTop() - getPaddingBottom();


        int sideLength = Math.min(availableWidth, availableHeight);


        float left = getPaddingLeft() + (availableWidth - sideLength) / 2f;
        float top = getPaddingTop() + (availableHeight - sideLength) / 2f;


        return new RectF(left, top, left + sideLength, top + sideLength);
    }


    private void updateShaderMatrix() {
    Log.i("TGA", "updateShaderMatrix");
        float scale;
        float dx = 0;
        float dy = 0;


        mShaderMatrix.set(null);


        if (mBitmapWidth * mDrawableRect.height() > mDrawableRect.width() * mBitmapHeight) {
            scale = mDrawableRect.height() / (float) mBitmapHeight;
            dx = (mDrawableRect.width() - mBitmapWidth * scale) * 0.5f;
        } else {
            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);
    }


}