mybatis查询语句揭秘之参数解析

一、前言

通过前面我们也知道,通过getMapper方式来进行查询,最后会通过mapperMehod类,对接口中传来的参数也会在这个类里面进行一个解析,随后就传到对应位置,与sql里面的参数进行一个匹配,最后获取结果。对于mybatis通常传参(这里忽略掉Rowbounds和ResultHandler两种类型)有几种方式。

1、javabean类型参数

2、非javabean类型参数

注意,本文是基于mybatis3.5.0版本进行分析。

1、参数的存储

2、对sql语句中参数的赋值

下面将围绕这这两方面进行

二、参数的存储

先看下面一段代码

@Test
 public void testSelectOrdinaryParam() throws Exception{
 SqlSession sqlSession = MybatisUtil.getSessionFactory().openSession();
 UserMapper mapper = sqlSession.getMapper(UserMapper.class);
 List<User> userList = mapper.selectByOrdinaryParam("张三1号");
 System.out.println(userList);
 sqlSession.close();
 }
 List<User> selectByOrdinaryParam(String username); // mapper接口
 <select id="selectByOrdinaryParam" resultMap="BaseResultMap">
 select
 <include refid="Base_Column_List"/>
 from user
 where username = #{username,jdbcType=VARCHAR}
 </select>

或许有的人会奇怪,这个mapper接口没有带@Param注解,怎么能在mapper配置文件中直接带上参数名呢,不是会报错吗,

在mybatis里面,对单个参数而言,直接使用参数名是没问题的,如果是多个参数就不能这样了,下面我们来了解下,mybatis的解析过程,请看下面代码,位于MapperMehod类的内部类MethodSignature构造函数中

public MethodSignature(Configuration configuration, Class<?> mapperInterface, Method method) {
 Type resolvedReturnType = TypeParameterResolver.resolveReturnType(method, mapperInterface);
 if (resolvedReturnType instanceof Class<?>) {
 this.returnType = (Class<?>) resolvedReturnType;
 } else if (resolvedReturnType instanceof ParameterizedType) {
 this.returnType = (Class<?>) ((ParameterizedType) resolvedReturnType).getRawType();
 } else {
 this.returnType = method.getReturnType();
 }
 this.returnsVoid = void.class.equals(this.returnType);
 this.returnsMany = configuration.getObjectFactory().isCollection(this.returnType) || this.returnType.isArray();
 this.returnsCursor = Cursor.class.equals(this.returnType);
 this.returnsOptional = Optional.class.equals(this.returnType);
 this.mapKey = getMapKey(method);
 this.returnsMap = this.mapKey != null;
 this.rowBoundsIndex = getUniqueParamIndex(method, RowBounds.class);
 this.resultHandlerIndex = getUniqueParamIndex(method, ResultHandler.class);
 // 参数解析类
 this.paramNameResolver = new ParamNameResolver(configuration, method);
 }

参数的存储解析皆由ParamNameResolver类来进行操作,先看下该类的构造函数

/**
 * config 全局的配置文件中心
 * method 实际执行的方法,也就是mapper接口中的抽象方法
 *
 */
public ParamNameResolver(Configuration config, Method method) {
 // 获取method中的所有参数类型
 final Class<?>[] paramTypes = method.getParameterTypes();
 // 获取参数中含有的注解,主要是为了@Param注解做准备
 final Annotation[][] paramAnnotations = method.getParameterAnnotations();
 final SortedMap<Integer, String> map = new TreeMap<>();
 // 这里实际上获取的值就是参数的个数。也就是二维数组的行长度
 int paramCount = paramAnnotations.length;
 // get names from @Param annotations
 for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
 // 排除RowBounds和ResultHandler两种类型的参数
 if (isSpecialParameter(paramTypes[paramIndex])) {
 // skip special parameters
 continue;
 }
 String name = null;
 // 如果参数中含有@Param注解,则只用@Param注解的值作为参数名
 for (Annotation annotation : paramAnnotations[paramIndex]) {
 if (annotation instanceof Param) {
  hasParamAnnotation = true;
  name = ((Param) annotation).value();
  break;
 }
 }
 // 即参数没有@Param注解
 if (name == null) {
 // 参数实际名称,其实这个值默认就是true,具体可以查看Configuration类中的该属性值,当然也可以在配置文件进行配置关闭
 // 如果jdk处于1.8版本,且编译时带上了-parameters 参数,那么获取的就是实际的参数名,如methodA(String username)
 // 获取的就是username,否则获取的就是args0 后面的数字就是参数所在位置
 if (config.isUseActualParamName()) {
  name = getActualParamName(method, paramIndex);
 }
 // 如果以上条件都不满足,则将参数名配置为 0,1,2../
 if (name == null) {
  // use the parameter index as the name ("0", "1", ...)
  // gcode issue #71
  name = String.valueOf(map.size());
 }
 }
 map.put(paramIndex, name);
 }
 names = Collections.unmodifiableSortedMap(map);
 }

这个构造函数的作用就是对参数名称进行一个封装,得到一个  “参数位置-->参数名称 “ 的一个map结构,这样做的目的是为了替换参数值,我们也清楚,实际传过来的参数就是一个一个Object数组结构,我们也可以将它理解为map结构。即 index --> 参数值,此就和之前的 map结构有了对应,也就最终可以得到一个 参数名称  --->  参数值 的一个对应关系。

public Object execute(SqlSession sqlSession, Object[] args) {
 Object result;
 switch (command.getType()) {
 // 其它情况忽略掉
 case SELECT:
 // 这里参数中含有resultHandler,暂不做讨论
 if (method.returnsVoid() && method.hasResultHandler()) {
  executeWithResultHandler(sqlSession, args);
  result = null;
 } else if (method.returnsMany()) {// 1、 返回结果为集合类型或数组类型,这种情况适用于大多数情况
  result = executeForMany(sqlSession, args);
 } else if (method.returnsMap()) {// 返回结果为Map类型
  result = executeForMap(sqlSession, args);
 } else if (method.returnsCursor()) {
  result = executeForCursor(sqlSession, args);
 } else {// 2、返回结果javabean类型,或普通的基础类型及其包装类等
  Object param = method.convertArgsToSqlCommandParam(args);
  result = sqlSession.selectOne(command.getName(), param);
  // 对java8中的optional进行了支持
  if (method.returnsOptional() &&
  (result == null || !method.getReturnType().equals(result.getClass()))) {
  result = Optional.ofNullable(result);
  }
 }
 break;
 default:
 throw new BindingException("Unknown execution method for: " + command.getName());
 }
 if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
 throw new BindingException("Mapper method '" + command.getName()
  + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
 }
 return result;
 }

这里主要分析1情况。对于2情况也就是接下来要说的参数赋值情况,不过要先介绍下method.convertArgsToSqlCommandParam这代码带来的一个结果是怎么样的

public Object convertArgsToSqlCommandParam(Object[] args) {
 return paramNameResolver.getNamedParams(args);
 }

public Object getNamedParams(Object[] args) {
 final int paramCount = names.size();
 if (args == null || paramCount == 0) {
 return null;
 } else if (!hasParamAnnotation && paramCount == 1) {// 1
 return args[names.firstKey()];
 } else {
 final Map<String, Object> param = new ParamMap<>();
 int i = 0;
 for (Map.Entry<Integer, String> entry : names.entrySet()) {
 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)) {
  param.put(genericParamName, args[entry.getKey()]);
 }
 i++;
 }
 return param;
 }
 }

可以很清楚的知道最后又调用了ParamNameResolver类的getNamedPaams方法,这个方法的主要作用就是,将原来的参数位置 -->  参数名称  映射关系转为  参数名称 --->参数值 ,并且新加一个参数名和参数值得一个对应关系。即

param1  ->参数值1

param2 -->参数值2

当然如果只有一个参数,如代码中的1部分,若参数没有@Param注解,且只有一个参数,则不会加入上述的一个对象关系,这也就是前面说的,对于单个参数,可以直接在sql中写参数名就ok的原因。下面回到前面

private <E> Object executeForMany(SqlSession sqlSession, Object[] args) {
 List<E> result;
 // 获取对应的一个映射关系,param类型有可能为map或null或参数实际类型
 Object param = method.convertArgsToSqlCommandParam(args);
 if (method.hasRowBounds()) {
 RowBounds rowBounds = method.extractRowBounds(args);
 result = sqlSession.<E>selectList(command.getName(), param, rowBounds);
 } else {
 result = sqlSession.<E>selectList(command.getName(), param);
 }
 // 如果返回结果类型和method的返回结果类型不一致,则进行转换数据结构
 // 其实就是result返回结果不是List类型,而是其他集合类型或数组类型
 if (!method.getReturnType().isAssignableFrom(result.getClass())) {
 if (method.getReturnType().isArray()) {// 为数组结果
 return convertToArray(result);
 } else {// 其他集合类型
 return convertToDeclaredCollection(sqlSession.getConfiguration(), result);
 }
 }
 return result;
 }

代码也不复杂,就是将得到的参数对应关系传入,最终获取结果,根据实际需求进行结果转换。

3、对sql语句中参数的赋值

其实前面一篇博客中也有涉及到。参数赋值的位置在DefaultParameterHandler类里面,可以查看前面一篇博客,这里不做过多介绍,传送门  mybatis查询语句的背后之封装数据

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对我们的支持。

时间: 2019-04-05

Mybatis实现增删改查及分页查询的方法

MyBatis的前身就是iBatis.是一个数据持久层(ORM)框架. MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持 久层框架.MyBatis消除了几乎所有的JDBC 代码和参数的手工 设置以及结果集的检索.MyBatis使用简单的XML或注解用于 配置和原始映射,将接口和Java 的POJOs(Plan Old Java Objects,普通的Java 对象)映射成数据库中的记录.每个 MyBatis应用程序主要都是使用SqlSessionFactory实例的,一个 SqlS

Mybatis查不到数据查询返回Null问题

mybatis突然查不到数据,查询返回的都是Null,但是 select count(*) from xxx查询数量,返回却是正常的. Preparing: SELECT id,a9004,a9005,a9015 FROM a90 where a9010 = ? ORDER BY id LIMIT 1 [DEBUG] org.apache.ibatis.logging.jdbc.BaseJdbcLogger.debug(BaseJdbcLogger.java:139):http-bio-8080

Mybatis查询语句结果集的总结大全

简单查询-resultType 数据准备 字段 注释 SNO 学号 SNAME 学生名字 SSEX 性别 SBIRITHDAY 生日 CLASS 班级 <!--建表语句:--> create table TEST.STUDENT ( SNO varchar(3) not null, SNAME varchar(4) not null, SSEX varchar(2) not null, SBIRTHDAY datetime null, CLASS varchar(5) null ) <!

mybatis查询语句揭秘之封装数据

一.前言 继上一篇mybatis查询语句的背后,这一篇主要围绕着mybatis查询的后期操作,即跟数据库交互的时候.由于本人也是一边学习源码一边记录,内容难免有错误或不足之处,还望诸位指正,本文只可当参考作用.谨记! 二.分析 继上一篇博文的查询例子,mybatis在最后的查询最终会走SimpleExecutor类的doQuery方法, @Override public <E> List<E> doQuery(MappedStatement ms, Object parameter

Mybatis多表关联查询的实现(DEMO)

概要 本节要实现的是多表关联查询的简单demo.场景是根据id查询某商品分类信息,并展示该分类下的商品列表. 一.Mysql测试数据 新建表Category(商品分类)和Product(商品),并插入几条测试数据. create table Category ( Id int not null auto_increment, Name varchar(80) null, constraint pk_category primary key (Id) ); INSERT INTO category

mybatis查询语句的背后揭秘

一.前言 在先了解mybatis查询之前,先大致了解下以下代码的为查询做了哪些铺垫,在这里我们要事先了解,myabtis会默认使用DefaultSqlSessionFactory作为sqlSessionFactory的实现类,而sqlSession的默认实现类为DefaultSqlSession public static SqlSessionFactory getSessionFactory() throws IOException { Reader reader = Resources.ge

MyBatis中的模糊查询语句

其实就只有一条sql语句 <select id = "search" resultType = "material"> select material_id,material_num,material_name,material_type,material_model,id from material where material_name like '%${value}%' or material_num like '%${value}%' </

Mybatis模糊查询和动态sql语句的用法

Mybatis 模糊查询和动态sql语句 模糊查询 对数据库最常用的操作就是查询了,但是如何使用Mybatis进行模糊查询呢?下面先看一个简单的模糊查询 <select id="select01" resultMap="BasicResultMap"> SELECT * FROM oa_employee WHERE emp_name LIKE #{asd} </select> 这是一条伪模糊查询, 因为没有实现真正的模糊 "%&qu

Mybatis传递多个参数进行SQL查询的用法

PS:ibatis3如何传递多个参数有两个方法:一种是使用java.Map,另一种是使用JavaBean. 当只向xxxMapper.xml文件中传递一个参数时,可以简单的用"_parameter"来接收xxxMapper.java传递进来的参数,并代入查询,比如说这样: (1)xxxMapper.java文件中这样定义: List<String> selectAllAirportCode(Boolean mapping); (2)这时在对应的xxxMapper.xml文件

详解MyBatis直接执行SQL查询及数据批量插入

一.直接执行SQL查询: 1.mappers文件节选 <resultMap id="AcModelResultMap" type="com.izumi.InstanceModel"> <result column="instanceid" property="instanceID" jdbcType="VARCHAR" /> <result column="insta

详解MyBatis的getMapper()接口、resultMap标签、Alias别名、 尽量提取sql列、动态操作

一.getMapper()接口 解析:getMapper()接口 IDept.class定义一个接口, 挂载一个没有实现的方法,特殊之处,借楼任何方法,必须和小配置中id属性是一致的 通过代理:生成接口的实现类名称,在MyBatis底层维护名称$$Dept_abc,selectDeptByNo() 相当于是一个强类型 Eg 第一步:在cn.happy.dao中定义一个接口 package cn.happy.dao; import java.util.List; import cn.happy.e

详解Mybatis框架SQL防注入指南

前言 SQL注入漏洞作为WEB安全的最常见的漏洞之一,在java中随着预编译与各种ORM框架的使用,注入问题也越来越少.新手代码审计者往往对Java Web应用的多个框架组合而心生畏惧,不知如何下手,希望通过Mybatis框架使用不当导致的SQL注入问题为例,能够抛砖引玉给新手一些思路. 一.Mybatis的SQL注入 Mybatis的SQL语句可以基于注解的方式写在类方法上面,更多的是以xml的方式写到xml文件.Mybatis中SQL语句需要我们自己手动编写或者用generator自动生成.

详解MyBatis逆向工程

1.什么是mybatis逆向工程 在使用mybatis时需要程序员自己编写sql语句,针对单表的sql语句量是很大的,mybatis官方提供了一种根据数据库表生成mybatis执行代码的工具,这个工具就是一个逆向工程. 逆向工程:针对数据库单表-->生成代码(mapper.xml.mapper.java.pojo..) mybatis-generator-core-1.3.2.jar-逆向工程运行所需要的jar核心 包 2.配置逆向工程的配置文件 配置文件generatorConfig.xml

详解MyBatis Generator自动创建代码(dao,mapping,poji)

连接的数据库为SQL server2008,所以需要的文件为sqljdbc4.jar 使用的lib库有: 在lib库目录下新建一个src文件夹用来存放生成的文件,然后新建generatorConfig.xml 里面代码为: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis G

详解MyBatis配置typeAliases的方法

0x00:前言参考 之前的<MyBatis 中 SqlMapConfig 配置文件详解>记了一下 MyBatis 中的核心配置文件各个标签的作用和使用场景,这篇文章细说一下配置文件中 typeAliases 标签的详细使用. 0x01:标签介绍 在 MyBatis 的 sql 映射配置文件中,需要使用 paramterType.resultType 来设置 sql 语句的输入输出参数,一般参数都是基本的数据类型或封装类型,但都需要声明该类型的全路径,java.lang.String,或者 cn

MyBatis直接执行SQL的工具SqlMapper

可能有些人也有过类似需求,一般都会选择使用其他的方式如Spring-JDBC等方式解决. 能否通过MyBatis实现这样的功能呢? 为了让通用Mapper更彻底的支持多表操作以及更灵活的操作,在2.2.0版本增加了一个可以直接执行SQL的新类SqlMapper. 我们来了解一下SqlMapper. SqlMapper提供的方法 SqlMapper提供了以下这些公共方法: Map<String,Object> selectOne(String sql) Map<String,Object&

详解Mybatis中的 ${} 和 #{}区别与用法

Mybatis 的Mapper.xml语句中parameterType向SQL语句传参有两种方式:#{}和${} 我们经常使用的是#{},一般解说是因为这种方式可以防止SQL注入,简单的说#{}这种方式SQL语句是经过预编译的,它是把#{}中间的参数转义成字符串,举个例子: select * from student where student_name = #{name} 预编译后,会动态解析成一个参数标记符?: select * from student where student_name

详解mybatis plus使用insert没有返回主键的处理

项目使用springboot搭建.最初的时候是使用mybatis,后来升级到mybatis plus.按照mp的官网介绍,使用mp的insert方法,对于自增的数据库表,mp会把主键写入回实例的对应属性.但实际操作起来,却没有主键. entity 类设置如下: @TableName(value = "USERINFO") public class UserInfo { /** * 指定自增策略 */ @TableId(value = "user_id",type =

详解MyBatis XML配置解析

MyBatis核心配置文件 <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <environm