首页手记分享一个效果非常好的自定义圆形ImageView（转载...

分享一个效果非常好的自定义圆形ImageView（转载自博客）

标签：

Android

本文分为三大部分：

CircleImageView的使用
CircleImageView源码分析
Android自定义View总结

CircleImageView项目源码下载：
https://github.com/hdodenhof/CircleImageView
打开源码会发现主要就是一个继承了ImageView 的类——CircleImageView .Java，代码优雅精致，效果很nice。下面会进行源码分析，让我加深了不少Canvas、BitmapShader、Matrix相关知识。

CircleImageView的使用

我这里一步步展示使用步骤，记录下当时遇到的问题。

按照上面的地址下载，项目文件名CircleImageView-master。目录下的circleimageview为库文件，sample为官方demo，使用fragment比较繁琐。这里我自己新建demo学会使用。
新建一个Android项目CircleImageViewDemo_1，复制上一步circleimageview文件夹里的CircleImageView.java到CircleImageViewDemo_1中。
CircleImageView.java地址：
CircleImageView-master\circleimageview\src\main\java\de\hdodenhof\circleimageview
项目src中：
这里写图片描述

此时会发现CircleImageView.java里报错，出错为没有R.styleable.CircleImageView。这是因为我们缺少自定义View的属性attrs.xml。在CircleImageView-master中找到attrs.xml并复制到项目里的res/values下。错误消失。

attrs.xml地址： 
CircleImageView-master\circleimageview\src\main\res\values

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="CircleImageView">
        <attr name="border_width" format="dimension" />
        <attr name="border_color" format="color" />
        <attr name="border_overlay" format="boolean" />
    </declare-styleable>
</resources>

4 接下来就要在activity_main.xml里使用CircleImageView了。我仿照官方demo进行layout布局，同时引用官方图片。

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical" 
    tools:context="com.example.circleimageviewdemo_1.MainActivity" >

    <RelativeLayout
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="1"
        android:padding="@dimen/base_padding"
        android:background="@color/light">

        <com.example.library.CircleImageView
            android:layout_width="160dp"
            android:layout_height="160dp"
            android:layout_centerInParent="true"
            android:class="lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAANSURBVBhXYzh8+PB/AAffA0nNPuCLAAAAAElFTkSuQmCC" data-original="@drawable/hugh"
            app:border_width="2dp"
            app:border_color="@color/dark" />

    </RelativeLayout>

    <RelativeLayout
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="1"
        android:padding="@dimen/base_padding"
        android:background="@color/dark">

        <com.example.library.CircleImageView
            android:layout_width="160dp"
            android:layout_height="160dp"
            android:layout_centerInParent="true"
            android:class="lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAANSURBVBhXYzh8+PB/AAffA0nNPuCLAAAAAElFTkSuQmCC" data-original="@drawable/hugh"
            app:border_width="2dp"
            app:border_color="@color/light" />

    </RelativeLayout>

</LinearLayout>

注意两点：

在xml布局文件中，声明我们的自定义View，路径要正确。
com.example.library.CircleImageView
一定要引入命名空间，xmlns:app=”http://schemas.android.com/apk/res-auto”，不然无法使用自定义属性。
MainActivity里不用修改，因为我直接在XML里面用src设置了图片，你也可以在MainActivity中用setImageXXX设置。直接运行看效果。
这里写图片描述

总结下CircleImageView的使用：

将CircleImageView.java拷贝到项目工程中
attrs.xml拷贝到res/values/目录下
在布局文件中声明自定义View，一定要引入命名空间xmlns:app=”http://schemas.android.com/apk/res-auto”。
Demo下载：
http://download.csdn.net/detail/zhoubin1992/8956647

CircleImageView源码分析

一直很好奇这个开源库是怎么自定义圆形ImageView，结果最近花了很多功夫进行分析，现在也非常迫切想整理出来，希望能帮到一些人。我也看了网络上的一些源码分析，有些分析是错误的会误导大家，有些说的不详细还是无法理解。
首先我先总结下CircleImageView的主要流程，让大家有个整体把握。然后再一步步进入源码分析。

CircleImageView的主要流程：

首先通过setImageXxx()方法设置图片Bitmap；
进入构造函数CircleImageView()获取自定义参数，以及调用setup()函数；
进入setup()函数（非常关键），进行图片画笔边界画笔(Paint)一些重绘参数初始化：构建渲染器BitmapShader用Bitmap来填充绘制区域,设置样式和内外圆半径计算等，以及调用updateShaderMatrix()函数和 invalidate()函数；
进入updateShaderMatrix()函数，计算缩放比例和平移，设置BitmapShader的Matrix参数等；
触发ondraw()函数完成最终的绘制。使用配置好的Paint先画出绘制内圆形来以后再画边界圆形。

下面来详细分析一下源码：

首先从项目里调用CircleImageView开始分析，我们要么在XML里面用src，要么调用CircleImageView的setImageXXX()方法设置图片。那我们的源码的运行入口在哪里呢，是从构造函数CircleImageView()开始呢还是从setImageXXX()开始？一开始就卡壳了。一开始我以为是从构造函数CircleImageView()开始跑，结果分析下来发现并不会进入setup();所以这是行不通的，那接下来就要论证是不是从setImageXXX()开始呢？我的方法是分别在两者进行System.out.println测试，看看谁先执行。测试结果会发现是从setImageXXX()开始。
这里写图片描述
那我们看下源码：
```
/**
 * 以下四个函数都是
 * 复写ImageView的setImageXxx()方法 
 * 注意这个函数先于构造函数调用之前调用
 * @param bm
 */
@Override
public void setImageBitmap(Bitmap bm) {
    super.setImageBitmap(bm);
    mBitmap = bm;
    setup();
}

@Override
public void setImageDrawable(Drawable drawable) {
    super.setImageDrawable(drawable);
    mBitmap = getBitmapFromDrawable(drawable);
    System.out.println("setImageDrawable -- setup");  
    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();
}
```
看上面代码会发现，四个函数都是获取图片Bitmap，调用setup()。
接下来那我们查看setup()源码：

        //因为mReady默认值为false,所以第一次进这个函数的时候if语句为真进入括号体内
        //设置mSetupPending为true然后直接返回，后面的代码并没有执行。
        if (!mReady) {
            mSetupPending = true;
            return;
        }

会发现第一次进入时，第一个if语句为真，进入括号体内设置mSetupPending为true然后直接返回，后面的代码并没有执行。为什么要这样设置mReady和mSetupPending呢不执行下面的代码呢，不要急，后面再解释。

接下来我们会进入构造函数CircleImageView()。查看源码：

    /**
     * 构造函数
     */
    public CircleImageView(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        //通过obtainStyledAttributes 获得一组值赋给 TypedArray（数组） , 这一组值来自于res/values/attrs.xml中的name="CircleImageView"的declare-styleable中。
        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CircleImageView, defStyle, 0);
        //通过TypedArray提供的一系列方法getXXXX取得我们在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);
        //调用 recycle() 回收TypedArray,以便后面重用
        a.recycle();
        System.out.println("CircleImageView -- 构造函数");  
        init();
    }

分析上面代码会发现很简单，就是首先通过TypedArray获取自定义参数，再调用init()函数：

    /**
     * 作用就是保证第一次执行setup函数里下面代码要在构造函数执行完毕时调用 
     */
    private void init() {
        //在这里ScaleType被强制设定为CENTER_CROP，就是将图片水平垂直居中，进行缩放。
        super.setScaleType(SCALE_TYPE);
        mReady = true;

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

因为在前面mSetupPending为真，则执行setup()，而且这里mReady 也为true，所以会执行setup()下面的代码。为什么要这样设置mSetupPending和mReady呢？
这是因为第一次进入setImageXXX()时候，我们无法获取自定义参数值，所以setup()下面的代码无法绘制我们想要的样式而是默认样式。而获取自定义参数只能在构造函数里，这样我们就能明白大神作者的意图了，通过设置mSetupPending和mReady控制第一次执行setup函数里下面代码要在构造函数执行完毕时。再者如果用户再进行setImageXXX()设置图片的话，就直接会执行setup()下面的代码，因为这之后mReady一直为true。

3 说了这么多，我们来看看setup()下面的代码到底是啥？没错，它就是这么酷炫，很关键：

    /**
     * 这个函数很关键，进行图片画笔边界画笔(Paint)一些重绘参数初始化：
     * 构建渲染器BitmapShader用Bitmap来填充绘制区域,设置样式以及内外圆半径计算等，
     * 以及调用updateShaderMatrix()函数和 invalidate()函数；
     */
    private void setup() {
        //因为mReady默认值为false,所以第一次进这个函数的时候if语句为真进入括号体内
        //设置mSetupPending为true然后直接返回，后面的代码并没有执行。
        if (!mReady) {
            mSetupPending = true;
            return;
        }
        //防止空指针异常
        if (mBitmap == null) {
            return;
        }
        // 构建渲染器，用mBitmap来填充绘制区域 ，参数值代表如果图片太小的话 就直接拉伸
        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();
        // 设置含边界显示区域，取的是CircleImageView的布局实际大小，为方形，查看xml也就是160dp(240px)  getWidth得到是某个view的实际尺寸
        mBorderRect.set(0, 0, getWidth(), getHeight());
        //计算 圆形带边界部分（外圆）的最小半径，取mBorderRect的宽高减去一个边缘大小的一半的较小值（这个地方我比较纳闷为什么求外圆半径需要先减去一个边缘大小）
        mBorderRadius = Math.min((mBorderRect.height() - mBorderWidth) / 2, (mBorderRect.width() - mBorderWidth) / 2);
        // 初始图片显示区域为mBorderRect（CircleImageView的布局实际大小）
        mDrawableRect.set(mBorderRect);
        if (!mBorderOverlay) {
            //demo里始终执行
            //通过inset方法  使得图片显示的区域从mBorderRect大小上下左右内移边界的宽度形成区域，查看xml边界宽度为2dp（3px）,所以方形边长为就是160-4=156dp(234px)
            mDrawableRect.inset(mBorderWidth, mBorderWidth);
        }
        //这里计算的是内圆的最小半径，也即去除边界宽度的半径
        mDrawableRadius = Math.min(mDrawableRect.height() / 2, mDrawableRect.width() / 2);
        //设置渲染器的变换矩阵也即是mBitmap用何种缩放形式填充
        updateShaderMatrix();
        //手动触发ondraw()函数 完成最终的绘制
        invalidate();
    }

上面代码注释我写的很详细不再一步步解释了，进行图片画笔边界画笔(Paint)一些重绘参数初始化：构建渲染器BitmapShader用Bitmap来填充绘制区域,设置样式以及内外圆半径计算等，以及调用updateShaderMatrix()函数和 invalidate()函数。
这里关于半径的计算，我画图举个例子：CircleImageView的布局宽高度均为160，边界的宽度为10如图所示：
这里写图片描述
那么去除边界宽度的内圆半径为70，带边界部分的外圆半径为75。

4 根据上面，接下来进入updateShaderMatrix()函数，查看源码：

    /**
    * 这个函数为设置BitmapShader的Matrix参数，设置最小缩放比例，平移参数。
    * 作用：保证图片损失度最小和始终绘制图片正中央的那部分
    */
    private void updateShaderMatrix() {
        float scale;
        float dx = 0;
        float dy = 0;

        mShaderMatrix.set(null);
        // 这里不好理解 这个不等式也就是(mBitmapWidth / mDrawableRect.width()) > (mBitmapHeight / mDrawableRect.height())
        //取最小的缩放比例
        if (mBitmapWidth * mDrawableRect.height() > mDrawableRect.width() * mBitmapHeight) {
            //y轴缩放 x轴平移 使得图片的y轴方向的边的尺寸缩放到图片显示区域（mDrawableRect）一样）
            scale = mDrawableRect.height() / (float) mBitmapHeight;
            dx = (mDrawableRect.width() - mBitmapWidth * scale) * 0.5f;
        } else {
            //x轴缩放 y轴平移 使得图片的x轴方向的边的尺寸缩放到图片显示区域（mDrawableRect）一样）
            scale = mDrawableRect.width() / (float) mBitmapWidth;
            dy = (mDrawableRect.height() - mBitmapHeight * scale) * 0.5f;
        }
        // shaeder的变换矩阵，我们这里主要用于放大或者缩小。
        mShaderMatrix.setScale(scale, scale);
        // 平移
        mShaderMatrix.postTranslate((int) (dx + 0.5f) + mDrawableRect.left, (int) (dy + 0.5f) + mDrawableRect.top);
        // 设置变换矩阵
        mBitmapShader.setLocalMatrix(mShaderMatrix);
    }

通过updateShaderMatrix函数设置BitmapShader的Matrix参数，对图片mBitmap位置用何种缩放平移形式填充。

if判断语句里mBitmapWidth mDrawableRect.height() > mDrawableRect.width() mBitmapHeight写成(mBitmapWidth / mDrawableRect.width()) > (mBitmapHeight / mDrawableRect.height())更好理解。
目的是用最小的缩放比例，使得图片的某个方向的边的尺寸缩放到图片显示区域（mDrawableRect）一样。做到了图片损失度最小。同时scale保证Bitmap的宽或高和目标区域一致，那么高或宽就需要进行位移，使得Bitmap居中。这里写得很nice。

5 现在万事俱备，只欠ondraw()了。接着上面再setup()最后会调用invalidate()函数触发ondraw()函数完成最终的绘制。查看源码：

    @Override
    protected void onDraw(Canvas canvas) {
        //如果图片不存在就不画
        if (getDrawable() == null) {
            return;
        }
        //绘制内圆形，参数内圆半径，图片画笔为mBitmapPaint
        canvas.drawCircle(getWidth() / 2, getHeight() / 2, mDrawableRadius, mBitmapPaint);
      //如果圆形边缘的宽度不为0 我们还要绘制带边界的外圆形 参数外圆半径，边界画笔为mBorderPaint
        if (mBorderWidth != 0) {
            canvas.drawCircle(getWidth() / 2, getHeight() / 2, mBorderRadius, mBorderPaint);
        }
    }

使用配置好的mBitmapPaint和mBorderPaint先画出绘制内圆形来以后再画边界圆形。源码还有一些自定义设置样式函数，很简单。
大功告成，是不是觉得思路比较简单，精致干练。

我总结下源码的精致之处：

流程控制的比较严谨，比如setup函数的使用
updateShaderMatrix保证图片损失度最小和始终绘制图片正中央的那部分
作者思路是画圆用渲染器位图填充，而不是把Bitmap重绘切割成一个圆形图片。
原文链接：http://blog.csdn.net/zhoubin1992/article/details/47258639

点击查看更多内容