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
//! Copyright (c) 2025-2026, Kirky.X
//!
//! MIT License
//!
//! 该模块定义了oxcache的宏实现，提供缓存注解功能。
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse::Parser, parse_macro_input, punctuated::Punctuated, Expr, ItemFn, Lit, Meta, Token};
#[proc_macro_attribute]
pub fn cached(args: TokenStream, item: TokenStream) -> TokenStream {
let parser = Punctuated::<Meta, Token![,]>::parse_terminated;
let args = parser.parse(args).expect("Failed to parse arguments");
let input = parse_macro_input!(item as ItemFn);
let mut service_name = "default".to_string();
let mut ttl = quote! { None };
let mut key_pattern = None;
let mut key_prefix = None;
let mut sync_mode = false;
for arg in args {
match arg {
// `sync` flag — boolean path-style argument (no value).
Meta::Path(path) if path.is_ident("sync") => {
sync_mode = true;
}
Meta::NameValue(nv) => {
if nv.path.is_ident("service") {
if let Expr::Lit(expr_lit) = nv.value {
if let Lit::Str(lit) = expr_lit.lit {
service_name = lit.value();
}
}
} else if nv.path.is_ident("ttl") {
if let Expr::Lit(expr_lit) = nv.value {
if let Lit::Int(lit) = expr_lit.lit {
let val = lit.base10_parse::<u64>().unwrap();
ttl = quote! { Some(#val) };
}
}
} else if nv.path.is_ident("key") {
if let Expr::Lit(expr_lit) = nv.value {
if let Lit::Str(lit) = expr_lit.lit {
key_pattern = Some(lit.value());
}
}
} else if nv.path.is_ident("key_prefix") {
if let Expr::Lit(expr_lit) = nv.value {
if let Lit::Str(lit) = expr_lit.lit {
key_prefix = Some(lit.value());
}
}
}
}
_ => {}
}
}
// Validate: `sync` cannot be combined with `async fn`. The sync branch
// generates a plain `fn`, which is incompatible with `async` in the
// user's signature. Fail loud at macro expansion time.
if sync_mode && input.sig.asyncness.is_some() {
panic!("`#[cached(sync)]` cannot be used with `async fn`; either remove `async` from the function signature or remove `sync` from the `#[cached]` arguments");
}
let fn_name = &input.sig.ident;
let fn_args = &input.sig.inputs;
let fn_output = &input.sig.output;
let fn_block = &input.block;
let vis = &input.vis;
// Extract return type from fn_output for type annotations
// For Result<T, E>, we need to extract T
let return_type = match fn_output {
syn::ReturnType::Default => quote! { () },
syn::ReturnType::Type(_, ty) => {
// Try to extract T from Result<T, E>
if let syn::Type::Path(path) = &**ty {
if let Some(seg) = path.path.segments.last() {
if seg.ident == "Result" {
if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
if let Some(first_arg) = args.args.first() {
quote! { #first_arg }
} else {
quote! { #ty }
}
} else {
quote! { #ty }
}
} else {
quote! { #ty }
}
} else {
quote! { #ty }
}
} else {
quote! { #ty }
}
}
};
// Generate argument names for key generation
let arg_names: Vec<_> = fn_args
.iter()
.filter_map(|arg| {
if let syn::FnArg::Typed(pat_type) = arg {
if let syn::Pat::Ident(pat_ident) = &*pat_type.pat {
return Some(&pat_ident.ident);
}
}
None
})
.collect();
// Generate cloned argument names for key generation to avoid ownership issues
let arg_names_cloned: Vec<_> = arg_names
.iter()
.map(|name| {
quote! { (#name).clone() }
})
.collect();
// Generate key logic with cloned args
let key_gen_with_cloned_args = if let Some(pattern) = key_pattern {
// Custom format string pattern: "user_{id}"
quote! {
format!(#pattern)
}
} else if let Some(prefix) = key_prefix {
// Use key_prefix with default generation
if arg_names.is_empty() {
quote! { format!("{}:{}:{}", #service_name, #prefix, stringify!(#fn_name)) }
} else {
quote! {
format!("{}:{}:{}:{:?}", #service_name, #prefix, stringify!(#fn_name), (#(#arg_names_cloned),*))
}
}
} else {
// Default key generation: service:fn_name:arg1:arg2...
if arg_names.is_empty() {
quote! { format!("{}:{}", #service_name, stringify!(#fn_name)) }
} else {
quote! {
format!("{}:{}:{:?}", #service_name, stringify!(#fn_name), (#(#arg_names_cloned),*))
}
}
};
let output = if sync_mode {
// Sync branch: generate a plain `fn` (no `async`). Uses
// `get_bytes_sync` / `set_bytes_sync` which require the registered
// cache to have been built with `sync_mode(true)`.
quote! {
#vis fn #fn_name(#fn_args) #fn_output {
let cache_key = #key_gen_with_cloned_args;
// Try to get cache instance, if fails, run original function
let cache = match ::oxcache::__internal_get_cache(#service_name) {
Some(c) => c,
None => return { #fn_block },
};
// Try get from cache using sync byte-level operations
if let Ok(Some(bytes)) = cache.get_bytes_sync(&cache_key) {
if let Ok(val) = cache.unified_serializer().deserialize::<#return_type>(&bytes) {
return ::std::result::Result::Ok(val);
}
}
// Run original function
let result = { #fn_block };
// Cache result if Ok
if let Ok(ref val) = result {
if let Ok(bytes) = cache.unified_serializer().serialize(val) {
let _ = cache.set_bytes_sync(&cache_key, bytes, #ttl);
}
}
result
}
}
} else {
// Async branch (default, original behavior)
quote! {
#vis async fn #fn_name(#fn_args) #fn_output {
let cache_key = #key_gen_with_cloned_args;
// Try to get cache instance, if fails, run original function
let cache = match ::oxcache::__internal_get_cache(#service_name) {
Some(c) => c,
None => return async { #fn_block }.await,
};
// Try get from cache using byte-level operations
if let Ok(Some(bytes)) = cache.get_bytes(&cache_key).await {
// Deserialize and return cached value using unified serializer
if let Ok(val) = cache.unified_serializer().deserialize::<#return_type>(&bytes) {
return ::std::result::Result::Ok(val);
}
}
// Run original function
let result = async { #fn_block }.await;
// Cache result if Ok
if let Ok(ref val) = result {
if let Ok(bytes) = cache.unified_serializer().serialize(val) {
let _ = cache.set_bytes(&cache_key, bytes, #ttl).await;
}
}
result
}
}
};
output.into()
}