4.3 MyBatis_映射文件_参数（Parameters）

╰半橙微兮° 2022-05-30 23:58 194阅读 0赞

先总结一下，后面再一个个解释：

1.  单个参数：直接使用\#\{参数名\}进行取值，mybatis没做特殊处理，参数名可以随便写。
2.  多个参数：使用\#\{param1\}，\#\{param2\}取值
3.  命名参数：通过@param("key")明确指定封装map中的key，就可以通过\#\{key\}取出参数值了
4.  POJO：如果多个参数正好是业务模型，这时候就可以传入业务模型，通过\#\{属性名\}就可以取值了
5.  Map：如果多个参数不是业务模型，而且不经常使用，可以自定义Map传入
6.  TO：如果多个参数不是业务模型，而且经常使用，可以自定义一个TO来传输对象

### 1、单个参数 ###

在配置sql映射文件中，sql语句传入一个参数时，应该怎么传呢

前面我们试验过mybatis不做特殊处理，只需要用  \#\{参数名\} 取出参数值就可以了。

<?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.pjf.mybatis.dao.HotelMapper">
        
        <select id="getHotel" resultType="com.pjf.mybatis.po.Hotel">
            select id,hotel_name as
            hotelName, hotel_address as hotelAddress, price from hotel
            where
         
            id=#{id} 
        </select>
    </mapper>注：事实上这里#{id}，参数名id可以写任何值，因为只有传了一个参数。。

### 2、多个参数 ###

首先举个例子，理所当然，很容易认为是这样去取参数值，直接写\#\{id\}和\#\{price\}

<?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.pjf.mybatis.dao.HotelMapper">
        
        <select id="getHotel" resultType="com.pjf.mybatis.po.Hotel">
            select id,hotel_name as
            hotelName, hotel_address as hotelAddress, price from hotel
            where
            id=#{id} and price =#{price}
        </select>
    </mapper>这样是不对的，运行之后发现报错了

Caused by: org.apache.ibatis.binding.BindingException: 
    Parameter 'id' not found. 
    Available parameters are [arg1, arg0, param1, param2]

事实上，多个参数时，mybatis会做特殊处理，多个参数会被封装成map

key是param1, param2.....或者0、1、2索引值

value是参数值

下面可以再实验下，将参数名改为\#\{param1\},\#\{ param2\}

<?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.pjf.mybatis.dao.HotelMapper">
        
        <select id="getHotel" resultType="com.pjf.mybatis.po.Hotel">
            select id,hotel_name as
            hotelName, hotel_address as hotelAddress, price from hotel
            where
            id=#{param1} and price =#{param2}
        </select>
    </mapper>

可以发现这时候结果就对了

### 3、命名参数 ###

事实上，人们还是习惯使用\#\{id\}和\#\{price\}而不是\#\{param1\}和\#\{param2\}，当然mybatis也提供了解决办法

通过@param("key")明确指定封装map中的key，就可以通过\#\{key\}取出参数值了

@param("key")写在hotelMapper接口上

package com.pjf.mybatis.dao;
    
    import org.apache.ibatis.annotations.Param;
    
    import com.pjf.mybatis.po.Hotel;
    
    public interface HotelMapper {
    
        public Hotel getHotel(@Param("id")Integer i,@Param("price")Integer j);
    
    }
    hotelMapper.xml

<?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.pjf.mybatis.dao.HotelMapper">
        
        <select id="getHotel" resultType="com.pjf.mybatis.po.Hotel">
            select id,hotel_name as
            hotelName, hotel_address as hotelAddress, price from hotel
            where
            id=#{id} and price =#{price}
        </select>
    </mapper>这时候就可以通过#{id}和#{price}取出参数值了。

### 4、map ###

上面是@param("key")指定一个key，那么我们当然也可以自己传入一个Map。

实例：

hotelMapper接口

package com.pjf.mybatis.dao;
    
    import java.util.Map;
    import org.apache.ibatis.annotations.Param;
    import com.pjf.mybatis.po.Hotel;
    
    public interface HotelMapper {
    
        public Hotel getHotel(Map<String,Integer> map);
    
    }

hotelMapper.xml和上面一样

<?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.pjf.mybatis.dao.HotelMapper">
        
        <select id="getHotel" resultType="com.pjf.mybatis.po.Hotel">
            select id,hotel_name as
            hotelName, hotel_address as hotelAddress, price from hotel
            where
            id=#{id} and price =#{price}
        </select>
    </mapper

测试类

package com.pjf.mybatis;
    
    import java.io.IOException;
    import java.io.InputStream;
    import java.util.HashMap;
    import java.util.Map;
    
    import org.apache.ibatis.io.Resources;
    import org.apache.ibatis.session.SqlSession;
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    import org.junit.Test;
    
    import com.pjf.mybatis.dao.HotelMapper;
    import com.pjf.mybatis.po.Hotel;
    
    public class TestHotel {
    
        public SqlSessionFactory sqlSessionFactory() throws IOException {
            // mybatis的配置文件
            String resource = "mybatis_config.xml";
            // 使用类加载器加载mybatis的配置文件（它也加载关联的映射文件）TestHotel.class.getClassLoader()
            InputStream is = Resources.getResourceAsStream(resource);
            // 构建sqlSession的工厂
            SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
            return sessionFactory;
        }
    
        // 查
        @Test
        public void getHotel() throws IOException {
    
            SqlSessionFactory sessionFactory = sqlSessionFactory();
            SqlSession session = sessionFactory.openSession();
            HotelMapper hotelMapper = session.getMapper(HotelMapper.class);
            System.out.println(hotelMapper.getClass());
            //手动封装一个map传入
            Map map =new HashMap<>();
            map.put("id", 1001);
            map.put("price", 997);
            Hotel hotel = hotelMapper.getHotel(map);
            System.out.println(hotel);
            session.close();
        }

### 5、对象参数（POJO） ###

如果多个参数正好是业务模型，这时候就可以直接传如对象，通过\#\{属性值\}就可以取到对象的属性值了

hotelMapper接口

package com.pjf.mybatis.dao;
    
    import java.util.Map;
    import org.apache.ibatis.annotations.Param;
    import com.pjf.mybatis.po.Hotel;
    
    public interface HotelMapper {
        public Hotel getHotel(Map<String,Integer> map);
       
     //直接传入hotel业务模型
        public void insertHotel(Hotel hotel);

### 6、对象参数（TO） ###

如果多个参数不是业务模型，但是有用的比较频繁时，这时候我们可以编写一个TO对象专门用来传递参数

package com.pjf.mybatis.po;
    
    public class HotelTo {
    
        private int id;
        private int price;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public int getPrice() {
            return price;
        }
    
        public void setPrice(int price) {
            this.price = price;
        }

这时候接口就可以修改为

package com.pjf.mybatis.dao;
    
    import java.util.Map;
    import org.apache.ibatis.annotations.Param;
    import com.pjf.mybatis.po.Hotel;
    
    public interface HotelMapper {
        public Hotel getHotel(Map<String,Integer> map);
       
     //传入HotelTo 模型
        public void insertHotel(HotelTo hotelTo);

###  思考： ###

public void insertHotel(Integer id,Hotel hotel);对于这个id应该sql怎么取值呢，是不是可以使用#{param1}，那么的Hotel对象的price应该怎么取值呢？