之前我们介绍过使用resultMap标签定义结果映射,将查询出的数据库表中的每条数据映射成对象,本篇我们在映射器中使用@Results进行结果映射。
如果您对resultMap标签不太了解,建议您先进行了解后再阅读本篇,可以参考:
Mybatis 普通结果映射(ResultMap)https://blog.youkuaiyun.com/m1729339749/article/details/132475733
一、数据准备
这里我们直接使用脚本初始化数据库中的数据
-- 如果数据库不存在则创建数据库
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 {
@Select("SELECT ID, USERNAME, AGE FROM T_USER")
List<UserInfo> findAll();
@Select("SELECT ID, USERNAME, AGE FROM T_USER WHERE ID = #{id}")
UserInfo find(Integer id);
}
@Select:查询注解,注解内需要提供查询语句,方法的参数作为查询语句中的参数,查询的结果作为方法的返回值。
四、引入配置文件
在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&useSSL=false&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");
execute((UserInfoMapper userInfoMapper) -> {
List<UserInfo> userInfoList = userInfoMapper.findAll();
System.out.println(userInfoList);
});
System.out.println("----------------------------------");
execute((UserInfoMapper userInfoMapper) -> {
UserInfo userInfo = userInfoMapper.find(2);
System.out.println(userInfo);
});
}
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对象。
执行的结果如下:
发现userId, name没有值,只有age字段有值
分析原因:
原因就在于从表中查询的字段有ID, USERNAME, AGE;而结果类型的字段只有age能够对应上,导致userId, name字段无法绑定值。
解决方法:
- 查询表数据时指定别名
- 使用@Results进行结果映射
六、查询表数据指定别名
修改UserInfoMapper映射类:
package cn.horse.demo;
import org.apache.ibatis.annotations.*;
import java.util.List;
public interface UserInfoMapper {
@Select("SELECT ID userId, USERNAME name, AGE FROM T_USER")
List<UserInfo> findAll();
@Select("SELECT ID userId, USERNAME name, AGE FROM T_USER WHERE ID = #{id}")
UserInfo find(Integer id);
}
执行的结果如下:
发现userId, name字段的值也查询出来了
七、使用@Results进行结果映射
这里我们使用@Results注解进行结果映射
1、使用无参数的构造方法创建映射类型对象
修改UserInfoMapper映射类:
package cn.horse.demo;
import org.apache.ibatis.annotations.*;
import java.util.List;
public interface UserInfoMapper {
@Results(id = "userInfoMap", value = {
@Result(column = "ID", property = "userId"),
@Result(column = "USERNAME", property = "name"),
@Result(column = "AGE", property = "age")
})
@Select("SELECT ID, USERNAME, AGE FROM T_USER")
List<UserInfo> findAll();
@ResultMap("userInfoMap")
@Select("SELECT ID, USERNAME, AGE FROM T_USER WHERE ID = #{id}")
UserInfo find(Integer id);
}
@Results:定义并使用结果映射注解,类似于XML中配置的resultMap标签,id代表的结果映射的编号,value代表的数据库表字段与类字段之间的映射关系列表。
@Result:定义字段结果映射注解,只能在@Results中使用,用来表示数据库表字段与类字段之间的映射关系,column代表的是数据库表字段,property代表的是类字段。
@ResultMap:使用结果映射注解,用于指定映射时使用的结果映射(结果映射的编号)。
从上面可以看出,findAll方法上定义并使用了userInfoMap结果映射,我们在find方法上使用了在findAll方法上定义的userInfoMap结果映射。
执行的结果如下:
发现userId, name字段的值也查询出来了
2、使用带有参数的构造方法创建映射类型对象(不建议使用)
修改UserInfoMapper映射类:
package cn.horse.demo;
import org.apache.ibatis.annotations.*;
import java.util.List;
public interface UserInfoMapper {
@Results(id = "userInfoMap", value = {
@Result(column = "AGE", property = "age")
})
@ConstructorArgs({
@Arg(column = "USERNAME", name = "name"),
@Arg(column = "ID", name = "userId")
})
@Select("SELECT ID, USERNAME, AGE FROM T_USER")
List<UserInfo> findAll();
@ResultMap("userInfoMap")
@Select("SELECT ID, USERNAME, AGE FROM T_USER WHERE ID = #{id}")
UserInfo find(Integer id);
}
@ConstructorArgs:代表使用指定的构造方法创建映射类型对象,具体使用哪个构造方法会根据参数的个数、类型、名称进行筛选,与参数的顺序无关;这里使用了带有两个参数的构造方法,构造方法的参数包含name和userId。
@Arg:代表的是构造方法参数的映射,column代表的是查询的列,name代表的是构造方法的参数名称。
执行的结果如下:
发现userId, name字段的值也查询出来了
可能出现的问题:
Exception in thread "main" java.lang.NoClassDefFoundError: Could not initialize class cn.horse.demo.SqlSessionUtils
at cn.horse.demo.Main.execute(Main.java:30)
at cn.horse.demo.Main.main(Main.java:12)
Caused by: java.lang.ExceptionInInitializerError: Exception org.apache.ibatis.exceptions.PersistenceException:
### Error building SqlSession.
### The error may exist in cn/horse/demo/UserInfoMapper.java (best guess)
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.builder.BuilderException: Error in result map 'cn.horse.demo.UserInfoMapper.userInfoMap'. Failed to find a constructor in 'cn.horse.demo.UserInfo' by arg names [name, userId]. There might be more info in debug log. [in thread "main"]
at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:80)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:64)
at cn.horse.demo.SqlSessionUtils.<clinit>(SqlSessionUtils.java:18)
at cn.horse.demo.Main.execute(Main.java:26)
... 1 more
造成的原因是编译时未保留方法的参数名
解决方法:
在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参数可以在编译时保留方法的参数名