MyBatis-Plus 实现动态字段排序

场景

虽然前端能根据返回的数组进行对字段的排序，但也仅局限于实现当前页的排序，无法满足全部数据的排序，所以需要走接口的查询进行排序，获取最全的排序数据。

业务需求

思路

1. 前端需传递排序的字段，该字段是正序还是倒叙。可能存在多个，所以字段为字符串数组，可以通过逗号分开。
2. 后端拿到参数后，如果字段名是驼峰命名，需要转为小写字母+下划线命名。
3. 将处理后的字段进行排序sql上的拼接处理后，拼接到 order by 语句后面，得到order by语句。
4. 根据MyBatis-Plus的 last 方法，将处理的order by语句进行拼接到查询sql语句后面。

实现

1. 前端传递的参数格式为：

{
  "sort": "userName,updateTime",
  "order": "asc,desc"
}

2. 后端接收排序对象 Sorter ,那个请求查询用到自定义排序就继承该类：

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 1. 基础排序对象，包含排序字段和排序方式
 */
@Data
public class Sorter
{

    @ApiModelProperty(value = "排序字段",example = "userName")
    private String sort;

    @ApiModelProperty(value = "排序方式",example = "asc/desc")
    private String order;

    /**
     * 根据查询条件拼接得到order by语句
     * @param sorter 分页查询条件
     * @return String
     */
    public static String getStatement(Sorter sorter)
    {
        String sort;
        String[] sortArray = {};
        String[] orderArray = {};
        String order = sorter.getOrder();
        String sortColumn = sorter.getSort();
        StringBuilder statement = new StringBuilder();

        // 多字段排序
        if (StringUtils.isNotEmpty(sortColumn))
        {
            // 驼峰命名转为下划线
            sort = StringUtils.toUnderScoreCase(sortColumn);

            if (sort.contains(",")) {
                sortArray = sort.split(",");
            }
        }
        else
        {
            return "";
        }
        if (StringUtils.isNotEmpty(order))
        {
            if (order.contains(",")) {
                orderArray = order.split(",");
            }
        }
        else
        {
            return "";
        }

        if (sortArray.length > 0 && orderArray.length > 0)
        {
            int length = sortArray.length;

            for (int i = 0; i < length; i++) {
                statement.append(sortArray[i]);
                statement.append(" ");
                statement.append(orderArray[i]);

                if (i < length - 1 ) {
                    statement.append(", ");
                }
            }
        }
        else
        {
            // " #{sort} #{order}“
            statement.append(sort);
            statement.append(" ");
            statement.append(order);
        }
        return statement.toString();
    }

    /**
     * 根据查询条件拼接得到order by语句
     * @param sorter 分页查询条件
     * @return String
     */
    public static String getOrderByStatement(Sorter sorter)
    {
        String statement = getStatement(sorter);

        if (StringUtils.isNotEmpty(statement))
        {
            return " order by " + statement;
        }
        else
        {
            return statement;
        }
    }
}

3. 处理字段驼峰式的工具类：

/**
 3. 字符串工具类
 4.  5. @author lcl
 */
public class StringUtils extends org.apache.commons.lang3.StringUtils
{
    /** 下划线 */
    private static final char SEPARATOR = '_';

    /**
     * * 判断一个字符串是否为非空串
     *
     * @param str String
     * @return true：非空串 false：空串
     */
    public static boolean isNotEmpty(String str)
    {
        return !isEmpty(str);
    }

    /**
     * 驼峰转下划线命名
     */
    public static String toUnderScoreCase(String str)
    {
        if (str == null)
        {
            return null;
        }
        StringBuilder sb = new StringBuilder();
        // 前置字符是否大写
        boolean preCharIsUpperCase = true;
        // 当前字符是否大写
        boolean curreCharIsUpperCase = true;
        // 下一字符是否大写
        boolean nexteCharIsUpperCase = true;
        for (int i = 0; i < str.length(); i++)
        {
            char c = str.charAt(i);
            if (i > 0)
            {
                preCharIsUpperCase = Character.isUpperCase(str.charAt(i - 1));
            }
            else
            {
                preCharIsUpperCase = false;
            }

            curreCharIsUpperCase = Character.isUpperCase(c);

            if (i < (str.length() - 1))
            {
                nexteCharIsUpperCase = Character.isUpperCase(str.charAt(i + 1));
            }

            if (preCharIsUpperCase && curreCharIsUpperCase && !nexteCharIsUpperCase)
            {
                sb.append(SEPARATOR);
            }
            else if ((i != 0 && !preCharIsUpperCase) && curreCharIsUpperCase)
            {
                sb.append(SEPARATOR);
            }
            sb.append(Character.toLowerCase(c));
        }
        return sb.toString();
    }
}

4. 请求查询的入参对象继承 Sorter 排序对象:

入参对象

5. Mapper层直接调用last在sql尾拼接语句方法，将Sorter的getOrderByStatement(Sorter sorter)方法传入：

语句拼接

结果

测试排序