mybatis之参数处理

最新推荐文章于 2024-01-03 22:16:23 发布

明湖起风了

最新推荐文章于 2024-01-03 22:16:23 发布

阅读量329

点赞数

分类专栏： myBatis 文章标签： mybatis java mysql

原文链接：https://frxcat.fun/pages/c86777/#%E5%8F%82%E6%95%B0%E5%A4%84%E7%90%86

版权

myBatis 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

参数处理

单个参数&多个参数&命名参数

单个参数：mybatis不会做特殊处理，
- #{参数名/任意名}：取出参数值。
多个参数：mybatis会做特殊处理。
- 通常操作
  - 方法：public Employee getEmpByIdAndLastName(Integer id,String lastName);
  - 取值：#{id},#{lastName}
- 上述操作会抛出异常：org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [1, 0, param1, param2]
- 多个参数会被封装成一个map，
  - key：param1…paramN,或者参数的索引也可以
  - value：传入的参数值
- #{}就是从map中获取指定的key的值；
【命名参数】：明确指定封装参数时map的key；@Param(“id”)
- 多个参数会被封装成一个map，
  - key：使用@Param注解指定的值
  - value：参数值
- #{指定的key}取出对应的参数值

public interface EmployeeMapper {

    public Employee getEmpByIdAndLastName(@Param("id") Integer id, @Param("lastName") String lastName);

    public Employee getEmpByIdAndLastName02(Integer id,String lastName);
}

    <select id="getEmpById" resultType="com.frx01.mybatis.bean.Employee" databaseId="mysql">
        select id,last_name lastName,gender,email from tbl_employee where id=#{id}
    </select>

    <!--public Employee getEmpByIdAndLastName(@Param("id") Integer id,@Param("lastName") String lastName);-->
    <select id="getEmpByIdAndLastName" resultType="com.frx01.mybatis.bean.Employee">
        select * from tbl_employee where id=#{id} and last_Name=#{lastName}
    </select>

    <select id="getEmpByIdAndLastName02" resultType="com.frx01.mybatis.bean.Employee">
        select * from tbl_employee where id=#{0} and last_Name=#{1}
    </select>

    @Test
    public void test04Parameters() throws IOException {
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        //1.获取到的SqlSession不会自动提交数据
        SqlSession openSession = sqlSessionFactory.openSession(true);
        try {
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
            //1.单个参数：mybatis不会做特殊处理
            //Employee empById = mapper.getEmpById(1);
            //System.out.println(empById);

            //2.多个参数:未作处理 ，mapper直用#{id},#{lastName}会抛异常
            //Employee employee = mapper.getEmpByIdAndLastName(1, "tom");
            //System.out.println(employee);
            //org.apache.ibatis.exceptions.PersistenceException:
            //### Error querying database.  Cause: org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [0, 1, param1, param2]
            //### Cause: org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [0, 1, param1, param2]
            
            //多个参数会被封装成 一个map
            //key：param1...paramN,或者参数的索引0, 1..也可以(这种方法的可读性较差)
            //value：传入的参数值
            System.out.println(mapper.getEmpByIdAndLastName02(1,"tom"));

            //3.
            //【命名参数】：明确指定封装参数时map的key；@Param("id")
            System.out.println(mapper.getEmpByIdAndLastName(1, "tom"));
        } finally {
            openSession.close();

        }
    }

POJO&Map&TO

POJO：如果多个参数正好是我们业务逻辑的数据模型，我们就可以直接传入pojo；
- #{属性名}：取出传入的pojo的属性值
Map：如果多个参数不是业务模型中的数据，没有对应的pojo，不经常使用，为了方便，我们也可以传入map
- #{key}：取出map中对应的值
如果多个参数不是业务模型中的数据，但是经常要使用，推荐来编写一个TO（Transfer Object）数据传输对象，如：

Page{
	int index;
	int size;
}

public interface EmployeeMapper {

    public Employee getEmpByMap(Map<String,Object> map);
}

  <!--public Employee getEmpByMap(Map<String,Object> map);-->
    <select id="getEmpByMap" resultType="com.frx01.mybatis.bean.Employee">
        select * from employee where id = #{id} and last_name=#{lastName}
    </select>

    @Test
    public void test04Parameters() throws IOException {
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        //1.获取到的SqlSession不会自动提交数据
        SqlSession openSession = sqlSessionFactory.openSession(true);
        try {
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);

            //4.
            //传入map
            HashMap<String, Object> map = new HashMap<>();
            map.put("id",1);
            map.put("lastName","Tom");
            Employee empByMap = mapper.getEmpByMap(map);
            System.out.println(empByMap);
        } finally {
            openSession.close();

        }
    }

参数封装扩展思考

思考========

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)
- public Employee getEmpById(List<Integer> ids);
  - 取值：取出第一个id的值： #{list[0]}

#源码分析-参数封装map的过程

结合源码，mybatis怎么处理参数

(@Param(“id”)Integer id,@Param(“lastName”)String lastName);
ParamNameResolver解析参数封装map的；
names：{0=id, 1=lastName}；构造器的时候就确定好了

确定流程：

获取每个标了param注解的参数的@Param的值：id，lastName；赋值给name;
每次解析一个参数给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;
    }
  }
}

总结：参数多时会封装map，为了不混乱，我们可以使用@Param来指定封装时使用的key；#{key}就可以取出map中的值；

##与$取值区别

#{}和${}都可以获取map中的值或者pojo对象属性的值；

select * from tbl_employee where id=${id} and last_name=#{lastName}
#Preparing:
select * from tbl_employee where id=2 and last_name=?

区别：

#{} : 是以预编译的形式，将参数设置到sql语句中；PreparedStatement；防止sql注入
${} : 取出的值直接拼装在sql语句中；会有安全问题；

大多情况下，我们去参数的值都应该去使用#{}。

原生jdbc不支持占位符的地方我们就可以使用${}进行取值，比如分表、排序。。。；按照年份分表拆分

select * from ${year}_salary where xxx;
select * from tbl_employee order by ${f_name} ${order}

取值时指定参数相关规则

#{}:更丰富的用法：

规定参数的一些规则：

javaType
jdbcType
mode（存储过程）
numericScale
resultMap
typeHandler
jdbcTypeName
expression（未来准备支持的功能）

例如：jdbcType

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

在我们数据为null的时候，有些数据库可能不能识别mybatis对null的默认处理。比如Oracle DB（报错）；
JdbcType OTHER：无效的类型；因为mybatis对所有的null都映射的是原生Jdbc的OTHER类型，Oracle DB不能正确处理;

由于全局配置中：jdbcTypeForNull=OTHER，Oracle DB不支持，两种解决方法：

在mapper文件中写#{email,jdbcType=NULL};
在全局配置文件<setting name="jdbcTypeForNull" value="NULL"/>

原文连接：XML 映射文件 | xustudyxu's Blog (frxcat.fun)