Usage
* `RequestHandler` must be subclassed to be used. You will have to override two methods * ([canHandleRequest] and [load]) with your custom logic to load images. * * You should then register your [RequestHandler] using * [Picasso.Builder.addRequestHandler] * * **Note:** This is a beta feature. The API is subject to change in a backwards incompatible * way at any time. * * @see Picasso.Builder.addRequestHandler */ abstract class RequestHandler { /** * [Result] represents the result of a [load] call in a [RequestHandler]. * * @see RequestHandler * @see [load] */ sealed class Result constructor( /** * Returns the resulting [Picasso.LoadedFrom] generated from a [load] call. */ val loadedFrom: LoadedFrom, /** * Returns the resulting EXIF rotation generated from a [load] call. */ val exifRotation: Int = 0 ) { class Bitmap constructor( val bitmap: android.graphics.Bitmap, loadedFrom: LoadedFrom, exifRotation: Int = 0 ) : Result(loadedFrom, exifRotation) class Drawable constructor( val drawable: android.graphics.drawable.Drawable, loadedFrom: LoadedFrom, exifRotation: Int = 0 ) : Result(loadedFrom, exifRotation) } interface Callback { fun onSuccess(result: Result?) fun onError(t: Throwable) } /** * Whether or not this [RequestHandler] can handle a request with the given [Request]. */ abstract fun canHandleRequest(data: Request): Boolean /** * Loads an image for the given [Request]. * @param request the data from which the image should be resolved. */ @Throws(IOException::class) abstract fun load( picasso: Picasso, request: Request, callback: Callback ) open val retryCount = 0 open fun shouldRetry( airplaneMode: Boolean, info: NetworkInfo? ) = false open fun supportsReplay() = false } ================================================ FILE: picasso/src/main/java/com/squareup/picasso3/ResourceDrawableRequestHandler.kt ================================================ /* * Copyright (C) 2018 Square, Inc. * * 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.squareup.picasso3 import android.content.Context import androidx.core.content.ContextCompat import com.squareup.picasso3.BitmapUtils.isXmlResource import com.squareup.picasso3.Picasso.LoadedFrom.DISK internal class ResourceDrawableRequestHandler private constructor( private val context: Context, private val loader: DrawableLoader ) : RequestHandler() { override fun canHandleRequest(data: Request): Boolean { return data.resourceId != 0 && isXmlResource(context.resources, data.resourceId) } override fun load( picasso: Picasso, request: Request, callback: Callback ) { val drawable = loader.load(request.resourceId) if (drawable == null) { callback.onError( IllegalArgumentException("invalid resId: ${Integer.toHexString(request.resourceId)}") ) } else { callback.onSuccess(Result.Drawable(drawable, DISK)) } } internal companion object { @JvmName("-create") internal fun create( context: Context, loader: DrawableLoader = DrawableLoader { resId -> ContextCompat.getDrawable(context, resId) } ) = ResourceDrawableRequestHandler(context, loader) } } ================================================ FILE: picasso/src/main/java/com/squareup/picasso3/ResourceRequestHandler.kt ================================================ /* * Copyright (C) 2013 Square, Inc. * * 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.squareup.picasso3 import android.content.ContentResolver import android.content.Context import com.squareup.picasso3.BitmapUtils.decodeResource import com.squareup.picasso3.BitmapUtils.isXmlResource import com.squareup.picasso3.Picasso.LoadedFrom.DISK internal class ResourceRequestHandler(private val context: Context) : RequestHandler() { override fun canHandleRequest(data: Request): Boolean { return if (data.resourceId != 0 && !isXmlResource(context.resources, data.resourceId)) { true } else { data.uri != null && ContentResolver.SCHEME_ANDROID_RESOURCE == data.uri.scheme } } override fun load( picasso: Picasso, request: Request, callback: Callback ) { var signaledCallback = false try { val bitmap = decodeResource(context, request) signaledCallback = true callback.onSuccess(Result.Bitmap(bitmap, DISK)) } catch (e: Exception) { if (!signaledCallback) { callback.onError(e) } } } } ================================================ FILE: picasso/src/main/java/com/squareup/picasso3/Transformation.kt ================================================ /* * Copyright (C) 2013 Square, Inc. * * 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.squareup.picasso3 import com.squareup.picasso3.RequestHandler.Result /** Image transformation. */ interface Transformation { /** * Transform the source result into a new result. If you create a new bitmap instance, you must * call [android.graphics.Bitmap.recycle] on `source`. You may return the original * if no transformation is required. */ fun transform(source: Result.Bitmap): Result.Bitmap /** * Returns a unique key for the transformation, used for caching purposes. If the transformation * has parameters (e.g. size, scale factor, etc) then these should be part of the key. */ fun key(): String } ================================================ FILE: picasso/src/main/java/com/squareup/picasso3/Utils.kt ================================================ /* * Copyright (C) 2013 Square, Inc. * * 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.squareup.picasso3 import android.app.ActivityManager import android.content.Context import android.content.pm.ApplicationInfo import android.content.pm.PackageManager import android.content.pm.PackageManager.NameNotFoundException import android.content.res.Resources import android.os.Handler import android.os.Looper import android.os.Message import android.os.StatFs import android.provider.Settings.Global import android.util.Log import androidx.core.content.ContextCompat import okio.BufferedSource import okio.ByteString import okio.ByteString.Companion.encodeUtf8 import java.io.File import java.io.FileNotFoundException import kotlin.math.max import kotlin.math.min internal object Utils { const val THREAD_PREFIX = "Picasso-" const val THREAD_IDLE_NAME = THREAD_PREFIX + "Idle" private const val PICASSO_CACHE = "picasso-cache" private const val MIN_DISK_CACHE_SIZE = 5 * 1024 * 1024 // 5MB private const val MAX_DISK_CACHE_SIZE = 50 * 1024 * 1024 // 50MB const val THREAD_LEAK_CLEANING_MS = 1000 /** Thread confined to main thread for key creation. */ val MAIN_THREAD_KEY_BUILDER = StringBuilder() /** Logging */ const val OWNER_MAIN = "Main" const val OWNER_DISPATCHER = "Dispatcher" const val OWNER_HUNTER = "Hunter" const val VERB_CREATED = "created" const val VERB_CHANGED = "changed" const val VERB_IGNORED = "ignored" const val VERB_ENQUEUED = "enqueued" const val VERB_CANCELED = "canceled" const val VERB_RETRYING = "retrying" const val VERB_EXECUTING = "executing" const val VERB_DECODED = "decoded" const val VERB_TRANSFORMED = "transformed" const val VERB_JOINED = "joined" const val VERB_REMOVED = "removed" const val VERB_DELIVERED = "delivered" const val VERB_REPLAYING = "replaying" const val VERB_COMPLETED = "completed" const val VERB_ERRORED = "errored" const val VERB_PAUSED = "paused" const val VERB_RESUMED = "resumed" /* WebP file header 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | 'R' | 'I' | 'F' | 'F' | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | File Size | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | 'W' | 'E' | 'B' | 'P' | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */ private val WEBP_FILE_HEADER_RIFF: ByteString = "RIFF".encodeUtf8() private val WEBP_FILE_HEADER_WEBP: ByteString = "WEBP".encodeUtf8() funPicasso
A powerful image downloading and caching library for Android
Introduction
Images add much-needed context and visual flair to Android applications. Picasso allows for hassle-free image loading in your application—often in one line of code!
Picasso.get().load("https://i.imgur.com/DvpvklR.png").into(imageView);
Many common pitfalls of image loading on Android are handled automatically by Picasso:
- Handling
ImageViewrecycling and download cancelation in an adapter. - Complex image transformations with minimal memory use.
- Automatic memory and disk caching.
Features
Adapter Downloads
Adapter re-use is automatically detected and the previous download canceled.
@Override public void getView(int position, View convertView, ViewGroup parent) {
SquaredImageView view = (SquaredImageView) convertView;
if (view == null) {
view = new SquaredImageView(context);
}
String url = getItem(position);
Picasso.get().load(url).into(view);
}
Image Transformations
Transform images to better fit into layouts and to reduce memory size.
Picasso.get() .load(url) .resize(50, 50) .centerCrop() .into(imageView)
You can also specify custom transformations for more advanced effects.
public class CropSquareTransformation implements Transformation {
@Override public Bitmap transform(Bitmap source) {
int size = Math.min(source.getWidth(), source.getHeight());
int x = (source.getWidth() - size) / 2;
int y = (source.getHeight() - size) / 2;
Bitmap result = Bitmap.createBitmap(source, x, y, size, size);
if (result != source) {
source.recycle();
}
return result;
}
@Override public String key() { return "square()"; }
}
Pass an instance of this class to the transform method.
Place Holders
Picasso supports both download and error placeholders as optional features.
Picasso.get()
.load(url)
.placeholder(R.drawable.user_placeholder)
.error(R.drawable.user_placeholder_error)
.into(imageView);
A request will be retried three times before the error placeholder is shown.
Resource Loading
Resources, assets, files, content providers are all supported as image sources.
Picasso.get().load(R.drawable.landing_screen).into(imageView1);
Picasso.get().load("file:///android_asset/DvpvklR.png").into(imageView2);
Picasso.get().load(new File(...)).into(imageView3);
Debug Indicators
For development you can enable the display of a colored ribbon which indicates the image source. Call setIndicatorsEnabled(true) on the Picasso instance.
Download
The source code to the Picasso, its samples, and this website is available on GitHub.
Maven
<dependency>
<groupId>com.squareup.picasso3</groupId>
<artifactId>picasso</artifactId>
<version>(insert latest version)</version>
</dependency>
Gradle
implementation 'com.squareup.picasso:picasso:(insert latest version)'
Contributing
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles by running mvn clean verify.
Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA).
License
Copyright 2013 Square, Inc. 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.
"+a+"";b=b.firstChild;g&&J(b,g,!0);K({h:d,j:g,c:b,i:1}); return b.innerHTML},prettyPrint:D.prettyPrint=function(a,d){function g(){for(var b=D.PR_SHOULD_USE_CONTINUATION?c.now()+250:Infinity;i