第一节:输入参数和输出参数
Mapper.xml映射文件中定义了操作数据库的sql,每个sql是一个statement,映射文件是mybatis的核心。
1.1 环境准备
第一步:创建项目添加依赖
项目名称:day04_mybatis01
依赖信息如下:
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.41</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
第二步:加入配置文件
Mybatis的核心配置mybatis-config.xml、log4j日志文件log4j.properties
<?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>
<!-- 和spring整合后 environments配置将废除 -->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url"
value="jdbc:mysql://localhost:3306/mybatis_01?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
</configuration>
### set log levels - for more verbose logging change 'info' to 'debug' , 'off' ###
log4j.rootLogger=info, stdout,file
### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.err
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
### direct messages to file mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=d:\\mylog.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
第三步:创建POJO
User.java
public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
//getter和setter
}
第四步:加入sql映射文件
在resources目录下创建com.qf.mapper文件夹,然后创建UserMapper.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">
<!-- namespace:命名空间,用于隔离sql-->
<mapper namespace="">
</mapper
第五步:加载映射文件
MyBatis框架需要加载UserMapper.xml映射文件,将UserMapper.xml添加在mybatis-config.xml,如下:
<mappers>
<mapper resource="com/qf/mapper/UserMapper.xml"/>
</mappers>
1.2 parameterType(输入参数)
1.2.1. 传递简单类型
参考昨天内容:传递int类型、String类型
使用#{}占位符,或者${}进行sql拼接。 (order by id 必须使用${})
扩展:如果传递多个简单类型,使用@Param注解实现
List<User> findByWhere(@Param("username") String username, @Param("sex") String sex);
SQL映射文件如下,不需要写parameterType
<select id="findByWhere" resultType="user">
select * from user where username like #{username} and sex=#{sex};
</select>
1.2.2. 传递pojo对象
参考昨天内容:传递pojo对象
#{}或者${}括号中的值为pojo属性名称。
1.2.3. 传递pojo包装对象
开发中通过可以使用pojo传递查询条件。
查询条件可能是综合的查询条件,不仅包括用户查询条件还包括其它的查询条件(比如查询用户信息的时候,将用户购买商品信息也作为查询条件),这时可以使用包装对象传递输入参数。
包装对象:Pojo类中的一个属性是另外一个pojo。
需求1:根据用户名模糊查询用户信息
查询条件放到QueryVo的user属性中。
编写QueryVo
public class QueryVo {
private User user;
private String username;
public User getUser() {
return user;
}
public void setUser(User user) {
this.user = user;
}
/get set
}
使用SQL语句:SELECT * FROM user WHERE username LIKE ‘%张%’;
在UserMapper.xml中配置sql,如下。
<select id="findUserByQueryVo" paramenterType="queryVo" resultType="user">
select * from user where username like #{user.username}
</select>
在UserMapper接口中添加方法,如下:
List<User> findUserQueryVo(QueryVo queryVo);
在UserMapperTest增加测试方法,如下:
@Test
public void testQueryUserByQueryVo() {
// MyBatis和spring整合,整合之后,交给spring管理
SqlSession sqlSession = MyBatisUtils.openSession();
// 创建Mapper接口的动态代理对象,整合之后,交给spring管理
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 使用userMapper执行查询,使用包装对象
QueryVo queryVo = new QueryVo();
// 设置user条件
User user = new User();
user.setUsername("%张%");
// 设置到包装对象中
queryVo.setUser(user);
// 执行查询
List<User> list = userMapper.findUserByQueryVo(queryVo);
for (User u : list) {
System.out.println(u);
}
sqlSession.close();
}
1.2.4. 传递map集合
需求2:分页查询用户信息
分页属性放入map集合中,注意:map的key要和sql中的占位符保持名字一致。
使用SQL语句:SELECT * FROM user limit #{offset},#{pagesize}
在UserMapper.xml中配置sql,如下。
<!-- 分页:map传参 -->
<select id="findUserByPage" parameterType="map" resultType="user">
SELECT * FROM user LIMIT #{offset}, #{pagesize}
</select>
在UserMapper接口中添加方法,如下:
List<User> findUserByPage(Map<String, Object> map);
在UserMapperTest增加测试方法,如下:
@Test
public void testQueryUserByPage() {
SqlSession sqlSession = MyBatisUtils.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
Map<String, Object> map = new HashMap<String, Object>();
map.put("offset", 0);
map.put("pagesize", 2);
// 执行查询
List<User> list = userMapper.findUserByPage(map);
for (User u : list) {
System.out.println(u);
}
sqlSession.close();
}
1.3. resultType(输出参数)
1.3.1. 输出简单类型
需求:查询用户表数据条数
使用sql:SELECT count(*) FROM user
在UserMapper.xml中配置sql,如下:
<select id="queryUserCount" resultType="int">
SELECT count(*) FROM user
</select>
在UserMapper添加方法,如下:
int queryUserCount();
在UserMapeprTest增加测试方法,如下:
@Test
public void testQueryUserCount() {
SqlSession sqlSession = MyBatisUtils.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 使用userMapper执行查询用户数据条数
int count = userMapper.queryUserCount();
System.out.println(count);
sqlSession.close();
}
注意:输出简单类型必须查询出来的结果集有一条记录,最终将第一个字段的值转换为输出类型。
1.3.2. 输出pojo对象
已讲
1.3.3. 输出pojo列表
已讲
1.4. resultMap
resultType可以指定将查询结果映射为pojo,但需要pojo的属性名和sql查询的列名一致方可映射成功。
如果sql查询字段名和pojo的属性名不一致,可以通过resultMap将字段名和属性名作一个对应关系 ,resultMap实质上还需要将查询结果映射到pojo对象中。
resultMap可以实现将查询结果映射为复杂类型的pojo,比如在查询结果映射对象中包括pojo和list实现一对一查询和一对多查询。
需求:查询订单表order的所有数据
使用sql语句:SELECT id, user_id, number, createtime, note FROM orders
1.4.1.创建pojo对象
Order对象:
public class Order {
// 订单id
private int id;
// 用户id
private Integer userId;
// 订单号
private String number;
// 订单创建时间
private Date createtime;
// 备注
private String note;
//get/set。。。
}
1.4.2. Mapper.xml文件
创建OrderMapper.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">
<!-- namespace:命名空间,用于隔离sql,还有一个很重要的作用,Mapper动态代理开发的时候使用,需要指定Mapper的类路径 -->
<mapper namespace="com.qf.mapper.OrderMapper">
<!-- 查询所有的订单数据 -->
<select id="queryOrderAll" resultType="order">
SELECT id, user_id,number,createtime, note FROM `order`
</select>
</mapper>
1.4.3. Mapper接口
编写接口如下:
public interface OrderMapper {
/**
* 查询所有订单
*
* @return
*/
List<Order> queryOrderAll();
}
1.4.4. 测试方法
编写测试方法OrderMapperTest如下:
@Test
public void testQueryAll() {
// 获取sqlSession
SqlSession sqlSession = MyBatisUtils.openSession();
// 获取OrderMapper
OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
// 执行查询
List<Order> list = orderMapper.queryOrderAll();
for (Order order : list) {
System.out.println(order);
}
}
发现userId为null
解决方案:使用resultMap
1.4.5. 使用resultMap
? 由于上边的mapper.xml中sql查询列(user_id)和Order类属性(userId)不一致,所以查询结果不能映射到pojo中。需要定义resultMap,resultMap将sql查询列(user_id)和Order类属性(userId)对应起来
改造OrderMapper.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">
<!-- namespace:命名空间,用于隔离sql,还有一个很重要的作用,Mapper动态代理开发的时候使用,需要指定Mapper的类路径 -->
<mapper namespace="com.qf.mapper.OrderMapper">
<!-- resultMap最终还是要将结果映射到pojo上,type就是指定映射到哪一个pojo -->
<!-- id:设置ResultMap的id -->
<resultMap type="order" id="orderResultMap">
<!-- 定义主键 ,非常重要。如果是多个字段,则定义多个id -->
<!-- property:主键在pojo中的属性名 -->
<!-- column:主键在数据库中的列名 -->
<id property="id" column="id" />
<!-- 定义普通属性 -->
<result property="userId" column="user_id" />
<result property="number" column="number" />
<result property="createtime" column="createtime" />
<result property="note" column="note" />
</resultMap>
<!-- 查询所有的订单数据 -->
<select id="queryOrderAll" resultMap="orderResultMap">
SELECT id, user_id,
number,
createtime, note FROM `order`
</select>
</mapper>
再次测试数据没有问题。
1.5 类型转换器
每当MyBatis设置参数到PrepareStatement或者从ResultSet结果集中取值时,就会用到TypeHandler来处理数据库类型与Java类型之间的转换。
myBatis类型转换器适用于 Java实体类中的类型和数据库中的类型不对应时。
下图是默认的TypeHandler:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WemtfvZW-1572750984098)(pic/08.png)]
案例:假如User中包含一个对象属性Address,如果把数据库中address转成Address对象呢?
(1)编写类型转换器
package com.qf.convert;
import com.qf.pojo.Address;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
/**
* wgy 2019/7/6 7:20
*/
public class AddressHandler implements TypeHandler<Address> {
/**
* /**
* * 此方法是在插入是进行设置参数
* * 参数: PreparedStatement
* * int i 为Jdbc预编译时设置参数的索引值
* * Address parameter 要插入的参数值
* * JdbcType jdbcType 要插入JDBC的类型
* */
@Override
public void setParameter(PreparedStatement ps, int i, Address parameter, JdbcType jdbcType) throws SQLException {
if(parameter==null){
ps.setString(i, null);
}else{
ps.setString(i, parameter.getAdd());
}
}
/**
* 该方法是获取参数时执行
* 参数: ResultSet rs 查询当前列数据
* * String cloumnName 查询当前列名称
* @param rs
* @param columnName
* @return
* @throws SQLException
*/
@Override
public Address getResult(ResultSet rs, String columnName) throws SQLException {
System.out.println(columnName);
String value=rs.getString(columnName);
Address address=new Address(value);
return address;
}
@Override
public Address getResult(ResultSet rs, int columnIndex) throws SQLException {
System.out.println("xxxxxxxxx");
return null;
}
@Override
public Address getResult(CallableStatement cs, int columnIndex) throws SQLException {
System.out.println("yyyyyyyyy");
return null;
}
}
(2)注册类型转换器
在mybatis的核心配置文件中添加
<!--全局注册类型转换器-->
<typeHandlers>
<typeHandler handler="com.qf.convert.AddressHandler" javaType="com.qf.pojo.Address" jdbcType="VARCHAR"></typeHandler>
</typeHandlers>
(3)测试