一篇博客带你学会MyBatis
概念
MyBatis是一款持久层框架,用于简化JDBC操作(JavaEE三层架构:表现层(用来做页面的代码),业务层(业务逻辑代码),持久层(对数据库操作的代码))(框架就是一个半成品软件,是一套可重用的、通用的代码基础模型)
mybatis基本流程
- 创建数据表
- 创建项目,导入坐标(需要的包)
- 编写maven核心配置文件,链接数据库
- 编写sql映射文件
- 编码执行sql实现增删改查
代码如下:
-
数据库代码就不复制了,直接展示数据表
-
创建一个maven项目,在pom.xml里面导入mybatis的依赖、mysql驱动、junit单元测试,注意mysql驱动一定要用电脑上安装的,否则运行时会报错,具体可以查看这篇博客Exception in thread "main" org.apache.ibatis.exceptions.PersistenceException: 解决办法
<?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>org.example</groupId>
<artifactId>mybatis-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<!-- mybatis的依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!-- mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.28</version>
</dependency>
<!-- junit单元测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
<!-- 添加slf4j日志api -->
<!-- <dependency>-->
<!-- <groupId>org.slf4j</groupId>-->
<!-- <artifactId>slf4j-log4j12</artifactId>-->
<!-- <version>1.7.19</version>-->
<!-- </dependency>-->
</dependencies>
</project>
- 编写MyBatis核心配置文件,在resources目录下创建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>
<!-- 日志 -->
<settings>
<setting name="logImpl" value="STDOUT_LOGGING" />
</settings>
<!-- 别名,UserMapper.xml文件中resultType属性就可以写pojo下的类名(类名还可以不区分大小写) -->
<typeAliases>
<package name="com.itheima.pojo"/>
</typeAliases>
<!--
environments:配置数据库链接环境信息,可以配置多个environment,通过切换default属性切换不同的environment
-->
<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:///mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- 数据库链接信息 -->
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<!-- 加载sql映射文件 -->
<!-- <mapper resource="com/itheima/mapper/UserMapper.xml"/>-->
<!-- mapper代理方式 -->
<package name="com.itheima.mapper"/>
</mappers>
</configuration>
- 编写sql映射文件
(1)在java目录下创建pojo包,在其下创建实体类,这是我对应数据库的user类
package com.itheima.pojo;
//整列操作快捷键 Alt+鼠标左键
//格式化快捷键 Ctrl+Alt+L
public class User {
private Integer id;
private String username;
private String PASSWORD;
private String gender;
private String addr;
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 String getPASSWORD() {
return PASSWORD;
}
public void setPASSWORD(String PASSWORD) {
this.PASSWORD = PASSWORD;
}
public String getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public String getAddr() {
return addr;
}
public void setAddr(String addr) {
this.addr = addr;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", PASSWORD='" + PASSWORD + '\'' +
", gender='" + gender + '\'' +
", addr='" + addr + '\'' +
'}';
}
}
(2)还在java目录下创建mapper包,存放sql映射的接口,在里面写所要执行的sql方法
package com.itheima.mapper;
import com.itheima.pojo.User;
import java.util.List;
public interface UserMapper {
List<User> selectAll();
User selectById(int id);
}
(3)编写sql映射文件,即真正的sql语句。在resources目录下创建与Java对应的mapper包,注意这里创建时要用/隔开,(创建对应的包是为了方便打包时,接口与映射文件在同一目录下),在包下创建UserMapper.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">
<!--
namespace: 名称空间
-->
<mapper namespace="com.itheima.mapper.UserMapper">
<select id="selectAll" resultType="user">
select * from tb_user;
</select>
<select id="selectById" resultType="user">
select *
from tb_user where id = #{id};
</select>
</mapper>
- 编写代码执行sql,在Java目录下创建MyBatisDemo类,用于执行sql
package com.itheima;
import com.itheima.mapper.UserMapper;
import com.itheima.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 java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
* MyBatis代理开发
*/
public class MyBatisDemo2 {
public static void main(String[] args) throws IOException {
//1. 加载MyBatis配置文件,获取SqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//2. 获取SqlSession对象,用它执行sql
SqlSession sqlSession = sqlSessionFactory.openSession();
//3. 执行sql
//List<User> users = sqlSession.selectList("test.selectAll");
//3.1获取UserMapper代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List<User> users = userMapper.selectAll();
System.out.println(users);
//4. 释放资源
sqlSession.close();
}
}
MyBatis核心配置文件
常用的几个属性(属性之间配置具有先后顺序):
<!-- 别名,UserMapper.xml文件中resultType属性就可以写pojo下的类名(类名还可以不区分大小写) -->
<typeAliases>
<package name="com.itheima.pojo"/>
</typeAliases>
<!--
environments:配置数据库链接环境信息,可以配置多个environment,通过切换default属性切换不同的environment
-->
<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:///mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- 数据库链接信息 -->
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<!-- 加载sql映射文件 -->
<!-- <mapper resource="com/itheima/mapper/UserMapper.xml"/>-->
<!-- mapper代理方式 -->
<package name="com.itheima.mapper"/>
</mappers>
MyBatis实际案例
此处我们先安装一个插件,MyBatisX,方便我们进行开发。安装方法也很简单,idea中settings——>plugins,搜索MyBatisX,install。
安装完成后我们进行实际案例的开发,首先我们要建表。sqlyog中执行以下代码,在mybatis中建立tb_brand表:(其中mybatis数据库我已经提前建好)
USE mybatis;
DROP TABLE IF EXISTS tb_brand;
CREATE TABLE tb_brand
(
id INT PRIMARY KEY AUTO_INCREMENT,
brand_name VARCHAR(20),
company_name VARCHAR(20),
ordered INT,
description VARCHAR(100),
STATUS INT
);
INSERT INTO tb_brand (brand_name,company_name,ordered,description,STATUS)
VALUES('三只松鼠','三只松鼠股份有限公司',5,'好吃不上火',0),
('华为','华为科技有限公司',100,'huawfasfak',1),
('小米','小米科技有限公司',50,'ababababbab',1);
SELECT * FROM tb_brand;
建完表之后,我们在idea项目中的pojo文件下建立brand实体类,代码如下:(我们只要定义变量即可,set、get和toString方法可以快捷创建)
package com.itheima.pojo;
public class Brand {
private Integer id;
private String brandName;
private String companyName;
private Integer ordered;
private String description;
private Integer status;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getBrandName() {
return brandName;
}
public void setBrandName(String brandName) {
this.brandName = brandName;
}
public String getCompanyName() {
return companyName;
}
public void setCompanyName(String companyName) {
this.companyName = companyName;
}
public Integer getOrdered() {
return ordered;
}
public void setOrdered(Integer ordered) {
this.ordered = ordered;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
@Override
public String toString() {
return "Brand{" +
"id=" + id +
", brandName='" + brandName + '\'' +
", companyName='" + companyName + '\'' +
", ordered=" + ordered +
", description='" + description + '\'' +
", status=" + status +
'}';
}
public Integer getStatus() {
return status;
}
public void setStatus(Integer status) {
this.status = status;
}
}
第三步我们需要编写接口方法,在mapper包下建立BrandMapper来编写接口,代码如下
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import java.util.List;
public interface BrandMapper {
/**
* 查询所有
*/
public List<Brand> selectAll();
}
第四步我们需要编写sql语句,其实MyBatisX就可以帮我们快速编写sql语句,我们在上一步编写接口时,快速alt+enter,就可以在sql映射文件中快速创建sql语句,我们只需要改写ResultType和编写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">
<!--
namespace: 名称空间
-->
<mapper namespace="com.itheima.mapper.BrandMapper">
<select id="selectAll" resultType="brand">
select * from tb_brand;
</select>
</mapper>
第五步,编写测试代码,我们在test目录下创建测试类,进行编码测试,代码如下:
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 testSelectAll() throws IOException {
//1. 获取sqlsessionFactory
//1. 加载MyBatis配置文件,获取SqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//2. 获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//3. 获取Mapper接口的代理对象
BrandMapper brandmapper = sqlSession.getMapper(BrandMapper.class);
//4. 执行方法
List<Brand> brands = brandmapper.selectAll();
System.out.println(brands);
//5. 释放资源
sqlSession.close();
}
}
至此,一个查询所有的实际案例就写完了,我把增删改查全部的代码放到下一个博客,流程大多是类似的,差异主要是参数的设置,还有就是动态的操作,对这些细节想看一看的可以看下一篇博客,我稍后把链接发上来。增删改查的流程主要是先创建数据表,之后再编写实体类,之后编写接口方法,再编写sql语句,最后编码执行sql。
另外,此处用的是配置文件完成增删改查,还可以用注解完成增删改查,就是在接口文件中用@+相应的语句来实现,下面是按id查询的一个例子(sql映射文件不用写,接口文件写以下代码即可):
@Select("select * from tb_user where id = #{id}")
public User selectById(int id);
但是注解只能完成简单的功能,所以此处对注解就不再多说。
mybatis参数传递
mybatis对于不同的参数有着不同的处理,对于多个参数还会进行封装。这边我就直接放结论了:接口文件中,对于单个参数的话,如果是pojo或map集合,可以直接使用,属性名/键名与参数占位符保持一致即可。如果是Collection,List,Array类型的话,需要@Param参数注解,替换默认的arg键名。多个参数也是@Param注解,替换默认键名。@Param参数注解代码例子如下
void delByIds(@Param("ids") int[] ids);