Skip to content
/ Spear Public
forked from panpf/sketch

Spear是Android上的一个图片加载器，目的是为了帮助开发者从本地或网络读取图片，然后处理并显示在ImageView上。Spear is an image loader for Android, the purpose is to help the developers to read a picture from a local or network, and then processed and displayed on the ImageView

0 stars 308 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

b2b2244424/Spear

BranchesTags
 
 

Repository files navigation

Logo Spear

Spear是Android上的一个图片加载器，目的是为了帮助开发者从本地或网络读取图片，然后处理并显示在ImageView上

Spear is an image loader for Android, the purpose is to help the developers to read a picture from a local or network, and then processed and displayed on the ImageView.

sample

###Features

  • 多种URI支持。支持http://、https://、assets://、content://、file://、drawable://等6种URI。
  • 异步加载。采用线程池来处理每一个请求，并且网络加载和本地加载会放在不同的线程池中执行，保证不会因为网络加载而堵塞本地加载。
  • 支持缓存。采用Lru算法在本地和内存中缓存图片，本地缓存可设置过期时间。
  • 支持ViewHolder。即使你在ListView中使用了ViewHolder也依然可以使用ImageLoader来加载图片，并且图片显示绝对不会混乱。
  • 重复下载过滤。如果两个请求的图片地址一样的话，第二个就会等待，一直到第一个下载成功后才会继续处理。
  • 即时取消无用请求。在onDetachedFromWindow或重复利用的时候会取消无用的请求。
  • 支持进度回调。通过progressListener()方法即可设置并开启进度回调。
  • 防止加载过大Bitmap,默认最大Bitmap限制为当前屏幕宽高的1.5倍，这样可以有效防止加载过大图片到内存中。
  • 重新处理图片尺寸。可自定义加载到内存的图片的尺寸，使用display()方法显示图片的时候还会自动根据ImageView的宽高来重新处理。
  • 自带RequestOptions管理器。你可以通过Spear.putOptions(Enum<?>, RequestOptions)存储RequestOptions。然后在使用的时候指定名称即可。
  • 提供SpearImageView。让加载图片更加简单，只需调用setImageBy***系列方法即可显示各种图片。
  • 额外提供load()和download()。如果你不是要显示图片只是想要加载然后用作其他用途，那么你可以使用load()方法。
  • 强大的自定义功能。可自定义请求分发与执行、缓存、解码、处理、显示、默认图片、失败图片等。
  • 强制使用单例模式。你只能通过Spear.with(Context)方法获取实例，降低使用复杂度

Sample App

###Usage guide

####显示图片 Spear支持以下六种URI：

Image from http or https

String uri = "http://www.huabian.com/uploadfile/2013/1222/20131222054754556.jpg";
Spear.with(context).display(uri, imageView).fire();

Image from file

Spear.with(context).display("file:///mnt/sfs.png", imageView).fire();

or

Spear.with(context).display(new File("/mnt/sfs.png"), imageView).fire();

Image from content provider

Spear.with(context).display("content://media/external/audio/albumart/13", imageView).fire();

or

Uri uri = ...;
Spear.with(context).display(uri, imageView).fire();

Image from drawable resource

Spear.with(context).display("drawable://"+R.drawable.ic_launcher, imageView).fire();

or

Spear.with(context).display(R.drawable.ic_launcher, imageView).fire();

Image from assets

Spear.with(context).display("assets://test.png", imageView).fire();

or

String uri = Scheme.ASSETS.createUri("test.png");
Spear.with(context).display(uri, imageView).fire();

一定要记得最后要调用fire()方法哦

####配置显示选项：

Spear.with(getBaseContext())
    .display("http://b.zol-img.com.cn/desk/bizhi/image/4/1366x768/1387347695254.jpg", imageView)
    .loadingDrawable(R.drawable.image_loading)    // 设置正在加载的时候显示的图片
    .loadFailedDrawable(R.drawable.image_load_fail)   // 设置当加载失败的时候显示的图片
    .disableDiskCache() // 禁用磁盘缓存
    .disableMemoryCache()   // 禁用内存缓存
    .diskCacheTimeout(60 * 1000) // 设置磁盘缓存有效期为60秒
    .maxsize(1000, 800) // 设置最大尺寸，用来解码Bitmap时计算inSampleSize，防止加载过大的图片到内存中，默认为当前屏幕的1.5倍
    .resize(300, 300)   // 重新定义图片宽高，将原始图片加载到内存中之后会使用ImageProcessor根据原始图片创建一张新的300x300的图片
    .displayer(new OriginalFadeInImageDisplayer())  // 设置图片显示器，在最后一步会使用ImageDisplayer来显示图片
    .processor(new CircleImageProcessor())  // 设置图片处理器
    .scaleType(ImageView.ScaleType.FIT_START)   // 设置图片显示模式，在使用ImageProcessor处理图片的时候会用到此参数，默认为ImageView的ScaleType
    .listener(new DisplayListener() {   // 设置监听器
        @Override
        public void onStarted() {
            
        }

        @Override
        public void onCompleted(String uri, ImageView imageView, BitmapDrawable drawable) {

        }

        @Override
        public void onFailed(FailureCause failureCause) {

        }

        @Override
        public void onCanceled() {

        }
    })
    .progressListener(new ProgressListener() {  // 设置进度监听器
        @Override
        public void onUpdateProgress(int totalLength, int completedLength) {
            
        }
    })
    .fire();

####download()、load()、display() Spear除了有display()方法用来显示图片之外，还有load()用来加载图片和download()方法用来下载图片

  • download()：下载图片，此方法仅仅实现将图片下载到本地；
  • load()：加载图片，此方法在将图片下载到本地之后会将图片加载到内存并实现本地缓存功能；
  • display()：显示图片，此方法在将图片下载并加载到内存之后，会将图片放到内存缓存中，然后显示在ImageView上，并实现内存缓存。

实际上整个显示图片的过程可分为下载、加载和显示三部分，这三个方法正好对应这三部分，因此你可以根据你的需求选择不同的方法来处理图片

这三个方法的用法都一样

display()与load()、download()的区别

  • display()的fire()方法必须在主线程执行，否则将会有异常发生
  • 在使用display()方法显示图片的时候，Spear会自动根据ImageView的宽高计算maxsize和resize，条件就是计算maxsize时要求ImageView的宽高至少有一个是固定的，而计算resize的时候要求宽高都是固定的，这样就省却了很多麻烦，也节省了内存
  • 可使用的属性display()最多，download()最少具体如下表所示：

下面是属性表（'-'代表不支持）

属性 download load display
diskCache true true true
diskCacheTimeout 0（永久有效） 0（永久有效） 0（永久有效）
maxsize - 设备屏幕尺寸的1.5倍 结合ImageView的宽高来计算
resize - null 结合ImageView的宽高来计算
ImageProcessor - null null
ScaleType - ScaleType.FIT_CENTER ScaleType.FIT_CENTER
memoryCache - - true
ImageDisplayer - - DefaultImageDisplayer（无任何特效）
loadingDrawable - - null
loadFailedDrawable - - null
listener null（在非主线程回调） null（在非主线程回调） null（在主线程回调）
progressListener null（在非主线程回调） null（在非主线程回调） null（在主线程回调）

####你可能还感兴趣的功能：

###Downloads

###Change log ###1.2.0

  • 优化。display的fire方法去掉了异步线程过滤，由于display基本都是在主线程执行的过滤异步线程没有意义
  • 优化。改善了需要通过Handler在主线程执行回调以及显示的方式，以前是使用Runnable，现在时通过Message，这样就避免了创建Runnable，由于display是非常频繁的操作，因此这将会是有意义的改善
  • 优化。优化了DisplayHelper的使用，以前是为每一次display都创建一个DisplayHelper，现在是只要你是按照display().fire()这样连续的使用，那么所有的display将共用一个DisplayHelper，这将会避免创建大量的DisplayHelper
  • 优化。ProgressListener.onUpdateProgress(long, long)改为ProgressListener.onUpdateProgress(int, int)，因为int足够用了

###1.1.3

  • 修改。修改ProgressCallback的名字为ProgressListener并且各个Request.Helper中的progressCallback()方法页改名为progressListener
  • 优化。DisplayRequest.Helper.fire()方法不再限制只能在主线程中执行
  • 修改。修改SpearImageView.setImageByDrawable()方法的名称为setImageByResource()

###1.1.2

  • 修改。修改DisplayRequest.Builder、LoadRequest.Builder、DownloadRequest.Builder的名字为DisplayRequest.Helper、LoadRequest.Helper、DownloadRequest.Helper，这是因为DisplayRequest.Builder原本应有的build()方法被fire()代替了，而功能也是大不一样，所以觉得叫Builder不太合适

###1.1.1

  • 新增。RequestFuture增加了getName()方法用于获取请求名称
  • 优化。优化了SpearImageView中onDetachedFromWindow()取消时的日志
  • 新增。SpearImageView的setImageUriBy***系列方法新增了返回值，返回对应的RequestFuture，方便查看请求的状态
  • 修改。SpearImageView的setImageByUri(Uri)方法改名为setImageByContent(Uri)

####1.1.0

  • 新增。ImageDownloader新增setProgressCallbackNumber(int)方法可用来控制进度回调次数
  • 新增。DownloadListener、LoadLinstener、DisplayListener的onCompleted()方法新增From参数，用来表示数据来自哪里
  • 新增。 SpearImageView新增类似Picasso的Debug功能，只需调用Spear.setDebugMode(true)开启调试模式即可开启此功能
  • 优化。优化内置的几种图片处理器的resize处理规则。当原图尺寸小于resize时，之前是担心会创建一张更大的图，浪费内存，于是做法是尺寸不变，现在的做法是依然处理但是resize要根据原图尺寸重新计算，原则就是保证新的resize小于原图尺寸并且宽高比同旧的resize一样。例如原图宽高是300x225，resize宽高是400x400，那么之前的结果就是resize还是400x400，最终图片是300x225，而现在的结果是调整resize为255x255，最终图片是225x225
  • 新增。支持仅根据宽或高限制图片大小，例如：maxsize为500x-1，意思就是宽最大为500，高随之缩放
  • 优化。调整了DefaultRequestExecitor的创建方式，网络下载线程池最大容量由10修改为5
  • 优化。调整了DisplayRequest.Helper的options()方法里应用DisplayOptions.resize的规则

####1.0.0 Spear脱胎换骨，全新出发

###License

/*
 * Copyright (C) 2013 Peng fei Pan <sky@xiaopan.me>
 * 
 * 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.
 */

About

Spear是Android上的一个图片加载器，目的是为了帮助开发者从本地或网络读取图片，然后处理并显示在ImageView上。Spear is an image loader for Android, the purpose is to help the developers to read a picture from a local or network, and then processed and displayed on the ImageView

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%