Mybatis 映射器中映射方法接受多个参数(@Param)

Mointor

于 2023-09-20 08:47:04 发布

阅读量316

点赞数

分类专栏： Mybatis 文章标签： mybatis java

本文链接：https://blog.csdn.net/m1729339749/article/details/133063604

版权

Mybatis 专栏收录该内容

34 篇文章 1 订阅

订阅专栏

前面我们介绍了使用Mybatis映射器进行数据的增删改查操作；本篇我们继续介绍在Mybatis映射器的映射方法中如何使用多个参数。

如果您对Mybatis使用映射器进行数据的增删改查操作不太了解，建议您先进行了解后再阅读本篇，可以参考：

Mybatis 使用映射器进行查询(@Select)、新增(@Insert)、修改(@Update)、删除(@Delete)https://blog.csdn.net/m1729339749/article/details/132831561

一、数据准备

这里我们直接使用脚本初始化数据库中的数据

-- 如果数据库不存在则创建数据库
CREATE DATABASE IF NOT EXISTS demo DEFAULT CHARSET utf8;
-- 切换数据库
USE demo;
-- 创建用户表
CREATE TABLE IF NOT EXISTS T_USER(
  ID INT PRIMARY KEY,
  USERNAME VARCHAR(32) NOT NULL,
  AGE INT NOT NULL 
);
-- 插入用户数据
INSERT INTO T_USER(ID, USERNAME, AGE)
VALUES(1, '张三', 20),(2, '李四', 22),(3, '王五', 24);

创建了一个名称为demo的数据库；并在库里创建了名称为T_USER的用户表并向表中插入了数据

二、创建实体类

在cn.horse.demo下创建UserInfo类

UserInfo类：

package cn.horse.demo;

public class UserInfo {

    private Integer id;
    private String name;
    private Integer age;

    public void setId(Integer id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append('{');
        stringBuilder.append("id: " + this.id);
        stringBuilder.append(", ");
        stringBuilder.append("name: " + this.name);
        stringBuilder.append(", ");
        stringBuilder.append("age: " + this.age);
        stringBuilder.append('}');
        return stringBuilder.toString();
    }
}

三、创建UserInfoMapper映射器

在cn.horse.demo下创建UserInfoMapper接口

UserInfoMapper接口：

package cn.horse.demo;

import org.apache.ibatis.annotations.*;

import java.util.List;

public interface UserInfoMapper {
}

四、引入配置文件

在resources下新建mybatis-config.xml配置文件，并引入UserInfoMapper映射器。

<?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>
    <settings>
        <setting name="logImpl" value="JDK_LOGGING"/>
    </settings>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="org.gjt.mm.mysql.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/demo?useUnicode=true&amp;useSSL=false&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="horse"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper class="cn.horse.demo.UserInfoMapper" />
    </mappers>
</configuration>

这里我们使用mapper引入映射器，只需要设置class属性为UserInfoMapper接口的全限类名。

五、启动程序配置

1、会话工具类

在cn.horse.demo包下新建SqlSessionUtils工具类

package cn.horse.demo;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.InputStream;
import java.util.Objects;

public class SqlSessionUtils {

    private static final SqlSessionFactory sqlSessionFactory;
    static {
        // 读取mybatis配置文件
        InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("mybatis-config.xml");
        // 根据配置创建SqlSession工厂
        sqlSessionFactory = new SqlSessionFactoryBuilder()
                .build(inputStream);
    }

    /**
     * 开启会话
     * @return
     */
    public static SqlSession openSession() {
        return sqlSessionFactory.openSession();
    }

    /**
     * 关闭会话
     * @param sqlSession
     */
    public static void closeSession(SqlSession sqlSession) {
        if(Objects.nonNull(sqlSession)) {
            sqlSession.close();
        }
    }
}

2、JDK 日志系统配置

在resources的目录下新建logging.properties配置文件

handlers=java.util.logging.ConsoleHandler
.level=INFO

cn.horse.demo.UserInfoMapper.level=FINER
java.util.logging.ConsoleHandler.level=ALL
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tT.%1$tL %4$s %3$s - %5$s%6$s%n

在cn.horse.demo下创建JdkLogConfig类

JdkLogConfig类：

package cn.horse.demo;

import java.io.IOException;
import java.io.InputStream;
import java.util.logging.LogManager;

public class JdkLogConfig {

    public JdkLogConfig() {
        try {
            InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("logging.properties");
            LogManager.getLogManager().readConfiguration(inputStream);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

3、启动程序配置

package cn.horse.demo;

import org.apache.ibatis.session.SqlSession;

import java.util.List;
import java.util.function.Consumer;

public class Main {
    public static void main(String[] args) {
        // 引入JDK日志配置
        System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");
    }

    private static void execute(Consumer<UserInfoMapper> function) {
        SqlSession sqlSession = null;
        try {
            sqlSession = SqlSessionUtils.openSession();
            function.accept(sqlSession.getMapper(UserInfoMapper.class));
            sqlSession.commit();
        } finally {
            SqlSessionUtils.closeSession(sqlSession);
        }
    }
}

execute方法用于执行操作，方法中使用sqlSession.getMapper方法获取映射器对象，然后将映射器对象具体的执行操作委托给了Consumer对象。

六、查询数据

在UserInfoMapper映射器中新增find方法

@Select("SELECT ID, USERNAME name, AGE FROM T_USER WHERE AGE BETWEEN #{startAge} AND #{endAge}")
List<UserInfo> find(Integer startAge, Integer endAge);

编写代码调用find方法

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");

// 查询
execute((UserInfoMapper userInfoMapper) -> {
    List<UserInfo> userInfoList = userInfoMapper.find(0, 22);
    for (UserInfo userInfo: userInfoList) {
        System.out.println(userInfo);
    }
});

执行后的结果如下：

Exception in thread "main" org.apache.ibatis.exceptions.PersistenceException: 
### Error querying database.  Cause: org.apache.ibatis.binding.BindingException: Parameter 'startAge' not found. Available parameters are [arg1, arg0, param1, param2]
### Cause: org.apache.ibatis.binding.BindingException: Parameter 'startAge' not found. Available parameters are [arg1, arg0, param1, param2]
	at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
	at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:150)
	at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:141)
	at org.apache.ibatis.binding.MapperMethod.executeForMany(MapperMethod.java:137)
	at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:75)
	at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:59)
	at jdk.proxy2/jdk.proxy2.$Proxy6.find(Unknown Source)
	at cn.horse.demo.Main.lambda$main$0(Main.java:15)
	at cn.horse.demo.Main.execute(Main.java:56)
	at cn.horse.demo.Main.main(Main.java:14)
Caused by: org.apache.ibatis.binding.BindingException: Parameter 'startAge' not found. Available parameters are [arg1, arg0, param1, param2]
	at org.apache.ibatis.binding.MapperMethod$ParamMap.get(MapperMethod.java:202)
	at org.apache.ibatis.reflection.wrapper.MapWrapper.get(MapWrapper.java:45)
	at org.apache.ibatis.reflection.MetaObject.getValue(MetaObject.java:122)
	at org.apache.ibatis.executor.BaseExecutor.createCacheKey(BaseExecutor.java:219)
	at org.apache.ibatis.executor.CachingExecutor.createCacheKey(CachingExecutor.java:146)
	at org.apache.ibatis.executor.CachingExecutor.query(CachingExecutor.java:82)
	at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:148)
	... 8 more

问题分析：

从上面的报错信息来看，是因为找不到startAge参数，而可用的参数是[arg1, arg0,param1, param2]，从可用参数来看，arg1,arg0是方法的参数（编译时未保留方法的参数名导致的），param1,param2同样也是代表的方法的参数（param1代表的是方法的第一个参数，param2代表的是方法的第二个参数）。

解决办法：

1）编译时保留方法的参数名（不建议）

在pom文件中新增编译参数

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>${maven.compiler.source}</source>
                <target>${maven.compiler.target}</target>
                <compilerArgs>
                    <arg>-parameters</arg>
                </compilerArgs>
                <encoding>${project.build.sourceEncoding}</encoding>
            </configuration>
        </plugin>
    </plugins>
</build>

其中-parameters参数可以在编译时保留方法的参数名

执行后的结果如下：

2）使用SQL语句中使用param1, param2等参数（不建议）

修改find方法上的Select注解SQL语句中的使用参数

@Select("SELECT ID, USERNAME name, AGE FROM T_USER WHERE AGE BETWEEN #{param1} AND #{param2}")
List<UserInfo> find(Integer startAge, Integer endAge);

执行后的结果如下：

3）使用@Param定义参数的名称（建议）

修改find方法，使用@Param定义参数的名称

@Select("SELECT ID, USERNAME name, AGE FROM T_USER WHERE AGE BETWEEN #{startAge} AND #{endAge}")
List<UserInfo> find(@Param("startAge") Integer startAge, @Param("endAge") Integer endAge);

@Param：参数注解，用来自定义参数的名称，在SQL中使用参数时，可以使用#{参数名}进行使用，例如：在find方法中我们使用@Param(“startAge”)、@Param(“endAge”)定义了两个名称为startAge、endAge的参数，在SQL中使用#{startAge}, #{endAge}方式使用参数；

执行后的结果如下：

注意：默认情况下，映射方法的参数会以 "param" 加参数位置被命名，例如我们在例子中看到的param1、param2，除非我们使用@Param对参数定义名称。

七、新增数据

在UserInfoMapper映射器中新增insert方法

@Insert("INSERT INTO T_USER(ID, USERNAME, AGE) VALUES(#{userInfo.id}, #{userInfo.name}, #{userInfo.age})")
Integer insert(@Param("userInfo") UserInfo userInfo);

@Param：参数注解，用来自定义参数的名称，在SQL中使用参数时，可以使用#{参数名}进行使用，例如：在insert方法中我们使用@Param(“userInfo”)定义了名称为userInfo的参数，由于参数类型时UserInfo类型，在SQL中使用时通过Ognl表达式获取对象中的值，获取id、name、age属性值时分别使用了#{userInfo.id}、#{userInfo.name}、#{userInfo.age}方式

编写代码调用insert方法

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");

// 插入
execute((UserInfoMapper userInfoMapper) -> {
    UserInfo userInfo = new UserInfo();
    userInfo.setId(5);
    userInfo.setName("王五");
    userInfo.setAge(5);
    Integer total = userInfoMapper.insert(userInfo);
    System.out.println("插入条数: " + total);
});

执行后的结果如下：

八、修改数据

在UserInfoMapper映射器中新增update方法

@Update("UPDATE T_USER SET USERNAME = #{userInfo.name}, AGE = #{userInfo.age} WHERE ID = #{userInfo.id}")
Integer update(@Param("userInfo") UserInfo userInfo);

@Param：参数注解，用来自定义参数的名称，在SQL中使用参数时，可以使用#{参数名}进行使用，例如：在update方法中我们使用@Param(“userInfo”)定义了名称为userInfo的参数，由于参数类型时UserInfo类型，在SQL中使用时通过Ognl表达式获取对象中的值，获取id、name、age属性值时分别使用了#{userInfo.id}、#{userInfo.name}、#{userInfo.age}方式

编写代码调用update方法

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");

// 更新
execute((UserInfoMapper userInfoMapper) -> {
    UserInfo userInfo = new UserInfo();
    userInfo.setId(5);
    userInfo.setName("王五2");
    userInfo.setAge(50);
    Integer total = userInfoMapper.update(userInfo);
    System.out.println("更新条数: " + total);
});

执行后的结果如下：

九、删除数据

在UserInfoMapper映射器中新增delete方法

@Delete("DELETE FROM T_USER WHERE ID = #{id}")
Integer delete(@Param("id") Integer id);

@Param：参数注解，用来自定义参数的名称，在SQL中使用参数时，可以使用#{参数名}进行使用，例如：在delete方法中我们使用@Param(“id”)定义了名称为id的参数，在SQL中使用#{id}方式使用参数

编写代码调用delete方法

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");

// 删除
execute((UserInfoMapper userInfoMapper) -> {
    Integer total = userInfoMapper.delete(5);
    System.out.println("删除条数: " + total);
});

执行后的结果如下：