MyBatis-Plus 参数别名是在 Mapper 接口中方法的参数前使用 @Param
注解所定义的。这些别名通常用于 MyBatis 映射文件中,以引用 Mapper 接口方法的参数。在 MyBatis-Plus 中,这些别名主要是为了使得动态 SQL 的编写变得更加简洁易懂,同时也是为了在构造复杂查询时保持代码的可读性。
以下是一些在 MyBatis-Plus 中常见的参数别名以及它们的含义:
-
@Param("ew")
- “ew” 通常是 “Entity Wrapper”的缩写,它指的是 MyBatis-Plus 中用于构造查询条件的 Wrapper 对象。这个 Wrapper 可以是QueryWrapper
、UpdateWrapper
等,它们用于构建动态 SQL 查询和更新条件。 -
@Param("et")
- “et” 代表 “Entity”,在一些方法中用于传递实体类对象,它用于表示要操作的数据记录的实体对象。 -
@Param("cm")
- “cm” 是 “Column Map”的缩写,它通常用于传递一个 Map 类型的参数,其中包含列名和对应的值,用于构建类似于 SQL 中的 WHERE 条件语句。 -
@Param("coll")
- “coll” 是 “Collection”的缩写,它用于表示传递给方法的集合类型参数,比如在执行批量查询或批量删除操作时使用。 -
@Param(Constants.ENTITY)
- 在 MyBatis-Plus 中,Constants.ENTITY
是一个常量,它的值通常是“et”,在这里作为参数别名,同样指的是实体对象。
public interface BaseMapper<T> {
// 示例:使用 @Param 注解定义参数别名
int update(@Param(Constants.ENTITY) T entity, @Param("ew") Wrapper<T> updateWrapper);
// 其他方法省略
}
在上述示例中,参数 T entity
被赋予了别名 et
(取决于 Constants.ENTITY
的值),而参数 Wrapper<T> updateWrapper
被赋予了别名 ew
。当这些方法被调用时,你可以在对应的 XML 映射文件或使用注解的 SQL 表达式中通过这些别名引用参数。
注意:在实际编码过程中,开发者可能会根据自己的习惯和需求定义不同的参数别名,上述解释只是一些常见的例子。在阅读和维护代码时,需要参考具体项目中使用的别名及其上下文含义。