MyBatis使用实践总结

﹏ヽ暗。殇╰゛Y 2023-05-30 09:26 9阅读 0赞

Mybatis中文官网地址：https://mybatis.org/mybatis-3/zh/index.html

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYW51cy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]

# **【1】插入后将主键ID放回到对象中** #

**MySQL数据库，SpringBoot+MyBatis。mapper.xml配置如下：**

<insert id="insert" useGeneratedKeys="true" keyProperty="id" parameterType="com.jane.knowledge.entity.SysMoment">
        insert into tb_sys_moment (id, title, content, 
          object_id, field1, field2, 
          field3, field4, create_time, 
          update_time)
        values (#{id,jdbcType=BIGINT}, #{title,jdbcType=VARCHAR}, #{content,jdbcType=VARCHAR}, 
          #{objectId,jdbcType=BIGINT}, #{field1,jdbcType=VARCHAR}, #{field2,jdbcType=VARCHAR}, 
          #{field3,jdbcType=VARCHAR}, #{field4,jdbcType=VARCHAR}, #{createTime,jdbcType=TIMESTAMP}, 
          #{updateTime,jdbcType=TIMESTAMP})
      </insert>

**效果如下：**

插入后的sysMoment:SysMoment{id=5,  content='测试朋友圈', objectId=5, , createTime=Sat Nov 09 14:55:55 CST 2019}

**主要核心思想：**

//id为对象的主键对应属性名
    useGeneratedKeys="true" keyProperty="id"

--------------------

# **【2】XML中使用CDATA** #

**① 什么是CDATA**

CDATA 是由XML定义的，跟Mybatis没啥关系。CDATA 指的是不由 XML 解析器进行解析的文本数据。被`<![CDATA[]]>`这个标记所包含的内容将表示为纯文本，比如`<![CDATA[<]]>`表示文本内容`“<”`。全名:`character data`。`<![CDATA[]]>`表示xml解析器忽略解析，比使用转义字符更快。

sql中有一些特殊的字符，在解析xml文件的时候会被转义。使用CDATA可以避免此类情况。比如包含`”<”、”>”、”&”`等字符，最好把他们都放到CDATA中。

**② mybatis的xml中使用**

实例如下：

<if test="queryParam.createTime != null">
          <![CDATA[AND create_time >= #{queryParam.createTime}]]>
      </if>

需要注意的是mybatis中的`<if test=""></if>、<where></where>、<choose></choose>、<trim></trim>` 等这些标签不能写到CDATA中。否则标签将不会被mybatis解析。

在XML中，需要转义的字符有： 
    　　(1)&　　	& 
    　　(2)<　　	< 
    　　(3)>　　	> 
    　　(4)＂　	" 
    　　(5)＇　　'

--------------------

# **【3】like与 concat** #

like的使用通常离不开concact函数，具体示例如下：

<if test="content !=null and content!=''">
    	and content like concat('%', #{content},'%')
    </if>

# 【4】Integer值为0的数据 return false #

Mybatis在进行`<if test="status != null and status != ''">`判空操作时，如果status为0的时候，该判断条件的值为false，也就是说Mybatis此时把0作为 `""`来进行判断的！

**解决办法：**

*  status确定为integer类型的，把`status!=”`给去掉就好了。
 *  对传递参数进行拦截处理，如转换类型

# 【5】mybatis对参数的处理 #

**参数可以指定一个特殊的数据类型：**

*  javaType 通常可以从参数对象中来去确定
 *  如果null 被当作值来传递，对于所有可能为空的列，jdbcType 需要被设置
 *  对于数值类型，还可以设置小数点后保留的位数
 *  mode 属性允许指定`IN，OUT 或INOUT` 参数。如果参数为`OUT` 或`INOUT`，参数对象属性的真实值将会被改变，就像在获取输出参数时所期望的那样。

参数位置支持的属性:

> javaType、jdbcType、mode、numericScale、resultMap、typeHandler、jdbcTypeName、expression

实际上通常被设置的是：`可能为空的列名指定jdbcType`

## **① 单个参数** ##

对于单个参数，mybatis不会做特殊处理，可以接受基本类型，对象类型，集合类型的值。这种情况MyBatis可直接使用这个参数，不需要经过任何处理。 `#{参数名/任意名}：取出参数值`。

**不进行@Param命名**

方法：public Employee getEmpById(Integer id);
    取值：#{id} 或者#{id2}

**进行@Param命名**

方法：public Employee getEmpById(@Param("name")Integer id);
    取值：#{ id}  或者#{ name}

## **② 多个参数(没有使用@Param命名)** ##

对于多个参数，mybatis会做特殊处理。多个参数会被封装成 一个map。

> key：param1…paramN,或者参数的索引也可以  
> value：传入的参数值  
> \#\{\}就是从map中获取指定的key的值；

实例如下：

方法：public Employee getEmpByIdAndLastName(Integer id,String lastName);
    取值：#{param1},#{param2}
    取值：#{0},#{1}

## **③ 多个参数使用@Param命名参数** ##

也可以对参数进行指定名称处理，使用指定的名称进行取值。明确指定封装参数时map的key，多个参数会被封装成 一个map。

> key：使用@Param注解指定的值  
> value：参数值  
> \#\{指定的key\}取出对应的参数值

实例如下：

方法：public Employee getEmpByIdAndLastName(@Param("id")Integer id,@Param("name")String lastName);
    取值：#{id},#{name}
    取值：#{param1},#{param2}

更多实例：

public Employee getEmp(@Param("id")Integer id,String lastName);
    	取值：id==>#{id/param1} lastName==>#{param2}
    
    public Employee getEmp(Integer id,@Param("e")Employee emp);
    	取值：id==>#{param1} lastName===>#{param2.lastName/e.lastName}

--------------------

## **④ 不同参数类型的处理** ##

*  POJO
    
    如果多个参数正好是我们业务逻辑的数据模型，我们就可以直接传入pojo：`#{属性名}：取出传入的pojo的属性值`
 *  Map
    
    如果多个参数不是业务模型中的数据，没有对应的pojo，不经常使用，为了方便，我们也可以传入map
    
        <select id="getEmpByMap" parameterType="hashmap" resultType="com.bean.Employee">
        	select * from ${tableName} where id=${id} and last_name=#{lastName}
        </select>
        #{key}：取出map中对应的值
 *  TO  
    如果多个参数不是业务模型中的数据，但是经常要使用，推荐来编写一个TO（Transfer Object）数据传输对象
    
        Page{
        	int index;
        	int size;
        }
 *  集合类型  
    如果是Collection（List、Set）类型或者是数组，也会特殊处理。也是把传入的list或者数组封装在map中。
    
        key：Collection(collection),如果是List还可以使用这个key(list)，数组(array)
        public Employee getEmpById(List<Integer> ids);
        取值：取出第一个id的值：   #{list[0]}

mybatis中参数解析的源码实例如下(`org.apache.ibatis.reflection.ParamNameResolver.public Object getNamedParams(Object[] args)`)：

//假设args集合为：[1,"tom"]
      public Object getNamedParams(Object[] args) { 
        final int paramCount = names.size();
         //1、参数为null直接返回
        if (args == null || paramCount == 0) { 
          return null;
        } else if (!hasParamAnnotation && paramCount == 1) { 
         //2、如果只有一个元素，并且没有Param注解；args[0]：单个参数直接返回
          return args[names.firstKey()];
        } else { 
       	 //3、多个元素或者有Param标注
          final Map<String, Object> param = new ParamMap<Object>();
          int i = 0;
         // 4、遍历names集合； e.g:{0=id, 1=lastName}
          for (Map.Entry<Integer, String> entry : names.entrySet()) { 
          //names集合的value作为key; names集合的key又作为取值的参考
          //e.g: param.put("id",1);
            param.put(entry.getValue(), args[entry.getKey()]);
            // add generic param names (param1, param2, ...)
            final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
            // ensure not to overwrite parameter named with @Param
            if (!names.containsValue(genericParamName)) { 
            //e.g:param.put("param1",1);
              param.put(genericParamName, args[entry.getKey()]);
            }
            i++;
          }
          return param;
        }
      }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qYW51cy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020012610525244.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9qYW51cy5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70