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

IT_陈寒

发布于 2023-12-14 11:36:42

8980

发布于 2023-12-14 11:36:42

文章被收录于专栏：开发经验

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

☆* o(≧▽≦)o *☆嗨~我是IT·陈寒🍹
✨博客主页：IT·陈寒的博客
🎈该系列文章专栏：架构设计
📜其他专栏：Java学习路线 Java面试技巧 Java实战项目 AIGC人工智能数据结构学习
🍹文章作者技术和水平有限，如果文中出现错误，希望大家能指正🙏
📜 欢迎大家关注！ ❤️

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

MyBatis-Plus动态表名简介

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

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

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

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)注解确保动态表名在分页查询时生效。

示例代码

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

实体类

@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)注解，保证动态表名在分页查询时生效。