Mybatis本是apache的一个开源项目ibatis,2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。
Mybatis是一个优秀的持久层框架,它对jdbc的操作数据库的过程进行封装,使开发者只需要关注SQL本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
Mybatis通过xml或注解的方式将要执行的各种statement(statement、preparedStatement、CallableStatement)配置起来,并通过java对象和statement中的sql进行映射生成最终执行的sql语句,最后由mybatis框架执行sql并将结果映射成java对象并返回。
使用jdbc编程问题总结
jdbc编程步骤:
- 加载数据库驱动
- 创建并获取数据库链接
- 创建jdbc statement对象
- 设置sql语句
- 设置sql语句中的参数(使用preparedStatement)
- 通过statement执行sql并获取结果
- 对sql执行结果进行解析处理
- 释放资源(resultSet、preparedstatement、connection)
jdbc程序:
public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
// 加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
// 通过驱动管理类获取数据库链接
connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8", "root", "root");
// 定义sql语句 ?表示占位符
String sql = "select * from user where username = ?";
// 获取预处理statement
preparedStatement = connection.prepareStatement(sql);
// 设置参数,第一个参数为sql语句中参数的序号(从1开始),第二个参数为设置的参数值
preparedStatement.setString(1, "王五");
// 向数据库发出sql执行查询,查询出结果集
resultSet = preparedStatement.executeQuery();
// 遍历查询结果集
while (resultSet.next()) {
System.out.println(resultSet.getString("id") + " " + resultSet.getString("username"));
}
} catch (Exception e) {
e.printStackTrace();
} finally {
// 释放资源
if (resultSet != null) {
try {
resultSet.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
if (preparedStatement != null) {
try {
preparedStatement.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
if (connection != null) {
try {
connection.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}
jdbc问题总结如下:
- 数据库连接创建、释放频繁造成系统资源浪费,从而影响系统性能。如果使用数据库连接池可解决此问题
- Sql语句在代码中硬编译,造成代码不易维护,实际应用中sql变化的可能较大,sql变动需要改变java代码
- 使用preparedStatement向占位符传参存在硬代码,因为sql语句的where条件不一定,可能多也可能较少,修改sql户要修改代码,系统不易维护。
- 对结果集解析存在硬编码(查询列名),sql变化导致解析代码变化,系统不易维护,如果能将数据库记录封装成pojo对象解析比较方便。
Mybatis架构
1、Mybatis配置
SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息。
mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。
2、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂。
3、由会话工厂创建sqlSelssion即会话,操作数据库需要通过sqlSession进行。
4、mybatis底层自定义了Executor执行器接口操作数据库,Executor接口有两个实现,一个是基本执行器,一个是缓存执行器。
5、Mapped Statement 也是mybatis一个底层封装对象,它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement 对象,sql的id即是Mapped Statement的id。
6、Mapped Statement 对sql执行输入参数进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement 在执行sql前将输入的java对象映射至sql中,输入参数映射就是jdbc编程中对preparedStatement设置参数。
7、Mapped Statement 对sql执行输出结果进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中,输出结果映射过程相当于jdbc编程中对结果的解析处理过程。
Mybatis入门程序
mybaits的代码由github.com管理
下载地址:https://github.com/mybatis/mybatis-3/releases
mybatis-3.2.7.jar :mybatis的核心包
lib文件夹 :mybatis的依赖包所在
mybatis-3.2.7.pdf :mybatis使用手册
1、创建Java工程,引入jar包
加入mybatis核心包、依赖包、数据驱动包。
mybatis核心包
mybatis依赖包
数据库驱动包(已添加)
2、引入配置文件
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
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">
<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="admin" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="sqlmap/User.xml"/>
</mappers>
</configuration>
SqlMapConfig.xml是mybatis核心配置文件,配置文件内容为数据源、事务管理。
3、创建pojo
pojo类作为mybatis进行sql映射使用,pojo类通常与数据库表对应,
数据库user表如下图:
User.java:
Public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
get/set……
4、sql映射文件
在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,还有一个很重要的作用,后面会讲 -->
<mapper namespace="user">
</mapper>
5、加载映射文件
mybatis框架需要加载Mapper.xml映射文件
将users.xml添加在SqlMapConfig.xml,如下:
业务需求
使用MyBatis实现以下功能:
根据用户id查询一个用户
- 映射文件
在user.xml中添加select标签,编写sql:
<!-- 根据用户id查询一个用户 -->
<!-- id:statement的id 或者叫做sql的id-->
<!-- parameterType:声明输入参数的类型 -->
<!-- resultType:声明输出结果的类型,应该填写pojo的全路径 -->
<!-- #{}:输入参数的占位符,相当于jdbc的? -->
<select id="selectById" parameterType="Integer" resultType="com.ithou.mybatis.pojo.User">
select * from User where id = #{i}
</select>
- 测试程序
// 根据用户id查询一个用户
@Test
public void demo1() throws IOException {
// 加载核心配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = sqlSession.selectOne("user.selectById", 10);
System.out.println(user);
}
根据用户名称模糊查询用户列表
- 映射文件
<!-- 根据用户名称模糊查询用户列表 -->
<!--
#{} select * from User where id = ? 占位符 ?=='小明'
${} select * from User where username like '%小明%' 字符串拼接
-->
<select id="find" parameterType="String" resultType="com.ithou.mybatis.pojo.User">
select * from User where username like '%${value}%'
</select>
- 测试程序
// 根据用户名称模糊查询用户列表
@Test
public void demo2() throws IOException {
// 加载配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();
List<User> list = sqlSession.selectList("user.find", "小明");
for (User user : list) {
System.out.println(user);
}
}
小结:
1、#{}和${}
#{}:表示一个占位符号,通过#{}可以实现preparedStatement向占位符中设置值,自动进行java类型和jdbc类型转换。#{}可以有效防止sql注入。可以接收简单类型值或pojo属性值。如果parameterType传输单个简单类型值,#{}括号中可以是value或其它名称。
${}:表示拼接sql串,通过${}可以将parameterType传入的内容拼接在sql中且不进行jdbc类型转换,${}可以接收简单类型值或pojo属性值,如果parameterType传输单个简单类型值,${}括号中只能是value。
2、parameterType和resultType
parameterType:指定输入参数类型,mybatis通过ognl从输入对象中获取参数值拼接在sql中。
resultType:指定输出结果类型,mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。如果有多条数据,则分别进行映射,并把对象放到容器List中
3、selectOne和selectList
selectOne:查询一条记录,如果使用selectOne查询多条记录则抛出异常
org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 3
at org.apache.ibatis.session.defaults.DefaultSqlSession.selectOne(DefaultSqlSession.java:70)
selectList:可以查询一条或多条记录
添加用户
- 映射文件
<!-- 添加用户 -->
<insert id="insert" parameterType="com.ithou.mybatis.pojo.User" useGeneratedKeys="true" keyProperty="id">
insert into User (id,username,sex,birthday,address) values (#{id},#{username},#{sex},#{birthday},#{address})
</insert>
- 测试程序
// 添加用户
@Test
public void demo3() throws IOException, ParseException {
// 加载配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = new User();
user.setUsername("Bob");
user.setSex("1");
user.setBirthday(new SimpleDateFormat("yyyy-MM-dd").parse("2000-03-05"));
user.setAddress("BeiJing");
int i = sqlSession.insert("user.insert", user);
sqlSession.commit();
System.out.println(user.getId());
}
更新用户
- 映射文件
<!-- 更新用户 -->
<update id="update" parameterType="com.ithou.mybatis.pojo.User">
update User set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address} where id=#{id}
</update>
- 测试程序
// 更新用户
@Test
public void demo4() throws IOException, ParseException {
// 加载配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = new User();
user.setId(25);
user.setUsername("jock");
user.setBirthday(new SimpleDateFormat("yyyy-MM-dd").parse("1986-01-15"));
user.setAddress("shanghai");
int i = sqlSession.update("user.update", user);
sqlSession.commit();
}
删除用户
- 映射文件
<!-- 删除用户 -->
<delete id="delete" parameterType="Integer">
delete from User where id = #{i}
</delete>
- 测试程序
// 删除用户
@Test
public void demo5() throws IOException {
// 加载配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();
int i = sqlSession.delete("user.delete", 26);
sqlSession.commit();
}
mybatis解决jdbc编程的问题
1、数据库连接创建、释放频繁造成系统资源浪费,从而影响系统性能。如果使用数据库连接池可解决此问题
解决:在SqlMapConfig.xml中配置数据连接池,使用连接池管理数据库连接
2、Sql语句在代码中硬编译,造成代码不易维护,实际应用中sql变化的可能较大,sql变动需要改变java代码
解决:将sql语句配置在XXXXmapper.xml文件中与java代码分离。
3、使用preparedStatement向占位符传参存在硬代码,因为sql语句的where条件不一定,可能多也可能较少,修改sql户要修改代码,系统不易维护。
解决:Mybatis自动将java对象映射至sql语句,通过statement中的parameterType定义输入参数的类型。
4、对结果集解析存在硬编码(查询列名),sql变化导致解析代码变化,系统不易维护,如果能将数据库记录封装成pojo对象解析比较方便。
解决:Mybatis自动将sql执行结果映射至java对象,通过statement中的resultType定义输出结果的类型。
mybatis与hibernate不同
Mybatis和hibernate不同,它不完全是一个ORM框架,因为MyBatis需要程序员自己编写Sql语句。mybatis可以通过XML或注解方式灵活配置要运行的sql语句,并将java对象和sql语句映射生成最终执行的sql,最后将sql执行的结果再映射生成java对象。
Mybatis学习门槛低,简单易学,程序员直接编写原生态sql,可严格控制sql执行性能,灵活度高,非常适合对关系数据模型要求不高的软件开发,例如互联网软件、企业运营类软件等,因为这类软件需求变化频繁,一但需求变化要求成果输出迅速。但是灵活的前提是mybatis无法做到数据库无关性,如果需要实现支持多种数据库的软件则需要自定义多套sql映射文件,工作量大。
Hibernate对象/关系映射能力强,数据库无关性好,对于关系模型要求高的软件(例如需求固定的定制化软件)如果用hibernate开发可以节省很多代码,提高效率。但是Hibernate的学习门槛高,要精通门槛更高,而且怎么设计O/R映射,在性能和对象模型之间如何权衡,以及怎样用好Hibernate需要具有很强的经验和能力才行。
总之,按照用户的需求在有限的资源环境下只要能做出维护性、扩展性良好的软件架构都是好架构,所以框架只有适合才是最好。
Mapper动态代理方式
开发规范:Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象。
Mapper接口开发需要遵循以下规范:
- Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
- Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
- Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
- Mapper.xml文件中的namespace与mapper接口的类路径相同。
创建Mapper接口:
public interface UserMapper {
//遵循四个原则:
//接口 方法名==User.xml中id名
//返回值类型 与 Mapper.xml文件中返回值类型要一致
//方法的入参类型 与Mapper.xml中入参类型要一致
//命名空间捆绑此接口
public User selectById(Integer id);
}
测试类:
// 根据用户id查询一个用户
@Test
public void demo1() throws IOException {
// 加载核心配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
// 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
// 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.selectById(10);
System.out.println(user);
}
小结:
1、selectOne和selectList
动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。
2、namespace
mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。
SqlMapConfig.xml配置文件
配置内容
SqlMapConfig.xml中配置的内容和顺序如下:
properties(属性)
settings(全局配置参数)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境集合属性对象)
environment(环境子属性对象)
transactionManager(事务管理)
dataSource(数据源)
mappers(映射器)
properties(属性)
jdbc.properties配置文件内容如下:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
SqlMapConfig.xml引用如下:
<configuration>
<properties resource="jdbc.properties"/>
......
注意: MyBatis 将按照下面的顺序来加载属性:
- 在 properties 元素体内定义的属性首先被读取。
- 然后会读取properties 元素中resource或 url 加载的属性,它会覆盖已读取的同名属性。
typeAliases(类型别名)
mybatis支持别名:
别名 | 映射的类型 |
_byte | byte |
_long | long |
_short | short |
_int | int |
_integer | int |
_double | double |
_float | float |
_boolean | boolean |
string | String |
byte | Byte |
long | Long |
short | Short |
int | Integer |
integer | Integer |
double | Double |
float | Float |
boolean | Boolean |
date | Date |
decimal | BigDecimal |
bigdecimal | BigDecimal |
map | Map |
自定义别名:
在SqlMapConfig.xml中配置如下:
<!-- 别名 包以其子包下所有类 头字母大小都行-->
<typeAliases>
<!-- 单个别名定义 -->
<!-- <typeAlias type="com.itheima.mybatis.pojo.User" alias="User"/> -->
<!-- 批量别名定义,扫描整个包下的类,别名为类名(大小写不敏感) -->
<package name="com.itheima.mybatis.pojo"/>
</typeAliases>
在mapper.xml配置文件中,就可以使用设置的别名了
别名大小写不敏感
mappers(映射器)
Mapper配置的几种方法:
1、<mapper resource=" " />
使用相对于类路径的资源(现在的使用方式) 如:<mapper resource="sqlmap/User.xml" />
2、<mapper class=" " />
使用mapper接口类路径 如:<mapper class="cn.itcast.mybatis.mapper.UserMapper"/>
注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。
3、<package name=""/>
注册指定包下的所有mapper接口 如:<package name="cn.itcast.mybatis.mapper"/>
注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。