APSmartStorage helps to get data from network and automatically caches data on disk or in memory in a smart configurable way. Here is how the APSmartStorage
flow diagram looks like:
- Load cached object from memory by URL
- Load cached object from file by URL
- Load object from network by URL
- Store loaded object to file
- Store loaded object to memory
- Parse loaded data from network (for instance, NSData to UIImage)
- Track loading progress
- Automatically purge memory cache on memory warning
- Set max object count to keep in memory to prevent memory overflow
- Set custom NSURLSessionConfiguration
Add APSmartStorage
pod to Podfile
Here is example how to use APSmartStorage
to store images
// setup data parsing block
APSmartStorage.sharedInstance.parsingBlock = ^(NSData *data, NSURL *url)
{
return [UIImage imageWithData:data scale:UIScreen.mainScreen.scale];
};
...
// show some progress/activity
...
// load object with URL
[APSmartStorage.sharedInstance loadObjectWithURL:imageURL completion:^(id object, NSError *error)
{
// hide progress/activity
if (error)
{
// show error
}
else
{
// do something with object
}
}];
Very often you don't need to store downloaded object in memory. For instance, you perform some background download for future, and you don't want to keep this objects in memory right now.
[APSmartStorage.sharedInstance loadObjectWithURL:someURL storeInMemory:NO completion:^(id object, NSError *error)
{
// do something
}];
But if any method call sets storeInMemory:YES
object will be stored in memory
[APSmartStorage.sharedInstance loadObjectWithURL:someURL storeInMemory:NO progress:^(NSUInteger percents)
{
// show progress percents value is between 0 and 100
} completion:^(id object, NSError *error)
{
// do something
}];
Objects stored at files could become outdated after some time, and application should reload it from network
[APSmartStorage.sharedInstance reloadObjectWithURL:objectURL completion:(id object, NSError *error)
{
if (error)
{
// show error and do something like use outdated version of object
}
else
{
// do something with object
}
}];
// remove object from memory
[APSmartStorage.sharedInstance removeObjectWithURLFromMemory:objectURL];
// remove all objects form memory
[APSmartStorage.sharedInstance removeAllFromMemory];
// remove object from memory and remove it file
[APSmartStorage.sharedInstance removeObjectWithURLFromStorage:objectURL];
// remove all objects from memory and all storage files
[APSmartStorage.sharedInstance removeAllFromStorage];
This methods also cancel network requests. And if request has been cancelled, callbacks will run with
nil
asobject
and with error with code 701.
If parsingBlock
doesn't set you will receive raw NSData
downloaded from network or read from file. So you should set one in most cases. If you need to parse data of different formats it will be a bit more complicated:
APSmartStorage.sharedInstance.parsingBlock = ^(NSData *data, NSURL *url)
{
// is URL of image
if ([url isImageURL])
{
return [UIImage imageWithData:data scale:UIScreen.mainScreen.scale];
}
// this is URL of something else
else
{
return [SomeObject objectWithData:data];
}
};
If max object count reached random object will be removed from memory before add next one
APSmartStorage.sharedInstance.maxObjectCount = 10;
APSmartStorage.sharedInstance.sessionConfiguration = sessionConfiguration;
Version 0.1.2
- Added tracking of load progress
- Renamed methods
Version 0.1.1
- Added ability to prevent object from been saved in memory
Version 0.1.0
- Added cancel network requests on object remove
- Renamed methods
Version 0.0.7
- Improved callbacks to run immediately if object found in memory storage
Version 0.0.6
- Fixed crash on 'nil' object set to memory storage
Version 0.0.5
- Public release
=======================
If you have improvements or concerns, feel free to post an issue and write details.
Check out all Alterplay's GitHub projects. Email us with other ideas and projects.