yang-base 0.3.0

个人使用构建后端服务器
Documentation
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
//! 数据库记录类型
//!
//! 提供 `Record` 类型,用于在不知道具体 Rust 实体时安全读取 MySQL 查询结果。
//! 每一行数据以 `serde_json::Map<String, serde_json::Value>` 的形式存储,
//! 支持所有常见 MySQL 类型到 JSON 类型的映射。
//!
//! # MySQL 类型映射规则
//!
//! | MySQL 类型 | JSON 类型 |
//! |-----------|----------|
//! | INT / BIGINT / MEDIUMINT / SMALLINT | Number (i64) |
//! | TINYINT | Number (i8) |
//! | TINYINT UNSIGNED | Number (u8) |
//! | FLOAT / DOUBLE | Number (f64) |
//! | DECIMAL / NUMERIC | String(保留精度,NEWDECIMAL 协议本就是字符串编码) |
//! | VARCHAR / TEXT / CHAR | String |
//! | BOOLEAN(即 TINYINT(1),sqlx 归一化) | Bool |
//! | DATE / DATETIME / TIMESTAMP | String (ISO 8601) |
//! | NULL | Null |
//! | BLOB / BINARY | String (Base64) |
//! | JSON | Object / Array |
//!
//! # 示例
//!
//! ```rust,ignore
//! use yang_base::table::Record;
//!
//! // 通过 sqlx::FromRow 自动从查询结果构建
//! let rows: Vec<Record> = query.all().await?;
//! for row in rows {
//!     println!("{:?}", row.as_map());
//! }
//! ```

use crate::error::BaseError;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};

/// 动态数据库记录
///
/// 以键值对形式存储一行数据库查询结果,支持任意表结构。
/// 字段名为键,字段值为 JSON 值。
///
/// # 字段
///
/// - `columns`:列名到 JSON 值的映射
///
/// # 示例
///
/// ```rust,ignore
/// use yang_base::table::Record;
/// use serde_json::json;
///
/// let row = Record::new()
///     .set("id", json!(1))
///     .set("name", json!("Alice"));
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(transparent)]
#[schemars(transparent)]
pub struct Record {
    columns: serde_json::Map<String, serde_json::Value>,
}

impl Record {
    /// 创建空记录。
    pub fn new() -> Self {
        Self {
            columns: serde_json::Map::new(),
        }
    }

    /// 链式写入字段值。
    pub fn set(mut self, key: impl Into<String>, value: impl Into<serde_json::Value>) -> Self {
        self.columns.insert(key.into(), value.into());
        self
    }

    /// 写入字段值并返回被替换的旧值。
    pub fn insert(
        &mut self,
        key: impl Into<String>,
        value: impl Into<serde_json::Value>,
    ) -> Option<serde_json::Value> {
        self.columns.insert(key.into(), value.into())
    }

    /// 获取指定列的原始 JSON 值。
    ///
    /// # 参数
    ///
    /// - `key`:列名
    ///
    /// # 返回
    ///
    /// - `Some(&Value)`:列存在时返回值的引用
    /// - `None`:列不存在
    pub fn get(&self, key: &str) -> Option<&serde_json::Value> {
        if key.trim().is_empty() {
            return None;
        }

        self.columns.get(key)
    }

    /// 读取必需字段并转换为目标类型。
    pub fn require<T>(&self, key: &str) -> Result<T, BaseError>
    where
        T: DeserializeOwned,
    {
        let value = self
            .get(key)
            .ok_or_else(|| BaseError::FieldNotFound("record".to_string(), key.to_string()))?;
        serde_json::from_value(value.clone())
            .map_err(|error| BaseError::InvalidFieldType(key.to_string(), error.to_string()))
    }

    /// 读取可选字段;字段不存在或为 `null` 时返回 `None`。
    pub fn optional<T>(&self, key: &str) -> Result<Option<T>, BaseError>
    where
        T: DeserializeOwned,
    {
        let Some(value) = self.get(key) else {
            return Ok(None);
        };
        if value.is_null() {
            return Ok(None);
        }
        serde_json::from_value(value.clone())
            .map(Some)
            .map_err(|error| BaseError::InvalidFieldType(key.to_string(), error.to_string()))
    }

    /// 返回字段映射的只读引用。
    pub fn as_map(&self) -> &serde_json::Map<String, serde_json::Value> {
        &self.columns
    }

    /// 消费记录并返回字段映射。
    pub fn into_map(self) -> serde_json::Map<String, serde_json::Value> {
        self.columns
    }

    /// 消费记录并返回查询写入层使用的 HashMap。
    #[cfg(feature = "mysql")]
    pub(crate) fn into_columns(self) -> std::collections::HashMap<String, serde_json::Value> {
        self.columns.into_iter().collect()
    }
}

impl Default for Record {
    fn default() -> Self {
        Self::new()
    }
}

impl From<serde_json::Map<String, serde_json::Value>> for Record {
    fn from(columns: serde_json::Map<String, serde_json::Value>) -> Self {
        Self { columns }
    }
}

/// 将 Record 转换为 serde_json::Value(Object 类型)。
impl From<Record> for serde_json::Value {
    fn from(row: Record) -> Self {
        serde_json::Value::Object(row.columns)
    }
}

/// 实现 sqlx::FromRow,支持从 MySQL 查询结果动态解码
///
/// 按 MySQL 列类型将值映射到对应的 JSON 类型:
/// - INT/BIGINT/MEDIUMINT/SMALLINT → i64
/// - TINYINT → i8
/// - TINYINT UNSIGNED → u8
/// - FLOAT/DOUBLE → f64
/// - DECIMAL/NUMERIC → String(保留精度)
/// - VARCHAR/TEXT/CHAR → String
/// - BOOLEAN(即 TINYINT(1))→ Bool
/// - DATE/DATETIME/TIMESTAMP → ISO 8601 字符串
/// - NULL → Null
/// - BLOB/BINARY → Base64 字符串
/// - JSON → Object/Array
#[cfg(feature = "mysql")]
impl<'r> sqlx::FromRow<'r, sqlx::mysql::MySqlRow> for Record {
    fn from_row(row: &'r sqlx::mysql::MySqlRow) -> Result<Self, sqlx::Error> {
        use sqlx::Column;
        use sqlx::Row;
        use sqlx::TypeInfo;
        use sqlx::ValueRef;

        let mut columns = serde_json::Map::new();

        // 遍历所有列,按类型解码
        for col in row.columns() {
            let col_name = col.name().to_string();
            let type_name = col.type_info().name().to_uppercase();

            // 先检查是否为 NULL
            let is_null: bool = row
                .try_get_raw(col.ordinal())
                .map(|v| v.is_null())
                .unwrap_or(false);

            if is_null {
                // NULL 值映射为 JSON Null
                columns.insert(col_name, serde_json::Value::Null);
                continue;
            }

            // 按 MySQL 类型名称解码
            let json_value = decode_mysql_column(row, col.ordinal(), &type_name)?;
            columns.insert(col_name, json_value);
        }

        Ok(Record { columns })
    }
}

/// MySQL 整数族列在解码时的语义分类。
///
/// sqlx 会把 `tinyint(1)` 归一化为 `BOOLEAN`(列宽 == 1),其余 tinyint 保持数值语义。
/// 抽出纯函数便于在无 MySQL 环境下单测「列名 → 解码分支」的映射,防止
/// BOOLEAN / TINYINT / TINYINT UNSIGNED 之间的语义再次漂移(验证需求: M24)。
#[cfg(feature = "mysql")]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum MysqlIntegerKind {
    /// 常规整数(INT/BIGINT/MEDIUMINT/SMALLINT 及其无符号变体),解码为 i64。
    Int64,
    /// tinyint(1)(sqlx 归一化为 BOOLEAN),解码为 bool。
    Boolean,
    /// 普通 tinyint,保持数值语义,解码为 i8。
    TinyInt,
    /// 无符号 tinyint,解码为 u8。
    TinyIntUnsigned,
    /// 非整数族类型,交由后续分支按字符串/浮点/日期等处理。
    Other,
}

/// 判定 MySQL 列类型名对应的整数族解码分支。
#[cfg(feature = "mysql")]
fn mysql_integer_kind(type_name: &str) -> MysqlIntegerKind {
    // 整数类型:INT、BIGINT、MEDIUMINT、SMALLINT(含 UNSIGNED 变体)
    if type_name.contains("INT") && !type_name.contains("TINYINT") {
        return MysqlIntegerKind::Int64;
    }
    match type_name {
        // tinyint(1) 在 MySQL 协议中被 sqlx 归一化为 BOOLEAN(列宽 == 1)
        "BOOLEAN" => MysqlIntegerKind::Boolean,
        "TINYINT" => MysqlIntegerKind::TinyInt,
        "TINYINT UNSIGNED" => MysqlIntegerKind::TinyIntUnsigned,
        _ => MysqlIntegerKind::Other,
    }
}

/// 根据 MySQL 列类型解码列值为 JSON 值
///
/// # 参数
///
/// - `row`:MySQL 行
/// - `ordinal`:列索引
/// - `type_name`:MySQL 类型名称(大写)
///
/// # 返回
///
/// - `Ok(Value)`:解码成功
/// - `Err(sqlx::Error)`:解码失败
#[cfg(feature = "mysql")]
fn decode_mysql_column(
    row: &sqlx::mysql::MySqlRow,
    ordinal: usize,
    type_name: &str,
) -> Result<serde_json::Value, sqlx::Error> {
    use base64::Engine;
    use sqlx::Row;

    match mysql_integer_kind(type_name) {
        // 整数类型:INT、BIGINT、MEDIUMINT、SMALLINT(含 UNSIGNED 变体)
        MysqlIntegerKind::Int64 => {
            let val: i64 = row.try_get(ordinal)?;
            return Ok(serde_json::Value::Number(val.into()));
        }
        // tinyint(1) 在 MySQL 协议中被 sqlx 归一化为 BOOLEAN(列宽 == 1);
        // 仅该形态映射为 bool,其余 tinyint 保持数值语义,避免与 FieldType::Integer 声明冲突。
        MysqlIntegerKind::Boolean => {
            let val: i8 = row.try_get(ordinal)?;
            return Ok(serde_json::Value::Bool(val != 0));
        }
        // 普通 tinyint 保持数值语义,不再映射为 bool。
        MysqlIntegerKind::TinyInt => {
            let val: i8 = row.try_get(ordinal)?;
            return Ok(serde_json::Value::Number(i64::from(val).into()));
        }
        // 无符号 tinyint 此前落到字符串兜底,try_get::<String> 因类型不兼容必然 Err。
        MysqlIntegerKind::TinyIntUnsigned => {
            let val: u8 = row.try_get(ordinal)?;
            return Ok(serde_json::Value::Number(u64::from(val).into()));
        }
        MysqlIntegerKind::Other => {}
    }

    // 定点类型:DECIMAL、NUMERIC
    // NEWDECIMAL 协议本就是字符串编码,读字符串以保留精度,避免 f64 舍入误差。
    if type_name == "DECIMAL" || type_name == "NUMERIC" {
        let val: String = row.try_get_unchecked(ordinal)?;
        return Ok(serde_json::Value::String(val));
    }

    // 浮点类型:FLOAT、DOUBLE
    if type_name == "FLOAT" || type_name == "DOUBLE" {
        let val: f64 = row.try_get(ordinal)?;
        // NaN 或 Infinity 无法编码为 JSON Number,返回结构化解码错误而非静默归零
        let json_num = serde_json::Number::from_f64(val).ok_or_else(|| {
            sqlx::Error::Decode("浮点数值为 NaN 或 Infinity 无法编码为 JSON Number".into())
        })?;
        return Ok(serde_json::Value::Number(json_num));
    }

    // 日期时间类型:DATE、DATETIME、TIMESTAMP
    if type_name == "DATE" {
        let val: chrono::NaiveDate = row.try_get(ordinal)?;
        // 转换为 ISO 8601 格式字符串
        return Ok(serde_json::Value::String(
            val.format("%Y-%m-%d").to_string(),
        ));
    }

    if type_name == "DATETIME" || type_name == "TIMESTAMP" {
        let val: chrono::NaiveDateTime = row.try_get(ordinal)?;
        // 转换为 ISO 8601 格式字符串
        return Ok(serde_json::Value::String(
            val.format("%Y-%m-%dT%H:%M:%S").to_string(),
        ));
    }

    if type_name == "TIME" {
        let val: chrono::NaiveTime = row.try_get(ordinal)?;
        return Ok(serde_json::Value::String(
            val.format("%H:%M:%S").to_string(),
        ));
    }

    // 二进制类型:BLOB、BINARY、VARBINARY、LONGBLOB、MEDIUMBLOB、TINYBLOB
    if type_name.contains("BLOB") || type_name.contains("BINARY") {
        let val: Vec<u8> = row.try_get(ordinal)?;
        // 转换为 Base64 字符串
        let encoded = base64::engine::general_purpose::STANDARD.encode(&val);
        return Ok(serde_json::Value::String(encoded));
    }

    // JSON 类型:直接解析为 JSON 值
    if type_name == "JSON" {
        let val: serde_json::Value = row.try_get(ordinal)?;
        return Ok(val);
    }

    // 字符串类型:VARCHAR、TEXT、CHAR、LONGTEXT、MEDIUMTEXT、TINYTEXT、ENUM、SET
    // 以及其他未知类型,尝试作为字符串读取
    let val: String = row.try_get(ordinal)?;
    Ok(serde_json::Value::String(val))
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn get_rejects_blank_column_name() {
        let mut row = Record::new();
        row.insert("", json!(1));
        row.insert("   ", json!(2));
        row.insert("name", json!("Alice"));

        assert_eq!(
            row.get("name").and_then(|value| value.as_str()),
            Some("Alice")
        );
        assert_eq!(row.get(""), None);
        assert_eq!(row.get("   "), None);
    }

    #[test]
    fn serializes_as_plain_object_and_checks_types() {
        let row = Record::new().set("id", 7).set("name", "Alice");

        assert_eq!(
            serde_json::to_value(&row).expect("记录应可序列化"),
            json!({
                "id": 7,
                "name": "Alice"
            })
        );
        assert_eq!(row.require::<i64>("id").expect("id 应为整数"), 7);
        assert!(row.require::<String>("id").is_err());
        assert!(row.require::<String>("missing").is_err());
    }

    #[cfg(feature = "mysql")]
    #[test]
    fn mysql_integer_kind_distinguishes_boolean_tinyint_and_unsigned() {
        // 只有 tinyint(1)(sqlx 归一化为 BOOLEAN)才映射 bool,其余保持数值语义。
        assert_eq!(mysql_integer_kind("BOOLEAN"), MysqlIntegerKind::Boolean);
        assert_eq!(mysql_integer_kind("TINYINT"), MysqlIntegerKind::TinyInt);
        assert_eq!(
            mysql_integer_kind("TINYINT UNSIGNED"),
            MysqlIntegerKind::TinyIntUnsigned
        );
        assert_eq!(mysql_integer_kind("INT"), MysqlIntegerKind::Int64);
        assert_eq!(mysql_integer_kind("INT UNSIGNED"), MysqlIntegerKind::Int64);
        assert_eq!(mysql_integer_kind("BIGINT"), MysqlIntegerKind::Int64);
        assert_eq!(mysql_integer_kind("MEDIUMINT"), MysqlIntegerKind::Int64);
        assert_eq!(mysql_integer_kind("SMALLINT"), MysqlIntegerKind::Int64);
        assert_eq!(mysql_integer_kind("VARCHAR"), MysqlIntegerKind::Other);
    }
}