文章目录
- 一、以前的方式
- 1. 创建maven工程并导包
- 2. 创建数据库表和对应的 JavaBean
- 3. 创建Mybatis全局配置文件
- 4. 创建sql映射文件
- 5. 测试
- 6. 项目结构
- 二、接口式编程(推荐)
- 1. 创建一个Dao层接口
- 2. 修改Mapper文件
- 3. 测试
- 三、SqlSession
一、以前的方式
1. 创建maven工程并导包
可以使用maven在线下载依赖,这里因为我已经下载好了jar包,直接导入就行了
新建一个lib文件夹,导入 mysql 驱动
和 mybatis-3.4.1
并将lib文件夹右键 add as library
可在官网下载 mybatis 的 jar 包 mybatis 官网
2. 创建数据库表和对应的 JavaBean
数据库表
CREATE TABLE `tbl_employee` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`last_name` varchar(255) DEFAULT NULL,
`gender` char(1) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
对应的 JavaBean
public class Employee {
Integer id;
String lastName; //字段名最好和数据库中的字段一致,如果不一致,可在sql语句中起别名
String gender;
String email;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String isGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
@Override
public String toString() {
return "Employee{" +
"id=" + id +
", lastName='" + lastName + '\'' +
", gender=" + gender +
", email='" + email + '\'' +
'}';
}
}
此处的 lastName 设置了和数据库中的字段 last_Name 是不一致的,我们在后面的配置文件中需要给数据库字段起对应的别名,否则会出错。
3. 创建Mybatis全局配置文件
MyBatis 的全局配置文件包含了影响 MyBatis 行为甚深 的设置(settings)和属性(properties)信息、如数据 库连接池信息等。指导着MyBatis进行工作。我们可以 参照官方文件的配置示例
新建 conf 文件夹,并右键 make Directory as source root
建立 mybatis-config.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>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!--将我们写好的sql映射文件注册到全局配置文件中-->
<mappers>
<mapper resource="EmployeeMapper.xml"/>
</mappers>
</configuration>
mappers 中注册的 sql 映射文件如下
4. 创建sql映射文件
映射文件的作用就相当于是定义数据库如何工作,编写sql语句。这也是我们使用MyBatis时编写的最多的文件。
同样在conf文件夹下,创建 EmployeeMapper.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">
<!--名称空间,随意起名-->
<mapper namespace="com.smallbeef.mybatis.EmployeeMapper">
<!--id:唯一标识
resultType: 返回值类型
#{id}:从传递过来的参数中取出id值-->
<select id="selectEmployee" resultType="com.smallbeef.mybatis.bean.Employee">
<!--由于lastName和数据库字段不一致,需要在此起别名-->
select id, last_name lastName, email, gender from tbl_employee where id = #{id}
</select>
</mapper>
5. 测试
- 根据xml配置文件(全局配置文件),创建一个
SqlSessionFactory
对象 - sql 映射文件:配置了每一个sql, 以及 sql 的封装规则
- 将 sql 映射文件注册在全局配置文件中
- 写代码:
1)根据全局配置文件得到 SqlSessionFactory
2) 使用 sqlSession 工厂,获取到sqlSession
对象使用它来执行增删改查
一个 sqlSession 就是代表和数据库的一次会话,用完关闭
3) 使用 sql 的唯一标识来告诉 MyBatis 执行哪个sql。sql都是保存在 sql 映射文件中的
public class MyBatisTest {
/**
* 1. 根据xml配置文件(全局配置文件),创建一个SqlSessionFactory对象
* 2. sql映射文件:配置了每一个sql,以及sql的封装规则
* 3. 将sql映射文件注册在全局配置文件中
* 4. 写代码:
* 1)根据全局配置文件得到SqlSessionFactory
* 2) 使用sqlSession工厂,获取到sqlSession对象使用它来执行增删改查
* 一个sqlSession就是代表和数据库的一次会话,用完关闭
* 3) 使用sql的唯一标识来告诉MyBatis执行哪个sql.sql都是保存在sql映射文件中的
*
**/
@Test
public void MybatisTest() throws IOException {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2. 获取sqlSession实例,能直接指向已经映射的sql语句
SqlSession sqlSession = sqlSessionFactory.openSession();
try {
// 第一个参数:要执行的sql语句的唯一标识(推荐写法:namespace + id 防止其他文件也有同样的id导致冲突)
// 第二个参数;传给sql语句进行执行的参数
Employee employee = sqlSession.selectOne("com.smallbeef.mybatis.EmployeeMapper.selectEmployee", 1);
System.out.println(employee);
} finally {
sqlSession.close();
}
}
}
查询结果:
Employee{id=1, lastName=‘Tom’, gender=0, email=‘123@qq.com’}
6. 项目结构
二、接口式编程(推荐)
1. 创建一个Dao层接口
在该接口中定义要执行的方法
public interface EmployeeMapper {
public Employee getEmpById(Integer id);
}
2. 修改Mapper文件
- 修改名称空间 namespace 为接口的全类名
- 修改 id 为接口的方法名
即将接口中的方法和 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">
<!--名称空间,指定为接口的全类名-->
<mapper namespace="com.smallbeef.mybatis.dao.EmployeeMapper">
<!--id:唯一标识
resultType: 返回值类型
#{id}:从传递过来的参数中取出id值-->
<!--public Employee getEmpById(Integer id)
将唯一标识id和接口中的方法进行绑定-->
<select id="getEmpById" resultType="com.smallbeef.mybatis.bean.Employee">
select id, last_name lastName, email, gender from tbl_employee where id = #{id}
</select>
</mapper>
3. 测试
使用 SqlSession 获取映射器进行操作
@Test
public void test01() throws IOException{
// 1. 获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2. 获取sqlSession实例
SqlSession sqlSession = sqlSessionFactory.openSession();
try {
// 3. 获取接口的实现类对象
// Mybatis会为接口自动的创建一个代理对象,由代理对象去执行增删改查方法
EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class);
// 4. 调用接口方法
Employee employee = mapper.getEmpById(1);
System.out.println(employee);
} finally {
sqlSession.close();
}
}
三、SqlSession
- SqlSession和 connection 一样,他们的实例不是线程安全的,因此是不能被共享的。
- SqlSession每次使用完成后需要正确关闭,这个 关闭操作是必须的
- SqlSession可以直接调用方法的id进行数据库操 作,但是我们一般还是推荐使用接口式编程,SqlSession获取 到Dao接口的代理类,执行代理对象的方法,可 以更安全的进行类型检查操作