失效¶
缓存失效工具与分组失效。
缓存失效器
提供多种缓存失效策略,确保数据一致性和缓存更新。
失效策略: - 主动失效:手动指定要失效的键 - 模式匹配失效:基于通配符模式失效 - 批量失效:清空所有或特定类型的数据 - 条件失效:基于条件表达式失效 - 分布式失效:跨多个缓存实例失效
使用示例: >>> invalidator = CacheInvalidator(cache) >>> await invalidator.invalidate_keys(["key1", "key2"]) >>> await invalidator.invalidate_pattern("user:*")
Source code in src/symphra_cache/invalidation.py
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 | |
__init__(cache, batch_size=100, enable_distributed=False)
¶
初始化缓存失效器
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cache
|
CacheManager
|
缓存管理器实例 |
required |
batch_size
|
int
|
批量操作大小 |
100
|
enable_distributed
|
bool
|
是否启用分布式失效 |
False
|
Source code in src/symphra_cache/invalidation.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | |
close()
async
¶
关闭失效器
Source code in src/symphra_cache/invalidation.py
425 426 427 428 429 430 | |
conditional_invalidation(condition, keys, check_interval=1.0)
async
¶
条件失效
当条件满足时才失效缓存。
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
condition
|
Callable[[], bool]
|
失效条件函数 |
required |
keys
|
list[CacheKey]
|
要失效的键 |
required |
check_interval
|
float
|
条件检查间隔(秒) |
1.0
|
Returns:
| Type | Description |
|---|---|
Task[int]
|
异步任务对象 |
Source code in src/symphra_cache/invalidation.py
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 | |
create_cache_group_invalidator(group_prefix)
¶
创建缓存组失效器
专门用于管理具有相同前缀的缓存键。
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_prefix
|
str
|
组前缀 |
required |
Returns:
| Type | Description |
|---|---|
CacheGroupInvalidator
|
缓存组失效器 |
Source code in src/symphra_cache/invalidation.py
411 412 413 414 415 416 417 418 419 420 421 422 423 | |
get_invalidation_history(limit=10)
¶
获取失效历史记录
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit
|
int
|
返回记录数量 |
10
|
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]]
|
失效历史列表(按时间倒序) |
Source code in src/symphra_cache/invalidation.py
347 348 349 350 351 352 353 354 355 356 357 | |
get_invalidation_stats()
¶
获取失效统计信息
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
统计信息字典 |
Source code in src/symphra_cache/invalidation.py
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | |
invalidate_all()
async
¶
失效所有缓存
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
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 | |
invalidate_by_condition(condition, max_keys=None)
async
¶
基于条件失效键
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
condition
|
Callable[[CacheKey, Any], bool]
|
失效条件函数,接收 (key, value) 返回是否失效 |
required |
max_keys
|
int | None
|
最大失效键数量 |
None
|
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
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 | |
invalidate_keys(keys, batch_size=None)
async
¶
失效指定的键
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
keys
|
list[CacheKey]
|
要失效的键列表 |
required |
batch_size
|
int | None
|
批量大小 |
None
|
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
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 | |
invalidate_pattern(pattern, max_keys=None)
async
¶
基于模式匹配失效键
支持通配符模式(* 和 ?)。
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pattern
|
str
|
匹配模式(如 "user:*", "session:??") |
required |
max_keys
|
int | None
|
最大失效键数量,None 表示无限制 |
None
|
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
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 | |
invalidate_prefix(prefix)
async
¶
失效指定前缀的所有键
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
键前缀 |
required |
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
163 164 165 166 167 168 169 170 171 172 173 | |
invalidate_with_dependencies(keys, dependency_resolver)
async
¶
失效键及其依赖项
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
keys
|
list[CacheKey]
|
主键列表 |
required |
dependency_resolver
|
Callable[[list[CacheKey]], list[CacheKey]]
|
依赖解析函数,返回相关的依赖键 |
required |
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
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 | |
schedule_invalidation(keys, delay)
async
¶
延迟失效
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
keys
|
list[CacheKey]
|
要失效的键 |
required |
delay
|
float
|
延迟时间(秒) |
required |
Returns:
| Type | Description |
|---|---|
Task[int]
|
异步任务对象 |
Source code in src/symphra_cache/invalidation.py
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | |
缓存组失效器
专门管理具有相同前缀的缓存键的失效。
使用示例: >>> group_invalidator = invalidator.create_cache_group_invalidator("user:") >>> await group_invalidator.invalidate_all() >>> await group_invalidator.invalidate_pattern("*:profile")
Source code in src/symphra_cache/invalidation.py
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 | |
__init__(parent, group_prefix)
¶
初始化缓存组失效器
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent
|
CacheInvalidator
|
父失效器 |
required |
group_prefix
|
str
|
组前缀 |
required |
Source code in src/symphra_cache/invalidation.py
445 446 447 448 449 450 451 452 453 454 | |
get_stats()
¶
获取组失效统计
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
统计信息 |
Source code in src/symphra_cache/invalidation.py
493 494 495 496 497 498 499 500 501 502 503 | |
invalidate_all()
async
¶
失效整个组的所有键
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
456 457 458 459 460 461 462 463 | |
invalidate_keys(relative_keys)
async
¶
失效组内的指定键
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
relative_keys
|
list[str]
|
相对于组前缀的键名列表 |
required |
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 | |
invalidate_pattern(pattern)
async
¶
失效组内匹配模式的键
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pattern
|
str
|
相对于组前缀的模式 |
required |
Returns:
| Type | Description |
|---|---|
int
|
实际失效的键数量 |
Source code in src/symphra_cache/invalidation.py
465 466 467 468 469 470 471 472 473 474 475 476 | |
创建缓存失效器工厂函数
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cache
|
CacheManager
|
缓存管理器 |
required |
strategy
|
str
|
失效策略 |
'default'
|
**kwargs
|
Any
|
其他参数 |
{}
|
Returns:
| Type | Description |
|---|---|
CacheInvalidator
|
缓存失效器实例 |
Source code in src/symphra_cache/invalidation.py
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 | |