rbatis_plus_sqlparser/rewrite/sql_rewriter.rs
1//! SQL 改写器(对标 mybatis-plus-jsqlparser `AbstractJsqlParser` + 分页改写)。
2//!
3//! 负责将原始 SQL 改写为带分页的 SQL。
4//!
5//! 对应 Java:
6//! - `com.baomidou.mybatisplus.extension.parser.JsqlParserSupport`
7//! - `com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor`
8//!
9//! 文件来源参考:`mybatis-plus-jsqlparser-support/.../plugins/inner/PaginationInnerInterceptor.java`
10
11use crate::dialect::SqlDialect;
12use crate::parser::SqlParser;
13
14/// SQL 改写器(对标 Java `AbstractJsqlParser` 的分页改写功能)。
15///
16/// 负责将原始 SQL 改写为带分页的 SQL。
17pub struct SqlRewriter;
18
19impl SqlRewriter {
20 /// 改写 SQL 添加分页(对标 `JsqlParserSupport.parserSingle()` + 方言改写)。
21 ///
22 /// # 参数
23 /// - `sql`: 原始 SQL
24 /// - `page_no`: 页码(从 1 开始)
25 /// - `page_size`: 每页大小
26 /// - `dialect`: 数据库方言
27 ///
28 /// # 返回
29 /// 改写后的分页 SQL。
30 pub fn rewrite_pagination(
31 sql: &str,
32 page_no: u64,
33 page_size: u64,
34 dialect: &dyn SqlDialect,
35 ) -> String {
36 let offset = (page_no - 1) * page_size;
37 dialect.build_pagination_sql(sql, offset, page_size)
38 }
39
40 /// 改写 COUNT SQL(对标 `JsqlParserSupport.parserMulti()` + COUNT 改写)。
41 ///
42 /// 将原始查询 SQL 改写为 COUNT 查询。
43 pub fn rewrite_count(sql: &str) -> String {
44 SqlParser::get_count_sql(sql)
45 }
46
47 /// 检查 SQL 是否可以安全分页(不包含 FOR UPDATE 等不安全语句)。
48 ///
49 /// 对应 Java `PaginationInnerInterceptor.consumes()` 中的安全检查
50 pub fn can_paginate(sql: &str) -> bool {
51 let parsed = SqlParser::parse(sql);
52 // FOR UPDATE / FOR SHARE 不能分页
53 if parsed.has_for_update {
54 return false;
55 }
56 // 只有 SELECT 可以分页
57 matches!(parsed.statement_type, crate::parser::StatementType::Select)
58 }
59}