Mybatis介绍之参数传递

Stella981
• 阅读 540

转载自 :https://blog.csdn.net/u010643307/article/details/70148702

1     使用Mapper接口时参数传递方式

       Mybatis在使用Mapper接口进行编程时,其实底层是采用了动态代理机制,表面上是调用的Mapper接口,而实际上是通过动态代理调用的SqlSession的对应方法,如selectOne(),有兴趣的朋友可以查看DefaultSqlSession的getMapper()方法实现,其最终会获得一个代理了Mapper接口的MapperProxy对象。MapperProxy对象在调用Mapper接口方法时会把传递的参数做一个转换,然后把转换后的参数作为入参调用SqlSession对应的操作方法(如selectOne、insert等)。转换过程可以参考MapperMethod的execute()方法实现。简单来说是以下规则:

1、如果传递过来是单参数,且没有以@Param注解进行命名,则直接将单参数作为真实的参数调用SqlSession的对应方法。

2、如果传递过来的不是单参数或者是包含以@Param注解进行命名的参数,则会将对应的参数转换为一个Map进行传递。具体规则如下:

2.1、      会把对应的参数按照顺序以param1、param2、paramN这样的形式作为Key存入目标Map中,第一个参数是param1,第N个参数是paramN。

2.2、      如果参数是以@Param注解命名的参数,则以@Param指定的名称作为Key存入目标Map中。

2.3、      如果参数不是以@Param注解命名的,则按照顺序以0、1、N这样的形式作为Key存入目标Map中,第一个参数是0,第N个参数是N。

       我们在Mapper.xml中定义SQL语句中用到的变量最终是以Mybatis按照上述规则把入参转换后的形式来进行解析的。

2     参数引用#与$的区别

       在Mybatis的Mapper.xml文件中为了构建动态的SQL,我们通常需要通过引用传递的参数来达到对应的效果。在引用传递的参数的时候有两种方式,一种是通过“#{var}”的形式引用,一种是通过“${var}”的形式引用。前者会被以预编译的方式传递,即会生成PreparedStatement来处理,对应的参数在SQL中会以“?”占位,然后调用PreparedStatement的相应API设值;而后者则会先处理好变量再执行相应的SQL,即对应的变量会先被替换,再执行替换了变量的SQL。在一个Mapper映射语句中我们可以同时使用“#”和“$”处理变量。

3     采用#{var}的形式处理变量

       采用#{var}的形式来引用变量时,其中的变量会在解析Mapper.xml文件中的语句时就被替换为占位符“?”,同时通过ParameterMapping类记录对应的变量信息。在真正执行对应的语句时会用传递的真实参数根据ParameterMapping信息给PreparedStatement设置参数,具体可参考PreparedStatementHandler的parameterize()方法实现。对应的变量在解析的时候都是以传递进来的参数为基础来解析的,根据前面的介绍我们知道,传递进来的参数只有两种情况,一种是原始类型的单参数,一种是被Mybatis封装过的Map。那对应的参数Mybatis的如何解析的呢?有三种情况。

       第一种,如果真实传递进来的是原始类型,那么对应的属性解析就是就是基于原始类型的属性。比如我们真是传递进来的一个User类型的对象,User对象有id、name等属性,那么我们在Mapper语句中采用#{var}形式访问变量的时候就可以使用#{id}和#{name}。这跟使用${var}形式访问变量是不同的,使用${var}形式时我们需要使用${_parameter.id}和${_parameter.name}。

   <insert id=_"insert"_parameterType=_"com.elim.learn.mybatis.model.User"_useGeneratedKeys=_"true"_ keyColumn=_"id"_ keyProperty=_"id"_>

      insert into t_user(name,username,email,mobile) values(#{name},#{username},#{email},#{mobile})

   

       第二种,如果真实传递进来的是一个Map,那么对应的变量则可以是这个Map里面的Key。比如下面示例中我们的接口方法对应的是两个参数,那最终到执行Mapper语句时会被封装成一个Map,Map里面的Key包含name、1、param1和param2,那么我们在使用的时候就可以使用这些变量。

   List findByNameAndMobile(@Param("name") String name, Stringmobile);

   <select id=_"findByNameAndMobile"_resultType=_"com.elim.learn.mybatis.model.User"_>

      select id,name,username,email,mobile from t_user where name=#{name} and mobile=#{1}

   

       第三种,真实传递进来的参数是可以被已经注册了的TypeHandler进行处理的,则直接使用真实传递进来的参数作为真实的变量值。这也是为什么我们经常可以在Mapper接口里面写delete(Integer id),然后在Mapper语句中直接写#{id}的原因,因为这个时候传递进来的参数是Integer类型,是可以直接被处理的,Mybatis将直接拿它的值作为当前变量id的值,而不会去取传递进来的值的id属性。换句话说,这个时候我们在Mapper语句中定义的变量可以随便命名,随便怎么命名都可以被Mybatis正确的处理。但是通常我们会把它命名为与接口方法参数名称一致,方便阅读。

   void delete(Long id);

   <insert id=_"delete"_ parameterType=_"java.lang.Long"_>

      delete t_user where id=#{id}

   

       关于预编译的参数处理是由DefaultParameterHandler类的setParameters()方法处理,核心代码如下,欲了解更多,可以参考DefaultParameterHandler的完整代码。

  public void setParameters(PreparedStatement ps) {

    ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());

    List parameterMappings =boundSql.getParameterMappings();

    if (parameterMappings != null) {

      for (inti = 0; i < parameterMappings.size(); i++) {

        ParameterMapping parameterMapping = parameterMappings.get(i);

        if (parameterMapping.getMode() != ParameterMode.OUT) {

          Object value;

          String propertyName = parameterMapping.getProperty();

          if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params

            value = boundSql.getAdditionalParameter(propertyName);

          } else if (parameterObject == null) {

            value = null;

          } else if(typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {

            value = parameterObject;

          } else {

            MetaObject metaObject =configuration.newMetaObject(parameterObject);

            value = metaObject.getValue(propertyName);

          }

          TypeHandler typeHandler = parameterMapping.getTypeHandler();

          JdbcType jdbcType = parameterMapping.getJdbcType();

          if (value == null && jdbcType == null) {

            jdbcType = configuration.getJdbcTypeForNull();

          }

          try {

            typeHandler.setParameter(ps, i + 1, value, jdbcType);

          } catch (TypeException e) {

            throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);

          } catch (SQLException e) {

            throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);

          }

        }

      }

    }

  }

4     采用${var}的形式处理变量

       采用“${var}”的形式来引用变量时,其中的变量会在MappedStatement调用getBoundSql()方法获取对应的BoundSql时被替换。${var}中的var可以是如下取值:

1、内置的_parameter变量,对应转换后的传递参数,在只传递单参数且是没有使用@Param注解对参数命名的时候如果我们需要通过${var}的形式来访问传递的单参数,则可以使用${_parameter};

2、如果对应的Mapper接口方法是多参数或者拥有@Param命名的参数时可以使用param1、paramN的形式;

3、如果对应的Mapper接口方法参数是@Param命名的方法参数,则可以使用@Param指定的名称;

4、如果对应的Mapper接口方法拥有多个参数,且拥有没有使用@Param命名的参数,那没有使用@Param命名的参数可以通过0、1、N形式访问。

       根据上述规则如我们有一个findById的方法其接收一个Long类型的参数作为ID,当使用${var}的形式引用变量时则可以写成如下这样:

   <select id=_"findById"_resultType=_"com.elim.learn.mybatis.model.User"_parameterType=_"java.lang.Long"_ >

      select id,name,username,email,mobile from t_user where id=${_parameter}

   

       当我们的Mapper接口方法参数使用了@Param命名的时候,我们还可以使用@Param指定的参数名。

public interface UserMapper {

   User findById(@Param("id") Long id);

}

   <select id=_"findById"_resultType=_"com.elim.learn.mybatis.model.User"_parameterType=_"java.lang.Long"_ >

      select id,name,username,email,mobile from t_user where id=${id}

   

       注意,但是使用了@Param对单参数命名后我们就不能再在Mapper语句中通过${_parameter}来引用接口方法参数传递过来的单参数了,因为此时其已经被包装为一个Map了,如果要通过_parameter来引用的话,我们应该使用${_parameter.param1}或${_parameter.varName},对于上面的示例来说就是${_parameter.param1}或${_parameter.id}。

       下面我们来看一个传递多参数的,假设我们有如下这样的一个Mapper语句及对应的Mapper接口方法,这个Mapper接口方法接收两个参数,第一个参数是用@Param注解指定了参数名为name,第二个参数是没有使用注解的,具体如下。

   

   <select id=_"findByNameAndMobile"_resultType=_"com.elim.learn.mybatis.model.User"_>

      select id,name,username,email,mobile from t_user where name='${name}' and mobile='${1}'

   

   List findByNameAndMobile(@Param("name") String name, Stringmobile);

     那我们的Mapper.xml文件中的对应语句需要Mapper接口方法参数时有哪几种方式呢?按照之前的规则,对于第一个方法参数name而言,因为使用了@Param指定了参数名name,所以我们可以在Mapper.xml文件中通过变量name和param1来引用它,而第二个参数mobile是没有使用@Param指定参数名的,则我们可以使用param2和参数相对位置“1”来引用它。如上面的示例中,我们就是通过第二个参数的相对位置“1”来引用的。如果我们把第二个参数改为${mobile}是引用不到,且系统会报如下错误,有兴趣的朋友可以试一下。

org.apache.ibatis.binding.BindingException: Parameter 'mobile' not found. Available parameters are [1, name, param1, param2]

       一般情况下为了防止SQL注入问题,是不建议直接在where条件中使用${var}的形式访问变量的,通常会用预编译形式的#{var}。而${var}往往是用来传递一些非where条件的内容,比如排序信息,具体用法请根据实际情况决定。

点赞
收藏
评论区
推荐文章
浅梦一笑 浅梦一笑
5个月前
初学 Python 需要安装哪些软件?超级实用,小白必看!
编程这个东西是真的奇妙。对于懂得的人来说,会觉得这个工具是多么的好用、有趣,而对于小白来说,就如同大山一样。其实这个都可以理解,大家都是这样过来的。那么接下来就说一下python相关的东西吧,并说一下我对编程的理解。本人也是小白一名,如有不对的地方,还请各位大神指出01名词解释:如果在编程方面接触的比较少,那么对于软件这一块,有几个名词一定要了解,比如开发环
blmius blmius
1年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
技术小男生 技术小男生
5个月前
linux环境jdk环境变量配置
1:编辑系统配置文件vi/etc/profile2:按字母键i进入编辑模式,在最底部添加内容:JAVAHOME/opt/jdk1.8.0152CLASSPATH.:$JAVAHOME/lib/dt.jar:$JAVAHOME/lib/tools.jarPATH$JAVAHOME/bin:$PATH3:生效配置
光头强的博客 光头强的博客
5个月前
Java面向对象试题
1、请创建一个Animal动物类,要求有方法eat()方法,方法输出一条语句“吃东西”。创建一个接口A,接口里有一个抽象方法fly()。创建一个Bird类继承Animal类并实现接口A里的方法输出一条有语句“鸟儿飞翔”,重写eat()方法输出一条语句“鸟儿吃虫”。在Test类中向上转型创建b对象,调用eat方法。然后向下转型调用eat()方
刚刚好 刚刚好
5个月前
css问题
1、在IOS中图片不显示(给图片加了圆角或者img没有父级)<div<imgsrc""/</divdiv{width:20px;height:20px;borderradius:20px;overflow:h
小森森 小森森
5个月前
校园表白墙微信小程序V1.0 SayLove -基于微信云开发-一键快速搭建,开箱即用
后续会继续更新,敬请期待2.0全新版本欢迎添加左边的微信一起探讨!项目地址:(https://www.aliyun.com/activity/daily/bestoffer?userCodesskuuw5n)\2.Bug修复更新日历2.情侣脸功能大家不要使用了,现在阿里云的接口已经要收费了(土豪请随意),\\和注意
晴空闲云 晴空闲云
5个月前
css中box-sizing解放盒子实际宽高计算
我们知道传统的盒子模型,如果增加内边距padding和边框border,那么会撑大整个盒子,造成盒子的宽度不好计算,在实务中特别不方便。boxsizing可以设置盒模型的方式,可以很好的设置固定宽高的盒模型。盒子宽高计算假如我们设置如下盒子:宽度和高度均为200px,那么这会这个盒子实际的宽高就都是200px。但是当我们设置这个盒子的边框和内间距的时候,那
艾木酱 艾木酱
5个月前
快速入门|使用MemFire Cloud构建React Native应用程序
MemFireCloud是一款提供云数据库,用户可以创建云数据库,并对数据库进行管理,还可以对数据库进行备份操作。它还提供后端即服务,用户可以在1分钟内新建一个应用,使用自动生成的API和SDK,访问云数据库、对象存储、用户认证与授权等功能,可专
Wesley13 Wesley13
1年前
MySQL查询按照指定规则排序
1.按照指定(单个)字段排序selectfromtable_nameorderiddesc;2.按照指定(多个)字段排序selectfromtable_nameorderiddesc,statusdesc;3.按照指定字段和规则排序selec
Wesley13 Wesley13
1年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
helloworld_28799839 helloworld_28799839
5个月前
常用知识整理
Javascript判断对象是否为空jsObject.keys(myObject).length0经常使用的三元运算我们经常遇到处理表格列状态字段如status的时候可以用到vue