yang_base/action/builtin/
select.rs1#![cfg(any(feature = "mysql", feature = "postgres"))]
3
4use crate::action::sql_bridge::count_query;
5use crate::action::{ActionContext, TypedHandler};
6use crate::error::BaseError;
7use crate::table::{Record, SortOrder, WhereCondition};
8use async_trait::async_trait;
9use serde::{Deserialize, Serialize};
10use yang_base_derive::Action;
11
12fn default_page() -> u32 {
13 1
14}
15fn default_page_size() -> u32 {
16 10
17}
18fn default_sort_order() -> SortOrder {
19 SortOrder::Asc
20}
21
22#[derive(Deserialize, schemars::JsonSchema)]
24#[serde(deny_unknown_fields)]
25pub struct OrderByItem {
26 pub field: String,
28 #[serde(default = "default_sort_order")]
30 pub direction: SortOrder,
31}
32
33#[derive(Deserialize, schemars::JsonSchema)]
35#[serde(deny_unknown_fields)]
36pub struct SelectQuery {
37 #[serde(default = "default_page")]
39 pub page: u32,
40 #[serde(default = "default_page_size")]
42 pub page_size: u32,
43 #[serde(default)]
45 pub search: Option<String>,
46 #[serde(rename = "where", default)]
48 pub where_clause: Option<WhereCondition>,
49 #[serde(default)]
51 pub order_by: Vec<OrderByItem>,
52 #[serde(default)]
54 pub count_total: bool,
55}
56
57#[derive(Serialize, schemars::JsonSchema)]
59pub struct SelectResult {
60 pub items: Vec<Record>,
62 pub page: u32,
64 pub page_size: u32,
66 #[serde(skip_serializing_if = "Option::is_none")]
68 pub total: Option<u64>,
69}
70
71#[derive(Action)]
73#[action(
74 name = "select",
75 display_name = "查询列表",
76 description = "分页 + 多条件 AND 查询"
77)]
78pub struct SelectAction;
79
80impl SelectAction {
81 pub fn new() -> Self {
83 Self
84 }
85}
86
87impl Default for SelectAction {
88 fn default() -> Self {
89 Self::new()
90 }
91}
92
93#[async_trait]
94impl TypedHandler for SelectAction {
95 type Input = SelectQuery;
96 type Output = SelectResult;
97
98 async fn handle(
99 &self,
100 ctx: ActionContext,
101 input: SelectQuery,
102 ) -> Result<SelectResult, BaseError> {
103 let SelectQuery {
104 page,
105 page_size,
106 search,
107 where_clause,
108 order_by,
109 count_total,
110 } = input;
111 if page == 0 || page_size == 0 || page_size > 100 {
112 return Err(BaseError::ParamInvalid(
113 "page/page_size".into(),
114 "page>=1, 1<=page_size<=100".into(),
115 ));
116 }
117
118 if ctx.user.is_none() {
121 return Err(BaseError::Unauthorized("需要登录".to_string()));
122 }
123 let mut q = ctx.table_query()?;
124 q.ensure_readable_projection()?;
125 q = q.search(search.as_deref())?;
126 if let Some(tree) = where_clause {
128 q = q.where_tree(tree)?;
129 }
130 let total = if count_total {
131 Some(count_query(q.clone()).await?)
132 } else {
133 None
134 };
135 for OrderByItem { field, direction } in order_by {
136 q = q.order_by(&field, direction)?;
137 }
138 q = q.page(page as usize, page_size as usize)?;
140 let items = q.all().await?;
141 Ok(SelectResult {
142 items,
143 page,
144 page_size,
145 total,
146 })
147 }
148}
149
150#[cfg(test)]
151mod tests {
152 use super::SelectQuery;
153
154 #[test]
155 fn select_query_accepts_generic_table_search() {
156 let query: SelectQuery = serde_json::from_value(serde_json::json!({
157 "search": "alice"
158 }))
159 .expect("通用 TableView 搜索词应属于标准 select 输入");
160
161 assert_eq!(query.search.as_deref(), Some("alice"));
162 }
163}