目录
Mybatis入门程序
1.Mybatis下载地址:https://github.com/mybatis/mybatis-3/releases
mybatis-3.2.7.jar
–> mybatis的核心包lib
–> mybatis的依赖包mybatis-3.2.7
–> mybatis使用手册
2.业务需求
- 根据用户id查询一个用户
- 根须用户名称模糊查询用户列表
- 添加用户
- 更新用户
- 删除用户
3.搭建工程,导入mybatis核心包, 依赖包, 数据库包
创建Source Folder
命名为config, 加入log4j.properties
, SqlMapConfig.xml
配置文件
log4j.properties
#OFF,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB,ALL
log4j.rootLogger =error,systemOut
#\u8F93\u51FA\u5230\u63A7\u5236\u53F0
log4j.appender.systemOut = org.apache.log4j.ConsoleAppender
log4j.appender.systemOut.layout = org.apache.log4j.PatternLayout
log4j.appender.systemOut.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
log4j.appender.systemOut.Threshold = DEBUG
log4j.appender.systemOut.ImmediateFlush = TRUE
log4j.appender.systemOut.Target = System.err
SqlMapConfig.xml
是mybatis核心配置文件,配置文件内容为数据源、事务管理
<?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">
<!-- 和spring整合后enviroment配置将废除 -->
<enviroments default="development">
<enviroment id="development">
<!-- 使用jdbc事务管理 -->
<transactionManager type="JDBC"/>
<!-- 数据库连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"></property>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis1?characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="12345678"/>
</dataSource>
</enviroment>
</enviroments>
4.创建pojo类
pojo类作为mybatis进行sql映射使用, po类通常与数据库表对应.
package com.feng.pojo;
import java.util.Date;
public class User {
private int id;
private String username;
private String sex;
private Date birthday;
private String address;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex + ", birthday=" + birthday + ", address="
+ address + "]";
}
}
5.sql映射文件
在config下创建sqlmap包,在sqlmap包下创建sql映射文件User.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,还有一个很重要的作用,后面会讲 -->
<generatorConfiguration>
<mapper namespace="test">
<!-- id:statement的id或者叫sql的id -->
<!-- parameterType: 声明输入参数的类型 -->
<!-- resultType: 声明输出结果的类型(返回的结果类型), 应该填写pojo的全路径 -->
<!-- #{}: 输入参数的占位符,相当于jdbc的? -->
<!-- select查询标签 ; #{id}类似jdbc的问号?,需要设置参数-->
<select id="queryUserById" parameterType="int" resultType="com.feng.pojo.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
</generatorConfiguration>
6.加载映射文件
mybatis框架需要加载Mapper.xml
映射文件, 将user.xml添加在sqlMapConfig.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">
<!-- 和spring整合后enviroment配置将废除 -->
<generatorConfiguration>
<enviroments default="development">
<enviroment id="development">
<!-- 使用jdbc事务管理 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"></property>
<property name="url"
value="jdbc:mysql://localhost:3306/mybatis1?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="12345678" />
</dataSource>
</enviroment>
</enviroments>
<!-- 配置用户的sql文件 -->
<mappers>
<mapper resource="sqlmap/User.xml"></mapper>
</mappers>
</generatorConfiguration>
7.测试(根据用户id查询一个用户)
- 创建
SqlSessionFactoryBulider
对象 - 加载
SqlMapConfig.xml
配置文件 - 创建
SqlSessionFactory
对象 - 创建
SqlSession
对象 - 执行
SqlSession
对象执行查询, 获取User - 打印结果
- 释放资源
public class MybatisTest {
private SqlSessionFactory sqlSessionFactory=null;
@Before
public void init() throws Exception {
// 1. 创建SqlsessionFactoryBulider对象,用来连接的数据库配置文件
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
// 2. 加载SqlMapConfig.xml文件,使用流的方式获取文件
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
// 3. 创建SqlSessionFactory对象,建立连接池
sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
}
@Test
public void testQueryUserById() {
// 4. 创建SqlSession对象,相当于Connection,openSession()打开连接
SqlSession sqlSession = sqlSessionFactory.openSession();
// 5. 执行SqlSession对象执行查询,获取结果User
// 第一个参数是User.xml的statement的id, 第二个参数是执行sql需要的参数
Object user = sqlSession.selectOne("queryUserById", 1);
// 6. 打印结果
System.out.println(user);
// 7. 释放资源
sqlSession.close();
}
}
#{}和${}
#{}表示一个占位符号, 通过#{}可以实现preparedStatement向占位符中设置值, 自动进行Java类型和jdbc类型的转换. #{}可以有效防止sql注入. #{}可以接受简单类型值或pojo属性值. 如果parameterType**传输单个简单类型值, #{}括号中可以是value或其他名称**.
${}表示拼接sql串,通过
${}可以将parameterType传入的内容拼接在sql中且不进行jdbc类型转换, 可以接收简单类型值或pojo属性值,如果parameterType∗∗传输单个简单类型值,
${}括号中只能是value**.parameterType和resultType
parameterType: 指定输入参数类型, mybatis通过ognl从输入对象中获取参数值拼接在sql中.
resultType: 指定输出结果类型, mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象. 如果有多条数据,则分别映射,并把对象放到List中
selectOne和selectList
selectOne查询一条记录, 如果使用selectOne查询多条记录,则抛出异常
实现根据用户姓名模糊查询用户
- 映射文件:在User.xml文件中添加如下配置:
<!-- 如果返回多个结果, mybatis会自动把返回的结果放在list容器中 -->
<!-- resultType的配置和返回一个结果的配置一样 -->
<!-- 实现根据用户姓名模糊查询用户 -->
<select id="queryUserByUsername" parameterType="String"
resultType="com.feng.pojo.User">
select * from user where username like #{username}
</select>
- 测试类中增加一下方法
@Test
public void testQueryUserByUsername() {
SqlSession sqlSession = sqlSessionFactory.openSession();
List<Object> list = sqlSession.selectList("queryUserByUsername", "%王%");
for (Object user : list) {
System.out.println(user);
}
sqlSession.close();
}
- 测试结果
插入操作--实现添加用户
- 映射文件,在User.xml配置文件中添加如下内容:
<!-- 保存用户 -->
<insert id="saveUser" parameterType="com.feng.pojo.User">
insert into user
(username, birthday, sex, address)
values
(#{username},#{birthday},#{sex},#{address})
</insert>
- 测试类中增加一下方法
@Test
public void testSaveUser() {
//创建sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = new User();
user.setUsername("张艺兴");
user.setSex("1");
user.setBirthday(new Date());
user.setAddress("长沙");
sqlSession.insert("saveUser", user);
System.out.println(user);
// 需要进行事务提交
sqlSession.commit();
sqlSession.close();
}
- 测试结果
MySQL自增主键返回
上图中,保存成功,但是id=0, 解决id返回不正常的问题.
- 修改User.xml映射文件,可以将mysql自增主键返回. 添加selectKey标签:
<!-- 保存用户 插入操作不需要返回值 -->
<insert id="saveUser" parameterType="com.feng.pojo.User">
<!-- selectKey: 实现主键返回 -->
<!-- keyColumn: 主键对应的表中哪一列 -->
<!-- keyProperty: 主键对应的pojo中的哪一个属性 -->
<!-- order: 设置在执行 insert语句前执行id的sql的sql,还是在执行insert语句之后执行查询id的sq(AFTER) -->
<!-- resultType: 设置返回的id的类型 -->
<selectKey keyColumn="id" keyProperty="id" order="AFTER"
resultType="int">
SELECT LAST_INSERT_ID()
</selectKey>
insert into user
(username, birthday, sex, address)
values
(#{username},#{birthday},#{sex},#{address})
</insert>
- 测试结果
修改用户
- 在User.xml配置文件中添加如下内容:
<!-- 更新操作 -->
<update id="updateUserById"
parameterType="com.feng.pojo.User">
update user set username = #{username} where id = #{id}
</update>
- 测试类中增加一下方法
@Test
public void testUpdateUserById() {
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = new User();
user.setId(1);
user.setUsername("王一博");
sqlSession.update("updateUserById", user);
System.out.println(user);
// 需要进行事务提交
sqlSession.commit();
sqlSession.close();
}
- 测试结果
删除用户
- 在User.xml配置文件中添加如下内容:
<!-- 删除操作 -->
<delete id="deleteUserById" parameterType="int">
delete from user where id = #{id}
</delete>
- 测试类中增加一下方法
@Test
public void testDeleteUserById() {
SqlSession sqlSession = sqlSessionFactory.openSession();
sqlSession.update("deleteUserById", 1);
sqlSession.commit();
sqlSession.close();
}
- 测试结果(没有id=1)
MyBatis解决jdbc编程的问题
- 数据库连接创建, 释放频繁造成系统资源浪费, 从而影响系统性能, 如果使用数据库连接池, 可解决此问题
解决: 在SqlMapConfig.xml中配置数据连接池, 使用连接池管理数据库连接.
- Sql语句写在代码中造成代码不易维护, 实际应用sql变化的可能较大, sql变动需要改变java代码
解决: 将sql语句配置在XXXmapper.xml文件中域java代码分离.
- 向sql语句传参数麻烦, 因为sql语句的where条件不一定, 可能多也可能少, 占位符需要和参数一一对应.
解决: MyBatis自动将java对象映射至sql语句, 通过statement中的parameterType定义输入参数的类型.
- 对结果集解析麻烦, sql变化导致解析代码变化, 且解析前需要遍历, 如果能将数据库记录封装成pojo对象解析比较方便.
解决: MyBatis将自动sql执行结果映射至Java对象, 通过statement中的resultType定义输出结果的类型.
Dao开发方法
使用MyBatis开发Dao, 通常有两个方法, 即原始Dao开发方法和Mapper动态代理开发方法.
- 需求
使用MyBatis开发Dao实现以下功能:
- 根据用户id查询一个用户信息
- 根据用户名称模糊查询用户登录信息列表
- 添加用户信息
- SqlSessionFactoryBuilder
SqlSessionFactoryBuilder用于创建SqlSessionFactory, SqlSessionFactory一旦创建完成就不需要SqlSessionFactoryBuilder了, 因为SqlSession是通过SqlSessionFactory创建的. 所以可以将SqlSessionFactoryBuilder当成一个工具类使用, 最佳使用范围是方法范围, 即方法体内局部变量.
- SqlSessionFactory
SqlSessionFactory是一个接口(连接池), 接口中定义了openSession的不同重载方法, SqlSessionFactory的最佳使用范围是整个应用运行期间, 一旦创建后可以重复使用, 通常以单例模式管理SqlSessionFactory
- SqlSession
SqlSession是一个面向用户的接口, sqlSession中定义了数据库操作方法.
每个线程都有他自己的sqlSession实例. SqlSession的实例不能共享使用, 它也是线程不安全的. 因此最佳的范围是请求或方法范围. 绝对不能将SqlSession实例的引用放在一个静态字段或实例字段中.
- SqlSession的使用范围
SqlSession中封装了对数据库的操作, 如:查询,插入, 更新, 删除等.
SqlSession通过SqlSessionFactory创建.
SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建.
打开一个sqlSession;使用完毕就要关闭它. 通常把这个关闭操作放到finally块中以确保每次都能执行关闭. 如下:
SqlSession session = sqlSessionFactory.openSession();
try {
// do work
} finally {
session.close();
}
原始Dao开发方式
原始Dao开发方式需要程序员编写Dao接口和Dao实现类
- 映射文件(User.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="test">
<!-- id:statement的id或者叫sql的id -->
<!-- parameterType: 声明输入参数的类型 -->
<!-- resultType: 声明输出结果的类型(返回的结果类型), 应该填写pojo的全路径 -->
<!-- #{}: 输入参数的占位符,相当于jdbc的? -->
<!-- select查询标签 ; #{id}类似jdbc的问号?,需要设置参数 -->
<!-- 根据id查询用户 -->
<select id="queryUserById" parameterType="int"
resultType="com.feng.pojo.User">
SELECT * FROM user WHERE id = #{id}
</select>
<!-- 如果返回多个结果, mybatis会自动把返回的结果放在list容器中 -->
<!-- resultType的配置和返回一个结果的配置一样 -->
<!-- 实现根据用户姓名模糊查询用户 -->
<select id="queryUserByUsername" parameterType="String"
resultType="com.feng.pojo.User">
select * from user where username like #{username}
</select>
<!-- 保存用户 插入操作不需要返回值 -->
<insert id="saveUser" parameterType="com.feng.pojo.User">
<!-- selectKey: 实现主键返回 -->
<!-- keyColumn: 主键对应的表中哪一列 -->
<!-- keyProperty: 主键对应的pojo中的哪一个属性 -->
<!-- order: 设置在执行 insert语句前执行id的sql的sql,还是在执行insert语句之后执行查询id的sq(AFTER) -->
<!-- resultType: 设置返回的id的类型 -->
<selectKey keyColumn="id" keyProperty="id" order="AFTER"
resultType="int">
SELECT LAST_INSERT_ID()
</selectKey>
insert into user
(username, birthday, sex, address)
values
(#{username},#{birthday},#{sex},#{address})
</insert>
</mapper>
- DAO接口开发
public interface UserDao {
// 根据id查询用户
User queryUserById(int id);
// 根据用户名模糊查询用户
List<User> queryUserByUsername(String username);
// 保存用户
void saveUser(User user);
}
- DAO实现开发
public class UserDaoImpl implements UserDao {
private SqlSessionFactory sqlSessionFactory;
public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
super();
this.sqlSessionFactory = sqlSessionFactory;
}
@Override
public User queryUserById(int id) {
SqlSession sqlSession = this.sqlSessionFactory.openSession();
User user = sqlSession.selectOne("queryUserById", id);
sqlSession.close();
return user;
}
@Override
public List<User> queryUserByUsername(String username) {
SqlSession sqlSession = sqlSessionFactory.openSession();
List<User> list = sqlSession.selectList("queryUserByUsername", username);
sqlSession.close();
return list;
}
@Override
public void saveUser(User user) {
SqlSession sqlSession = sqlSessionFactory.openSession();
sqlSession.insert("saveUser", user);
sqlSession.commit();
sqlSession.close();
}
}
- Dao测试类
public class UserDaoTest {
private SqlSessionFactory sqlSessionFactory;
@Before
public void init() throws IOException {
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
}
@Test
public void testQueryUserById() {
UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
User user = userDao.queryUserById(16);
System.out.println(user);
}
@Test
public void testQueryUserByUsername() {
UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
List<User> list = userDao.queryUserByUsername("%张%");
for (User user : list) {
System.out.println(user);
}
}
@Test
public void testSaveUser() {
UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
User user = new User();
user.setUsername("刘备");
user.setBirthday(new Date());
user.setSex("1");
user.setAddress("蜀国");
userDao.saveUser(user);
System.out.println(user);
}
}
- 测试结果
testQueryUserById()
testQueryUserByUsername()
testSaveUser()
原始Dao开发存在问题
- Dao方法体存在重复代码: 通过SqlSessionFactory创建SqlSession, 调用SqlSession的数据库操作方法
- 调用sqlSession的数据库操作方法需要指定statement的id, 这里存在硬编码, 不利于开发维护
Mapper动态代理方式
- 开发规范
Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口), 由MyBatis框架根据接口定义创建接口的动态代理对象, 代理对象的方法体同上边Dao接口实现类方法.
Mapper接口开发需要遵循以下规范:
- Mapper.xml文件中的namespace与mapper接口的类路径相同
- Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
- Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同
- Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
映射文件(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 -->
<!-- 还有一个很重要的作用, 使用动态代理开发DAO, 1. namespace必须和Mapper类接口类路径一致 -->
<mapper namespace="com.feng.dao.UserMapper">
<!-- 根据用户id查询用户
1. id必须和Mapper接口方法名一致
2. parameterType必须和接口方法参数类型一致
3. resultType必须和接口方法返回值类型一致
-->
<select id="queryUserById" parameterType="int" resultType="com.feng.pojo.User">
select * from user where id = #{id}
</select>
<select id="queryUserByUsername" parameterType="string" resultType="com.feng.pojo.User">
select * from user where username like '%${value}%'
</select>
<insert id="saveUser" parameterType="com.feng.pojo.User">
<selectKey keyProperty="id" keyColumn="id" order="AFTER" resultType="int">
select last_insert_id()
</selectKey>
insert into user(username, birthday, sex, address) values
(#{username}, #{birthday}, #{sex}, #{address})
</insert>
</mapper>
- 接口文件(UserMapper.java)
public interface UserMapper {
User queryUserById(int id);
List<User> queryUserByUsername(String username);
void saveUser(User user);
}
- 在SqlMapConfig.xml文件加载配置文件
<mapper resource="mapper/UserMapper.xml"/>
- 测试类
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
@Before
public void init() throws IOException {
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
}
@Test
public void testQueryUserById() {
// 获取sqlSession, 和spring整合后由spring管理
SqlSession sqlSession = this.sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 执行查询方法
User user = userMapper.queryUserById(1);
System.out.println(user);
// 和spring整合后由spring管理
sqlSession.close();
}
@Test
public void testQueryUserByUsername() {
// 获取sqlSession, 和spring整合后由spring管理
SqlSession sqlSession = this.sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 执行查询方法
List<User> list = userMapper.queryUserByUsername("张");
for (User user : list) {
System.out.println(user);
}
// 和spring整合后由spring管理
sqlSession.close();
}
@Test
public void testSaveUser() {
// 获取sqlSession, 和spring整合后由spring管理
SqlSession sqlSession = this.sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 创建保存对象
User user = new User();
user.setUsername("刘备");
user.setBirthday(new Date());
user.setSex("0");
user.setAddress("蜀国");
// 执行查询方法
userMapper.saveUser(user);
// 提交事务
sqlSession.commit();
// 和spring整合后由spring管理
sqlSession.close();
}
}
- 测试结果同上
- selectOne和selectList 动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定, 如果返回list则调用selectList方法, 如果返回单个对象, 则调用selectOne方法
- namespace mybatis官方推荐使用mapper代理方法开发mapper接口, 程序员不用编写mapper接口实现类,使用mapper代理方法时, 输入参数可以使用pojo包装对象或map对象, 保证dao的通用性.