# Booming
[](https://github.com/yangKJ/RxNetworks)
[](https://cocoapods.org/pods/Booming)
[](https://cocoapods.org/pods/RxNetworks)
[](https://cocoapods.org/pods/HollowCodable)
**[Booming](https://github.com/yangKJ/RxNetworks)** is a base network library for Swift. Developed for Swift 5, it aims to make use of the latest language features. The framework's ultimate goal is to enable easy networking that makes it easy to write well-maintainable code.
**[RxNetworks](https://github.com/yangKJ/RxNetworks)** is a declarative and reactive networking library for Swift.
**đ§. RxSwift + Moya + HandyJSON / Codable + Plugins.đđđ**
-------
English | [**įŽäŊä¸æ**](README_CN.md)
This is a network api set of infrastructure based on Moya, also support responsive network with RxSwift.
## Features
At the moment, the most important features of Booming can be summarized as follows:
- [x] Support reactive network requests combined with [RxSwift](https://github.com/ReactiveX/RxSwift).
- [x] Support for [OOP](https://github.com/yangKJ/RxNetworks/blob/master/Booming/NetworkAPIOO.swift) also support [POP](https://github.com/yangKJ/RxNetworks/blob/master/Booming/NetworkAPI.swift) network requests.
- [x] Support data parsing with [HandyJSON](https://github.com/alibaba/HandyJSON) and [Codable](https://github.com/yangKJ/HollowCodable).
- [x] Support simple customization of various network plugins for [Moya](https://github.com/Moya/Moya).
- [x] Support uploading and downloading files or resources [plugin](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkFilesPlugin.swift).
- [x] Support configuration of general request and path, general parameters, etc.
- [x] Support for added default plugins with `BoomingSetup.basePlugins`.
- [x] Support authorization certificate [plugin](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkAuthenticationPlugin.swift) with Alamofire [RequestInterceptor](https://github.com/Alamofire/Alamofire/blob/master/Source/Features/RequestInterceptor.swift).
- [x] Support automatic managed [loading](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Huds/NetworkLoadingPlugin.swift) plugins hud.
- [x] Support token [plugin](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkTokenPlugin.swift) validation and automatically retries new token requests.
- [x] Support shared [plugin](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkSharedPlugin.swift) that do not request the same network repeatedly.
- [x] Support separate plugin library, eg: [Loading](https://cocoapods.org/pods/NetworkHudsPlugin) / [AnimatedLoading](https://cocoapods.org/pods/NetworkLottiePlugin) / [Cache](https://cocoapods.org/pods/NetworkCachePlugin).
- [x] Support 18 plugins have been packaged for you to use.
### Usages
How to use [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
```
SharedAPI.userInfo(name: "yangKJ").request(successed: { response in
// do somthing..
}, failed: { error in
print(error.localizedDescription)
})
or use async/await with swift 5.5
Task {
do {
let response = try await LoadingAPI.test2("666").requestAsync()
let json = response.bpm.mappedJson
// do somthing..
let model = LoadingModel.deserialize(from: json, designatedPath: "data")
} catch {
block(error.localizedDescription)
}
}
```
### Plugins
[](https://cocoapods.org/pods/NetworkHudsPlugin)
[](https://cocoapods.org/pods/NetworkCachePlugin)
[](https://cocoapods.org/pods/NetworkLottiePlugin)
This module is mainly based on moya package network related plugins.
- At present, 14 plugins have been packaged for you to use:
- [Header](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkHttpHeaderPlugin.swift): Network HTTP Header Plugin.
- [Authentication](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkAuthenticationPlugin.swift): Interceptor plugin.
- [Debugging](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkDebuggingPlugin.swift): Network printing, built in plugin.
- [GZip](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkGZipPlugin.swift): Network data unzip plugin.
- [Shared](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkSharedPlugin.swift): Network sharing plugin.
- [Files](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkFilesPlugin.swift): Network downloading files And Uploading resources plugin.
- [Token](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkTokenPlugin.swift): Token verify plugin.
- [Ignore](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkIgnorePlugin.swift): Ignore plugin, the purpose is to ignore a plugin in this network request.
- [CustomCache](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Features/NetworkCustomCachePlugin.swift): Custom network data caching plugin.
- [Cache](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Cache/NetworkCachePlugin.swift): Network data cache plugin.
- [Lottie](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Lottie/AnimatedLoadingPlugin.swift): Animation loading plugin based on lottie.
For ios platform:
- [Loading](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Huds/NetworkLoadingPlugin.swift): Loading animation plugin.
- [Warning](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Huds/NetworkWarningPlugin.swift): Network failure prompt plugin.
- [Indicator](https://github.com/yangKJ/RxNetworks/blob/master/Plugins/Views/NetworkIndicatorPlugin.swift): Indicator plugin.
If you want to use token plugin and auth plugin you can refer to the project use case.
- [Auth](https://github.com/yangKJ/RxNetworks/blob/master/RxNetworks/Plugins/Auth/AuthPlugin.swift): Authorization plugin.
đˇ Simple to use, implement the protocol method in the API protocol, and then add the plugin to it:
```
var plugins: APIPlugins {
let cache = NetworkCachePlugin.init()
let loading = NetworkLoadingPlugin.init()
let warning = NetworkWarningPlugin.init()
let shared = NetworkSharedPlugin.init()
let gzip = NetworkGZipPlugin.init()
return [loading, cache, warning, shared, gzip]
}
```
### RxSwift
This module mainly supports responsive data binding.
```
func request(_ count: Int) -> Observable<[CacheModel]> {
CacheAPI.cache(count).request()
.deserialized(ApiResponse<[CacheModel]>.self)
.compactMap { $0.data }
.observe(on: MainScheduler.instance)
.catchAndReturn([])
}
```
### HollowCodable
**[HollowCodable](https://github.com/yangKJ/HollowCodable)** is a codable customization using property wrappers library for Swift.
This module is serialize and deserialize the data, Replace HandyJSON.
đˇ Example of use in conjunction with the network part:
```
func request(_ count: Int) -> Observable<[LoadingModel]> {
CodableAPI.cache(count)
.request(callbackQueue: DispatchQueue(label: "request.codable"))
.deserialized(ApiResponse<[LoadingModel]>.self)
.compactMap({ $0.data })
.observe(on: MainScheduler.instance)
.catchAndReturn([])
}
```
RxSwift deserialized extension.
```swift
public extension Observable where Element: Any {
@discardableResult func deserialized(_ type: T.Type) -> Observable where T: HollowCodable {
return self.map { element -> T in
return try T.deserialize(element: element)
}
}
@discardableResult func deserialized(_ type: [T].Type) -> Observable<[T]> where T: HollowCodable {
return self.map { element -> [T] in
return try [T].deserialize(element: element)
}
}
@discardableResult func deserialized(_ type: T.Type) -> Observable> where T: HasResponsable, T.DataType: HollowCodable {
return self.map { element -> ApiResponse in
return try T.deserialize(element: element)
}
}
@discardableResult func deserialized(_ type: T.Type) -> Observable> where T: HasResponsable, T.DataType: Collection, T.DataType.Element: HollowCodable {
return self.map { element -> ApiResponse<[T.DataType.Element]> in
return try T.deserialize(element: element)
}
}
}
```
### HandyJSON
â ī¸ Note: This module is not recommended because it has stopped maintenance.
This module is based on HandyJSON package network data parsing.
- Roughly divided into the following 3 parts:
- [HandyDataModel](https://github.com/yangKJ/RxNetworks/blob/master/Sources/HandyJSON/HandyDataModel.swift): Network outer data model.
- [HandyJSONError](https://github.com/yangKJ/RxNetworks/blob/master/Sources/HandyJSON/HandyJSONError.swift): Parse error related.
- [RxHandyJSON](https://github.com/yangKJ/RxNetworks/blob/master/Sources/HandyJSON/RxHandyJSON.swift): HandyJSON data parsing, currently provides two parsing solutions.
đˇ Example of use in conjunction with the network part:
```
func request(_ count: Int) -> Driver<[CacheModel]> {
CacheAPI.cache(count).request()
.asObservable()
.mapHandyJSON(HandyDataModel<[CacheModel]>.self)
.compactMap { $0.data }
.observe(on: MainScheduler.instance)
.delay(.seconds(1), scheduler: MainScheduler.instance)
.asDriver(onErrorJustReturn: [])
}
```
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager. For usage and installation instructions, visit their website. To integrate using CocoaPods, specify it in your Podfile:
```
pod 'Booming'
```
You should define your minimum deployment target explicitly, like:
```
platform :ios, '11.0'
```
If you want import cache plugin:
```
pod 'NetworkCachePlugin'
```
If you want import loading plugin:
```
pod 'NetworkHudsPlugin'
```
If you wang using Codable:
```
pod 'HollowCodable'
```
If responsive networking is required:
```
pod 'RxNetworks/RxSwift'
```
For other plugins and modules excluded, please read the [podspec](https://github.com/yangKJ/RxNetworks/blob/master/Booming.podspec) file.
### Remarks
> The general process is almost like this, the Demo is also written in great detail, you can check it out for yourself.đˇ
>
> [**BoomingDemo**](https://github.com/yangKJ/RxNetworks)
>
> Tip: If you find it helpful, please help me with a star. If you have any questions or needs, you can also issue.
>
> Thanks.đ
### About the author
- đˇ **E-mail address: [yangkj310@gmail.com](yangkj310@gmail.com) đˇ**
- đ¸ **GitHub address: [yangKJ](https://github.com/yangKJ) đ¸**
Buy me a coffee or support me on [GitHub](https://github.com/sponsors/yangKJ?frequency=one-time&sponsor=yangKJ).
Alipay or WeChat. Thanks.
-----
### License
Booming is available under the [MIT](LICENSE) license. See the [LICENSE](LICENSE) file for more info.
-----