MyBatis 教程

MyBatis parameterMap

本章节将介绍怎样使用 <parameterMap> 和 <parameter> 标签映射参数。

在开始使用之前,我们先看看这两个标签的 DTD 定义。如下:

<!-- 用来定义一组参数,包含多个 parameter 标签 -->
<!ELEMENT parameterMap (parameter+)?>
<!ATTLIST parameterMap
    id CDATA #REQUIRED
    type CDATA #REQUIRED>

<!-- 定义一个参数,可以指定参数类型、Java 属性等信息 -->
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
    property CDATA #REQUIRED
    javaType CDATA #IMPLIED
    jdbcType CDATA #IMPLIED
    mode (IN | OUT | INOUT) #IMPLIED
    resultMap CDATA #IMPLIED
    scale CDATA #IMPLIED
    typeHandler CDATA #IMPLIED>

上面 DTD 定义映射参数的标签信息,其中:

  • parameterMap:标签可以用来定义参数组,可以为参数组指定ID、参数类型(即该参数是对那个JavaBean进行映射)

  • parameter:标签用来定义单个的参数;其中,property 用来指定对应 JavaBean 属性,javaType 对应Java类型,jdbcType对应数据库类型,mode 用于定义存储过程参数类型(输入、输出、输入输入类型)等

下面使用 <parameterMap> 将参数 ArgBean 对象进行映射。ArgBean.java 类内容如下:

public class ArgBean {
    private String name;
    private int age;
    // 忽略 getter 和 setter
}

XML 配置如下:

<parameterMap id="PARAM_MAP" type="com.hxstrive.mybatis.parameter.demo2.ArgBean">
    <parameter property="age" javaType="integer" />
    <parameter property="name" javaType="String" />
</parameterMap>

上面实例中将 com.hxstrive.mybatis.parameter.demo2.ArgBean 映射成 PARAM_MAP,在该映射中有两个参数,分别是 age 和 name,而且通过 javaType 指定参数的 java 类型。然后我们就可以在 <select> 等标签的 parameterMap 属性中引用我们定义的 PARAM_MAP 映射。

注意:当我们使用 JavaBean 作为参数时,您可以不使用 <parameterMap> 进行映射。

实例

(1)MyBatis 配置信息 mybatis-cfg.xml 内容如下:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="database.properties"/>
    <environments default="MySqlDatabase" >
        <environment id="MySqlDatabase" >
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/hxstrive/mybatis/parameter/demo2/UserMapper.xml" />
    </mappers>
</configuration>

(2)Mapper 接口定义 UserMapper.java 内容如下:

package com.hxstrive.mybatis.parameter.demo2;

import java.util.List;

public interface UserMapper {
    List<UserBean> getUsers(ArgBean argBean);
    List<UserBean> getUsers2(ArgBean argBean);
}

(3)Mapper XML 文件 UserMapper.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="com.hxstrive.mybatis.parameter.demo2.UserMapper">

    <resultMap id="RESULT_MAP" type="com.hxstrive.mybatis.parameter.demo2.UserBean">
        <id column="user_id" jdbcType="INTEGER" property="userId" />
        <result column="name" jdbcType="VARCHAR" property="name" />
        <result column="sex" jdbcType="VARCHAR" property="sex" />
        <result column="age" jdbcType="INTEGER" property="age" />
    </resultMap>

    <!-- 参数没有进行映射 -->
    <select id="getUsers" resultMap="RESULT_MAP">
        select `user_id`, `name`, `sex`, `age`
        from `user`
        where `age`=#{age} and `name` like #{name}
    </select>

    <!-- 参数进行了映射 -->
    <parameterMap id="PARAM_MAP" type="com.hxstrive.mybatis.parameter.demo2.ArgBean">
        <parameter property="age" javaType="integer" />
        <parameter property="name" javaType="String" />
    </parameterMap>

    <select id="getUsers2" parameterMap="PARAM_MAP" resultMap="RESULT_MAP">
        select `user_id`, `name`, `sex`, `age`
        from `user`
        where `age`=#{age} and `name` like #{name}
    </select>

</mapper>

(4)定义实体Bean,参数Bean ArgBean.java 内容如下:

package com.hxstrive.mybatis.parameter.demo2;

public class ArgBean {
    private String name;
    private int age;
    // 忽略 setter 和 getter
}

返回结果实体Bean UserBean.java 内容如下:

package com.hxstrive.mybatis.parameter.demo2;

public class UserBean {
   private Integer userId;
   private String name;
   private String sex;
   private Integer age;
   // 忽略 setter 和 getter

   @Override
   public String toString() {
      return "UserBean{" +
            "userId=" + userId +
            ", name='" + name + '\'' +
            ", sex='" + sex + '\'' +
            ", age=" + age +
            '}';
   }
}

(5)客户端代码如下:

package com.hxstrive.mybatis.parameter.demo2;

import org.apache.ibatis.io.Resources;
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;

public class ParameterDemo2 {

    public static void main(String[] args) throws Exception {
        String cfgName = "com/hxstrive/mybatis/parameter/demo2/mybatis-cfg.xml";
        InputStream input = Resources.getResourceAsStream(cfgName);
        SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory sqlFactory = factoryBuilder.build(input);
        SqlSession sqlSession = sqlFactory.openSession(true);
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        ArgBean argBean = new ArgBean();
        argBean.setAge(28);
        argBean.setName("%Zh%");

        List<UserBean> userBeanList = userMapper.getUsers(argBean);
        for(UserBean userBean : userBeanList) {
            System.out.println(userBean);
        }

        System.out.println("------------------ 分割线 ------------------");
        userBeanList = userMapper.getUsers(argBean);
        for(UserBean userBean : userBeanList) {
            System.out.println(userBean);
        }
    }

}
说说我的看法
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号