MyBatis
前言
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
了解阅读文档:mybatis-3中文文档
一、了解Maven
Maven是基于项目对象模型(POM project object model),可以通过一小段描述信息(配置)来管理项目的构建,报告和文档的软件项目管理工具。
Maven的核心功能便是合理叙述项目间的依赖关系,通俗点讲,就是通过pom.xml文件的配置获取jar包,而不用手动去添加jar包
下载配置Maven环境:最详细IDEA2020新版本创建maven项目并导入jar包
Maven仓库导入依赖及创建
- 步骤一:打开IDEA,File----》New----》project----》
----》
- 步骤二:删除src目录作为父工程(Mybatis-Test),在pom.xml(Mybatis-Test)导入需要的jar包
<?xml version="1.0" encoding="GBK"?>
<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">b
<!--父工程-->
<groupId>org.example</groupId>
<artifactId>Mybatis-Test</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>mybatis-01</module>
</modules>
<!--导入依赖-->
<dependencies>
<!--MySQL驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!--junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
</dependencies>
<!--在build中配置resource,来防止我们资源导出失败问题-->
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
</project>
- 步骤三:新建一个module作为子工程,在module中编写代码,右键项目名–》New----》module----》重复步骤一,建立一个子工程
- 步骤四:配置子工程的pom.xml(mybatis-01),主要配置resource,来防止我们资源导出失败问题。
<?xml version="1.0" encoding="GBK"?>
<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">
<parent>
<artifactId>Mybatis-Test</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>mybatis-01</artifactId>
<!--在build中配置resource,来防止我们资源导出失败问题-->
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
</project>
二、编写第一个Mybatis程序
1.从 xml文件中构建SqlSessionFactory
- SqlSessionFactory是MyBatis的关键对象,它是个单个数据库映射关系经过编译后的内存镜像.
- SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象类获得,而SqlSessionFactoryBuilder则可以从XML配置文件或一个预先定制的Configuration的实例构建出SqlSessionFactory的实例.
- 每一个MyBatis的应用程序都以一个SqlSessionFactory对象的实例为核心.同时SqlSessionFactory也是线程安全的,SqlSessionFactory一旦被创建,应该在应用执行期间都存在.在应用运行期间不要重复创建多次,建议使用单例模式.
- SqlSessionFactory是创建SqlSession的工厂
- 构建SqlSessionFactory的xml文件需要写在resource目录下并命名为mybatis-config.xml
- resource目录在子工程ser/main/resource
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核心配置文件-->
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/hz?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
2.从 SqlSessionFactory 中获取 SqlSession
- SqlSession是MyBatis的关键对象,是执行持久化操作的独享,类似于JDBC中的Connection.它是应用程序与持久层之间执行交互操作的一个单线程对象,也是MyBatis执行持久化操作的关键对象.
- SqlSession对象完全包含以数据库为背景的所有执行SQL操作的方法,它的底层封装了JDBC连接,可以用SqlSession实例来直接执行被映射的SQL语句.
- 每个线程都应该有它自己的SqlSession实例.
- SqlSession的实例不能被共享,同时SqlSession也是线程不安全的,绝对不能讲SqlSeesion实例的引用放在一个类的静态字段甚至是实例字段中.也绝不能将SqlSession实例的引用放在任何类型的管理范围中,比如Servlet当中的HttpSession对象中.使用完SqlSeesion之后关闭Session很重要
- java代码写在src/main/java中,测试类写在src/test/java
package dao.utils;
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;
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
InputStream inputStream = null;
try {
//使用mybatis第一步:获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
3.探究已映射的 SQL 语句
- 事实上 MyBatis 提供的所有特性都可以利用基于 XML 的映射语言来实现,我们需要对数据库进行操作都可以配置xml文件实现。
- 我们可以先定义一个Mapper接口,里面放一些抽象方法,然后配置xml文件来实现这些方法。
- 每个Mapper.xml文件都需要在Mybatis核心配置文件(mybatis-config.xml)中注册!
定义接口:
package dao.userdao;
import dao.pojo.User;
import java.util.List;
public interface UserMapper {
//查询全部用户
List<User> getUserList();
//根据Id查询用户
User getUserById(int id);
//insert一个用户
boolean addUser(User user);
//修改用户
boolean updateUser(User user);
//删除用户
boolean deleteUser(int id);
}
相对应的Mapper.xml文件:
注意:
- namespace中的包名要和Dao/mapper接口的包名一致
- id对应namespace接口中的方法名
- resultType是SQL语句的返回值类型
- parameterType方法参数类型
- 增删改需要提交事务
- 我们这里User类的属性必须与数据库表user相同
- 记得在Mybatis核心配置文件(mybatis-config.xml)中注册
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">
<!--namespace=绑定一个对应的dao接口/mapper接口-->
<mapper namespace="dao.userdao.UserMapper">
<!--select查询-->
<select id="getUserList" resultType="dao.pojo.User">
select * from user_login
</select>
<select id="getUserById" parameterType="int" resultType="dao.pojo.User">
select * from user_login where id = #{id}
</select>
<insert id="addUser" parameterType="dao.pojo.User">
insert into user_login values (#{Id},#{name},#{pwd})
</insert>
<update id="updateUser" parameterType="dao.pojo.User">
update user_login set name = #{name},pwd = #{pwd} where Id = #{Id}
</update>
<delete id="deleteUser" parameterType="int">
delete from user_login where Id = #{id}
</delete>
</mapper>
注册UserMapper.xml后的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核心配置文件-->
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/hz?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!--每个Mapper.xml文件都需要在Mybatis核心配置文件中注册!-->
<mappers>
<mapper resource="dao/userdao/UserMapper.xml"/>
</mappers>
</configuration>
4.Junit测试
- 代码写在src/test/java下,包名名最好与src/mian/java下相同。
- JJUnit是用于编写和运行可重复的自动化测试的开源测试框架, 这样可以保证我们的代码按预期工作。JUnit可广泛用于单独的Java程序。
package dao.userdao;
import dao.pojo.User;
import dao.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
public class UserMapperTest {
@Test
public void test(){
//第一步获得sqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
//执行SQL
//方式一:getMapper
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
System.out.println(userList);
//方式二:
//List<User> users = sqlSession.selectList("dao.userdao.getUserList");//我们要返回一个List
//关闭sqlSession
sqlSession.close();
}
@Test
public void test2(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User userById = mapper.getUserById(44);
System.out.println(userById);
sqlSession.close();
}
@Test
public void addUser(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
boolean b = mapper.addUser(new User(22, "66", "88"));
//提交事务
sqlSession.commit();
System.out.println(b);
sqlSession.close();
}
@Test
public void updateUser(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
boolean b = mapper.updateUser(new User(11, "张", "123"));
//提交事务
sqlSession.commit();
System.out.println(b);
sqlSession.close();
}
@Test
public void deletUser(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
boolean b = mapper.deleteUser(11);
//提交事务
sqlSession.commit();
System.out.println(b);
sqlSession.close();
}
}
程序下载
Github:第一个Mybatis程序