【原文】https://www.toutiao.com/i6594610137560777223/
一、什么是MyBatis
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。
MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。它对jdbc的操作数据库的过程进行封装,使程序员只需要关注 SQL 本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
二、MyBatis框架
- mybatis配置:SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息;mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。
- 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂
- 由会话工厂创建sqlSession即会话,操作数据库需要通过sqlSession进行。
- mybatis底层自定义了Executor执行器接口操作数据库,Executor接口有两个实现,一个 是基本执行器、一个是缓存执行器。
- Mapped Statement也是mybatis一个底层封装对象,它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象,sql的id即是Mapped statement的id。
- Mapped Statement对sql执行输入参数进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中,输入参数映射就是jdbc编程中对preparedStatement设置参数。
- Mapped Statement对sql执行输出结果进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中,输出结果映射过程相当于jdbc编程中对结果的解析处理过程。
三.入门程序
- 需求
- 根据用户id(主键)查询用户信息
- 根据用户名称模糊查询用户信息
- 添加用户
- 删除用户
- 更新用户
2. 所需jar包
- MyBatis下载
- mybatis-3.4.4.jar :核心包
- mysql-connector-java-5.1.jar:mysql的驱动包
3. 工程结构
4. log4j.properties
# Global logging configuration
#在开发的环境下,日志级别要设置成DEBUG,生产环境设置成info或error
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
5. SqlMapConfig.xml
MyBatis核心配置文件,配置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">
<configuration>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理,事务控制由mybatis管理-->
<transactionManager type="JDBC" />
<!-- 数据库连接池,由mybatis管理-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 加载映射文件 -->
<mappers>
<mapper resource="sqlmap/User.xml"/>
</mappers>
</configuration>
6.根据用户id(主键)查询用户信息
1)创建po类
View Codepackage joanna.yan.mybatis.entity;
import java.sql.Date;
public class User {
//属性名称和数据库字段名称保持一致
private int id;
private String username;
private Date birthday;
private String sex;
private String address;
public User(String username, Date birthday, String sex, String address) {
super();
this.username = username;
this.birthday = birthday;
this.sex = sex;
this.address = address;
}
public User(int id, String username, Date birthday, String sex,
String address) {
super();
this.id = id;
this.username = username;
this.birthday = birthday;
this.sex = sex;
this.address = 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 String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex
+ ", address=" + address + ", birthday=" + birthday + "]";
}
}
2)映射文件
映射文件命名:
User.xml(原始的ibatis的命名方式),mapper代理开发映射文件名称叫XXXMapper.xml,比如:UserMapper.xml、ItemsMapper.xml。
在映射文件中配置sql语句。
<?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进行分类化的管理,理解为sql隔离
注意:使用mapper代理开发时,namespace有特殊作用 -->
<mapper namespace="test">
<!--在映射文件中配置很多sql语句 -->
<!--需求:通过id查询用户表的记录 -->
<!--id:标识映射文件中的sql,称为statement的id。将sql语句封装在mapperStatement的对象中,所有id称为Statement的id;
parameterType:指定输入参数的类型,这里指定int型;
#{}:表示一个占位符;
#{id}:其中id表示接收输入的参数,参数名称就是id,如果输入参数是简单类型,#{}中的参数名可以任意,可以是value或其它名称;
resultType:指定输出结果所映射的Java对象类型,select指定resultType表示将单条记录映射成Java对象。
-->
<select id="findUserById" parameterType="java.lang.Integer" resultType="joanna.yan.mybatis.entity.User">
select * from user where id=#{id}
</select>
</mapper>
3)在SqlMapConfig.xml中加载映射文件
<!-- 加载映射文件 -->
<mappers>
<mapper resource="sqlmap/User.xml"/>
</mappers>
4)程序编写
public class MybatisFirst {
@Test
public void findUserByIdTest(){
//mybatis的配置文件
String resource="SqlMapConfig.xml";
InputStream inputStream=null;
SqlSession sqlSession=null;
try {
inputStream=Resources.getResourceAsStream(resource);
//1.创建会话工厂,传入mybatis的配置文件信息
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
//2.通过工厂得到SqlSession
sqlSession=factory.openSession();
//3.通过SqlSession操作数据库
//参数一:映射文件中的statement的id,等于namespace+"."+statement的id;
//参数二:指定和映射文件中所匹配的parameterType类型的参数;
//sqlSession.selectOne结果是与映射文件所匹配的resultType类型的对象;
//selectOne:查询一条结果
User user=sqlSession.selectOne("test.findUserById", 1);
System.out.println(user.toString());
} catch (IOException e) {
e.printStackTrace();
}finally{
if(sqlSession!=null){
sqlSession.close();
}
if(inputStream!=null){
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
}
7.根据用户名称模糊查询用户信息
1)映射文件
使用User.xml,添加根据用户名称模糊查询用户信息的sql语句。
<!--
需求:根据用户名称模糊查询用户信息,可能返回多条数据
resultType:指定的就是单条记录所映射的Java类型;
${}:表示拼接sql字符串,将接收到的参数内容不加任何修饰的拼接在sql中。使用${}拼接sql,可能会引起sql注入;
${value}:接收输入参数的内容,如果传入的是简单类型,${}中只能使用value
-->
<select id="findUserByName" parameterType="java.lang.String" resultType="joanna.yan.mybatis.entity.User">
select * from user where username LIKE '%${value}%'
</select>
2)程序编写
@Test
public void findUserByNameTest(){
//mybatis的配置文件
String resource="SqlMapConfig.xml";
InputStream inputStream=null;
SqlSession sqlSession=null;
try {
inputStream=Resources.getResourceAsStream(resource);
//1.创建会话工厂,传入mybatis的配置文件信息
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
//2.通过工厂得到SqlSession
sqlSession=factory.openSession();
//3.通过SqlSession操作数据库
//参数一:映射文件中的statement的id,等于namespace+"."+statement的id;
//参数二:指定和映射文件中所匹配的parameterType类型的参数;
//sqlSession.selectOne结果是与映射文件所匹配的resultType类型的对象;
//list中的user和resultType类型一致
List<User> list=sqlSession.selectList("test.findUserByName", "小明");
System.out.println(list);
} catch (IOException e) {
e.printStackTrace();
}finally{
if(sqlSession!=null){
sqlSession.close();
}
if(inputStream!=null){
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
8.添加用户
1)映射文件
在User.xml配置添加用户的statement(多个sql)。
<!--
需求:添加用户
parameterType:指定输入的参数类型是pojo(包括用户信息);
#{}:中指定pojo的属性名称,接收到pojo对象的属性值,mybatis通过ONGL(类似于struts2的OGNL)获取对象的属性值
-->
<insert id="insertUser" parameterType="joanna.yan.mybatis.entity.User">
insert into user (username,sex,address,birthday) values (#{username},#{sex},#{address},#{birthday})
</insert>
2)程序编写
@Test
public void insertUserTest(){
//mybatis的配置文件
String resource="SqlMapConfig.xml";
InputStream inputStream=null;
SqlSession sqlSession=null;
try {
inputStream=Resources.getResourceAsStream(resource);
//1.创建会话工厂,传入mybatis的配置文件信息
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
//2.通过工厂得到SqlSession
sqlSession=factory.openSession();
User user=new User("yan",new Date(System.currentTimeMillis()),"女", "上海");
//3.通过SqlSession操作数据库
//参数一:映射文件中的statement的id,等于namespace+"."+statement的id;
//参数二:指定和映射文件中所匹配的parameterType类型的参数;
sqlSession.insert("test.insertUser",user);
//提交事务
sqlSession.commit();
System.out.println(user.getId());
} catch (IOException e) {
e.printStackTrace();
}finally{
if(sqlSession!=null){
sqlSession.close();
}
if(inputStream!=null){
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
3)自增主键返回
mysql自增主键:执行insert提交之前自动生成一个自增主键。
通过Mysql函数获取到刚插入记录的自增主键:LAST_INSERT_ID()
是insert之后调用此函数。
修改insertUser定义:
<!--
需求:添加用户
parameterType:指定输入的参数类型是pojo(包括用户信息);
#{}:中指定pojo的属性名称,接收到pojo对象的属性值,mybatis通过ONGL(类似于struts2的OGNL)获取对象的属性值
-->
<insert id="insertUser" parameterType="joanna.yan.mybatis.entity.User">
<!-- 将insert插入的数据的主键返回到User对象中;
select last_insert_id():得到刚inser进去记录的主键值,只适用于自增主键;
keyProperty:将查询到的主键值,设置到parameterType指定的对象的那个属性;
order:select last_insert_id()的执行顺序,相对于insert语句来说它的执行顺序;
resultType:指定select last_insert_id()的结果类型;
-->
<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
select last_insert_id()
</selectKey>
insert into user (username,sex,address,birthday) values (#{username},#{sex},#{address},#{birthday})
</insert>
4)非自增主键返回(使用uuid())
使用mysql的uuid()函数生成主键,需要修改表中id字段类型为String,长度设置为35位。
执行思路:
先通过uuid()查询到主键,将主键输入到sql语句中。
执行uuid()语句顺序相对于insert语句之前执行。
<!--
需求:添加用户
parameterType:指定输入的参数类型是pojo(包括用户信息);
#{}:中指定pojo的属性名称,接收到pojo对象的属性值,mybatis通过ONGL(类似于struts2的OGNL)获取对象的属性值
-->
<insert id="insertUser" parameterType="joanna.yan.mybatis.entity.User"><!--
使用mysql的uuid(),实现非自增主键的返回;
执行过程:通过uuid()得到主键,将主键设置到user对象的id的属性中,其次,在inser执行时,从user对象中取出id属性值;
-->
<selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
select uuid()
</selectKey>
insert into user (id,username,sex,address,birthday) values (#{id},#{username},#{sex},#{address},#{birthday})
</insert>
通过oracle的序列生成主键:
<selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
SELECT 序列名.nextval()
</selectKey>
insert into user(id,username,birthday,sex,address) value(#{id},#{username},#{birthday},#{sex},#{address})
9.删除用户和更新用户
1)映射文件
<!-- 需求:删除用户 -->
<delete id="deleteUser" parameterType="java.lang.Integer">
delete from user where id=#{id}
</delete>
<!-- 需求:更新用户 注意:id必须存在 -->
<update id="updateUser" parameterType="joanna.yan.mybatis.entity.User">
update user set username=#{username},sex=#{sex},address=#{address},birthday=#{birthday} where id=#{id}
</update>
2)程序编写
@Test
public void deleteUserTest(){
//mybatis的配置文件
String resource="SqlMapConfig.xml";
InputStream inputStream=null;
SqlSession sqlSession=null;
try {
inputStream=Resources.getResourceAsStream(resource);
//1.创建会话工厂,传入mybatis的配置文件信息
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
//2.通过工厂得到SqlSession
sqlSession=factory.openSession();
//3.通过SqlSession操作数据库
//参数一:映射文件中的statement的id,等于namespace+"."+statement的id;
//参数二:指定和映射文件中所匹配的parameterType类型的参数;
sqlSession.delete("test.deleteUser",3);
//提交事务
sqlSession.commit();
} catch (IOException e) {
e.printStackTrace();
}finally{
if(sqlSession!=null){
sqlSession.close();
}
if(inputStream!=null){
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
@Test
public void updateUserTest(){
//mybatis的配置文件
String resource="SqlMapConfig.xml";
InputStream inputStream=null;
SqlSession sqlSession=null;
try {
inputStream=Resources.getResourceAsStream(resource);
//1.创建会话工厂,传入mybatis的配置文件信息
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
//2.通过工厂得到SqlSession
sqlSession=factory.openSession();
User user=new User(2,"yan",new Date(System.currentTimeMillis()), "女", "上海");
//3.通过SqlSession操作数据库
//参数一:映射文件中的statement的id,等于namespace+"."+statement的id;
//参数二:指定和映射文件中所匹配的parameterType类型的参数;
//根据id更新用户
sqlSession.update("test.updateUser",user);
//提交事务
sqlSession.commit();
} catch (IOException e) {
e.printStackTrace();
}finally{
if(sqlSession!=null){
sqlSession.close();
}
if(inputStream!=null){
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
四、 总结
1.parameterType
在映射文件中通过parameterType指定输入参数的类型。
2.resultType
在映射文件中通过resultType指定输出结果的类型
3.#{}和${}
#{}表示一个占位符,#{}接收输入参数。#{}可以有效防止sql注入。类型可以是简单类型,pojo、hashmap。如果接收简单类型,#{}中可以写成value或其它名称。
#{}接收pojo对象值,通过OGNL读取对象中的属性值,通过属性.属性.属性...的方式获取对象属性值。
${}表示一个拼接符号,拼接sql串,会引起sql注入存在安全隐患,所以不建议使用${}。${}接收输入参数,类型可以是简单类型,pojo、hashmap。如果接收简单类型,${}中只能写成value。
${}接收pojo对象值,通过OGNL读取对象中的属性值,通过属性.属性.属性...的方式获取对象属性值。
4.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可以查询一条或多条记录。
5.MyBatis和Hibernate本质区别和应用场景
1)hibernate:是一个标准ORM框架(对象关系映射)。入门门槛较高,不需要程序员写sql,sql语句自动生成了。对sql语句进行优化、修改比较困难。
应用场景:使用于需要变化不多的中小型项目,比如:后台管理系统,erp、orm、oa。。。
2)mybatis:专注是sql本身,需要程序员之家编写sql语句,sql修改、优化比较方便。mybatis是一个不完全的ORM框架,虽然程序员自己写sql,mybatis也可以实现映射(输入映射、输出映射)。
应用场景:适用与需求变化较多的项目,比如:互联网项目。