1 前言
mybatis是一个优秀的基于java的持久层框架,它内部封装了jdbc,使开发者只需要关注sql语句本身,而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
通过xml或注解的方式将要执行的各种statement配置起来,并通过java对象和statement中sql的动态参数进行映射生成最终执行的sql语句,最后由框架执行sql并将结果映射为java对象并返回。
采用ORM(Object Relational Mapping)思想解决了实体和数据库映射的问题,屏蔽了jdbc api底层访问细节,使我们不用与jdbc api打交道,就可以完成对数据库的持久化操作。
文末会给出源码链接。
2 Mybatis框架快速入门
2.1 搭建Mybatis开发环境(使用.xml配置)
数据库准备
USE DATABASE eesy; CREATE TABLE `user` ( `id` INT(11) NOT NULL AUTO_INCREMENT, `username` VARCHAR(32) NOT NULL COMMENT '用户名称', `birthday` DATETIME DEFAULT NULL COMMENT '生日', `sex` CHAR(1) DEFAULT NULL COMMENT '性别', `address` VARCHAR(256) DEFAULT NULL COMMENT '地址', PRIMARY KEY (`id`) ) ENGINE=INNODB DEFAULT CHARSET=utf8; INSERT INTO `user`(`id`,`username`,`birthday`,`sex`,`address`) VALUES (41,'老王','2018-02-27 17:47:08','男','北京'),(42,'小二王','2018-03-02 15:09:37','女','北京金燕龙'),(43,'小二王','2018-03-04 11:34:34','女','北京金燕龙'),(45,'传智播客','2018-03-04 12:04:06','男','北京金燕龙'),(46,'老王','2018-03-07 17:37:26','男','北京'),(48,'小马宝莉','2018-03-08 11:44:00','女','北京修正');
2.1.1 添加Mybatis3.4.5的坐标
首先创建maven工程,之后在pom.xml中添加坐标,如下:
<dependencies> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.5</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.6</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.12</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.10</version> <scope>test</scope> </dependency> </dependencies>
2.1.2 数据库User表对应的实体类
package domain; import java.io.Serializable; import java.util.Date; public class User implements Serializable { private Integer id; private String username; private Date birthday; private String sex; private String address; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } 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; } }
2.1.3 dao层
package dao; import domain.User; import java.util.List; public interface UserDao { /** * 查询所有用户 * @return */ List<User> findAll(); }
2.1.4 编写Dao层接口的映射文件UserDao.xml
创建位置:必须和dao接口在相同的包中。
名称:必须以持久层接口名称命名文件名,扩展名是.xml
mapper标签namespace属性的取值必须是dao接口的全限定类名;
操作配置(<select>),id属性的取值必须是dao接口的方法名
<?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="dao.UserDao"> <!-- 配置查询所有操作,查询结果封装在User类里 --> <select id="findAll" resultType="domain.User"> select * from user; </select> </mapper>
2.1.5 编写 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"> <!--mybatis的主配置文件--> <configuration> <!--配置环境--> <environments default="mysql"> <!--配置mysql的环境--> <environment id="mysql"> <!--配置事务类型--> <transactionManager type="JDBC"></transactionManager> <!--配置数据源(连接池)--> <dataSource type="POOLED"> <!--配置连接数据库的4个基本信息--> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/eesy_mybatis"/> <property name="username" value="root"/> <property name="password" value="root"/> </dataSource> </environment> </environments> <!-- 告知mybatis映射配置的位置 --> <mappers> <mapper resource="dao/UserDao.xml"/> </mappers> </configuration>
2.1.6 测试类
程序套路比较固定,基本步骤如下:
1.读取配置文件
2.创建SqlSessionFactory工厂
3.创建SqlSession
4.创建dao接口的代理对象 getMapper()
5.执行dao中的方法
6.释放资源
package test; import dao.UserDao; import domain.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 java.io.IOException; import java.io.InputStream; import java.util.List; public class MybatisTest { public static void main(String[] args) throws IOException { // 读取配置文件 InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml"); // 创建SqlSessionFactory工厂 SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(in); // 使用工厂生产SqlSession SqlSession session = factory.openSession(); // 使用SqlSession创建Dao接口的代理对象 UserDao userDao = session.getMapper(UserDao.class); // 使用代理对象执行dao中的方法 List<User> users = userDao.findAll(); for (User user : users) { System.out.println(user); } // 释放资源 session.close(); in.close(); } }
2.2 使用注解开发方法
使用注解时,就不需要 resources/dao/UserDao.xml 文件了
在dao接口的方法上使用@Select注解,并且指定SQL语句
UserDao.java 中
package dao; import domain.User; import org.apache.ibatis.annotations.Select; import java.util.List; public interface UserDao { /** * 查询所有用户 * @return */ @Select("select * from user") List<User> findAll(); }
SqlMapConfig.xml 全局配置文件里,如果使用注解来配置的话,应该是用class属性指定被注解的dao全限定类名
<mappers> <mapper class="dao.UserDao"/> </mappers>
2.3 设计模式分析
在编写测试类时,按照了六个步骤来进行的,其中涉及到了构建者、工厂、代理等设计模式。
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(in);
创建工厂时使用了构建者模式,可以把对象的创建细节隐藏,使得使用者直接调用方法即可拿到对象。
SqlSession session = factory.openSession();
生产SqlSession使用了工厂模式,可以降低类之间的依赖关系(解耦)。
UserDao userDao = session.getMapper(UserDao.class);
创建Dao接口实现类使用了代理模式,可以在不修改源码的基础上对已有方法增强。
注意:
实际应用时,绝对路径和相对路径都不可用,(在部署成webapp后src目录没了)
所以实际中只用两种方法:
1.类加载器,但只能读取类路径的配置文件
2.使用ServletContext的getRealPath()获得绝对路径
mybatis在使用代理dao的方式实现增删改查时:
1.创建代理对象
2.在代理对象中调用selectList