【MyBatis】| MyBatis参数处理（接口中方法的参数专栏）

蔚落 2024-03-30 14:26 161阅读 0赞

**目录**

一：MyBatis参数处理

1. 单个简单类型参数

2. Map参数

3. 实体类参数（PoJo类）

4. 多参数

5. @Param注解（命名参数）

6. 参数是数组或者集合

--------------------

## 一：MyBatis参数处理 ##

> 接口中方法的参数专栏！

#### **1. 单个简单类型参数**  ####

> **简单类型包括：**
> 
> ①基本数据类型：byte 、short、 int、 long、 float、 double、 char
> 
> ②对应的包装类型：Byte、 Short、 Integer、 Long、 Float、 Double、 Character
> 
> ③字符串：String
> 
> ④util包下的Date：java.util.Date
> 
> ⑤sql包下的Date：java.sql.Date

> （1）数据的准备t\_student表

①创建表的结构

![122c902dea1943ffb5c0da55578a9ce0.png][]

②向表中插入数据

![db95efe042864783921d3351a678e08b.png][]

> （2）把结构搭起来

![feffaafca5b4418382f191d78d29c56f.png][]

pom.xml中引入依赖

①①①<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.bjpowernode</groupId>
        <artifactId>mybatis-007-param</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        
        <dependencies>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.10</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.23</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.11</version>
            </dependency>
        </dependencies>
        
        <properties>
            <maven.compiler.source>1.8</maven.compiler.source>
            <maven.compiler.target>1.8</maven.compiler.target>
        </properties>
    
    </project>

①java下mapper包的StudentMapper接口，编写抽象的方法（三兄弟之一）

package com.bjpowernode.mybatis.mapper;
    
    public interface StudentMapper {
    }

java下pojo包的Student类，用来封装对象

package com.bjpowernode.mybatis.pojo;
    
    import java.util.Date;
    
    public class Student {
        private Long id;
        private String name;
        private Integer age;
        private Double height;
        private Date birth;
        private Character sex;
    
        public Student() {
        }
        public Student(Long id, String name, Integer age, Double height, Date birth, Character sex) {
            this.id = id;
            this.name = name;
            this.age = age;
            this.height = height;
            this.birth = birth;
            this.sex = sex;
        }
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public Integer getAge() {
            return age;
        }
    
        public void setAge(Integer age) {
            this.age = age;
        }
    
        public Double getHeight() {
            return height;
        }
    
        public void setHeight(Double height) {
            this.height = height;
        }
    
        public Date getBirth() {
            return birth;
        }
    
        public void setBirth(Date birth) {
            this.birth = birth;
        }
    
        public Character getSex() {
            return sex;
        }
    
        public void setSex(Character sex) {
            this.sex = sex;
        }
    
        @Override
        public String toString() {
            return "Student{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    ", height=" + height +
                    ", birth=" + birth +
                    ", sex=" + sex +
                    '}';
        }
    }

java下utils包的工具类SqlSessionUtils，用来连接数据库的

package com.bjpowernode.mybatis.utils;
    
    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 java.io.IOException;
    
    public class SqlSessionUtils {
        // 工具类的构造方法一般都是私有化的，防止创建对象
        public SqlSessionUtils() {
        }
        // SqlSessionFactory对象，一个SqlSessionFactory对应一个environment，一个environment对应一个数据库
        private static SqlSessionFactory sqlSessionFactory;
        static {
            try {
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader("mybatis-config.xml"));
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        // 定义一个方法，获取会话对象
        public static SqlSession openSession(){
            return sqlSessionFactory.openSession();
        }
    
    }

②resources下mapper包的StudetMapper.xml，编写sql语句（三兄弟之二）

②resource下的jdbc.properties，连接数据库的配置信息

jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis
    jdbc.username=root
    jdbc.password=123

resource下的logback.xml，日志配置文件

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration debug="false">
        
        <property name="LOG_HOME" value="/home"/>
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <logger name="com.apache.ibatis" level="TRACE"/>
        <logger name="java.sql.Connection" level="DEBUG"/>
        <logger name="java.sql.Statement" level="DEBUG"/>
        <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
        
        <root level="DEBUG">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE"/>
        </root>
    </configuration>

resource下的mybatis-config.xml，核心配置文件

<?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>
        <properties resource="jdbc.properties"/>
        <typeAliases>
            <package name="com.bjpowernode.mybatis.pojo"/>
        </typeAliases>
        <environments default="dev">
            <environment id="dev">
                <transactionManager type="JDBC"/>
                <dataSource type="POOLED">
                    <property name="driver" value="${jdbc.driver}"/>
                    <property name="url" value="${jdbc.url}"/>
                    <property name="username" value="${jdbc.username}"/>
                    <property name="password" value="${jdbc.password}"/>
                </dataSource>
            </environment>
        </environments>
        <mappers>
            <package name="com.bjpowernode.mybatis.mapper"/>
        </mappers>
    </configuration>

③test包下的java的StudeMapperTest，编写测试方法，用来测试（三兄弟之三）

package com.bjpowernode.mybatis.test;
    
    public class StudentMapperTest {
    }

> **（3）MyBatis参数之单个参数Long类型**
> 
> 需求：根据id查、根据name查、根据birth查、根据sex查

三兄弟之一：StudentMapper接口，编写方法

package com.bjpowernode.mybatis.mapper;
    
    import com.bjpowernode.mybatis.pojo.Student;
    import java.util.*;
    
    public interface StudentMapper {
        // 当接口中的方法的参数只有一个（单个参数），并且参数的类型是简单类型
        List<Student> selectById(Long id);
        List<Student> selectByName(String name);
        List<Student> selectByBirth(Date birth);
        List<Student> selectBySex(Character sex);
    
    }

三兄弟之二：StudentMapper.xml文件，编写sql语句

> ①实际上select标签还有一个属性paraterType，作用是告诉MyBatis框架，方法的参数类型是什么；也可以省略不写，因为MyBatis框架自身带有类型自动推断机制！
> 
> ②注意：MyBatis框架实际上也内置了很多别名，可以参考开发手册[配置\_MyBatis中文网][MyBatis]
> 
> ，例如：java.lang.Long的别名就是long
> 
> ③注意：实际上\#\{\}里面除了写变量名，也有其它属性，例如：
> 
> javaType用来指定类型 、jdbcType用来指定在数据库表中的类型，都可以省略！
> 
> ④总结：javaType、jdbcType、parameterType这些参数都是可以省略的，加上以后可能效率会更高一些，因为省去了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.bjpowernode.mybatis.mapper.StudentMapper">
        
        <select id="selectById" resultType="student">
            select * from t_student where id = #{id};
        </select>
    
        <select id="selectByName" resultType="student">
            
            select * from t_student where name = #{name};
        </select>
    
        <select id="selectByBirth" resultType="student">
            select * from t_student where birth = #{birth};
        </select>
    
        <select id="selectBySex" resultType="student">
            select * from t_student where sex = #{sex};
        </select>
    </mapper>

三兄弟之三：StudentMappeTest类，用来编写测试类

package com.bjpowernode.mybatis.test;
    
    import com.bjpowernode.mybatis.mapper.StudentMapper;
    import com.bjpowernode.mybatis.pojo.Student;
    import com.bjpowernode.mybatis.utils.SqlSessionUtils;
    import org.apache.ibatis.session.SqlSession;
    import org.junit.Test;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.List;
    
    /**
     * @Author：朗朗乾坤
     * @Package：com.bjpowernode.mybatis.test
     * @Project：mybatis
     * @name：StudentMapperTest
     * @Date：2023/1/4 16:33
     */
    public class StudentMapperTest {
        @Test
        public void testSelectById(){
            SqlSession sqlSession = SqlSessionUtils.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
            List<Student> students = mapper.selectById(1L);
            students.forEach(student -> System.out.println(student));
            sqlSession.close();
        }
    
        @Test
        public void testSelectByName(){
            SqlSession sqlSession = SqlSessionUtils.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
            List<Student> students = mapper.selectByName("张三");
            students.forEach(student -> System.out.println(student));
            sqlSession.close();
        }
    
        @Test
        public void testSelectByBirth() throws Exception{
            SqlSession sqlSession = SqlSessionUtils.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
    
            // 把一个字符串转化为Date类型
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
            Date birth = sdf.parse("1999-06-04");
    
            List<Student> students = mapper.selectByBirth(birth);
            students.forEach(student -> System.out.println(student));
            sqlSession.close();
        }
    
        @Test
        public void testSelectBySex(){
            SqlSession sqlSession = SqlSessionUtils.openSession();
            StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
    
            // 把一个char类型转化为包装类Character
            Character sex = Character.valueOf('男');
    
            List<Student> students = mapper.selectBySex(sex);
            students.forEach(student -> System.out.println(student));
            sqlSession.close();
        }
    }

#### **2. Map参数**  ####

三兄弟之一：StudentMapper接口，编写方法

> **传的参数是一个Map集合：key是String类型，value是具体的值**

package com.bjpowernode.mybatis.mapper;
    
    import com.bjpowernode.mybatis.pojo.Student;
    
    import java.util.*;
    
    public interface StudentMapper {
      
        // 保存学生信息，通过Map参数（单个参数），并且参数的类型不是简单类型，是Map集合
        int insertStringByMap(Map<String,Object> map);
    
    }

三兄弟之二：StudentMapper.xml文件，编写sql语句

> 注意：这里参数的变量名必须是Map集合的key！

<?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.bjpowernode.mybatis.mapper.StudentMapper">
        
        <insert id="insertStringByMap">
            insert into t_student(id,name,age,height,birth,sex)
            values(null,#{name},#{age},#{height},#{birth},#{sex});
        </insert>
    </mapper>

三兄弟之三：StudentMappeTest类，用来编写测试类

> 需要创建一个Map集合，然后往这个集合里面存数据，最后把这个集合传进去。
> 
> 注：一定要手动提交，MyBatis是需要手动提交数据的！

#### **3. 实体类参数（PoJo类）** ####

> 所谓的实体类，就是前面我们写的Student类，用来封装对象的！

三兄弟之一：StudentMapper接口，编写方法

> 把Student类作为参数传过去！

package com.bjpowernode.mybatis.mapper;
    
    import com.bjpowernode.mybatis.pojo.Student;
    
    import java.util.*;
    
    public interface StudentMapper {
        // 保存学生信息，通过PoJo参数（单个参数），并且参数的类型不是简单类型，是Student类
        int insertStudentByPOJO(Student student);
    }

三兄弟之二：StudentMapper.xml文件，编写sql语句

> 注意：\#\{\} ⾥⾯写的是属性名字；这个属性名其本质上是：set/get⽅法名去掉set/get之后全部小写的名字；不仅仅只是属性名，要有对应的setter和getter方法！

<?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.bjpowernode.mybatis.mapper.StudentMapper">
        <insert id="insertStudentByPOJO">
            insert into t_student(id,name,age,height,birth,sex)
            values(null,#{name},#{age},#{height},#{birth},#{sex});
        </insert>
    </mapper>

三兄弟之三：StudentMappeTest类，用来编写测试类

> 需要创建一个student对象，调用无参或者有参构造方法都可以，并给每个属性赋上值！最后把这个student对象传过去！

#### **4. 多参数** ####

三兄弟之一：StudentMapper接口，编写方法

> 所谓的多参数就是根据多个字段进行查询，例如：通过name和sex这两个字段进行查询！

package com.bjpowernode.mybatis.mapper;
    
    import com.bjpowernode.mybatis.pojo.Student;
    
    import java.util.*;
    
    public interface StudentMapper {
        // 根据name和sex查询Student信息
        List<Student> selectByNameAndSex(String name,Character sex);
    }

三兄弟之二：StudentMapper.xml文件，编写sql语句

> **如果是多个参数的话，MyBatis底层是怎样做的呢？****MyBatis框架会自动创建一个Map集合，并且Map集合是这种方式存储参数的：**
> 
> ①**第一种：采用arg0、arg1、arg2....这种方式，下标从0开始**，例如：map.put("arg0",name)和map.put("arg1",sex)；
> 
> ②**第二种：采用param1、param2、param3....这种方式，下标从1开始**，例如：map.put("param1",name)和map.put("param2",sex)；
> 
> **注意：**也可以两个参数混合着用；对于低版本的MyBatis中，使用的是：\#\{0\}和\#\{1\}形式...

三兄弟之三：StudentMappeTest类，用来编写测试类

> 按照变量对应的类型，进行传参！

#### **5. @Param注解（命名参数）**  ####

> **可以不使⽤arg0、arg1， param1、param2吗，这个map集合的key我们可以⾃定义吗？**
> 
> 答：当然，**可以使⽤@Param注解自定义key即可**，这样可以增强可读性。

三兄弟之一：StudentMapper接口，编写方法

> 编写sql语句时，使用@Param注解的方式对参数进行重命名，其中属性名是value可以省略；重命名后MyBatis框架底层的实现原理：map.put("name",name)，map.put("sex",sex)

package com.bjpowernode.mybatis.mapper;
    
    import com.bjpowernode.mybatis.pojo.Student;
    import org.apache.ibatis.annotations.Param;
    
    import java.util.*;
    
    public interface StudentMapper {
        // 使用@Param注解的方式重命名
        List<Student> selectByNameAndSexParam(@Param(value = "name") String name,
        @Param("sex") Character sex);
    }

三兄弟之二：StudentMapper.xml文件，编写sql语句

> **使用@Param注解重名后，只有arg0、arg1这种方式失效了，还是有两种存储方式：**
> 
> **第一种：还是使用param1、param2....这种方式，下标从1开始；**例如：map.put("param1",name)和map.put("param2",sex)；
> 
> **第二种：使用@Param注解，@Param("name") String name；**例如：
> 
> map.put("name",name)和map.put("sex",sex)；使用自己定义的名字作为key

三兄弟之三：StudentMappeTest类，用来编写测试类

####  ####

#### 6. 参数是数组或者集合 ####

> **比如：**我们进行批量删除，前面传统的方法是使用$\{\}，然后使用in($\{ids\})，里面传的是一个String类型的字符串过去。现在我们使用里面传一个Long类型的数组，然后使用动态SQL的foreach标签进行遍历！

三兄弟之一：StudentMapper接口，编写方法

> **注：**如果参数是一个数组，参数不能直接使用ids，也需要@Param注解，因为底层存储实际上使用的是一个map集合，它的key默认是**array或arg0**；使用@Param注解重命名增加可读性！

三兄弟之二：StudentMapper.xml文件，编写sql语句

> 批量删除，可以使用in(1,2,3)或者id=1 or id = 2这两种形式，这里就暂时使用in，具体解释在动态SQL会详细讲解！

[122c902dea1943ffb5c0da55578a9ce0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/b5dc3a883e8342d2b000527fca39fe88.png
[db95efe042864783921d3351a678e08b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/be63ef441df04368998a497bc5ef6dac.png
[feffaafca5b4418382f191d78d29c56f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/c2b9cbf4ee374a3d8d8814effdadf42e.png
[MyBatis]: https://mybatis.net.cn/configuration.html#typeAliases