简介
1、MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
2、MyBatis让程序将主要精力放在SQL上,通过MyBatis提供的映射方式,自由灵活生成(半自动化,大部分需要程序员编写SQL)满足需要SQL语句。
3、MyBatis可以将向 preparedStatement中的输入参数自动进行输入映射,将查询结果集灵活映射成Java对象。(输出映射)
MyBatis的执行流程
搭建环境
1、创建一个Java工程
2、在 WEB-INF/lib 中添加相应的jar包,下载地址:https://github.com/mybatis/mybatis-3/releases
这里的jar文件分为两类,一类是MyBaits本生的jar包,另一类在lib文件夹,MyBaits项目所依赖的jar包
- lib下:依赖包
- mybatis-3.4.6.jar:核心 包
- mybatis-3.4.6.pdf,操作指南
要进行连接数据库还需要数据库的l驱动包
第一个入门实例
1、工程结构
2、创建表
--自增长生成主键
DROP TABLE IF EXISTS t_role;
CREATE TABLE t_role(
id INT(5) NOT NULL AUTO_INCREMENT COMMENT '角色id',
role_name VARCHAR(150) COMMENT '角色姓名',
note VARCHAR(150) COMMENT '角色备注',
PRIMARY KEY (id)
);
INSERT INTO t_role( role_name, note) VALUES ("Saber","fate stay night");
INSERT INTO t_role( role_name, note) VALUES ("鸣人","火影忍者");
INSERT INTO t_role( role_name, note) VALUES ("佐助","火影忍者");
--uuid生成主键
DROP TABLE IF EXISTS t_role;
CREATE TABLE t_role(
id VARCHAR(36) NOT NULL COMMENT '角色id' ,
role_name VARCHAR(150) COMMENT '角色姓名',
note VARCHAR(150) COMMENT '角色备注',
PRIMARY KEY (id)
);
INSERT INTO t_role( id,role_name, note) VALUES (UUID(),"Saber","fate stay night");
INSERT INTO t_role( id,role_name, note) VALUES (UUID(),"鸣人","火影忍者");
INSERT INTO t_role( id,role_name, note) VALUES (UUID(),"佐助","火影忍者");
3、创建一个POJO(Plain Ordinary Java Object,简单的Java对象)类
package ecut.first.po;
import java.io.Serializable;
public class Role implements Serializable{
private static final long serialVersionUID = -4663460700843152533L;
private Integer id;
private String roleName;
private String note;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getRoleName() {
return roleName;
}
public void setRoleName(String roleName) {
this.roleName = roleName;
}
public String getNote() {
return note;
}
public void setNote(String note) {
this.note = note;
}
@Override
public String toString() {
String s ="id ="+id+",name =" + roleName+", note = " +note;
return s;
}
}
4、添加log4j的支持
在src目录下增加log4j.properties配置文件,内容如下
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# MyBatis logging configuration...
log4j.logger.ecut.first.mapper=TRACE
# 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、编写XML配置文件
参考http://www.mybatis.org/mybatis-3/zh/configuration.html 配 置mybatis的运行环境,数据源、事务已经引入映射文件等。
让Eclipse支持mybatis-config.xml的智能提示,将mybatis-3.4.6.jar中的/org/apache/ibatis/builder/xml/mybatis-3-config.dtd和/org/apache/ibatis/builder/xml/mybatis-3-mapper.dtddtd文件复制到容易查找的目录下,在Eclipse的导航选择Widow下的preferences,选择如下目录
点击Add,显示如下页面,Key Type选择URI
Location 选择dtd文件所在路径,Key填入http://mybatis.org/dtd/mybatis-3-config.dtd,用一样的方式配置映射文件。
<?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>
<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/test?useUnicode=true&characterEncoding=UTF8" />
<property name="username" value="root" />
<property name="password" value="123456" />
</dataSource>
</environment>
</environments>
</configuration>
6、编写映射文件
在配置文件中给role类取别名,方便在映射文件中引用角色类
<!-- 别名定义 -->
<typeAliases>
<!-- 批量别名定义
指定包名,mybatis自动扫描包中的po类,自动定义别名,别名就是类名(首字母大写或小写都可以)
-->
<!-- <package name="ecut.first.po"/> -->
<!-- 针对单个别名定义
type:类型的路径
alias:别名
-->
<typeAlias type="ecut.first.po.Role" alias="Role"/>
</typeAliases>
编写映射文件
<?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查询角色表的记录 -->
<!-- 通过 select执行数据库查询
id:标识 映射文件中的 sql
将sql语句封装到mappedStatement对象中,所以将id称为statement的id
parameterType:指定输入 参数的类型,这里指定Integer型
#{}表示一个占位符号
#{id}:其中的id表示接收输入 的参数,参数名称就是id,如果输入 参数是简单类型,#{}中的参数名可以任意,可以value或其它名称
resultType:指定sql输出结果 的所映射的java对象类型,select指定resultType表示将单条记录映射成的java对象。
-->
<select id="getRole" parameterType="java.lang.Integer" resultType="Role">
SELECT id , role_name as roleName , note FROM t_role WHERE id = #{value}
</select>
<!-- 根据note模糊查询角色信息,可能返回多条
resultType:指定就是单条记录所映射的java对象 类型
${}:表示拼接sql串,将接收到参数的内容不加任何修饰拼接在sql中。
使用${}拼接sql,引起 sql注入
${value}:接收输入 参数的内容,如果传入类型是简单类型,${}中只能使用value
-->
<select id="getRoles" parameterType="java.lang.String" resultType="Role">
SELECT id , role_name AS roleName , note FROM t_role WHERE note LIKE '%${value}%'
</select>
<!-- 添加角色
parameterType:指定输入 参数类型是pojo(包括 角色信息)
#{}中指定pojo的属性名,接收到pojo对象的属性值,mybatis通过OGNL获取对象的属性值
-->
<insert id="insertRole" parameterType="Role">
<!--
将插入数据的主键返回,返回到role对象中
SELECT LAST_INSERT_ID():得到刚insert进去记录的主键值,只适用与自增主键
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 t_role(role_name, note) VALUES (#{roleName},#{note})
<!--
使用mysql的uuid()生成主键
执行过程:
首先通过uuid()得到主键,将主键设置到role对象的id属性中
其次在insert执行时,从role对象中取出id属性值
-->
<!--
<selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
SELECT UUID()
</selectKey>
INSERT INTO t_role(id, role_name, note) VALUES (#{id},#{roleName},#{note}) -->
</insert>
<!-- 根据id删除角色-->
<delete id="deleteRole" parameterType="java.lang.Integer" >
DELETE FROM t_role WHERE id = #{value}
</delete>
<!-- 根据id更新角色
分析:
需要传入角色的id
需要传入角色的更新信息
parameterType指定role对象,包括 id和更新信息,注意:id必须存在
#{id}:从输入 role+对象中获取id属性值
-->
<update id="updateRole" parameterType="Role" >
UPDATE t_role SET role_name = #{roleName} , note=#{note} WHERE id = #{id}
</update>
</mapper>
parameterType和resultType
- 在映射文件中通过parameterType指定输入 参数的类型。
- 在映射文件中通过resultType指定输出结果的类型。
#{}和${}
- #{}表示一个占位符号,#{}接收输入参数,类型可以是简单类型,pojo、hashmap。
- 如果接收简单类型,#{}中可以写成value或其它名称。
- #{}接收pojo对象值,通过OGNL读取对象中的属性值,通过属性.属性.属性...的方式获取对象属性值
- ${}表示一个拼接符号,会引用sql注入,所以不建议使用${}。
- ${}接收输入参数,类型可以是简单类型,pojo、hashmap。
- 如果接收简单类型,${}中只能写成value。
- ${}接收pojo对象值,通过OGNL读取对象中的属性值,通过属性.属性.属性...的方式获取对象属性值。
selectKey标签:
- 在插入数据时候可以通过配置selectKey的方式将插入数据的主键返回,必须指定resultType,不然会抛出org.apache.ibatis.executor.ExecutorException: A query was run and no Result Maps were found for the Mapped Statement 'test.insertRole!selectKey'. It's likely that neither a Result Type nor a Result Map was specified.
- 对于MySQL自增主键 ,是在执行insert提交之前自动生成一个自增主键。通过LAST_INSERT_ID()函数获取到刚插入记录的自增主键,因此selectKey标签的order是BEFORE
- 对于MySQL非自增返回而是通过UUID()函数生成的主键,是先通过uuid()查询到主键,将主键输入 到sql语句中,需要修改表中id字段类型为string,长度设置成35位。执行uuid()语句顺序相对于insert语句之前执行,因此selectKey标签的order是AFTER
selectOne和selectList
- selectOne表示查询出一条记录进行映射。如果使用selectOne可以实现使用selectList也可以实现(list中只有一个对象)。
- selectList表示查询出一个列表(多条记录)进行映射。如果使用selectList查询多条记录,不能使用selectOne。
- 如果使用selectOne报错:org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found:3
在配置文件中加载映射文件
<!-- 加载 映射文件 -->
<mappers>
<!--通过resource方法一次加载一个映射文件 -->
<mapper resource="ecut/first/mapper/Role.xml"/>
<!-- 通过mapper接口加载单个 映射文件
遵循一些规范:需要将mapper接口类名和mapper.xml映射文件名称保持一致,且在一个目录 中
上边规范的前提是:使用的是mapper代理方法
-->
<!-- <mapper class="ecut.first.mapper.RoleMapper"/> -->
<!-- 批量加载mapper
指定mapper接口的包名,mybatis自动扫描包下边所有mapper接口进行加载
遵循一些规范:需要将mapper接口类名和mapper.xml映射文件名称保持一致,且在一个目录 中
上边规范的前提是:使用的是mapper代理方法
-->
<!-- <package name="ecut.first.mapper"/> -->
</mappers>
7、编写测试类
package ecut.first.test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import ecut.first.po.Role;
public class FirstTest {
private SqlSessionFactory factory;
public @Before void init() throws IOException {
// mybatis配置文件
String resource = "ecut/first/mybaits-config.xml";
// 得到配置文件流
InputStream inputStream = Resources.getResourceAsStream(resource);
// 创建会话工厂,传入mybatis的配置文件信息
factory = new SqlSessionFactoryBuilder().build(inputStream);
// 通过工厂得到SqlSession
}
// 根据id查询角色信息,得到一条记录结果
public @Test void testGetRole() {
// 通过SqlSession操作数据库
SqlSession session = factory.openSession();
// 第一个参数:映射文件中statement的id,等于=namespace+"."+statement的id
// 第二个参数:指定和映射文件中所匹配的parameterType类型的参数
// sqlSession.selectOne结果 是与映射文件中所匹配的resultType类型的对象
// selectOne查询出一条记录
Role r = session.selectOne("test.getRole", 1);
System.out.println(r);
// 释放资源
session.close();
}
// 根据note模糊查询角色列表
public @Test void testGetRoles() {
SqlSession session = factory.openSession();
// list中的role和映射文件中resultType所指定的类型一致
List<Role> r = session.selectList("test.getRoles", "火影");
// List<Role> r = session.selectList("test.getRoles", "' or 1=1 or '");
System.out.println(r);
// 释放资源
session.close();
}
//添加角色信息
public @Test void testInsertRole() {
SqlSession session = factory.openSession();
Role r = new Role();
r.setRoleName("鸣人");
r.setNote("火影忍者");
session.insert("test.insertRole", r);
System.out.println(r.getId());
// 提交事务
session.commit();
// 获取角色信息主键
System.out.println(r.getId());
// 释放资源
session.close();
}
//根据id删除角色信息
public @Test void testDeleteRole() {
SqlSession session = factory.openSession();
session.delete("test.deleteRole",2);
session.commit();
// 释放资源
session.close();
}
//更新角色信息
public @Test void testUpdatRole(){
SqlSession session = factory.openSession();
Role r = new Role();
//必须设置id
r.setId(1);
r.setRoleName("鸣人");
r.setNote("火影忍者");
session.update("test.updateRole", r);
session.commit();
// 释放资源
session.close();
}
}
${}表示一个拼接符号,会引用sql注入,所谓的sql注入就是利用现有应用程序,将(恶意)的SQL命令注入到后台数据库执行一些恶意的操作,比如在模糊查询的测试案例中,传入的note是‘or 1=1 or‘ 使我们原本的意图发生了改变,将所有的数据都查询了出来,所以不建议使用${}。
MyBaits和Hibernate的区别和应用场景
hibernate:是一个标准ORM框架(对象关系映射)。入门门槛较高的,不需要程序写sql,sql语句自动生成了。对sql语句进行优化、修改比较困难的。
应用场景:
适用与需求变化不多的中小型项目,比如:后台管理系统,erp、orm、oa。。
mybatis:专注是sql本身,需要程序员自己编写sql语句,sql修改、优化比较方便。mybatis是一个不完全 的ORM框架,虽然程序员自己写sql,mybatis 也可以实现映射(输入映射、输出映射)。
应用场景:
适用与需求变化较多的项目,比如:互联网项目。
转载请于明显处标明出处