简介
什么是 MyBatis?
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
1入门案例
①导入Mybatis相关坐标
<dependencies>
<!--mybatis坐标-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql驱动坐标-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
<scope>runtime</scope>
</dependency>
<!--单元测试坐标-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!--日志坐标-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
</dependencies>
②创建表和实体类
CREATE TABLE `user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`username` varchar(20) DEFAULT NULL,
`password` varchar(13) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;INSERT INTO `user`(`id`, `username`, `password`) VALUES (1, 'zhangsan', '123');
INSERT INTO `user`(`id`, `username`, `password`) VALUES (2, 'lisi', '234');
package com.nie.pojo;
import lombok.Data;
@Data
public class User {
private int id;
private String username;
private String password;
}
③编写Mybatis核心配置文件mybatis-config.xml(命名可以任意,通常使用mybatis-config.xml),该配置文件的根节点为configuration,根节点内包含的常用一级节点及含义如下:
properties:属性信息,相当于mybatis的全局变量
settings:设置信息,通过它对mybatis的功能进行调整
typeAliases:类型别名,可以为类型设置一些简短的名字
typeHandlers:类型处理器,可以为不同的类型设置相应的处理器
objectFactory:对象工厂,指定mybatis创建新对象时使用的工厂
objectWrapperFactory:对象包装工厂,指定mybatis使用的对象包装器工厂
reflectorFactory:反射器工厂,设置mybatis的反射器工厂
plugins:插件,为mybatis配置插件,修改或扩展mybatis行为
environments:配置mybatis运行的环境信息,如数据源信息等
databaseIdProvider:数据源编号,
mapper:映射文件,配置映射文件或映射接口文件的地址
<?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>
<!--通过properties标签加载外部properties文件-->
<properties resource="jdbc.properties"></properties>
<!-- 自定义别名 映射文件中可直接使用user-->
<typeAliases>
<typeAlias type="com.nie.pojo.User" alias="user"></typeAlias>
</typeAliases>
<!--数据源环境-->
<environments default="developement">
<environment id="developement">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--加载映射文件-->
<mappers>
<mapper resource="com/nie/mybatis/UserMapper.xml"></mapper>
</mappers>
</configuration>
jdbc.properties 配置文件
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/nie?serverTimezone=GMT%2B8&characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
④编写crud映射xml文件UserMapper.xml,一般来完成Java方法与sql语句的映射,java对象与sql参数的映射,sql查询结果与java对象的映射等,通常一个项目中有多个映射文件,根节点为mapper
映射文件常见属性
insert – 映射插入语句。
update – 映射更新语句。
delete – 映射删除语句。
select – 映射查询语句。
id 在命名空间中唯一的标识符,可以被用来引用这条语句。
parameterType 将会传入这条语句的参数的类全限定名或别名。这个属性是可选的,因为 MyBatis可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
parameterMap已废弃
resultType 期望从这条语句中返回结果的类全限定名或别名。 注意,如果返回的是集合,那应该设置为集合包含的类型,而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。
resultMap 对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性,如果你对其理解透彻,许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。
<?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="com.nie.mapper.UserMapper"> 代理方式-->
<mapper namespace="userMapper">
<select id="findAll" resultType="com.nie.pojo.User">
select * from user
</select>
<select id="findById" resultType="com.nie.pojo.User" parameterType="int">
select * from user where id=#{id}
</select>
<insert id="insertUser" parameterType="com.nie.pojo.User">
insert into user(id,username,password) values (#{id},#{username},#{password})
</insert>
<update id="updateUser" parameterType="com.nie.pojo.User">
update user set username=#{username},password=#{password} where id=#{id}
</update>
<delete id="deleteById" parameterType="int">
delete from user where id=#{id}
</delete>
</mapper>
⑤测试代码
package com.nie;
import com.nie.pojo.User;
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.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class MybatisTest {
@Test
public void test01() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
List<User> list = session.selectList("userMapper.findAll");
System.out.println(list);
session.close();
}
@Test
public void test02() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);
User user = session.selectOne("userMapper.findById",1);
System.out.println(user);
session.close();
}
@Test
public void test03() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);
User user = new User();
user.setId(3);
user.setUsername("新张飞");
user.setPassword("zhangfei");
session.update("userMapper.insertUser",user);
session.close();
}
@Test
public void test04() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);
User user = new User();
user.setId(3);
user.setUsername("新张飞");
user.setPassword("zhangfei");
session.update("userMapper.updateUser",user);
session.close();
}
@Test
public void test05() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);
session.delete("userMapper.deleteById",3);
session.close();
}
}
2动态代理方式开发
代理开发方式介绍
采用 Mybatis 的代理开发方式实现 DAO 层的开发,这种方式是日常开发的主流。
Mapper 接口开发方法只需要程序员编写Mapper 接口(相当于Dao 接口),由Mybatis 框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。
Mapper 接口开发需要遵循以下规范:
1、 Mapper.xml文件中的namespace与mapper接口的全限定名相同
2、 Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
3、 Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同
4、 Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
对应结构如图
①UserMapper接口
package com.nie.mapper;
import com.nie.pojo.User;
import java.util.List;
public interface UserMapper {
public User findById(int id);
public List<User> findAll();
public void insertUser(User user);
public void updateUser(User user);
public void deleteById(int id);
}
②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">
<mapper namespace="com.nie.mapper.UserMapper">
<!--<mapper namespace="userMapper">-->
<select id="findAll" resultType="com.nie.pojo.User">
select * from user
</select>
<select id="findById" resultType="com.nie.pojo.User" parameterType="int">
select * from user where id=#{id}
</select>
<insert id="insertUser" parameterType="com.nie.pojo.User">
insert into user(id,username,password) values (#{id},#{username},#{password})
</insert>
<update id="updateUser" parameterType="com.nie.pojo.User">
update user set username=#{username},password=#{password} where id=#{id}
</update>
<delete id="deleteById" parameterType="int">
delete from user where id=#{id}
</delete>
</mapper>
③测试方法
package com.nie;
import com.nie.mapper.UserMapper;
import com.nie.pojo.User;
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.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class MapperProxyTest {
@Test
public void test01() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> userList = mapper.findAll();
System.out.println(userList);
session.close();
}
@Test
public void test02() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
UserMapper mapper = session.getMapper(UserMapper.class);
User user = mapper.findById(1);
System.out.println(user);
session.close();
}
@Test
public void test03() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
UserMapper mapper = session.getMapper(UserMapper.class);
User user = new User();
user.setId(3);
user.setUsername("张飞");
user.setPassword("zhangfei");
mapper.insertUser(user);
session.close();
}
@Test
public void test04() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
UserMapper mapper = session.getMapper(UserMapper.class);
User user = new User();
user.setId(3);
user.setUsername("zhangf");
user.setPassword("zhangfei");
mapper.updateUser(user);
session.close();
}
@Test
public void test05() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession session = sqlSessionFactory.openSession(true);//开启事务 默认是关闭的
UserMapper mapper = session.getMapper(UserMapper.class);
mapper.deleteById(3);
session.close();
}
}