Mybatis order 排序问题

曾写过一篇博客，是接触了一段时间的mybatis开发总结的：《Mybatis，怀疑--使用--感悟》。又过去了一段时间，前不久和别人联调接口，遇到了mybatis的排序问题。这篇博客就来总结一下，在mybatis框架下，如何实现排序？

    排序，是个很基础的需求。实现的时候只需要在查询语句后面加上order by 某个字段即可。在mybatis中，用工具可以帮助我们自动生成底层的一套东西，便可以满足我们基本的增删改查需求。那么，怎么样可以在select语句后面加上order by语句呢？下面就结合项目中的实践来分享给大家。

    【方法一 Example中处理排序】

    用mybatis自动生成工具，会生成几个文件，其中包括~Mapper.XML和~Example文件。我们能够实现基本的增删改查，也是建立在这几个文件的基础上。不知道大家有没有注意过~Mapper.XML 文件中SelectByExample中有排序的语句？如下图所示：

    所以说，在我们逻辑层代码中，利用Example进行条件查询的时候，也可以将orderBy条件写上，具体代码如下：

[java]  view plain  copy

 

1. public List<Article> findAllArticles() {  
2.         ArticleExample example = new ArticleExample();  
3.         example.setOrderByClause("`index` ASC,id ASC");  
4.         List<Article> list = articleMapper.selectByExample(example);  
5.         LOG.debug("findArticles with site={} and categoryId={} return: {}",  
6.                 list);  
7.         return list;  
8.     }    

   【方法二 PageBounds中处理排序】

    PageBounds，分页，这也是一个很基本的需求。在项目中，直接引入了mybatis封装好的插件。

    而你如果看过这里面的源码，你会发现，其中也给我们提供了一个排序的实现。也就是说，若接口中包含分页参数，你完全可以利用分页去实现排序。下面是我单元测试中的代码：

[java]  view plain  copy

 

1. public void findArticlesByCategory1() {  
2.         // 分页中实现排序，利用下面封装好的方法，传参数即可  
3.         /* 
4.          * public PageBounds(int page, int limit, List<SortBy> orders) { 
5.          * this(page, limit, orders, true); } 
6.          */  
7.         PageBounds pb = new PageBounds(1, 3, new SortBy("index",  
8.                 Direction.DESC, "`index`"));  
9.         Response<List<ArticleModel>> response = articleService  
10.                 .findArticlesByCategory("INFO", "main_app_info", pb);  
11.         Assert.assertTrue(response.getData().size() > 0);// 正常  
12.     }   

    结果可以实现排序吗？答案是，可以实现，但是并没有实现。却报错了：

    但如果，我将排序字段改了，根据id排序，代码如下：

[java]  view plain  copy

 

1. public void findArticlesByCategory1() {  
2.         // 分页中实现排序，利用下面封装好的方法，传参数即可  
3.         PageBounds pb = new PageBounds(1, 3, new SortBy("id", Direction.DESC,  
4.                 "id"));  
5.         Response<List<ArticleModel>> response = articleService  
6.                 .findArticlesByCategory("INFO", "main_app_info", pb);  
7.         Assert.assertTrue(response.getData().size() > 0);// 正常  
8.         System.out.print(response.getData());  
9.     }    

    测试是可以通过的。再回到出错的截图上， 为什么我框出了order by的语句部分呢。因为出错的原因就在这里了。index属于关键字，写一个简单的'select * from Table order by index DESC',在mysql数据库中都会执行出错，所以，我在代码中给index加了``符号，但生成后的语句，并没有带符号。

    这样看来，就是因为index关键字转换不了的原因，所以没法实现在分页中用该字段去排序。哎，前期的数据表设计的人都没见过，不会让我因为这个又重新生成一套底层文件吧。这都已经上了生产的项目，这样的改动太大了。

    但我想到的是，实际上，自己也实现了在example中去根据index字段排序的。我可以用example去给它排好序，但因为接口是要提供给其它平台的，而调用此接口的人也不是一方，一边需要按'index'字段排序，而另一边又不需要，这样就不能都满足了。

    所以，最后的解决办法就是【方法一 + 方法二 = 方法三】

    【方法三 Example与PageBounds结合排序】

    调用此接口的，根据自己的需要传入对应的参数，如果不需要按某字段排序，只需要传入 int page, int limit即可；如果需要按某字段排序，传入的参数包括 int page, int limit，List<SortBy>.而我的逻辑代码只需要判断一下，如果传入了排序字段，先从List<SortBy>中获取，再写入到Example中，这样，index关键字的问题解决了，排序的灵活性也解决了。

    具体代码如下：

[java]  view plain  copy

 

1. public List<Article> findArticlesByCategoryId(String site, Long catId,  
2.             PageBounds pb) {  
3.         ArticleExample example = new ArticleExample();  
4.         example.createCriteria().andSiteLike("%" + site + "%")  
5.                 .andCatIdEqualTo(catId).andIsDeletedEqualTo(false)  
6.                 .andStatusEqualTo(article_published)  
7.                 .andPublishTimeLessThanOrEqualTo(new Date()); // 添加筛选条件：未删除的，已发布的，且发布时间小于或等于当前时间  
8.         List<SortBy> sortBies = new ArrayList<SortBy>();  
9.         sortBies = pb.getOrders();  
10.         if (sortBies != null && !sortBies.isEmpty()) {  
11.             String orderString = "";  
12.             String orderDirection = "";  
13.             for (SortBy sortBy : sortBies) {  
14.                 orderString = sortBy.getOrderExpr();  
15.                 Direction direction = sortBy.getDirection();  
16.                 orderDirection = direction.toString();  
17.             }  
18.   
19.             pb.setOrders(null);  
20.             // 前端需要，按显示顺序字段排序。若传了排序参数，则按参数进行排序  
21.             example.setOrderByClause(orderString + " " + orderDirection);  
22.         }  
23.   
24.         List<Article> list = articleMapper.selectByExample(example, pb);  
25.         LOG.debug("findArticles with site:{} and categoryId={} return: {}",  
26.                 site, catId, list);  
27.         return list;  
28.     }  

【项目总结】

    最开始接触排序的问题是因为我们平台端的需要， 很多东西他们封装好了，我 就在项目中一层层的找代码，同时也上网查了查mybatis中可以如何实现排序。

     第一种方法Example中设置排序就是我从查资料中获取到的。后来遇到了问题，看代码的时候就发现在PageBounds中也有一套排序，而且默认了是按每个表中的create_time字段排序的。猜想是两者发生了冲突，所以直接将PageBounds中的排序给set null值了。我的问题也解决了。

    这一次，通过给其它平台联调，让我接触到了第二种方法，原来mybatis封装好的分页插件可以这样玩。同样，也收获到了1+1>2的效果，两者的结合，更是很简单地解决了我遇到的问题。