MyBatis-Plus动态表名使用selectPage方法不生效问题解析与解决

快来打我* 2024-04-15 14:02 80阅读 0赞

#### 文章目录 ####

*   *  MyBatis-Plus动态表名简介
     *  selectPage方法不生效的问题
     *  解决方案：SqlParser注解与BaseMapper的selectPage方法
     *  示例代码
     *   *  实体类
         *  Mapper接口
         *  Service层
         *  Controller层
     *  总结

![在这里插入图片描述][579a429daf314744b995f37351b46548.gif_pic_center]

> ?MyBatis-Plus动态表名使用selectPage方法不生效问题解析与解决
> 
> --------------------
> 
>  *  ☆\* o(≧▽≦)o \*☆嗨~我是IT·陈寒?
>  *  ✨博客主页：[IT·陈寒的博客][IT]
>  *  ?该系列文章专栏：[架构设计][Link 1]
>  *  ?其他专栏：[Java学习路线][Java] [Java面试技巧][Java 1] [Java实战项目][Java 2] [AIGC人工智能][AIGC] [数据结构学习][Link 2]
>  *  ?文章作者技术和水平有限，如果文中出现错误，希望大家能指正?
>  *  ? 欢迎大家关注！ ❤️

--------------------

MyBatis-Plus是MyBatis的增强工具，在简化MyBatis的操作和提供更多便捷功能的基础上，引入了一些新的特性。其中，动态表名是MyBatis-Plus的一个重要功能之一。然而，一些开发者在使用`selectPage`方法时可能会遇到动态表名不生效的问题。本文将深入分析这个问题的原因，并提供相应的解决方案。  
![在这里插入图片描述][208740b1ed784943a1614ad5a5757e18.png_pic_center]

### MyBatis-Plus动态表名简介 ###

在实际应用中，我们有时需要动态地指定表名，而不是在SQL语句中写死表名。MyBatis-Plus提供了一种方便的方式来实现动态表名，通常通过注解`@TableName`和`@SqlParser`来完成。

@TableName("dynamic_table")
    public class MyEntity {
        
        // 实体类字段
    }

在上述代码中，`@TableName`注解指定了表名为`dynamic_table`，这样在进行CRUD操作时，MyBatis-Plus就会自动使用该表名。

![在这里插入图片描述][d5eb514887bd4b5e9c09834b21e0300e.png_pic_center]

### selectPage方法不生效的问题 ###

有些开发者在使用`selectPage`方法时可能会遇到一个问题：动态表名似乎不起作用，查询操作仍然在默认的表上执行。这个问题的原因在于`selectPage`方法的实现机制以及动态表名的注入时机。

`selectPage`方法通常用于分页查询，而在分页查询时，MyBatis-Plus会在进行总记录数查询时先执行一条SQL，然后再执行具体的分页查询SQL。这两次查询中动态表名的注入时机是不同的。

### 解决方案：SqlParser注解与BaseMapper的selectPage方法 ###

为了解决动态表名在`selectPage`方法中不生效的问题，我们需要结合使用`@SqlParser`注解和`BaseMapper`的`selectPage`方法。

首先，在实体类上使用`@SqlParser`注解，标明使用动态表名：

@TableName("dynamic_table")
    @SqlParser(filter = true)
    public class MyEntity {
        
        // 实体类字段
    }

其中，`@SqlParser(filter = true)`表示该实体类启用动态表名过滤器。

接下来，在Mapper接口中使用`@SqlParser`注解，并结合`selectPage`方法：

@SqlParser(filter = true)
    public interface MyEntityMapper extends BaseMapper<MyEntity> {
        
        // 其他方法...
    
        @SqlParser(filter = true)
        IPage<MyEntity> selectMyEntityPage(Page<MyEntity> page, @Param(Constants.WRAPPER) Wrapper<MyEntity> wrapper);
    }

在上述代码中，我们使用了`@SqlParser(filter = true)`注解，确保在该Mapper接口的所有方法中启用动态表名过滤器。同时，在`selectMyEntityPage`方法中，使用`@SqlParser(filter = true)`注解确保动态表名在分页查询时生效。

![在这里插入图片描述][4efa4ed1958e47dea0047bad5c127199.png_pic_center]

### 示例代码 ###

下面通过一个具体的示例代码来演示解决方案的实现。

#### 实体类 ####

@TableName("dynamic_table")
    @SqlParser(filter = true)
    public class User {
        
        @TableId(type = IdType.AUTO)
        private Long id;
    
        private String username;
    
        private String email;
    
        // 省略其他字段的 getter 和 setter
    }

#### Mapper接口 ####

@SqlParser(filter = true)
    public interface UserMapper extends BaseMapper<User> {
        
        @SqlParser(filter = true)
        IPage<User> selectUserPage(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
    }

#### Service层 ####

@Service
    public class UserService {
        
        @Autowired
        private UserMapper userMapper;
    
        public IPage<User> getUserPage(Page<User> page, Wrapper<User> wrapper) {
        
            return userMapper.selectUserPage(page, wrapper);
        }
    }

#### Controller层 ####

@RestController
    @RequestMapping("/user")
    public class UserController {
        
        @Autowired
        private UserService userService;
    
        @GetMapping("/page")
        public IPage<User> getUserPage(@RequestParam(defaultValue = "1") long current,
                                       @RequestParam(defaultValue = "10") long size) {
        
            Page<User> page = new Page<>(current, size);
            QueryWrapper<User> wrapper = new QueryWrapper<>();
            // 可以在此添加其他查询条件
            return userService.getUserPage(page, wrapper);
        }
    }

在上述示例代码中，我们通过`@SqlParser(filter = true)`注解确保动态表名过滤器的启用，并在分页查询的方法上同样使用了`@SqlParser(filter = true)`注解，保证动态表名在分页查询时生效。

### 总结 ###

MyBatis-Plus作为MyBatis的增强工具，提供了方便、高效的数据库操作方式。在使用动态表名时，特别是在分页查询中，可能会遇到`selectPage`方法

![在这里插入图片描述][5bd83aa61f874b06b221031d92548466.png_pic_center]

动态表名不生效的问题。通过结合使用`@SqlParser`注解和`BaseMapper`的`selectPage`方法，我们可以解决这个问题，确保动态表名在分页查询时能够正确生效。在实际项目中，根据具体情况合理使用动态表名，以提高代码的灵活性和可维护性。

--------------------

> ?结尾 ❤️ 感谢您的支持和鼓励！ ??  
> ?您可能感兴趣的内容：
> 
>  *  【[Java面试技巧][Java 1]】[Java面试八股文 - 掌握面试必备知识（目录篇）][Java_ -]
>  *  【[Java学习路线][Java]】[2023年完整版Java学习路线图][2023_Java]
>  *  【[AIGC人工智能][AIGC]】[Chat GPT是什么，初学者怎么使用Chat GPT，需要注意些什么][Chat GPT_Chat GPT]
>  *  【[Java实战项目][Java 2]】[SpringBoot+SSM实战：打造高效便捷的企业级Java外卖订购系统][SpringBoot_SSM_Java]
>  *  【[数据结构学习][Link 2]】[从零起步：学习数据结构的完整路径][Link 3]
> 
> > ![在这里插入图片描述][d7565cfc032647bfb69e7971731a06a2.gif_pic_center]

[579a429daf314744b995f37351b46548.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/555bc943f8964e50b77d3cfd6165be2b.gif
[IT]: https://blog.csdn.net/qq_43546721?type=blog
[Link 1]: https://blog.csdn.net/qq_43546721/category_12435443.html?spm=1001.2014.3001.5482
[Java]: https://blog.csdn.net/qq_43546721/category_12367981.html
[Java 1]: https://blog.csdn.net/qq_43546721/category_12384780.html?spm=1001.2014.3001.5482
[Java 2]: https://blog.csdn.net/qq_43546721/category_12378614.html?spm=1001.2014.3001.5482
[AIGC]: https://blog.csdn.net/qq_43546721/category_12369819.html?spm=1001.2014.3001.5482
[Link 2]: https://blog.csdn.net/qq_43546721/category_12417284.html?spm=1001.2014.3001.5482
[208740b1ed784943a1614ad5a5757e18.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/d1d42007c30b4a4dbcfd9495432b218e.png
[d5eb514887bd4b5e9c09834b21e0300e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/087dddeafd2d43c89f16edbe437f5825.png
[4efa4ed1958e47dea0047bad5c127199.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/4a47033f43104899b3932a001a3940dc.png
[5bd83aa61f874b06b221031d92548466.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/4ecb14d10c964026be19ff2704035adf.png
[Java_ -]: https://blog.csdn.net/qq_43546721/article/details/131832856
[2023_Java]: https://blog.csdn.net/qq_43546721/article/details/131550605
[Chat GPT_Chat GPT]: https://blog.csdn.net/qq_43546721/article/details/131866932
[SpringBoot_SSM_Java]: https://blog.csdn.net/qq_43546721/article/details/132119791
[Link 3]: https://blog.csdn.net/qq_43546721/article/details/132404477
[d7565cfc032647bfb69e7971731a06a2.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/d4862d6c10564064bfba7a049ad8dd59.gif