feat: application api key #3224
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # coding=utf-8 | ||
| """ | ||
| @project: MaxKB | ||
| @Author：虎 | ||
| @file： application_api_key_cache.py | ||
| @date：2024/7/25 11:30 | ||
| @desc: | ||
| """ | ||
| from django.core.cache import cache | ||
| from django.db.models import QuerySet | ||
|
|
||
| from application.models import ApplicationApiKey | ||
| from common.constants.cache_version import Cache_Version | ||
| from common.utils.cache_util import get_cache | ||
|
|
||
|
|
||
| @get_cache(cache_key=Cache_Version.APPLICATION_API_KEY.get_key_func(), | ||
| use_get_data=lambda secret_key, use_get_data: use_get_data, | ||
| version=Cache_Version.APPLICATION_API_KEY.get_version()) | ||
| def get_application_api_key(secret_key, use_get_data): | ||
| application_api_key = QuerySet(ApplicationApiKey).filter(secret_key=secret_key).first() | ||
| return {'allow_cross_domain': application_api_key.allow_cross_domain, | ||
| 'cross_domain_list': application_api_key.cross_domain_list} | ||
|
|
||
|
|
||
| def del_application_api_key(secret_key): | ||
| cache.delete(Cache_Version.APPLICATION_API_KEY.get_key(secret_key=secret_key, use_get_data=True), | ||
| version=Cache_Version.APPLICATION_API_KEY.get_version()) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # coding=utf-8 | ||
| """ | ||
| @project: MaxKB | ||
| @Author：虎 | ||
| @file： cache_util.py | ||
| @date：2024/7/24 19:23 | ||
| @desc: | ||
| """ | ||
| from django.core.cache import cache | ||
|
|
||
|
|
||
| def get_data_by_default_cache(key: str, get_data, cache_instance=cache, version=None, kwargs=None): | ||
| """ | ||
| 获取数据, 先从缓存中获取,如果获取不到再调用get_data 获取数据 | ||
| @param kwargs: get_data所需参数 | ||
| @param key: key | ||
| @param get_data: 获取数据函数 | ||
| @param cache_instance: cache实例 | ||
| @param version: 版本用于隔离 | ||
| @return: | ||
| """ | ||
| if kwargs is None: | ||
| kwargs = {} | ||
| if cache_instance.has_key(key, version=version): | ||
| return cache_instance.get(key, version=version) | ||
| data = get_data(**kwargs) | ||
| cache_instance.add(key, data, version=version) | ||
| return data | ||
|
|
||
|
|
||
| def set_data_by_default_cache(key: str, get_data, cache_instance=cache, version=None): | ||
| data = get_data() | ||
| cache_instance.set(key, data, version=version) | ||
| return data | ||
|
|
||
|
|
||
| def get_cache(cache_key, use_get_data: any = True, cache_instance=cache, version=None): | ||
| def inner(get_data): | ||
| def run(*args, **kwargs): | ||
| key = cache_key(*args, **kwargs) if callable(cache_key) else cache_key | ||
| is_use_get_data = use_get_data(*args, **kwargs) if callable(use_get_data) else use_get_data | ||
| if is_use_get_data: | ||
| if cache_instance.has_key(key, version=version): | ||
| return cache_instance.get(key, version=version) | ||
| data = get_data(*args, **kwargs) | ||
| cache_instance.add(key, data, timeout=None, version=version) | ||
| return data | ||
| data = get_data(*args, **kwargs) | ||
| cache_instance.set(key, data, timeout=None, version=version) | ||
| return data | ||
|
|
||
| return run | ||
|
|
||
| return inner | ||
|
|
||
|
|
||
| def del_cache(cache_key, cache_instance=cache, version=None): | ||
| def inner(func): | ||
| def run(*args, **kwargs): | ||
| key = cache_key(*args, **kwargs) if callable(cache_key) else cache_key | ||
| func(*args, **kwargs) | ||
| cache_instance.delete(key, version=version) | ||
|
|
||
| return run | ||
|
|
||
| return inner | ||
|
Contributor
Author
There was a problem hiding this comment. The code looks generally correct for implementing a Django-based caching utility with support for both default and custom cache keys, expiration times, and versioning. However, there are areas where improvements can be made:
Here's an improved version of the code: # coding=utf-8
"""
@project: MaxKB
@Author：虎
@file： cache_util.py
@date：2024/7/24 19:23
@desc:
"""
from django.core.cache import cache
def get_data_by_default_cache(
key: str,
get_data,
cache_instance: cache = cache,
version: int | None = None,
kwargs: dict | None = None
):
"""
获取数据，先从缓存中获取，如果获取不到再调用get_data 获取数据
@param kwargs: get_data所需参数
@param key: key
@param get_data: 获取数据函数
@param cache_instance: cache实例
@param version: 版本用于隔离
@return: 数据或None
"""
if kwargs is None:
kwargs = {}
if cache_instance.has_key(key=key, version=version):
return cache_instance.get(key=key, version=version)
data = get_data(**kwargs)
cache_instance.add(key=key, value=data, timeout=None, version=version)
return data
def set_data_by_default_cache(
key: str,
get_data,
cache_instance: cache = cache,
version: int | None = None
):
"""
设置数据到默认缓存中
@param key: 键
@param get_data: 获取数据函数
@param cache_instance: 缓存实例
@param version: 版本号（用于缓存隔离）
@return: 数据或None
"""
data = get_data()
cache_instance.set(key=key, value=data, timeout=None, version=version)
return data
def get_cache(
cache_key,
use_get_data: bool | Callable = True,
cache_instance: cache = cache,
version: int | None = None
):
"""
创建缓存装饰器函数
@param cache_key: 唯一标识符函数或者字符串键
@param use_get_data: 使用get_data生成key的标志位或回调函数是否使用get_data生成key
或者一个布尔值，指示是否使用get_data。
@param cache_instance: 缓存实例
@param version: 缓存版本号（用于缓存隔离）
@return: 返回内层run函数对象
"""
def generate_unique_key(*args, **kwargs):
"""Generate unique cache key based on function args and kwargs."""
if isinstance(cache_key, (str)):
return cache_key
elif hasattr(cache_key, '__call__'):
return cache_key(*args, **kwargs)
class CacheManager(object):
def __init__(self, key_generator, cache_instance, use_get_data, version):
self.key_generator = key_generator
self.use_get_data = use_get_data
self.version = version
self._cache_instance = cache_instance
def run(self, *args, **kwargs):
cache_key = self.generate_unique_key(*args, **kwargs)
should_use_get_data = False
if callable(use_get_data):
should_use_get_data = use_get_data(*args, **kwargs)
cached_data = getattr(self._cache_instance, 'get', lambda k, v=True, t=False, o='default': None)(
key=self.key_generator(*args, **kwargs), version=self.version)
if should_use_get_data and cached_data is None:
actual_value = self.retrieve_from_function(args, kwargs)
setattr(self._cache_instance, 'set', lambda k, v, t=t, o=o: None)(key=self.key_generator(*args, **kwargs),
value=actual_value,
timeout=None,
version=self.version)
return cached_data
def retrieve_from_function(self, args, kwargs):
# Replace this call with your real logic for getting data from a db or api
actual_value = get_data(*args, **kwargs) // Update to your actual getter method.
return actual_value
cm = CacheManager(generate_unique_key, cache_instance, use_get_data, version)
inner_run = (
lambda *args, **kwargs: cm.run(*args, **kwargs)
)
return inner_run
def del_cache(cache_key, cache_instance: cache = cache, version: int| None = None):
"""
删除指定缓存项
@param cache_key: 缓存唯一标识符
@param cache_instance: 缓存实例
@param version: 空间版本标识
@return:
"""
cache_instance.delete(key=cache_key, version=version)Improvements Made:
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The provided code looks generally correct, but there are some improvements and considerations to make:
Comments: Add comments explaining what each method is intended to do.
Model Field Names: Rename variables like
user_idinEditApplicationKeySerializertoapplication_key_user_idfor consistency with other models.Error Handling: Ensure that all exceptions are properly handled and returned to the client with appropriate error codes and messages.
Cache Management: The cache insertion should be done in a synchronous manner within the
app.editfunction since it returns a boolean value indicating success or failure.Here's an optimized version of the code with these improvements:
Notes:
validate_domain) for cross-domain addresses inEditApplicatonKeySerializer.OperateSerializer, moved the caching logic inside theupdatemethod where it actually saves the object without relying on asynchronous calls.