Mybatis参数(parameterType)

在此之前，我们已经介绍了Mybatis的一些基本用法，包括了Mybatis查询数据、结果映射（resultMap）等。本篇我们主要介绍Mybatis在查询数据时如何传递参数。

一、准备工作

这里我们直接使用脚本初始化数据库中的数据

-- 如果数据库不存在则创建数据库
CREATE DATABASE IF NOT EXISTS demo DEFAULT CHARSET utf8;
-- 切换数据库
USE demo;
-- 创建用户表
CREATE TABLE IF NOT EXISTS T_USER(
  ID INT PRIMARY KEY,
  USERNAME VARCHAR(32) NOT NULL,
  AGE INT NOT NULL 
);
-- 插入用户数据
INSERT INTO T_USER(ID, USERNAME, AGE)
VALUES(1, '张三', 20),(2, '李四', 22),(3, '王五', 24);

创建了一个名称为demo的数据库；并在库里创建了名称为T_USER的用户表并向表中插入了数据

二、创建用户实体类

在cn.horse.demo包下创建UserInfo实体类，为了方便打印用户的信息这里重写了ToString()方法

package cn.horse.demo;

public class UserInfo {

    private Integer id;
    private String name;
    private Integer age;

    @Override
    public String toString() {
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append('{');
        stringBuilder.append("id: " + this.id);
        stringBuilder.append(", ");
        stringBuilder.append("name: " + this.name);
        stringBuilder.append(", ");
        stringBuilder.append("age: " + this.age);
        stringBuilder.append('}');
        return stringBuilder.toString();
    }
}

三、配置XML配置文件

这里我在resources下创建了一个demo的目录，并在目录下创建了一个UserInfoMapper.xml的配置文件。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.horse.demo.UserInfoMapper">

    <select id="findByAge" resultType="cn.horse.demo.UserInfo">
        SELECT
            ID,
            USERNAME name,
            AGE
        FROM T_USER
        WHERE AGE > #{age}
    </select>

    <select id="findByObject" resultType="cn.horse.demo.UserInfo">
        SELECT
        ID,
        USERNAME name,
        AGE
        FROM T_USER
        WHERE AGE BETWEEN #{startAge} AND #{endAge}
    </select>
</mapper>

findByAge查询标签用于查询年龄大于age的用户列表

findByObject查询标签用于查询年龄从startAge到endAge之间的用户列表

#{age }、#{startAge}、#{endAge} 这些是查询的参数，在预处理阶段会使用?进行替换掉，在执行阶段会把参数的值传入进行查询操作。

另外，需要在mybatis-config.xml文件中配置UserInfoMapper.xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="org.gjt.mm.mysql.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/demo?useUnicode=true&amp;useSSL=false&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="horse"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="demo/UserInfoMapper.xml" />
    </mappers>
</configuration>

四、查询数据列表工具类

在cn.horse.demo下创建StatementUtils类，在类中编写find静态方法用于查询数据列表，方法接收两个参数：语句和参数。

package cn.horse.demo;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.InputStream;
import java.util.List;
import java.util.Objects;

public abstract class StatementUtils {

    public static void find(String statement, Object parameter) {
        // 读取mybatis配置文件
        InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("mybatis-config.xml");
        // 根据配置创建SqlSession工厂
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                .build(inputStream);

        SqlSession sqlSession = null;
        try {
            // 创建SqlSession
            sqlSession = sqlSessionFactory.openSession();
            // 查询用户列表
            List<UserInfo> userInfoList = sqlSession.selectList(statement, parameter);
            for (UserInfo userInfo: userInfoList) {
                System.out.println(userInfo);
            }
        } finally {
            // 关闭会话
            if(Objects.nonNull(sqlSession)) {
                sqlSession.close();
            }
        }
    }
}

五、基本类型作为参数

测试：

这里我们查询年龄大于21岁的所有用户

StatementUtils.find("cn.horse.demo.UserInfoMapper.findByAge", 21);

执行的结果如下：

注意：基本类型作为参数时，SQL语句中使用的参数名不限制

六、对象作为参数

这里我们新建用户查询类

UserInfoQuery类：

package cn.horse.demo;

public class UserInfoQuery {

    private Integer startAge;
    private Integer endAge;

    public void setStartAge(Integer startAge) {
        this.startAge = startAge;
    }

    public void setEndAge(Integer endAge) {
        this.endAge = endAge;
    }
}

其中startAge, endAge代表开始和结束年龄

测试：

这里我们查询年龄段从20岁到22岁之间的所有用户

UserInfoQuery userInfoQuery = new UserInfoQuery();
userInfoQuery.setStartAge(20);
userInfoQuery.setEndAge(22);
StatementUtils.find("cn.horse.demo.UserInfoMapper.findByObject", userInfoQuery);

执行的结果如下：

注意：对象作为参数时，SQL语句中使用的参数名需要与对象中的字段一致。

七、Map集合作为参数

测试：

这里我们查询年龄段从20岁到22岁之间的所有用户

Map<String, Object> parameter = new HashMap<>();
parameter.put("startAge", 20);
parameter.put("endAge", 22);
StatementUtils.find("cn.horse.demo.UserInfoMapper.findByObject", parameter);

执行的结果如下：

注意：Map作为参数时，SQL语句中使用的参数名需要能根据参数名在Map集合中取到参数值。