endy-see / sketch

Sketch是Android上一个强大且全面的图片加载器，支持GIF，手势缩放以及分块显示超大图片。Sketch is a powerful and comprehensive image loader on Android, with support for GIF, gesture zooming, block display super large image

Sketch

English version of the README.md

Sketch是Android上一个强大且全面的图片加载器，支持GIF，手势缩放以及分块显示超大图片

特性

• 多种URI支持. 支持http://或https://、asset://、content://、file:///sdcard/sample.jpg或/sdcard/sample.jpg、drawable://、data:image/或data:img/等6种URI
• 支持gif图. 集成了android-gif-drawable 1.2.6可以方便的显示gif图片，感谢koral--
• 支持手势缩放. 支持手势缩放功能，在PhotoView的基础上进行了优化，增加了滚动条，定位等功能
• 支持分块显示超大图. 支持分块显示超大图功能，从此再大的图片也不怕了
• 支持三级缓存. 通过LruMemoryCache、LruDiskCache复用图片，加快显示时间；通过LruBitmapPool复用Bitmap，减少因GC而造成的卡顿
• 支持纠正图片方向. 可纠正方向不正的图片，并且分块显示超大图功能也支持，仅限jpeg格式的图片
• 支持读取APK图标. 支持直接读取本地APK文件的图标或根据包名和版本号读取已安装APP的图标
• 支持Base64图片. 支持解析 Base64 格式的图片
• 支持各种列表. 在各种列表（ListView、RecyclerView）中循环使用不错位，并且不占用setTag()方法
• 自动防止加载过大Bitmap 可通过maxSize来控制加载到内存的图片的尺寸，默认为ImageView的layout_width和layout_height或屏幕的宽高
• 独家TransitionDrawable支持. 独家支持任意尺寸的两张图片使用TransitionDrawable过渡显示，保证不变形
• 只加载或只下载. 除了display()方法可以显示图片之外，你还可以通过load()方法只加载图片到内存中或通过download()方法只下载图片到本地
• 移动网络下暂停下载. 内置了移动网络下暂停下载图片的功能，你只需开启即可
• 自动选择合适的Bitmap.Config. 根据图片的MimeType自动选择合适的Bitmap.Config，减少内存浪费，例如对于JPEG格式的图片就会使用Bitmap.Config.RGB_565解码
• 特殊文件预处理. 通过ImagePreprocessor可对特殊文件（例如多媒体文件）进行预处理，提取出其包含的图片，读取APK文件的图标就是通过这个功能实现的
• 强大且灵活的自定义. 可自定义下载、缓存、解码、处理、显示、占位图等各个环节

示例APP

扫描二维码下载示例APP，也可点击直接下载（Click download APK）

使用指南

导入

1.在app的build.gradle文件的dependencies节点中加入依赖

compile 'me.xiaopan:sketch:$sketch_version'

请自行替换 $sketch_version 为最新的版本 (不要"v")

如果需要播放GIF就添加sketch-gif的依赖

compile 'me.xiaopan:sketch-gif:$sketch_gif_version'

请自行替换$sketch_gif_version 为最新的版本 (不要"v")

Android Studio会自动合并AAR中所包含的权限和混淆配置

2.如果您的APP想要兼容 API 13 (Android 3.2) 及以下的版本，那么需要在您的 Application 中调用释放缓存的方法（Android 4.0以上能直接通过Context注册并回调）

public class MyApplication extends Application {    

    @Override
    public void onTrimMemory(int level) {
        super.onTrimMemory(level);

        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
            Sketch.with(getBaseContext()).onTrimMemory(level);
        }
    }

    @Override
    public void onLowMemory() {
        super.onLowMemory();

        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
            Sketch.with(getBaseContext()).onLowMemory();
        }
    }
}

显示图片

SketchImageView sketchImageView = (SketchImageView) findViewById(R.id.image_main);

// display image from net
sketchImageView.displayImage("http://t.cn/RShdS1f");

// display image from SDCard
sketchImageView.displayImage("/sdcard/sample.jpg");
sketchImageView.displayImage("file:///sdcard/sample.jpg");

// display resource drawable
sketchImageView.displayResourceImage(R.drawable.sample);

// display image from asset
sketchImageView.displayAssetImage("sample.jpg");

// display image from content provider
sketchImageView.displayContentImage(Uri.parse("content://com.android.gallery/last"));

// display base64 image
sketchImageView.displayImage("data:image/jpeg;base,/9j/4QaO...U7T/in//Z");

// display apk icon from SDCard
sketchImageView.displayImage("/sdcard/google_play.apk");

// display installed app icon
sketchImageView.displayInstalledAppIcon("com.tencent.qq", 210);

SketchImageView详细使用说明.md

支持的URI

Type	Scheme	Method In SketchImageView
File in network	http://, https://	displayImage(String)
File in SDCard	/, file://	displayImage(String)
Content Provider	content://	displayContentImage(Uri)
Asset in app	asset://	displayAssetImage(String)
Resource in app	resource://	displayResourceImage(int)
Base64	data:image/, data:/img/	displayImage(String)

支持的图片类型

• jpeg：
• png：
• gif：
• bmp：
• webp：

download()、load()、display()

Sketch共有display()、load()、download()三个方法可供使用，你可以根据你的需求选择合适的方法

• download()方法会下载图片到本地，并实现本地缓存
• load()方法在download()方法的基础上，加载图片到内存中，并对图片进行处理
• display()方法在load()方法的基础上，将图片缓存在内存中并显示在ImageView上

示例：

// 显示
Sketch.with(context).display("http://t.cn/RShdS1f", sketchImageView)
    .loadingImage(R.drawable.image_loading)
    .commit();

// 加载
Sketch.with(context).load("http://t.cn/RShdS1f", new LoadListener() {
    @Override
    public void onCompleted(LoadResult loadResult) {

    }

    ...
}).maxSize(100, 100).commit();

// 下载
Sketch.with(context).download("http://t.cn/RShdS1f", new DownloadListener() {
    @Override
    public void onCompleted(DownloadResult downloadResult) {

    }

    ...
}).commit();

load()和download()还支持同步执行，详情请参考同步执行load和download.md

你可能还感兴趣的功能：

基础功能：

• SketchImageView详细使用说明.md
• 播放GIF图片.md
• 手势缩放、旋转图片.md
• 分块显示超大图片.md
• 配置各种属性和属性管理.md
• 通过ShapeSize在绘制时改变图片的尺寸.md
• 通过ImageShaper在绘制时以圆形、圆角等形状显示图片.md
• 通过ImageProcessor将图片变成高斯模糊的、倒影的.md
• 通过ImageDisplayer以过渡、渐入等方式显示图片.md
• 通过MaxSize控制图片大小.md
• 通过Resize修剪图片尺寸.md
• 通过StateImage灵活的使用各种图片作为loadingImage.md
• 了解自动纠正图片方向功能.md

进一步提升用户体验：

• 让任意尺寸的两张图片都能使用TransitionDrawable过渡显示.md
• 通过thumbnailMode属性显示更清晰的缩略图.md
• 通过cacheProcessedImageInDisk属性缓存需要复杂处理的图片，提升显示速度.md
• 移动网络下暂停下载图片，节省流量.md
• 列表滑动时暂停加载图片，提升流畅度.md
• 显示APK或已安装APP的图标.md
• 通过ImagePreprocessor显示特殊文件中的图片（例如视频、MP3）.md
• 通过MemoryCacheStateImage先显示较模糊的图片，然后再显示清晰的图片.md

更多：

• 同步执行load和download.md
• 了解inSampleSize计算规则.md
• 了解并配置BitmapPool.md
• 了解并配置内存缓存.md
• 了解并配置本地缓存.md
• 了解并配置HttpStack.md
• 监听加载开始、成功、失败以及下载进度.md
• 了解何时取消请求以及如何主动取消请求.md
• 通过ErrorTracker监控Sketch的异常.md
• 同步输出Sketch运行日志到SD卡.md
• 配置混淆（Proguard）.md

特别感谢

koral - android-gif-drawable

chrisbanes - PhotoView

bumptech - glide （BitmapPool）

License

Copyright (C) 2013 Peng fei Pan <[e-mail]>

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.