MyBatis 使用 POJO 参数动态查询教程
项目结构概览(基于图片描述):
mybatis02
├─ src/main/java
│ └─ cn.cjxy
│ ├─ domain # 实体类(如 Emp.java)
│ ├─ mapper # Mapper 接口(如 EmpMapper.java)
│ └─ pojo # 查询参数 POJO(如 QueryPojo.java)
├─ src/main/resources
│ ├─ cn.cjxy.mapper # XML 映射文件(如 EmpMapper.xml)
│ └─ mybatis-config.xml
一、POJO 参数定义
1.1 查询参数封装类 QueryPojo.java
package cn.cjxy.pojo;import cn.cjxy.domain.Emp;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;@Data
@NoArgsConstructor
@AllArgsConstructor
public class QueryPojo {private Emp emp; // 嵌套对象(用于模糊查询名称)private Double start; // 薪资范围下限private Double end; // 薪资范围上限
}
- Lombok 注解作用:
@Data
:自动生成getter/setter
@NoArgsConstructor
:无参构造器@AllArgsConstructor
:全参构造器
二、Mapper 接口与 XML 映射配置
2.1 Mapper 接口方法 EmpMapper.java
List<Emp> findByPojo(QueryPojo pojo); // 接收 POJO 参数
2.2 XML 动态查询配置 EmpMapper.xml
<select id="findByPojo" resultType="cn.cjxy.domain.Emp">SELECT * FROM emp WHERE salary >= #{start} AND salary <= #{end} AND name LIKE #{emp.name} <!-- 访问嵌套对象属性 -->
</select>
- 关键点:
#{start}
和#{end}
直接访问QueryPojo
的成员变量#{emp.name}
通过嵌套对象访问Emp
的name
属性
三、测试类实现
3.1 测试代码 Test01.java
@Test
public void testFindByPojo() throws IOException {// 1. 创建 Emp 对象并设置模糊查询条件Emp emp = new Emp();emp.setName("%小%"); // 包含"小"的任意位置// 2. 封装查询参数到 POJOQueryPojo pojo = new QueryPojo();pojo.setEmp(emp);pojo.setStart(6000.00); // 薪资范围:6000~8000pojo.setEnd(8000.00);// 3. 执行查询List<Emp> empList = mapper.findByPojo(pojo);// 4. 输出结果empList.forEach(System.out::println);
}
3.2 执行流程
- 参数构建:
- 创建
Emp
对象,设置name
为模糊查询条件%小%
- 将
Emp
对象及薪资范围封装到QueryPojo
- 创建
- SQL 动态生成:
- MyBatis 解析
#{emp.name}
→ 获取emp.getName()
- 最终生成 SQL:
- MyBatis 解析
SELECT * FROM emp
WHERE salary >= 6000.00 AND salary <= 8000.00 AND name LIKE '%小%'
四、核心优势与注意事项
4.1 优势
- 参数集中管理:
- 将散落的参数封装为对象,提高代码可读性
- 支持复杂查询:
- 可嵌套对象、集合等复杂结构
- 动态 SQL 友好:
- 结合
<if>
标签实现条件过滤:
- 结合
<if test="start != null">AND salary >= #{start}
</if>
4.2 注意事项
- 属性访问规则:
- MyBatis 通过
getter
方法访问属性,需确保QueryPojo
和Emp
类有对应的getter
(或使用 Lombok)
- MyBatis 通过
- 模糊查询语法:
- 通配符
%
应在 Java 代码中设置(如%小%
),而非 XML 中拼接,避免 SQL 注入风险
- 通配符
- 空值处理:
- 若
emp
为null
,#{emp.name}
会抛出NullPointerException
,建议初始化对象:
- 若
public class QueryPojo {private Emp emp = new Emp(); // 防御性初始化
}
五、完整代码对照
文件 | 关键代码 |
---|---|
QueryPojo.java | 封装 Emp 对象及薪资范围 |
EmpMapper.java | List<Emp> findByPojo(QueryPojo pojo); |
EmpMapper.xml | 通过 #{start} , #{end} , #{emp.name} 动态拼接 SQL |
Test01.java | 构建 QueryPojo 参数并调用 Mapper 方法 |
六、扩展应用
- 动态条件增强:
结合<where>
和<if>
标签实现可选条件查询:
<select id="findByPojo" resultType="cn.cjxy.domain.Emp">SELECT * FROM emp <where><if test="start != null">AND salary >= #{start}</if><if test="end != null">AND salary <= #{end}</if><if test="emp.name != null">AND name LIKE #{emp.name}</if></where>
</select>
- 分页查询整合:
在QueryPojo
中添加pageNum
和pageSize
字段,结合PageHelper
插件实现分页:
PageHelper.startPage(pojo.getPageNum(), pojo.getPageSize());
List<Emp> list = mapper.findByPojo(pojo);