当前位置：首页 > news >正文

Springboot中 MyBatis-Flex TableDef 的使用

news 来源：原创 2025/6/13 11:27:26

什么是 TableDef？

TableDef 是 MyBatis-Flex 框架提供的一个强大特性，用于定义数据库表的元数据。它提供了一种类型安全的方式来引用数据库表和列，避免了直接使用字符串字面量可能带来的问题。

原文链接：https://blog.ybyq.wang/archives/576.html

为什么需要 TableDef？

在传统的 MyBatis 开发中，我们经常需要写这样的代码：

QueryWrapper query = QueryWrapper.create().where("user_id = ?", userId).and("status = ?", status);

这种方式存在以下问题：

容易拼写错误
重构困难
没有代码提示
类型不安全

TableDef 的优势

使用 TableDef 后，代码变成了这样：

QueryWrapper query = QueryWrapper.create().where(USER.USER_ID.eq(userId)).and(USER.STATUS.eq(status));

主要优势：

类型安全，编译时就能发现错误
代码提示，IDE 可以自动补全
重构方便，如果表名或字段名改变，只需要修改一处
代码更清晰，易于维护

实际项目中的应用

让我们通过宠物商店项目中的实际例子来看看 TableDef 的使用：

1. 定义 TableDef

首先，我们需要为每个表创建一个 TableDef 类：

public class PetTableDef extends TableDef {public static final PetTableDef PET = new PetTableDef();public final QueryColumn ID = new QueryColumn(this, "id");public final QueryColumn USER_ID = new QueryColumn(this, "user_id");public final QueryColumn NAME = new QueryColumn(this, "name");public final QueryColumn BREED = new QueryColumn(this, "breed");public final QueryColumn AVATAR = new QueryColumn(this, "avatar");public PetTableDef() {super("pet", "p");}
}

2. 在查询中使用

在 Service 层中使用 TableDef 进行查询：

@Service
public class PetServiceImpl implements PetService {@Autowiredprivate PetMapper petMapper;@Overridepublic List<Pet> getPetsByUserId(Integer userId) {return petMapper.selectListByQuery(QueryWrapper.create().where(PET.USER_ID.eq(userId)));}
}

3. 复杂查询示例

使用 TableDef 可以轻松构建复杂的查询：

// 多表联查
QueryWrapper query = QueryWrapper.create().select(PET.NAME,PET.BREED,USER.NICKNAME.as("ownerName")).from(PET).leftJoin(USER).on(PET.USER_ID.eq(USER.ID)).where(PET.USER_ID.eq(userId));// 条件查询
QueryWrapper query = QueryWrapper.create().where(PET.NAME.like(keyword)).and(PET.BREED.eq(breed)).orderBy(PET.ID.desc());// 分页查询
Page<Pet> page = petMapper.paginate(new Page<>(pageNum, pageSize),QueryWrapper.create().where(PET.USER_ID.eq(userId))
);

4. 动态 SQL

TableDef 也支持动态 SQL 的构建：

QueryWrapper query = QueryWrapper.create().where(PET.USER_ID.eq(userId));if (StringUtils.isNotBlank(keyword)) {query.and(PET.NAME.like(keyword));
}if (StringUtils.isNotBlank(breed)) {query.and(PET.BREED.eq(breed));
}