MyBatis中的占位符入参方法有哪些

作者:有用网 阅读量:189 发布时间:2024-01-05
关键字 mybatis

本篇内容主要讲解“MyBatis中的占位符入参方法有哪些”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“MyBatis中的占位符入参方法有哪些”吧!

    前言

    #{}
    占位符会被解析为JDBC中的预编译语句(Prepared Statement)中的参数占位符
    ?
    ,一个
    #{}
    会被解析为一个
    ?

    ${}
    占位符标识的位置会直接被替换为入参,是简单的字符串替换。

    正文

    一. 入参是基本类型并且参数个数为1

    映射接口中查询单条记录的方法定义如下。

    // 使用#{}作为参数占位符
    MyInfo getMyInfoByNameUseWell(String infoName);
    // 使用${}作为参数占位符
    MyInfo getMyInfoByNameUseDollar(String infoName);

    与之对应的映射文件中的查询标签定义如下。

    <select id="getMyInfoByNameUseWell" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = #{name}
    </select>
    <select id="getMyInfoByNameUseDollar" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = '${name}'
    </select>

    入参是基本类型(示例中是String类型)且参数个数只有一个时,使用

    #{}
    ${}
    占位符均不要求占位符指定的名称与映射接口中的参数名相等,但是
    #{}
    进行占位符替换后参数会添加上
    ''
    号,而
    ${}
    进行占位符替换是直接进行字符串替换,所以上述示例中,使用
    ${}
    占位符时需要在占位符两侧添加
    ''
    号。

    二. 入参是基本类型并且参数个数大于1

    映射接口中查询单条记录的方法定义如下。

    // 使用#{}作为参数占位符
    MyInfo getMyInfoByNameTypeUseWell(@Param("infoName") String infoName, @Param("infoType") String infoType);
    // 使用${}作为参数占位符
    MyInfo getMyInfoByNameTypeUseDollar(@Param("infoName") String infoName, @Param("infoType") String infoType);

    与之对应的映射文件中的查询标签定义如下。

    <select id="getMyInfoByNameTypeUseWell" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = #{infoName} AND info_type = #{infoType}
    </select>
    <select id="getMyInfoByNameTypeUseDollar" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = '${infoName}' AND info_type = '${infoType}'
    </select>

    入参是基本类型且参数个数大于一个时,此时需要在映射接口的方法中使用@Param注解定义参数的名称,并且要求占位符指定的名称需要与@Param注解定义的名称相等,否则报错

    三. 入参是自定义类型

    映射接口中查询单条记录的方法定义如下。

    // 使用#{}作为参数占位符
    MyInfo getMyInfoByQueryParamUseWell(QueryParam queryParam);
    // 使用${}作为参数占位符
    MyInfo getMyInfoByQueryParamUseDollar(QueryParam queryParam);

    其中自定义类型QueryParam定义如下。

    @Data
    public class QueryParam {
        private String infoName;
        private String infoType;
        public QueryParam(String infoName, String infoType) {
            this.infoName = infoName;
            this.infoType = infoType;
        }
    }

    与之对应的映射文件中的查询标签定义如下。

    <select id="getMyInfoByQueryParamUseWell" resultMap="myInfoMap"
            parameterType="com.learn.mybatis.dynamic.entity.QueryParam">
        SELECT * FROM myinfo WHERE info_name = #{infoName} AND info_type = #{infoType}
    </select>
    <select id="getMyInfoByQueryParamUseDollar" resultMap="myInfoMap"
            parameterType="com.learn.mybatis.dynamic.entity.QueryParam">
        SELECT * FROM myinfo WHERE info_name = '${infoName}' AND info_type = '${infoType}'
    </select>

    入参是自定义类型时,占位符指定的名称需要与自定义类型中的字段名相同,否则报错

    四. 入参是Map类型

    映射接口中查询单条记录的方法定义如下。

    // 使用#{}作为参数占位符
    MyInfo getMyInfoByMapUseWell(Map<String, Object> queryParamMap);
    // 使用${}作为参数占位符
    MyInfo getMyInfoByMapUseDollar(Map<String, Object> queryParamMap);

    与之对应的映射文件中的查询标签定义如下。

    <select id="getMyInfoByMapUseWell" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = #{infoName} AND info_type = #{infoType}
    </select>
    <select id="getMyInfoByMapUseDollar" resultMap="myInfoMap">
        SELECT * FROM myinfo WHERE info_name = '${infoName}' AND info_type = '${infoType}'
    </select>

    入参是Map时,占位符指定的名称需要与Map的key相等,这样才能将key对应的value与占位符进行替换

    五. 只能使用${}的场景

    通过上面几点分析,发现大多数能够使用

    ${}
    占位符的场景都可以使用
    #{}
    占位符,而且
    #{}
    占位符相比
    ${}
    占位符还具有能够防止SQL注入提高执行速度的功能,但是如下几种场景,只能够使用
    ${}
    占位符。

    1. 入参是表名

    当入参是表名时,此时如果表名的参数占位符使用

    #{}
    ,会报错,因为表名不确定时,是无法进行预编译SQL的,所以这种场景只能使用
    ${}
    作为表名的参数占位符。下面是示例。

    映射接口中的示例方法定义如下。

    // 传入表名实现动态创建表
    void createMyInfoTable(String tableName);
    // 传入表名动态指定被查询的表
    MyInfo getMyInfoByNameUseWellDynmic(@Param("tableName") String tableName, @Param("infoName") String infoName);

    与之对应的映射文件中的标签定义如下。

    <update id="createMyInfoTable">
        CREATE TABLE ${tableName} (
            id INT(11) PRIMARY KEY AUTO_INCREMENT,
            info_name VARCHAR(255),
            info_type ENUM('USER', 'HOUSE', 'CAR'),
            info_detail VARCHAR(255),
            info_seq INT(11)
        )
    </update>
    <select id="getMyInfoByNameUseWellDynmic" resultMap="myInfoMap">
        SELECT * FROM ${tableName} WHERE info_name = #{infoName}
    </select>

    2. 入参是列名

    当入参是列名时,此时也只能使用

    ${}
    作为列名的参数占位符。下面是示例。

    映射接口中的方法定义如下。

    // 为数据库表创建索引
    // 表名,索引名,加索引的列的列名全部动态指定
    void createIndex(@Param("tableName") String tableName, 
                     @Param("indexName") String indexName, 
                     @Param("columnNames") List&lt;String&gt; columnNames);
    // 对查询结果集进行排序并动态指定排序的列名
    List&lt;MyInfo&gt; getMyInfosSorted(String columnName);

    与之对应的映射文件中的标签定义如下。

    <update id="createIndex">
        CREATE INDEX
            ${indexName}
        ON
            ${tableName}
        <foreach collection="columnNames" item="columnName"
                    open="(" separator="," close=")">
            ${columnName}
        </foreach>
    </update>
    <select id="getMyInfosSorted" resultMap="myInfoMap">
        SELECT * FROM myinfo ORDER BY ${columnName} DESC
    </select>

    在为数据库表创建索引的示例中,表名,索引名和加索引的列的列名全部都需要使用

    ${}
    作为参数占位符,否则会报错。在对查询结果集进行排序的示例中,如果列名占位符不使用
    ${}
    而使用
    #{}
    ,不会报错,但是无法实现根据指定列进行排序的功能。

    #发表评论
    提交评论