Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pircate/RxNetwork
A swift network library based on Moya/RxSwift.
https://github.com/Pircate/RxNetwork
cache moya rxswift
Last synced: about 2 months ago
JSON representation
A swift network library based on Moya/RxSwift.
- Host: GitHub
- URL: https://github.com/Pircate/RxNetwork
- Owner: Pircate
- License: mit
- Created: 2018-04-19T03:44:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-12T05:04:42.000Z (almost 5 years ago)
- Last Synced: 2024-10-08T02:15:12.887Z (3 months ago)
- Topics: cache, moya, rxswift
- Language: Swift
- Homepage:
- Size: 27 MB
- Stars: 50
- Watchers: 6
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - RxNetwork - A swift network library based on Moya/RxSwift. `pod 'RxNetwork/Cacheable'` (OOM-Leaks-Crash / Rx Series)
- awesome - RxNetwork - A swift network library based on Moya/RxSwift. `pod 'RxNetwork/Cacheable'` (OOM-Leaks-Crash / Rx Series)
README
# RxNetwork
[](https://travis-ci.org/Pircate/RxNetwork)
[](http://cocoapods.org/pods/RxNetwork)
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/RxNetwork)
[](https://cocoapods.org/pods/RxNetwork)
[](https://codebeat.co/projects/github-com-pircate-rxnetwork-master)
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Requirements
* iOS 9.0
* Swift 5.0
## Installation
RxNetwork is available through [CocoaPods](http://cocoapods.org) or [Carthage](https://github.com/Carthage/Carthage). To install
it, simply add the following line to your Podfile or Cartfile:
#### Podfile
```ruby
pod 'RxNetwork'
```
缓存
```ruby
pod 'RxNetwork/Cacheable'
```
#### Cartfile
```ruby
github "Pircate/RxNetwork"
```
## Usage
### Import
``` swift
import RxNetwork
```
### Configuration
```swift
Network.Configuration.default.timeoutInterval = 20
Network.Configuration.default.plugins = [NetworkIndicatorPlugin()]
Network.Configuration.default.replacingTask = { target in
// configure common parameters etc.
switch target.task {
case let .requestParameters(parameters, encoding):
let params: [String: Any] = ["token": "", "sign": "", "body": parameters]
return .requestParameters(parameters: params, encoding: encoding)
default:
return target.task
}
}
// or
let configuration = Network.Configuration()
configuration.timeoutInterval = 20
configuration.plugins = [NetworkIndicatorPlugin()]
Network.Configuration.default = configuration
```
### Allow storage strategy
确保缓存的数据是正确的 JSON 格式，否则解析数据的时候会失败导致序列抛出异常。
如下，仅当 code 为 200 时返回的数据才是正确的 JSON 格式。
```
extension Storable where Self: TargetType {
public var allowsStorage: (Moya.Response) -> Bool {
return {
do {
return try $0.mapCode() == 200
} catch {
return false
}
}
}
}
```
### Request without cache
```swift
StoryAPI.latest
.request()
.map(StoryListModel.self)
.subscribe(onSuccess: { (model) in
}).disposed(by: disposeBag)
```
### Request with cache
```swift
/*
{
"top_stories": []
}
*/
StoryAPI.latest
.onCache(StoryListModel.self, { (model) in
})
.request()
.subscribe(onSuccess: { (model) in
})
.disposed(by: disposeBag)
StoryAPI.latest
.cache
.request()
.map(StoryListModel.self)
.subscribe(onNext: { (model) in
}).disposed(by: disposeBag)
```
```swift
/*
{
"code": 2000,
"message": "Ok",
"result": []
}
*/
TestTarget.test(count: 10)
.onCache([TestModel].self, { (models) in
})
.requestObject()
.subscribe(onSuccess: { (models) in
})
.disposed(by: disposeBag)
TestTarget.test(count: 10)
.cache
.request()
.mapObject([TestModel].self)
.subscribe(onNext: { (models) in
})
.disposed(by: disposeBag)
```
### Cacheable
为 `target` 提供缓存功能，请遵循 `Cacheable` 协议
```swift
enum API: TargetType, Cacheable {
case api
// 设置缓存过期时间
var expiry: Expiry {
return .never
}
}
```
## Author
Pircate, [email protected]
## License
RxNetwork is available under the MIT license. See the LICENSE file for more info.