一篇部落格帶你學會MyBatis
2023-03-11 18:00:15
概念
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);