-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathSTBaseViewModel.swift
More file actions
1068 lines (971 loc) · 42 KB
/
Copy pathSTBaseViewModel.swift
File metadata and controls
1068 lines (971 loc) · 42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// STBaseViewModel.swift
// STBaseProject
//
// Created by 寒江孤影 on 2018/3/14.
//
import UIKit
import Combine
import CryptoKit
import Foundation
// MARK: - 错误类型枚举
public enum STBaseError: LocalizedError, Equatable {
case success
case networkError(String)
case dataError(String)
case validationError(String)
case businessError(code: Int, message: String)
case origin(error: Error)
case originErrorDescription(reason: String)
case unknown
public var errorDescription: String? {
switch self {
case .success:
return "success"
case .networkError(let message):
return "网络错误: \(message)"
case .dataError(let message):
return "数据错误: \(message)"
case .validationError(let message):
return "验证错误: \(message)"
case .businessError(_, let message):
return message
case .origin(let error):
return error.localizedDescription
case .originErrorDescription(let reason):
return reason
case .unknown:
return "未知错误"
}
}
public var errorCode: Int {
switch self {
case .success:
return 0
case .networkError:
return -1001
case .dataError:
return -1002
case .validationError:
return -1003
case .businessError(let code, _):
return code
case .origin:
return -1004
case .originErrorDescription:
return -1005
case .unknown:
return -9999
}
}
public static func == (lhs: STBaseError, rhs: STBaseError) -> Bool {
switch (lhs, rhs) {
case (.success, .success),
(.unknown, .unknown):
return true
case (.networkError(let l), .networkError(let r)),
(.dataError(let l), .dataError(let r)),
(.validationError(let l), .validationError(let r)),
(.originErrorDescription(let l), .originErrorDescription(let r)):
return l == r
case (.businessError(let lc, let lm), .businessError(let rc, let rm)):
return lc == rc && lm == rm
case (.origin(let l), .origin(let r)):
return (l as NSError) == (r as NSError)
default:
return false
}
}
}
// MARK: - 加载状态枚举
public enum STLoadingState: Equatable {
case idle
case loading
case loaded
case failed(STBaseError)
case empty
}
// MARK: - 刷新状态枚举
public enum STRefreshState: Equatable {
case idle
case refreshing
case noMoreData
case failed(STBaseError)
}
// MARK: - 缓存配置
public struct STCacheConfig {
public var enableCache: Bool
public var cacheKey: String
public var cacheExpiration: TimeInterval
public var cachePolicy: STCachePolicy
public enum STCachePolicy: Equatable {
case memory
case disk
case both
}
public init(enableCache: Bool = false,
cacheKey: String = "",
cacheExpiration: TimeInterval = 300,
cachePolicy: STCachePolicy = .memory) {
self.enableCache = enableCache
self.cacheKey = cacheKey
self.cacheExpiration = cacheExpiration
self.cachePolicy = cachePolicy
}
}
open class STBaseViewModel: NSObject {
public let loadingState = CurrentValueSubject<STLoadingState, Never>(.idle)
public let refreshState = CurrentValueSubject<STRefreshState, Never>(.idle)
public let errorPublisher = PassthroughSubject<STBaseError, Never>()
public let dataUpdated = PassthroughSubject<Void, Never>()
public var requestConfig = STRequestConfig()
public var cacheConfig = STCacheConfig()
public var httpSession: STHTTPSessionProviding = STHTTPSession.shared
public var requestHeaders = STRequestHeaders()
public var jsonDecoder: JSONDecoder = JSONDecoder()
public var jsonEncoder: JSONEncoder = JSONEncoder()
public private(set) var cancellables = Set<AnyCancellable>()
private let cache = NSCache<NSString, STMemoryCacheEntry>()
private let stateLock = NSLock()
private var inflightRequests = [STDataRequest]()
private var activeLoadingRequestCount = 0
private var pendingLoadingFailure: STBaseError?
deinit {
STLog("🌈 -> \(self) 🌈 ----> 🌈 dealloc")
}
public override init() {
super.init()
self.st_setupBindings()
}
/// 依赖注入构造器:用于测试或自定义 HTTP 会话替换默认单例。
public convenience init(httpSession: STHTTPSessionProviding) {
self.init()
self.httpSession = httpSession
}
private func st_setupBindings() {
self.loadingState
.removeDuplicates()
.receive(on: DispatchQueue.main)
.sink { [weak self] state in
self?.st_handleLoadingStateChange(state)
}
.st_store(in: self)
self.refreshState
.removeDuplicates()
.receive(on: DispatchQueue.main)
.sink { [weak self] state in
self?.st_handleRefreshStateChange(state)
}
.st_store(in: self)
}
private func st_handleLoadingStateChange(_ state: STLoadingState) {
switch state {
case .loading:
self.st_onLoading()
case .loaded:
self.st_onLoaded()
case .failed(let error):
self.st_onFailed(error)
case .empty:
self.st_onEmpty()
case .idle:
break
}
}
private func st_handleRefreshStateChange(_ state: STRefreshState) {
switch state {
case .refreshing:
self.st_onRefreshing()
case .noMoreData:
self.st_onNoMoreData()
case .failed(let error):
self.st_onRefreshFailed(error)
case .idle:
break
}
}
// MARK: - 可重写的方法
open func st_onLoading() {}
open func st_onLoaded() {}
open func st_onFailed(_ error: STBaseError) {
self.errorPublisher.send(error)
}
open func st_onEmpty() {}
open func st_onRefreshing() {}
open func st_onNoMoreData() {}
open func st_onRefreshFailed(_ error: STBaseError) {
self.errorPublisher.send(error)
}
// MARK: - 网络请求核心方法
public func st_requestPublisher<T: Codable>(url: String, method: STHTTPMethod = .get, parameters: [String: Any]? = nil, encodingType: STParameterEncoder.EncodingType = .json, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
Deferred { [weak self] () -> AnyPublisher<T, STBaseError> in
guard let self = self else {
return Fail(error: STBaseError.unknown).eraseToAnyPublisher()
}
let shouldShowLoading = self.requestConfig.showLoading
if shouldShowLoading {
self.st_beginLoadingRequest()
}
return self.st_dispatchRequestPublisher(url: url, method: method, parameters: parameters, encodingType: encodingType)
.tryMap { [weak self] response -> T in
guard let self = self else {
throw STBaseError.unknown
}
let result = self.st_resultFromHTTPResponse(response, responseType: responseType)
switch result {
case .success(let value):
return value
case .failure(let error):
throw error
}
}
.mapError { error -> STBaseError in
if let baseError = error as? STBaseError {
return baseError
}
return STBaseError.origin(error: error)
}
.handleEvents(
receiveOutput: { [weak self] _ in
self?.dataUpdated.send()
},
receiveCompletion: { [weak self] completion in
guard shouldShowLoading else { return }
switch completion {
case .finished:
self?.st_finishLoadingRequest(.loaded)
case .failure(let error):
self?.st_finishLoadingRequest(.failed(error))
}
},
receiveCancel: { [weak self] in
guard shouldShowLoading else { return }
self?.st_cancelLoadingRequest()
}
)
.eraseToAnyPublisher()
}
.eraseToAnyPublisher()
}
public func st_request<T: Codable>(url: String, method: STHTTPMethod = .get, parameters: [String: Any]? = nil, encodingType: STParameterEncoder.EncodingType = .json, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
var token: AnyCancellable?
token = self.st_requestPublisher(url: url, method: method, parameters: parameters, encodingType: encodingType, responseType: responseType)
.sink(
receiveCompletion: { [weak self] state in
if case .failure(let error) = state {
completion(.failure(error))
}
if let token = token {
self?.st_removeCancellable(token)
}
},
receiveValue: { value in
completion(.success(value))
}
)
if let token = token {
self.st_storeCancellable(token)
}
}
open func st_dispatchRequestPublisher(url: String, method: STHTTPMethod, parameters: [String: Any]?, encodingType: STParameterEncoder.EncodingType) -> AnyPublisher<STHTTPResponse, Never> {
let request = self.httpSession.request(url, method: method, parameters: parameters, encoding: encodingType, headers: self.requestHeaders, interceptor: nil, requestConfig: self.requestConfig)
return self.st_responsePublisher(for: request)
}
open func st_dispatchRequestPublisher(_ request: URLRequest) -> AnyPublisher<STHTTPResponse, Never> {
guard let httpSession = self.httpSession as? STHTTPURLRequestSessionProviding else {
return Just(STHTTPResponse(
data: nil,
response: nil,
error: STBaseError.originErrorDescription(reason: "当前 HTTP 会话不支持 URLRequest 请求")
)).eraseToAnyPublisher()
}
let dataRequest = httpSession.request(request, interceptor: nil, requestConfig: self.requestConfig)
return self.st_responsePublisher(for: dataRequest)
}
private func st_responsePublisher(for request: STDataRequest) -> AnyPublisher<STHTTPResponse, Never> {
self.st_trackInflight(request)
return request.responsePublisher
.handleEvents(
receiveCompletion: { [weak self] _ in
self?.st_untrackInflight(request)
},
receiveCancel: { [weak self] in
request.cancel()
self?.st_untrackInflight(request)
}
)
.eraseToAnyPublisher()
}
open func st_dispatchRequest(url: String, method: STHTTPMethod, parameters: [String: Any]?, encodingType: STParameterEncoder.EncodingType, completion: @escaping (STHTTPResponse) -> Void) {
var token: AnyCancellable?
token = self.st_dispatchRequestPublisher(url: url, method: method, parameters: parameters, encodingType: encodingType)
.sink { [weak self] response in
completion(response)
if let token = token {
self?.st_removeCancellable(token)
}
}
if let token = token {
self.st_storeCancellable(token)
}
}
public func st_getPublisher<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
self.st_requestPublisher(url: url, method: .get, parameters: parameters, responseType: responseType)
}
public func st_postPublisher<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
self.st_requestPublisher(url: url, method: .post, parameters: parameters, responseType: responseType)
}
public func st_putPublisher<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
self.st_requestPublisher(url: url, method: .put, parameters: parameters, responseType: responseType)
}
public func st_deletePublisher<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
self.st_requestPublisher(url: url, method: .delete, parameters: parameters, responseType: responseType)
}
public func st_get<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.st_request(url: url, method: .get, parameters: parameters, responseType: responseType, completion: completion)
}
public func st_post<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.st_request(url: url, method: .post, parameters: parameters, responseType: responseType, completion: completion)
}
public func st_put<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.st_request(url: url, method: .put, parameters: parameters, responseType: responseType, completion: completion)
}
public func st_delete<T: Codable>(url: String, parameters: [String: Any]? = nil, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.st_request(url: url, method: .delete, parameters: parameters, responseType: responseType, completion: completion)
}
/// 直接基于已构造好的 URLRequest 发起请求;保留原始 headers / body / 超时等定制
public func st_request<T: Codable>(_ request: URLRequest, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
guard request.url != nil else {
completion(.failure(.dataError("无效的 URL")))
return
}
var token: AnyCancellable?
token = self.st_requestPublisher(request, responseType: responseType)
.sink(
receiveCompletion: { [weak self] state in
if case .failure(let error) = state {
completion(.failure(error))
}
if let token = token {
self?.st_removeCancellable(token)
}
},
receiveValue: { value in
completion(.success(value))
}
)
if let token = token {
self.st_storeCancellable(token)
}
}
public func st_requestPublisher<T: Codable>(_ request: URLRequest, responseType: T.Type) -> AnyPublisher<T, STBaseError> {
guard request.url != nil else {
return Fail(error: STBaseError.dataError("无效的 URL")).eraseToAnyPublisher()
}
return Deferred { [weak self] () -> AnyPublisher<T, STBaseError> in
guard let self = self else {
return Fail(error: STBaseError.unknown).eraseToAnyPublisher()
}
let shouldShowLoading = self.requestConfig.showLoading
if shouldShowLoading {
self.st_beginLoadingRequest()
}
return self.st_dispatchRequestPublisher(request)
.tryMap { [weak self] response -> T in
guard let self = self else {
throw STBaseError.unknown
}
let result = self.st_resultFromHTTPResponse(response, responseType: responseType)
switch result {
case .success(let value):
return value
case .failure(let error):
throw error
}
}
.mapError { error -> STBaseError in
if let baseError = error as? STBaseError {
return baseError
}
return STBaseError.origin(error: error)
}
.handleEvents(
receiveOutput: { [weak self] _ in
self?.dataUpdated.send()
},
receiveCompletion: { [weak self] completion in
guard shouldShowLoading else { return }
switch completion {
case .finished:
self?.st_finishLoadingRequest(.loaded)
case .failure(let error):
self?.st_finishLoadingRequest(.failed(error))
}
},
receiveCancel: { [weak self] in
guard shouldShowLoading else { return }
self?.st_cancelLoadingRequest()
}
)
.eraseToAnyPublisher()
}
.eraseToAnyPublisher()
}
// MARK: - 参数提取(用于 URLRequest)
private func st_extractParameters(from request: URLRequest) -> [String: Any]? {
if let httpMethod = request.httpMethod, httpMethod.uppercased() == "GET" {
return self.st_extractQueryParameters(from: request.url)
}
if let httpBody = request.httpBody {
return self.st_extractBodyParameters(from: httpBody)
}
return nil
}
private func st_extractQueryParameters(from url: URL?) -> [String: Any]? {
guard let url = url,
let components = URLComponents(url: url, resolvingAgainstBaseURL: false),
let queryItems = components.queryItems else {
return nil
}
var parameters: [String: Any] = [:]
for item in queryItems {
parameters[item.name] = item.value ?? ""
}
return parameters.isEmpty ? nil : parameters
}
private func st_extractBodyParameters(from data: Data) -> [String: Any]? {
if let json = try? JSONSerialization.jsonObject(with: data) as? [String: Any] {
return json
}
guard let string = String(data: data, encoding: .utf8) else {
return nil
}
return self.st_parseFormData(string)
}
private func st_parseFormData(_ formString: String) -> [String: Any]? {
let pairs = formString.components(separatedBy: "&")
var parameters: [String: Any] = [:]
for pair in pairs {
let components = pair.components(separatedBy: "=")
if components.count == 2 {
let rawKey = components[0].replacingOccurrences(of: "+", with: " ")
let rawValue = components[1].replacingOccurrences(of: "+", with: " ")
let key = rawKey.removingPercentEncoding ?? rawKey
let value = rawValue.removingPercentEncoding ?? rawValue
parameters[key] = value
}
}
return parameters.isEmpty ? nil : parameters
}
// MARK: - 响应处理
private func st_decodeResponse<T: Codable>(_ httpResponse: STHTTPResponse, responseType: T.Type) -> Result<T, STBaseError> {
guard let data = httpResponse.data, !data.isEmpty else {
return .failure(.dataError("响应数据为空"))
}
do {
return .success(try self.jsonDecoder.decode(responseType, from: data))
} catch DecodingError.keyNotFound(let key, let context) {
let message = "JSON解析失败:缺少必需的字段 '\(key.stringValue)',路径:\(context.codingPath.map { $0.stringValue }.joined(separator: "."))"
self.st_logDecodeError("keyNotFound", message: message, data: data)
return .failure(.dataError(message))
} catch DecodingError.valueNotFound(let value, let context) {
let message = "JSON解析失败:字段 '\(context.codingPath.map { $0.stringValue }.joined(separator: "."))' 的值为空,期望类型:\(value)"
self.st_logDecodeError("valueNotFound", message: message, data: data)
return .failure(.dataError(message))
} catch DecodingError.typeMismatch(let type, let context) {
let message = "JSON解析失败:字段 '\(context.codingPath.map { $0.stringValue }.joined(separator: "."))' 类型不匹配,期望:\(type),实际:\(context.debugDescription)"
self.st_logDecodeError("typeMismatch", message: message, data: data)
return .failure(.dataError(message))
} catch DecodingError.dataCorrupted(let context) {
let message = "JSON解析失败:数据损坏,路径:\(context.codingPath.map { $0.stringValue }.joined(separator: ".")),原因:\(context.debugDescription)"
self.st_logDecodeError("dataCorrupted", message: message, data: data)
return .failure(.dataError(message))
} catch {
let message = "JSON解析失败:\(error.localizedDescription)"
self.st_logDecodeError("unknown", message: message, data: data)
return .failure(.dataError(message))
}
}
private func st_logDecodeError(_ tag: String, message: String, data: Data) {
var log = "[st_decodeResponse][\(tag)] \(message)"
if let jsonString = String(data: data, encoding: .utf8) {
log += "\n原始数据: \(jsonString)"
}
STLog(log)
}
private func st_handleHTTPResponse<T: Codable>(_ httpResponse: STHTTPResponse, responseType: T.Type, completion: @escaping (Result<T, STBaseError>) -> Void) {
let result = self.st_resultFromHTTPResponse(httpResponse, responseType: responseType)
switch result {
case .success(let value):
self.st_handleSuccess(value, completion: completion)
case .failure(let error):
self.st_handleError(error, completion: completion)
}
}
private func st_resultFromHTTPResponse<T: Codable>(_ httpResponse: STHTTPResponse, responseType: T.Type) -> Result<T, STBaseError> {
if httpResponse.isSuccess {
return self.st_decodeResponse(httpResponse, responseType: responseType)
}
return .failure(self.st_convertHTTPError(httpResponse.error))
}
private func st_convertHTTPError(_ error: Error?) -> STBaseError {
if let baseError = error as? STBaseError {
return baseError
} else if let httpError = error as? STHTTPError {
switch httpError {
case .networkError(let networkError):
return STBaseError.networkError(networkError.localizedDescription)
case .serverError(let code):
return STBaseError.networkError("服务器错误: \(code)")
case .invalidURL:
return STBaseError.dataError("无效的 URL")
case .noData:
return STBaseError.dataError("无数据返回")
case .timeout:
return STBaseError.networkError("请求超时")
case .decodingError:
return STBaseError.dataError("数据解码失败")
case .cancelled:
return STBaseError.networkError("请求已取消")
}
} else if let error = error {
return STBaseError.origin(error: error)
} else {
return STBaseError.unknown
}
}
private func st_handleSuccess<T>(_ result: T, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.loadingState.send(.loaded)
completion(.success(result))
self.dataUpdated.send()
}
private func st_handleError<T>(_ error: STBaseError, completion: @escaping (Result<T, STBaseError>) -> Void) {
self.loadingState.send(.failed(error))
completion(.failure(error))
}
// MARK: - 缓存管理
/// 写入缓存。需要 `cacheConfig.enableCache == true` 且 key 非空。
public func st_setCache<T: Codable>(_ object: T, forKey key: String) {
guard self.cacheConfig.enableCache, !key.isEmpty else { return }
guard let data = self.st_encodeCachePayload(object) else { return }
let entry = STMemoryCacheEntry(data: data, expiration: Date().addingTimeInterval(self.cacheConfig.cacheExpiration))
self.cache.setObject(entry, forKey: NSString(string: key))
if self.cacheConfig.cachePolicy == .disk || self.cacheConfig.cachePolicy == .both {
self.st_saveToDisk(data: data, expiration: entry.expiration, forKey: key)
}
}
/// 读取缓存(解码为指定类型),过期或不存在返回 nil。
public func st_getCache<T: Codable>(forKey key: String, as type: T.Type) -> T? {
guard self.cacheConfig.enableCache, !key.isEmpty else { return nil }
let nsKey = NSString(string: key)
if let entry = self.cache.object(forKey: nsKey) {
if entry.expiration > Date() {
return self.st_decodeCachePayload(entry.data, as: type)
}
self.cache.removeObject(forKey: nsKey)
}
if self.cacheConfig.cachePolicy == .disk || self.cacheConfig.cachePolicy == .both,
let payload = self.st_loadFromDisk(forKey: key) {
if payload.expiration > Date() {
self.cache.setObject(STMemoryCacheEntry(data: payload.data, expiration: payload.expiration), forKey: nsKey)
return self.st_decodeCachePayload(payload.data, as: type)
}
self.st_removeFromDisk(forKey: key)
}
return nil
}
public func st_removeCache(forKey key: String) {
guard !key.isEmpty else { return }
self.cache.removeObject(forKey: NSString(string: key))
if self.cacheConfig.cachePolicy == .disk || self.cacheConfig.cachePolicy == .both {
self.st_removeFromDisk(forKey: key)
}
}
public func st_clearCache() {
self.cache.removeAllObjects()
if self.cacheConfig.cachePolicy == .disk || self.cacheConfig.cachePolicy == .both {
self.st_clearDiskCache()
}
}
private func st_encodeCachePayload<T: Codable>(_ object: T) -> Data? {
do {
return try self.jsonEncoder.encode(object)
} catch {
STLog("[STBaseViewModel] 缓存编码失败: \(error.localizedDescription)")
return nil
}
}
private func st_decodeCachePayload<T: Codable>(_ data: Data, as type: T.Type) -> T? {
do {
return try self.jsonDecoder.decode(type, from: data)
} catch {
STLog("[STBaseViewModel] 缓存解码失败: \(error.localizedDescription)")
return nil
}
}
// MARK: - 磁盘缓存
private struct STDiskCachePayload: Codable {
let data: Data
let expiration: Date
}
private func st_diskCacheURL(forKey key: String) -> URL? {
guard let cacheDirectory = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first else { return nil }
let safeName = self.st_safeCacheFileName(forKey: key)
return cacheDirectory.appendingPathComponent("\(safeName).cache")
}
private func st_safeCacheFileName(forKey key: String) -> String {
let digest = SHA256.hash(data: Data(key.utf8))
return digest.map { String(format: "%02x", $0) }.joined()
}
private func st_saveToDisk(data: Data, expiration: Date, forKey key: String) {
guard let fileURL = self.st_diskCacheURL(forKey: key) else { return }
let payload = STDiskCachePayload(data: data, expiration: expiration)
do {
let encoded = try self.jsonEncoder.encode(payload)
try encoded.write(to: fileURL, options: .atomic)
} catch {
STLog("[STBaseViewModel] 磁盘缓存写入失败: \(error.localizedDescription)")
}
}
private func st_loadFromDisk(forKey key: String) -> STDiskCachePayload? {
guard let fileURL = self.st_diskCacheURL(forKey: key) else {
return nil
}
do {
let data = try Data(contentsOf: fileURL)
return try self.jsonDecoder.decode(STDiskCachePayload.self, from: data)
} catch {
STLog("[STBaseViewModel] 磁盘缓存读取失败: \(error.localizedDescription)")
return nil
}
}
private func st_removeFromDisk(forKey key: String) {
guard let fileURL = self.st_diskCacheURL(forKey: key) else { return }
do {
try FileManager.default.removeItem(at: fileURL)
} catch {
STLog("[STBaseViewModel] 磁盘缓存删除失败: \(error.localizedDescription)")
}
}
private func st_clearDiskCache() {
guard let cacheDirectory = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first else {
return
}
do {
let cacheFiles = try FileManager.default.contentsOfDirectory(at: cacheDirectory, includingPropertiesForKeys: nil)
cacheFiles.forEach { fileURL in
guard fileURL.pathExtension == "cache" else { return }
do {
try FileManager.default.removeItem(at: fileURL)
} catch {
STLog("[STBaseViewModel] 清理磁盘缓存失败: \(error.localizedDescription)")
}
}
} catch {
STLog("[STBaseViewModel] 读取缓存目录失败: \(error.localizedDescription)")
}
}
// MARK: - 数据验证
open func st_validateData<T>(_ data: T) -> Bool { true }
open func st_validateResponse<T>(_ response: T) -> Bool { true }
// MARK: - 工具方法
public func st_createRequest(url: URL, method: String = "GET", body: Data? = nil) -> URLRequest {
var request = URLRequest(url: url)
request.httpMethod = method
request.httpBody = body
request.timeoutInterval = self.requestConfig.timeoutInterval
request.cachePolicy = self.requestConfig.cachePolicy
request.allowsCellularAccess = self.requestConfig.allowsCellularAccess
request.httpShouldHandleCookies = self.requestConfig.httpShouldHandleCookies
request.httpShouldUsePipelining = self.requestConfig.httpShouldUsePipelining
request.networkServiceType = self.requestConfig.networkServiceType
let headers = self.requestHeaders.st_getHeaders()
for (key, value) in headers {
request.setValue(value, forHTTPHeaderField: key)
}
return request
}
public func st_parseJSON<T: Codable>(_ data: Data, type: T.Type) -> Result<T, STBaseError> {
let result = data.decodeResult(type, using: self.jsonDecoder)
switch result {
case .success(let decoded):
return .success(decoded)
case .failure(let error):
return .failure(STBaseError.dataError("JSON解析失败: \(error.localizedDescription)"))
}
}
public func st_toJSON<T: Codable>(_ object: T) -> Result<Data, STBaseError> {
let result = object.encodeToJSONData(using: self.jsonEncoder)
switch result {
case .success(let data):
return .success(data)
case .failure(let error):
return .failure(STBaseError.dataError("JSON编码失败: \(error.localizedDescription)"))
}
}
// MARK: - 文件上传和下载
public func st_upload<T: Codable>(url: String, parameters: [String: Any]? = nil, files: [STUploadFile], responseType: T.Type, progress: ((STUploadProgress) -> Void)? = nil, completion: @escaping (Result<T, STBaseError>) -> Void) {
if self.requestConfig.showLoading {
self.loadingState.send(.loading)
}
let uploadRequest = self.httpSession.upload(url, files: files, parameters: parameters, headers: self.requestHeaders, interceptor: nil, requestConfig: self.requestConfig)
if let progress = progress {
uploadRequest.progressPublisher
.sink(receiveValue: progress)
.st_store(in: self)
}
var token: AnyCancellable?
token = uploadRequest.responsePublisher.sink { [weak self] response in
self?.st_handleHTTPResponse(response, responseType: responseType, completion: completion)
if let token = token {
self?.st_removeCancellable(token)
}
}
if let token = token {
self.st_storeCancellable(token)
}
}
/// 真正基于 URLSession download task 的下载,避免大文件全量入内存。
/// 默认会写入到调用方提供的 destination;若未提供则使用临时目录中的随机文件。
public func st_download(url: String, destination: URL? = nil, progress: ((STDownloadProgress) -> Void)? = nil, completion: @escaping (URL?, STBaseError?) -> Void) {
if self.requestConfig.showLoading {
self.loadingState.send(.loading)
}
let targetURL = destination ?? FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
let downloadRequest = self.httpSession.download(
url,
to: targetURL,
method: .get,
parameters: nil,
encoding: .url,
headers: self.requestHeaders,
dispatch: STDownloadDispatch(
options: .default,
resumeData: nil,
interceptor: nil,
requestConfig: self.requestConfig
)
)
if let progress = progress {
downloadRequest.progressPublisher
.sink(receiveValue: progress)
.st_store(in: self)
}
var token: AnyCancellable?
token = downloadRequest.responsePublisher.sink(receiveCompletion: { [weak self] state in
if case .failure(let error) = state {
let baseError = self?.st_convertHTTPError(error) ?? STBaseError.origin(error: error)
self?.loadingState.send(.failed(baseError))
completion(nil, baseError)
}
if let token = token {
self?.st_removeCancellable(token)
}
}, receiveValue: { [weak self] fileURL in
self?.loadingState.send(.loaded)
completion(fileURL, nil)
})
if let token = token {
self.st_storeCancellable(token)
}
}
// MARK: - 内存管理
public func st_cleanup() {
self.stateLock.lock()
let requests = self.inflightRequests
self.inflightRequests.removeAll()
self.stateLock.unlock()
requests.forEach { _ = $0.cancel() }
self.st_removeAllCancellables()
self.cache.removeAllObjects()
self.loadingState.send(.idle)
self.refreshState.send(.idle)
}
// MARK: - 内部辅助
fileprivate func st_storeCancellable(_ cancellable: AnyCancellable) {
self.stateLock.lock()
self.cancellables.insert(cancellable)
self.stateLock.unlock()
}
private func st_removeCancellable(_ cancellable: AnyCancellable) {
self.stateLock.lock()
self.cancellables.remove(cancellable)
self.stateLock.unlock()
}
private func st_trackInflight(_ request: STDataRequest) {
self.stateLock.lock()
self.inflightRequests.append(request)
self.stateLock.unlock()
}
private func st_untrackInflight(_ request: STDataRequest) {
self.stateLock.lock()
if let index = self.inflightRequests.firstIndex(where: { $0 === request }) {
self.inflightRequests.remove(at: index)
}
self.stateLock.unlock()
}
private func st_removeAllCancellables() {
self.stateLock.lock()
self.cancellables.removeAll()
self.activeLoadingRequestCount = 0
self.pendingLoadingFailure = nil
self.stateLock.unlock()
}
private func st_beginLoadingRequest() {
self.stateLock.lock()
self.activeLoadingRequestCount += 1
let shouldSendLoading = self.activeLoadingRequestCount == 1
self.stateLock.unlock()
if shouldSendLoading {
self.loadingState.send(.loading)
}
}
private func st_finishLoadingRequest(_ terminalState: STLoadingState) {
self.stateLock.lock()
if case .failed(let error) = terminalState {
self.pendingLoadingFailure = error
}
if self.activeLoadingRequestCount > 0 {
self.activeLoadingRequestCount -= 1
}
let shouldSendTerminalState = self.activeLoadingRequestCount == 0
let stateToSend: STLoadingState
if shouldSendTerminalState, let pendingLoadingFailure = self.pendingLoadingFailure {
stateToSend = .failed(pendingLoadingFailure)
self.pendingLoadingFailure = nil
} else {
stateToSend = terminalState
}
self.stateLock.unlock()
if shouldSendTerminalState {
self.loadingState.send(stateToSend)
}
}
private func st_cancelLoadingRequest() {
self.stateLock.lock()
if self.activeLoadingRequestCount > 0 {
self.activeLoadingRequestCount -= 1
}
let shouldSendIdle = self.activeLoadingRequestCount == 0
if shouldSendIdle {
self.pendingLoadingFailure = nil
}
self.stateLock.unlock()
if shouldSendIdle {
self.loadingState.send(.idle)
}
}
}
private extension AnyCancellable {
func st_store(in viewModel: STBaseViewModel) {
viewModel.st_storeCancellable(self)
}
}
/// 内存缓存条目(NSCache 要求 class 类型)
private final class STMemoryCacheEntry {
let data: Data
let expiration: Date
init(data: Data, expiration: Date) {
self.data = data
self.expiration = expiration
}
}
// MARK: - 便捷扩展
extension STBaseViewModel {
public func st_bindLoadingState<T: AnyObject>(to object: T, keyPath: ReferenceWritableKeyPath<T, Bool>) {
self.loadingState
.map { state -> Bool in
if case .loading = state { return true }
return false
}
.removeDuplicates()
.receive(on: DispatchQueue.main)
.assign(to: keyPath, on: object)
.store(in: &self.cancellables)
}
public func st_bindError<T: AnyObject>(to object: T, keyPath: ReferenceWritableKeyPath<T, String?>) {
self.errorPublisher
.map { $0.errorDescription }
.receive(on: DispatchQueue.main)
.assign(to: keyPath, on: object)
.store(in: &self.cancellables)
}
public func st_bindDataUpdate<T: AnyObject>(to object: T, action: @escaping (T) -> Void) {
self.dataUpdated
.receive(on: DispatchQueue.main)
.sink { [weak object] _ in
if let object = object {
action(object)
}
}
.store(in: &self.cancellables)
}
/// 设置认证 Token
public func st_setAuthToken(_ token: String, type: STAuthorizationType) {
self.requestHeaders.st_setAuthorization(token, type: type)
}
/// 设置自定义认证头
public func st_setCustomAuth(_ value: String) {
self.requestHeaders.st_setCustomAuthorization(value)