1Mybatis概述
1.1Mybatis介绍
MyBatis是一个优秀的持久层框架,它对jdbc操作数据库的过程进行封装,使开发者只需要关注 SQL 本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
Mybatis通过xml或注解的方式将要执行的各种statement(statement、preparedStatement、CallableStatement)配置起来,并通过java对象和statement中的sql进行映射生成最终要执行的sql语句,最后由mybatis框架执行sql并将结果映射成java对象并返回。
1.2Mybatis和JDBC的比较
Mybatis框架使用2个XML文件来封装jdbc操作中的步骤,具体如下:
1.3Mybatis适用场合
MyBatis是一个灵活的DAO层解决方案,满足较高的性能要求,可以在很多场合使用,但一般以下场合不建议使用:
- 需要支持多种数据库或数据库有移植要求
- 完全动态SQL,例如:字段都要动态生成
- 使用的不是关系型数据库
2第一个Mybatis程序
Mybatis程序开发的步骤:
第1步:新建JAVA项目
第2步:导入jar包(包括数据库驱动包)
第3步:创建数据库及表(如已创建,可省略)
第4步:编写主配置文件mybatis.cfg.xml
第5步:创建实体类
第6步:创建SQL映射文件XxxMapper.xml
第7步:创建DAO接口及实现类
第8步:添加log4j.properties
第9步:编写测试类并测试
编写mybatis程序,需求:向员工表中添加员工信息
2.1新建java项目
创建一个java项目,命名:mybatis_hello
2.2导入jar包
解压mybatis-3.3.0.zip,把它的lib目录里的8个jar及mybatis-3.3.0.jar,jdbc驱动包共计10个jar拷贝到自己项目的lib目录,并添加到构建路径
2.3创建数据库及表(如已创建,可省略)
创建数据库mybatis_db,创建表t_employee
2.4编写主配置文件mybatis.cfg.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>
<!-- 配置当前数据库环境(信息),default用来指定当前默认的数据库环境 -->
<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_db" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 加载sql映射文件 -->
<mappers>
<mapper resource="cn/sxt/mapper/EmployeeMapper.xml" />
</mappers>
</configuration>
2.5创建实体类
在domain包(就是以前的entity)下创建Employee实体类
2.6 创建SQL映射文件XxxMapper.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">
<mapper namespace="cn.sxt.mapper.EmpMapper">
<!--
namespace:名称空间
id:唯一标识 resultType:返回值类型
#{xx}:占位符,用于接收传过来的参数值
-->
<insert id="addEmp" parameterType="cn.sxt.domain.Employee" useGeneratedKeys="true">
insert into t_employee(ename,sex,salary) values(#{ename},#{sex},#{salary})
</insert>
</mapper>
2.7创建DAO接口及实现类
EmployeeDao接口提供insert方法,实现类如下:
public class EmployeeDaoImpl implements EmployeeDao {
@Override
public int insert(Employee emp) {
int i=0;
String resource = "mybatis.cfg.xml";
InputStream inputStream = null;
SqlSession session = null;
try {
// 加载主配置文件
inputStream = Resources.getResourceAsStream(resource);
// 构造SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
.build(inputStream);
// 获取session
session = sqlSessionFactory.openSession();
// 执行crud操作,默认启动事务
i=session.insert("cn.sxt.mapper.EmpMapper.addEmp", emp);
// 提交事务
session.commit();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
// 回滚事务
session.rollback();
} finally {
// 关闭session
session.close();
}
return i;
}
}
2.8添加log4j.properties
在项目中添加log4j.properties可以记录程序运行过程中的日志,例如将生成的sql语句记下来,并输出到控制台。Log4j.properties配置如下:
# Global logging configuration log4j.rootLogger=DEBUG, stdout # Console output... log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n |
2.9 编写测试类并测试
@Test
public void test3() {
// 创建员工
Employee emp = new Employee();
emp.setEname("张大龙");
emp.setSalary(6000);
emp.setSex("女");
EmployeeDao dao = new EmployeeDaoImpl();
int i = dao.insert(emp);
System.out.println(i);
}
3Mybatis完成基本CRUD操作
3.1工具类MyBatisUtil
先封装一个工具类MyBatisUtil,提供返回SqlSession对象的方法
public class MyBatisUtil {
private static SqlSessionFactory sqlSessionFactory;
static {
String resource = "mybatis.cfg.xml";
InputStream inputStream = null;
// 加载主配置文件
try {
inputStream = Resources.getResourceAsStream(resource);
// 构造SqlSessionFactory对象
sqlSessionFactory = new SqlSessionFactoryBuilder()
.build(inputStream);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public static SqlSession getSession() {
SqlSession session = sqlSessionFactory.openSession();
return session;
}
3.2 改造Dao接口及实现
public interface EmployeeDao {
int insert(Employee emp);
//修改
int update(Employee emp);
//删除
int delete(int eid);
//查询一个
Employee queryById(int eid);
//查询所有
List<Employee> queryAll();
}
public class EmployeeDaoImpl implements EmployeeDao {
@Override
public int update(Employee emp) {
SqlSession session=MyBatisUtil.getSession();
int i = session.update("cn.sxt.mapper.EmpMapper.updateEmp", emp);
session.commit();
session.close();
return i;
}
@Override
public int delete(int eid) {
SqlSession session=MyBatisUtil.getSession();
int i = session.delete("cn.sxt.mapper.EmpMapper.deleteEmp", eid);
session.commit();
session.close();
return i;
} ...
}
3.3 修改Mapper.xml
加入针对其它几个操作的sql标签
<select id="selectEmp" resultType="cn.sxt.domain.Employee">
select * from t_employee where
eid=#{id}
</select>
<select id="selectAll" resultType="cn.sxt.domain.Employee">
select * from t_employee
</select>
<update id="updateEmp" parameterType="cn.sxt.domain.Employee">
update t_employee set ename=#{ename},sex=#{sex},salary=#{salary} where
eid=#{eid}
</update>
<delete id="deleteEmp">
delete from t_employee where eid=#{id}
</delete>
3.4 测试crud操作
3.5 常用API对象及方法总结
1.SqlSessionFactory
方法:
-- openSession():获取一个Session
2. SqlSession
方法:
-- insert():插入数据
-- update():修改数据
-- delete():删除数据
--selectOne():查询一条记录
-- selectList(): 查询所有记录
-- commit():提交事务
-- close():关闭session
4 XxxMapper.xml文件总结
4.1 Mapper标签及属性
定义了对应的数据库操作的语句,完成对数据库的不同操作进隔离(区分),
namespace属性=“自定义值”
4.2 DML操作标签及属性
insert,update,delete 定义了数据库的具体dml操作。
id属性:”自定义的值”,在整个Mapper.xml文件中唯一,通常用namespace.id 获得对应的Statement的唯一标识
parameterType:“参数的类型”,如果参数是简单类型,通常可省略
对应DML操作,resultType可以省略
4.3 DQL操作标签及属性
select 定义具体的DQL操作
id属性:”自定义的值”,在整个Mapper.xml文件中唯一,通常用namespace.id 获得对应的Statement对象的唯一标识定位sql)(
parameterType:“参数的类型”,如果参数是简单类型,通常可省略
resultType属性:“返回值的类型”,如果返回值为集合,则resultType是指集合中元素的类型。
DQL标签(select)的resultType属性不可以省略
4.4占位符#{}和${}
#{xxx}:这种占位符会进行预编译,变成?占位符
如果传入的参数是简单类型且只有1个参数,那么xxx可以随意写;如果有多个简单参数,那么xxx不能随便写,只能写保存该参数 的map中的key,#{key}是根据key拿到参数的值
如果参数是javaBean类型的,则xxx必须和javabean类的getXxx方法对应,即#{ename}必须对应javaBean类中的getEname()方法,由于getXxx()方法就是根据javaBean的属性生成的,所以xxx必须写成属性名
${xxx}:不进行预编译,直接将传入的参数替换xxx
如果传入的参数是简单类型且只有1个参数,那么xxx只能是value;
如果参数是javaBean类型的,那么xxx必须是javaBean中的属性名,并且需要手动加上’’(当参数的值是String类型时)
注意:${xxx}在底层用的是普通Statement拼接SQL语句,可能造成sql注入
例如:
<select id="queryById" resultType="employee">
select * from t_employee where eid=${value}
</select>
5 DAO层的代理开发
5.1 DAO层传统开发
数据访问层即DAO层,DAO层的传统开发方式是:
- .编写DAO接口
- .编写DAO实现类
传统DAO开发存在的问题有:
1)存在一定量的重复代码。比如:通过SqlSessionFactory创建SqlSession;调用SqlSession的方法操作数据库;提交事务,关闭Sqlsession。
2)存在一些硬编码。比如:调用SqlSession的方法操作数据库时,statementt的唯一标识,这里存在了硬编码。
3) 误导开发工程师:调用sqlSession的操作数据库的方法,参数2都是Object类型,这样即使传的实参是错的,编译时也不会报错
5.2 DAO层代理开发(重点)
采用DAO层代理开发,程序员只需要编写Mapper接口(相当于dao接口)。Mybatis会自动的为Mapper接口创建动态代理实现类。
5.2.1代理开发规范
1、 Mapper接口的全限定名要和Mapper.xml的namespace的值相同。
2、 Mapper接口的方法名称要和Mapper.xml中的statement的id相同;
3、 Mapper接口中方法的参数类型要和Mapper.xml中statement的parameterType的值保持一致。
4、 Mapper接口中方法的返回值类型要和Mapper.xml中statement的resultType值保持一致;
5.2.2定义Mapper接口
public interface EmployeeMapper {
//添加
int insert(Employee emp);
// 修改
int update(Employee emp);
// 删除
int delete(int eid);
// 查询一个
Employee queryById(int eid);
// 查询所有
List<Employee> queryAll();
}
5.2.3定义Mapper.xml文件
<mapper namespace="cn.sxt.mapper.EmployeeMapper">
<!-- id必须和接口中的方法名一致 -->
<insert id="insert" parameterType="employee"
useGeneratedKeys="true">
insert into t_employee(ename,sex,salary)
values(#{ename},#{sex},#{salary})
</insert>
<update id="update" parameterType="employee">
update t_employee set ename=#{ename},sex=#{sex},salary=#{salary} where
eid=#{eid} </update>
<delete id="delete">
delete from t_employee where eid=#{id}
</delete>
<select id="queryById" resultType="employee">
select * from t_employee where
eid=${value}
</select>
<select id="queryAll" resultType="employee">
select * from t_employee
</select>
</mapper>
5.2.4创建测试类
// 添加
@Test
public void test1() {
SqlSession session = MyBatisUtil.getSession();
// 获取Mapper接口的实现类对象(Mapper接口.class)
EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
// EmployeeDao dao=new EmployeeDaoImpl();
// 调用Mapper接口中的方法
Employee emp = new Employee("张无忌", "男", 8250);
int i = mapper.insert(emp);
if (i > 0) {
System.out.println("添加成功");
} else {
System.out.println("添加失败");
}
session.commit();
session.close();
}
// 修改
@Test
public void test2() {
SqlSession session = MyBatisUtil.getSession();
// 获取Mapper接口的实现类对象(Mapper接口.class)
EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
// EmployeeDao dao=new EmployeeDaoImpl();
// 调用Mapper接口中的方法
Employee emp = new Employee("纪晓芙", "女", 4350);
emp.setEid(9);
int i = mapper.update(emp);
if (i > 0) {
System.out.println("修改成功");
} else {
System.out.println("修改失败");
}
session.commit();
session.close();
}
// 测试全查询
@Test
public void test3() {
SqlSession session = MyBatisUtil.getSession();
EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
List<Employee> list = mapper.queryAll();
for (Employee employee : list) {
System.out.println(employee);
}
session.close();
}
// 测试查询单个对象
@Test
public void test4() {
SqlSession session = MyBatisUtil.getSession();
EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
Employee emp = mapper.queryById(5);
if (emp != null) {
System.out.println(emp);
} else {
System.out.println("查无此人");
}
session.close();
}
// 测试删除
@Test
public void test5() {
SqlSession session = MyBatisUtil.getSession();
EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
int i = mapper.delete(5);
if (i > 0) {
System.out.println("删除成功");
} else {
System.out.println("删除失败");
}
session.commit();
session.close();
}
6核心配置文件其它配置
6.1加载Properties文件
- .在src下加入db.properties配置文件
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/mybatis_db
username=root
password=root
b).在mybatis.cfg.xml中用 properties标签加载db.properties文件
dataSource配置如下:
6.2TypeAliases类型别名
在typeAliases标签里可以为类型指名别名 使得在Mapper.xml中可以简化引用 。例如用typeAlias 指定某个类型的别名:
<typeAliases>
<!-- 为类型指定别名,type是全限定类名,alias是别名 -->
<typeAlias type="cn.sxt.domain.Employee" alias="emp"/>
</typeAliases>
还可用package标签为某个包下的所有类指定别名,默认别名就是类名(不区分大小写)
<typeAliases>
<!-- 为类型指定别名,type是全限定类名,alias是别名 -->
<!-- <typeAlias type="cn.sxt.domain.Employee" alias="emp"/> -->
<!-- 为某个包下的所有类指定别名,默认别名就是类名 -->
<package name="cn.sxt.domain"/>
</typeAliases>
Mapper.xml中引用Employee
<select id="selectEmp" resultType="employee">
select * from t_employee where
eid=${value}
</select>
6.3加载映射文件的三种方式
方式一:通过mapper的resource属性加载
语法:<mapper resource="" />
例如:<mapper resource="cn/sxt/mapper/EmployeeMapper.xml" />
方式二:通过mapper的class属性加载,class指定Mapper接口的全限定名,例如:
<mapper class="cn.sxt.mapper.EmployeeMapper" />
方式三:通过指定接口所在的包名称,自动扫描包下的所有mapper接口并加载映射文件
语法:<package name=""/>
例如:<package name="cn.sxt.mapper" />
7 mybatis单表查询深入
7.1 使用resultType作为返回结果类型
属性名和字段名必须一致,才能使用resultType来映射结果集。resultType直接表示返回值类型
7.2 使用resultMap作为返回结果类型(重点重点重点)
resultMap是Mybatis最强大的元素之一,它可以将查询到的复杂数据(比如查询到几个表中数据)映射到一个结果集当中。同时,可以使用它解决属性名和字段名不一致的问题。resultMap作为返回结果类型时,是对外部ResultMap的引用(通过id引用)
例如:
<resultMap type="card" id="cardMap">
<!-- id节点配置主键映射的属性 -->
<id column="id" property="id"/>
<!-- 普通属性与字段的映射, column:字段名 property:实体类的属性名 -->
<result column="cardno" property="card_no"/>
</resultMap>
<!-- select标签上resultMap引用上面的resultMap -->
<select id="queryAll" resultMap="cardMap">
select * from t_card
</select>
7.3 使用sql片段提高sql复用性
在Mapper.xml文件中可使用SQL片段来提高SQL复用性
Sql片段的使用:
- .定义SQL片段
例如: <sql id="empSql">select * from t_employee</sql>
- .在select标签中引用SQL片段
<select id="queryById" resultType="employee">
<!-- 引用SQL片段 -->
<include refid="empSql"></include> where
eid=${value}
</select>
7.4 分页查询
Mybatis的Mapper接口中针对分页查询需要2个方法,并在映射文件中提供sql实现:
- .在Mapper接口中增加方法
//分页查询获取当前页的集合,startIndex是当前页的首行的索引
List<Employee> queryData(int startIndex,int pageSize );
//总记录数
int queryCount();
- 在Mapper.xml中提供sql实现
<select id="queryData" resultType="employee">
<include refid="empSql"></include> limit #{param1},#{param2}
</select>
<select id="queryCount" resultType="int">
select count(*) from t_employee
</select>