一、MyBatis入门
1.环境搭建
步骤一:创建Maven工程并导入坐标
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>Zhongger</groupId>
<artifactId>MyBatisDay01</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
</dependencies>
</project>
一般而言,Mybatis框架依赖的Jar包就只需要以下两个
<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.38</version>
</dependency>
创建数据库中的Users数据表,SQL语句如下:
CREATE TABLE Users(
id INT,
user_name VARCHAR(30),
pass_word VARCHAR(50)
);
向数据库中插入数据,查询结果如下:
步骤二:创建实体类和Dao的接口
如图所示,项目的目录结构为:
首先创建Dao接口(IUserDao.java)
package cn.zhongger.dao;
import cn.zhongger.domain.User;
import java.util.List;
/**
* 用户持久层接口
*/
public interface IUserDao {
List<User> findAll();
}
然后创建实现IUserDao接口的实体类(User.java)
package cn.zhongger.domain;
import java.io.Serializable;
public class User implements Serializable {
private Integer id;
private String user_name;
private String pass_word;
public User(Integer id, String user_name, String pass_word) {
this.id = id;
this.user_name = user_name;
this.pass_word = pass_word;
}
public User() {
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUser_name() {
return user_name;
}
public void setUser_name(String user_name) {
this.user_name = user_name;
}
public String getPass_word() {
return pass_word;
}
public void setPass_word(String pass_word) {
this.pass_word = pass_word;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", user_name='" + user_name + '\'' +
", pass_word='" + pass_word + '\'' +
'}';
}
}
步骤三:创建MyBatis的主配置文件SqlMapConfig.xml
一般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">
以下是完整的MyBatis主配置文件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>
<!--mybatis的主配置文件-->
<environments default="mysql">
<!--配置mysql环境-->
<environment id="mysql">
<!--配置事务类型-->
<transactionManager type="JDBC">
</transactionManager>
<!--配置数据源(连接池)-->
<dataSource type="POOLED">
<!--配置连接数据库的四个基本信息-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/zmy"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!--指定映射配置文件的配置,映射配置文件指的是每个dao独立的配置文件-->
<mappers>
<mapper resource="cn/zhongger/dao/IUserDao.xml"/>
</mappers>
</configuration>
步骤四 创建映射配置文件 IUserDao.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">
以下是完整的映射配置文件 IUserDao.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="cn.zhongger.dao.IUserDao">
<!--配置查询所有-->
<select id="findAll">
select *from Users;
</select>
</mapper>
环境搭建的注意事项:
a.创建IUserDao.xml和IUserDao.java时,这样命名是为了和我们之前的知识保持一致。在MyBatis中,它把持久层的操作接口名称和映射文件也叫做:Mapper 。故IUserDao和IUserMapper是一样的,只是命名风格不同罢了。哈哈, 我是跟着黑马的教程学的,所以这种命名风格我也一直用着~
b.在IDEA中创建目录的时候,它和包是不一样的。
包在创建时:cn.zhonger.dao是三级结构
目录在创建时:cn.zhongger.dao是一级目录
c.Mybatis的映射配置文件位置必须和Dao接口的包结构相同
d.映射配置文件的mapper标签namespace属性的取值必须是Dao接口的全限定类名
e.映射配置文件的操作配置,id属性的取值必须是Dao接口的方法名
当我们遵从了第3,4,5点后,我们在开发中就无需再写Dao接口的实现类
2.入门案例
在test/java包中新建cn.zhongger.test包,然后在该包下新建MybatisTest.java测试类
目录结构如图所示:
编写该类的代码如下:
package cn.zhongger.test;
import cn.zhongger.dao.IUserDao;
import cn.zhongger.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 {
/**
* 入门案例
* @param args
*/
public static void main(String[] args) throws IOException {
//1.读取配置文件
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
//3.使用工厂生成SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//4.使用SqlSession创建Dao接口的代理对象
IUserDao mapper = sqlSession.getMapper(IUserDao.class);
//5.使用代理对象执行方法
List<User> users = mapper.findAll();
//6.遍历users的List,并打印
for (User user:users
) {
System.out.println(user);
}
//6.释放资源
sqlSession.close();
inputStream.close();
}
}
运行以下发现会报如下错:
Exception in thread "main" org.apache.ibatis.exceptions.PersistenceException:
### Error querying database. Cause: org.apache.ibatis.executor.ExecutorException: A query was run and no Result Maps were found for the Mapped Statement 'cn.zhongger.dao.IUserDao.findAll'. It's likely that neither a Result Type nor a Result Map was specified.
### The error may exist in cn/zhongger/dao/IUserDao.xml
### The error may involve cn.zhongger.dao.IUserDao.findAll
### The error occurred while handling results
### SQL: select *from Users;
### Cause: org.apache.ibatis.executor.ExecutorException: A query was run and no Result Maps were found for the Mapped Statement 'cn.zhongger.dao.IUserDao.findAll'. It's likely that neither a Result Type nor a Result Map was specified.
at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:150)
at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:141)
at org.apache.ibatis.binding.MapperMethod.executeForMany(MapperMethod.java:139)
at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:76)
at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:59)
at com.sun.proxy.$Proxy2.findAll(Unknown Source)
at cn.zhongger.test.MybatisTest.main(MybatisTest.java:30)
Caused by: org.apache.ibatis.executor.ExecutorException: A query was run and no Result Maps were found for the Mapped Statement 'cn.zhongger.dao.IUserDao.findAll'. It's likely that neither a Result Type nor a Result Map was specified.
报org.apache.ibatis.exceptions.PersistenceException:异常的原因很简单,就是MyBatis框架并不知道SQL语句执行的结果要封装到哪里,MyBatis框架的设计之初是会封装所有的表所有的对象,若不指明要封装的对象,则会让MyBatis无法知晓这些表或对象之间的关系,从而报错。解决的办法如下:
修改映射配置文件 IUserDao.xml,添加属性resultType
,属性值为实体类的全限定类名,在这个例子中,我的实体类的全限定类名为cn.zhongger.domain.User
,下面给出修改后的配置文件IUserDao.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="cn.zhongger.dao.IUserDao">
<!--配置查询所有-->
<select id="findAll" resultType="cn.zhongger.domain.User">
select *from Users;
</select>
</mapper>
再次运行MybatisTest.java,控制台打印如下信息:
这与数据库中的内容一致,这样我们就完成了 MyBatis的第一个入门案例的学习。
3.使用注解来进行配置(无需配置Map映射的xml)
步骤一:先移除IUserDao.xml,在IUserDao的findAll()方法上加上注解@Select(“select * from Users”)
package cn.zhongger.dao;
import cn.zhongger.domain.User;
import org.apache.ibatis.annotations.Select;
import java.util.List;
/**
* 用户持久层接口
*/
public interface IUserDao {
@Select("select * from Users")
List<User> findAll();
}
步骤二:修改SqlMapConfig.xml,将resource属性修改成class属性,属性值为IUserDao的全限定类名
<mappers>
<mapper class="cn.zhongger.dao.IUserDao"></mapper>
</mappers>
再次运行测试类代码,所得的结果与xml配置的结果一致。
总结
1.配置pron.xml文件,写完要依赖的Jar包的配置信息后,要检查项目栏中External Libraries中是否含有导入的包,若没有,证明导入失败,要重新写配置文件。
2.配置MyBatis.xml文件,最好记住这些套路,或者把一些固定的配置信息写进一个文件保存好来,方便多次重复使用。
3.配置Map映射文件,要注意到设置resultType属性和属性值,避免PersistenceException报错。
4.下面的目录结构要一致,resources下的是directory,创建的时候要分开来创建。
5.测试类的代码中用到的几种设计模式
public class MybatisTest {
/**
* 入门案例
* @param args
*/
public static void main(String[] args) throws IOException {
//1.读取配置文件
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
//3.使用工厂生成SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//4.使用SqlSession创建Dao接口的代理对象
IUserDao mapper = sqlSession.getMapper(IUserDao.class);
//5.使用代理对象执行方法
List<User> users = mapper.findAll();
//6.遍历users的List,并打印
for (User user:users
) {
System.out.println(user);
}
//6.释放资源
sqlSession.close();
inputStream.close();
}
}
创建SqlSessionFactory工厂使用了构建者模式:把对象的创建细节隐藏,使得使用者直接调用方法即可拿到对象;
生产SqlSession使用了工厂模式,优势是解耦,降低类之间的依赖关系;
创建IUserDao接口使用了代理模式,优势是在不修改源码的基础上,对已有方法增强。