MyBatis3系列__04CRUD以及参数处理

本文将会简单介绍一下MyBatis的CRUD以及结合源码讲解一下MyBatis对参数的处理。

作为一个ORM框架,最基本的使用也就是CRUD了,MyBatis提供了两种方法:xml配置文件和动态注解。个人推荐xml配置文件,方式毕竟注解方式还是要将sql写在代码中,并且动态查询的时候还用嵌套script标签,相当麻烦,扯远了,回归主题。

## 1.CRUD

      创建一个dao接口,定义方法:

```

package com.mybatis.learn.dao;

import com.mybatis.learn.bean.Employee;

public interface EmployeeMapper {

    public Employee getEmpById(Integer id);

    public int addEmployee(Employee employee);

    public boolean updateEmployeeById(Employee employee);

    public void deleteEmployeeById(Integer id);

}

```

    创建一个xml文件并在其中编写sql语句,注意将Mapper与xml文件进行绑定(在mybatis-config.xml文件中使用Mapper标签)。

```

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE mapper

        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.mybatis.learn.dao.EmployeeMapper">

    <!--

        resultType:指定查询结果的返回值类型;MyBatis会自动创建一个ResultMap对象,

            然后基于查找出来的属性名进行键值对封装,看到返回类型是Blog对象,

            从ResultMap中取出与Blog对象对应的键值对进行赋值。

        resultMap:原理同上,当提供的返回类型是resultMap时,因为Map不能很好表示领域模型,

            就需要自己再进一步的把它转化为对应的对象,这常常在复杂查询中很有作用。

    -->

    <select id="getEmpById" resultType="com.mybatis.learn.bean.Employee">

    select id, last_name lastName, gender, email from tbl_employee where id = #{id}

  </select>

<!--

    useGeneratedKeys: true为使用主键绑定,

    keyProerty: 指定主键,

    parameterKey: 指定参数类型

-->

    <insert id="addEmployee" parameterType="com.mybatis.learn.bean.Employee"

            statementType="PREPARED" useGeneratedKeys="true" keyProperty="id">

        insert into tbl_employee (last_name, gender, email) values (#{lastName}, #{gender}, #{email})

    </insert>

    <update id="updateEmployeeById" parameterType="com.mybatis.learn.bean.Employee">

        update tbl_employee set last_name=#{lastName}, gender=#{gender}, email=#{email} where id=#{id}

    </update>

    <delete id="deleteEmployeeById" parameterType="java.lang.Integer">

        delete from tbl_employee where id=#{id}

    </delete>

</mapper>

```

    其中, 各自方法的标签见文知意。需要注意的是,namespace写你的Mapper类的全类名,然后各自的方法中的id填写你的方法名,从而完成了绑定。

## 2.参数处理

    要是只能一句话概括的话,MyBatis会将参数封装为一个map,这是结论,下面详细说明:

    大致分为两种情况:

### 1.单个参数且没有@param注解时:

      MyBatis不会进行特殊处理(看上去,其实这种情况只是处理的一种解决方案,后面结合源码会详细介绍),即:#{参数名/任意名}:取出参数值。注意,#{}中不一定要是准确的参数名,比如错把id写成了iddd一样可以运行,因为MyBatis只是取出对应位置的值而已。

### 2.多个参数或者单个参数有@param注解时:

      MyBatis会将参数封装成一个map:

          key:param1...paramN,或者参数的索引也可以

  value:传入的参数值

          #{}就是从map中获取指定的key的值;

在MyBatis处理参数过程中,可能会抛出的异常:(当你写成#{id}并且没有加上@param(“id”)时)

      org.apache.ibatis.binding.BindingException:

Parameter 'id' not found.

Available parameters are [1, 0, param1, param2]

报这个异常的例子:

```

public Employee getEmpByIdAndLastName(Integer id,String lastName);

取值:#{id},#{lastName}

```

    当然,当你的参数过多时,建议你传入的参数为一个POJO,这样就无需使用@param,也能正常传参。

            #{属性名}:取出传入的pojo的属性值 。

    而当没有对应的POJO时,也可以直接传入一个map,反正MyBatis也会封装一个map,你只需在存入

            map时指定号key和value就行了。

    如果多个参数不是业务模型中的数据,但是经常要使用,推荐来编写一个TO(Transfer Object)数据

          传输对象

          Page{

        int index;

        int size;

          }

OK,相信你大致明白了,来搞一下练习吧:

```

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}

/**

特别注意:如果是Collection(List、Set)类型或者是数组,也会特殊处理。也是把传入的list或者数组封装在map中。key:Collection(collection),如果是List还可以使用这个key(list),数组(array)

**/

public Employee getEmpById(List<Integer> ids);

取值:取出第一个id的值:  #{list[0]}

```

Ok,现在贴一下部分源码,我加了一点注解:

```

(@Param("id")Integer id,@Param("lastName")String lastName);

ParamNameResolver解析参数封装map的;

//1、names:{0=id, 1=lastName};构造器的时候就确定好了

确定流程:

1.获取每个标了param注解的参数的@Param的值:id,lastName;  赋值给name;

2.每次解析一个参数给map中保存信息:(key:参数索引,value:name的值)

name的值:

标注了param注解:注解的值

没有标注:

1.全局配置:useActualParamName(jdk1.8):name=参数名

2.name=map.size();相当于当前元素的索引

{0=id, 1=lastName,2=2}

//args【1,"Tom",'hello'】:

public Object getNamedParams(Object[] args) {

    final int paramCount = names.size();

    //1、参数为null直接返回

    if (args == null || paramCount == 0) {

      return null; 

  //2、如果只有一个元素,并且没有Param注解;args[0]:单个参数直接返回

    } else if (!hasParamAnnotation && paramCount == 1) {

      return args[names.firstKey()];

    //3、多个元素或者有Param标注

    } else {

      final Map<String, Object> param = new ParamMap<Object>();

      int i = 0; 

      //4、遍历names集合;{0=id, 1=lastName,2=2}

      for (Map.Entry<Integer, String> entry : names.entrySet()) {

          //names集合的value作为key;  names集合的key又作为取值的参考args[0]:args【1,"Tom"】:

      //eg:{id=args[0]:1,lastName=args[1]:Tom,2=args[2]}

        param.put(entry.getValue(), args[entry.getKey()]);   

        // add generic param names (param1, param2, ...)param

        //额外的将每一个参数也保存到map中,使用新的key:param1...paramN

        //效果:有Param注解可以#{指定的key},或者#{param1}

        final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);

        // ensure not to overwrite parameter named with @Param

        if (!names.containsValue(genericParamName)) {

          param.put(genericParamName, args[entry.getKey()]);

        }

        i++;

      }

      return param;

    }

  }

}

```

一点补充:

$ 和#的不同:

```

//  #{}是一般情况都使用的,在MyBatis预编译sql的时候会将对应的#{参数名}替换为?,还能防止sql注入。

//  ${}的存在也是有价值的,虽然会引起sql注入,但是能解决一些#{}无法搞定的场景,比如排序,表名字等等,举例如下:

@Select("select * from user where ${column} = #{value}")

User findByColumn(@Param("column") String column, @Param("value") String value);

//其中 ${column} 会被直接替换,而 #{value} 会被使用 ? 预处理.

```

###  #{}:更丰富的用法:

规定参数的一些规则:

javaType、 jdbcType、 mode(存储过程)、 numericScale、

resultMap、 typeHandler、 jdbcTypeName、 expression(未来准备支持的功能);

jdbcType通常需要在某种特定的条件下被设置:

在我们数据为null的时候,有些数据库可能不能识别mybatis对null的默认处理。比如Oracle(报错);

JdbcType OTHER:无效的类型;因为mybatis对所有的null都映射的是原生Jdbc的OTHER类型,oracle不能正确处理;

由于全局配置中:jdbcTypeForNull=OTHER;oracle不支持;两种办法

1、#{email,jdbcType=OTHER};

2、jdbcTypeForNull=NULL

<setting name="jdbcTypeForNull" value="NULL"/>

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,657评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,889评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,057评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,509评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,562评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,443评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,251评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,129评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,561评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,779评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,902评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,621评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,220评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,838评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,971评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,025评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,843评论 2 354

推荐阅读更多精彩内容