利用Mybatis自定义排序规则实现复杂排序

原创

舒一笑不秃头

修改于 2025-09-03 17:38:43

21600

代码可运行

运行总次数：0

代码可运行

场景分析

本次需要实现规则是根据用户点击目录左侧——弹出排序选项，文件名A-Z：英文A-Z → 中文A-Z → 数字0-9 ，文件名Z-A：与A-Z相反，最近更新时间：文件夹按文件夹修改时间，文档按文档修改时间。图片直达链接

如何实现？

1.改造接口增加参数

    /**
     * 排序类型: NAME_ASC(文件名A-Z), NAME_DESC(文件名Z-A), TIME_DESC(最近更新时间)
     */
    @Schema(description = "排序类型: NAME_ASC(文件名A-Z), NAME_DESC(文件名Z-A), TIME_DESC(最近更新时间)")
    private String sortType;

2.修改默认查询子集排序规则

// 排序 - 默认按sort字段排序，如果需要其他排序规则会在数据库层处理
this.children.sort(Comparator.comparing(KbPageTreeResp::getSort, Comparator.nullsLast(Comparator.naturalOrder())));

这个表达式是一个复合比较器，用于处理包含 null 值的排序场景。

1. `Comparator.naturalOrder()`

这是一个基础比较器，用于对实现了 Comparable 接口的对象进行自然排序
对于 Integer 类型，自然排序就是数值升序（1, 2, 3, 4...）
相当于调用对象的 compareTo() 方法

2. `Comparator.nullsLast(...)`

这是一个装饰器比较器，用于处理 null 值
nullsLast 表示：将 null 值排在最后
它接受一个内部比较器作为参数，用于比较非 null 值

3. 组合效果

Comparator.nullsLast(Comparator.naturalOrder()) 的排序规则是：

非 null 值：按照自然排序（升序）排列
null 值：统一排在最后面
混合情况：非 null 值在前面按升序排列，null 值在最后

4. 实际例子

假设 sort 字段的值有：[3, null, 1, null, 2]

排序后的结果将是：[1, 2, 3, null, null]

// 示例代码
List<Integer> sorts = Arrays.asList(3, null, 1, null, 2);
sorts.sort(Comparator.nullsLast(Comparator.naturalOrder()));
System.out.println(sorts); // 输出: [1, 2, 3, null, null]

5. 在您代码中的应用

在 KbPageTreeResp 类中，这个比较器用于：

this.children.sort(Comparator.comparing(KbPageTreeResp::getSort, 
    Comparator.nullsLast(Comparator.naturalOrder())));

Comparator.comparing(KbPageTreeResp::getSort, ...) 提取每个对象的 sort 字段进行比较
如果某些页面的 sort 字段为 null，这些页面会被排在最后
其他有 sort 值的页面按照数值升序排列

6. 为什么需要处理 `null`？

在实际业务中，页面的 sort 字段可能：

新创建的页面还没有设置排序值（null）
某些页面被明确设置为不参与排序（null）
数据迁移或其他原因导致的空值

使用 nullsLast 可以确保程序不会因为 null 值而抛出 NullPointerException，同时提供合理的排序行为。

3.自定义排序规则

动态构建 SQL 排序语句（ORDER BY）*的 Java 方法。它的核心作用是根据*文件类型、标题、时间等多个维度，对一组文件/文件夹进行复合排序，并且支持多种排序策略（升序、降序、按时间、按名称等）。

    /**
     * 构建ORDER BY语句
     * 文件夹和文件分别排序，文件夹在前，文件在后
     * xxxxx节点始终置顶
     * 
     * @return ORDER BY语句
     */
    private String buildOrderByClause() {
        StringBuilder orderBy = new StringBuilder();
        
        // 1. xxxxxx节点置顶
        orderBy.append("ORDER BY CASE WHEN title = 'xxxxxx' THEN 0 ELSE 1 END, ");
        
        // 2. 文件夹在前，文件在后
        orderBy.append("CASE WHEN type = 'FOLDER' THEN 0 ELSE 1 END, ");
        
        // 3. 根据排序类型进行排序
        if (StrUtil.isNotBlank(this.sortType)) {
            switch (this.sortType.toUpperCase()) {
                case "NAME_ASC":
                    // 文件名A-Z：英文A-Z → 中文A-Z → 数字0-9
                    // 使用ASCII码和字符判断来实现优先级排序
                    orderBy.append("CASE ")
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) BETWEEN 65 AND 90 OR ASCII(SUBSTRING(title, 1, 1)) BETWEEN 97 AND 122 THEN CONCAT('1', title) ") // 英文字母
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) > 127 THEN CONCAT('2', title) ") // 中文字符
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) BETWEEN 48 AND 57 THEN CONCAT('3', title) ") // 数字
                            .append("ELSE CONCAT('4', title) ") // 其他字符
                            .append("END ASC");
                    break;
                case "NAME_DESC":
                    // 文件名Z-A：与A-Z相反
                    orderBy.append("CASE ")
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) BETWEEN 65 AND 90 OR ASCII(SUBSTRING(title, 1, 1)) BETWEEN 97 AND 122 THEN CONCAT('1', title) ") // 英文字母
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) > 127 THEN CONCAT('2', title) ") // 中文字符
                            .append("WHEN ASCII(SUBSTRING(title, 1, 1)) BETWEEN 48 AND 57 THEN CONCAT('3', title) ") // 数字
                            .append("ELSE CONCAT('4', title) ") // 其他字符
                            .append("END DESC");
                    break;
                case "TIME_DESC":
                    // 最近更新时间：文件夹按文件夹修改时间，文档按文档修改时间
                    orderBy.append("modifier_time DESC");
                    break;
                default:
                    // 默认排序：修改时间降序 + sort升序 + 标题升序
                    orderBy.append("modifier_time DESC, sort ASC, title ASC");
                    break;
            }
        } else {
            // 默认排序：修改时间降序 + sort升序 + 标题升序
            orderBy.append("modifier_time DESC, sort ASC, title ASC");
        }
        
        return orderBy.toString();
    }
}


正确的排序代码

    /**
     * 构建ORDER BY语句
     * 文件夹和文件分别排序，文件夹在前，文件在后
     * xxxxxx节点始终置顶
     * 
     * @return ORDER BY语句
     */
    private String buildOrderByClause() {
        StringBuilder orderBy = new StringBuilder();
        
        // 1. xxxxx沉淀节点置顶
        orderBy.append("ORDER BY CASE WHEN title = 'xxxxxx' THEN 0 ELSE 1 END, ");
        
        // 2. 文件夹在前，文件在后
        orderBy.append("CASE WHEN type = 'FOLDER' THEN 0 ELSE 1 END, ");
        
        // 3. 根据排序类型进行排序
        if (StrUtil.isNotBlank(this.sortType)) {
            switch (this.sortType.toUpperCase()) {
                case "NAME_ASC":
                    // 文件名A-Z：英文A-Z → 中文A-Z → 数字0-9
                    // 统一使用gbk_chinese_ci排序规则避免collation冲突
                    orderBy.append("CASE ")
                            .append("WHEN title REGEXP '^[A-Za-z]' THEN 1 ") // 英文字母开头
                            .append("WHEN title REGEXP '^[\\u4e00-\\u9fa5]' THEN 2 ") // 中文字符开头
                            .append("WHEN title REGEXP '^[0-9]' THEN 3 ") // 数字开头
                            .append("ELSE 4 ") // 其他字符
                            .append("END ASC, ")
                            .append("CONVERT(")
                            .append("CASE ")
                            .append("WHEN title REGEXP '^[A-Za-z]' THEN UPPER(title) ") // 英文按字母序，忽略大小写
                            .append("WHEN title REGEXP '^[\\u4e00-\\u9fa5]' THEN title ") // 中文保持原样
                            .append("WHEN title REGEXP '^[0-9]' THEN LPAD(title, 20, '0') ") // 数字按数值序，左补零确保正确排序
                            .append("ELSE title ") // 其他字符按默认序
                            .append("END USING gbk) COLLATE gbk_chinese_ci ASC");
                    break;
                case "NAME_DESC":
                    // 文件名Z-A：数字9-0 → 中文Z-A → 英文Z-A
                    // 统一使用gbk_chinese_ci排序规则避免collation冲突
                    orderBy.append("CASE ")
                            .append("WHEN title REGEXP '^[0-9]' THEN 1 ") // 数字开头优先
                            .append("WHEN title REGEXP '^[\\u4e00-\\u9fa5]' THEN 2 ") // 中文字符其次
                            .append("WHEN title REGEXP '^[A-Za-z]' THEN 3 ") // 英文字母最后
                            .append("ELSE 4 ") // 其他字符
                            .append("END ASC, ")
                            .append("CONVERT(")
                            .append("CASE ")
                            .append("WHEN title REGEXP '^[A-Za-z]' THEN UPPER(title) ") // 英文按字母序，忽略大小写
                            .append("WHEN title REGEXP '^[\\u4e00-\\u9fa5]' THEN title ") // 中文保持原样
                            .append("WHEN title REGEXP '^[0-9]' THEN LPAD(title, 20, '0') ") // 数字按数值序，左补零确保正确排序
                            .append("ELSE title ") // 其他字符按默认序
                            .append("END USING gbk) COLLATE gbk_chinese_ci DESC");
                    break;
                case "TIME_DESC":
                    // 最近更新时间：文件夹按文件夹修改时间，文档按文档修改时间
                    orderBy.append("modifier_time DESC");
                    break;
                default:
                    // 默认排序：修改时间降序 + sort升序 + 标题升序
                    orderBy.append("modifier_time DESC, sort ASC, CONVERT(title USING gbk) COLLATE gbk_chinese_ci ASC");
                    break;
            }
        } else {
            // 默认排序：修改时间降序 + sort升序 + 标题升序（中文按拼音）
            orderBy.append("modifier_time DESC, sort ASC, CONVERT(title USING gbk) COLLATE gbk_chinese_ci ASC");
        }
        
        return orderBy.toString();
    }