MyBatis 框架基本的增删改查

﹏ヽ暗。殇╰゛Y 2023-10-14 10:47 28阅读 0赞

> 提示：写代码要严谨

#### 文章目录 ####

*  前言
 *  Mybatis和JDBC的区别
 *  Mybatis优势
 *  前期准备
 *  MyBatis CRUD操作流程
 *   *  增加功能
     *  删除功能
     *  修改功能
     *  查询功能
     *   *  \#\{\} 占位符
         *  $\{\} 占位符
         *  两种占位符的区别❗
     *  映射文件总结❗
 *  mapper 代理方式实现CRUD
 *   *  mapper代理开发规范
     *  增加功能
     *  删除功能
     *  修改功能
     *  查询功能

--------------------

## 前言 ##

`提示：`[mybatis官网][mybatis]

MyBatis 代码最主要的是简化 dao 层代码，把dao中复杂的、大量的JDBC代码，简化成了接口和映射文件

ORM思想  
O：po类  
R：关系，数据库  
M：mapper，映射

## Mybatis和JDBC的区别 ##

JDBC是Java提供的一个用于执行SQL语句的Java API，可以为多种关系数据库提供统一访问。  
MyBatis是一个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射，将Java的POJO(Plain Old Java Objects，ji简单对象)映射成数据库中的记录。  
MyBatis是对JDBC的封装。

## Mybatis优势 ##

1.  与JDBC相比，减少了50%以上的代码量。
2.  MyBatis是最简单的持久化框架，小巧并且简单易学。
3.  MyBatis灵活，不会对应用程序或者数据库的现有设计强加任何影响，SQL写在XML里，从程序代码中彻底分离，降低耦合度，便于统一管理和优化，可重用。
4.  提供XML标签，支持编写动态SQL语句（XML中使用if, else）。
5.  提供结果映射标签，支持对象与数据库的ORM字段关系映射。

## 前期准备 ##

**第一步：新建项目Maven项目**  
![请添加图片描述][1d365b97574d409f9d55983944e56618.png]  
在下一步中勾选第一个选项，创建一个简单的项目，最后填写相关信息后完成  
![请添加图片描述][75c45460c9094c5996683e16d31e4861.png]

如果有需要导入的配置文件：  
![在这里插入图片描述][34c7f795145c4ac18554b4449f4cc1fe.png]  
这样做的好处是：即便原有的配置文件被删掉也没事

**第二步：完善 pom.xml 文件**

项目建成后在 pom.xml 文件中导入相关代码，比如：

缺什么加什么

<dependencies>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.1</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.21</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
        </dependencies>
        <build>
            <resources>
                <resource>
                    
                    <directory>src/main/java</directory>
                    <includes>
                        
                        <include>**/*.properties</include>
                        <include>**/*.xml</include>
                    </includes>
                    <filtering>false</filtering>
                </resource>
                <resource>
                    
                    <directory>src/main/resources</directory>
                    <includes>
                        
                        <include>**/*.properties</include>
                        <include>**/*.xml</include>
                        <include>**/*.yml</include>
                    </includes>
                    <filtering>false</filtering>
                </resource>
            </resources>
        </build>

**第三步：配置 main/resources 文件夹**

1.  `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>
        <typeAliases>
        <package name=""/>
        </typeAliases>
        
        <environments default="development">
            
            <environment id="development">
                
                <transactionManager type="MANAGED" />
                
                <dataSource type="POOLED">
                    <property name="driver" value="com.mysql.cj.jdbc.Driver" />
                    <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8&serverTimezone=Asia/Shanghai" />
                    <property name="username" value="root" />
                    <property name="password" value="123456" />
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
        		
            <mapper resource="" />
            <mapper resource="" />
        </mappers>
    </configuration>

1.  `log4j.properties`配置文件，可以显示 log 输出

### direct log messages to stdout ###
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.Target=System.out
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%d{
        yyyy-MM-dd HH:mm:ss} %m%n
    log4j.rootLogger=debug,stdout

1.  新建映射文件 `XyzMapper.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="">
    
    </mapper>

**第四步：在 test/java 文件夹下创建 test 测试类**

import java.io.InputStream;
    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.After;
    import org.junit.Before;
    import org.junit.Test;
    
    public class AppTest {
        
    	private SqlSession session=null;
    	@Before
    	public void before() throws Exception {
        
    	    // 与main/resources文件夹中的 mybatis-config.xml 配置文件名字对应
    		InputStream input = Resources.getResourceAsStream("mybatis-config.xml");
    		SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(input);
    		session= ssf.openSession();
    	}
    	@After
    	public void after() {
        
    		session.close();
    	} 
    	
    	@Test 
    	public void test() {
        
    		
    	}
    		
    }

--------------------

`提示：以下是本篇文章正文内容，下面案例可供参考`

## MyBatis CRUD操作流程 ##

MySQL建表语句：

drop table  if exists emp;
    
    create table EMP
    (
        EMPNO int primary key,
        ENAME varchar(20),
        JOB varchar(9),
        MGR int,
        HIREDATE date,
        SAL double,
        COMM double,
        DEPTNO int,
      foreign key (DEPTNO) references DEPT (DEPTNO)
    );

### 增加功能 ###

在main/java文件夹中新建 po 包及类

public class Emp {
        
    	private Integer empno;
    	private String ename;
    	private String job;
    	private Integer mgr;
    	private Date hiredate;
    	private Double sal;
    	private Double comm;
    	private Integer Deptno;
    	// 自动生成 Getter、Setter、toString()、有参无参方法
    }

在main.resources文件夹中新建映射文件 mapper.xml

这里面写的就是SQL语句

parameterType里面的参数是：在 po 类中双击类的名字，右键复制限定名  
![在这里插入图片描述][06c5da35409a417aa4602aaf352447cf.png]  
SQL语句中的具体数据要写成`#{}`占位符的写法

大括号中的属性名要与 po 类中的名字一致（注意大小写），而 po 类中的名字要与数据库中的名字一致

<mapper namespace="emp">
    	         
    	<insert id="insertEmp" parameterType="com.mybatis.po.Emp">
    		insert into emp 
    		values(#{empno},#{ename},#{job},#{mgr},#{hiredate},#{sal},#{comm},#{Deptno})
    	</insert>
    </mapper>

接下来在 config.xml 文件中增加配置文件

<mappers>
        		
            <mapper resource="EmpMapper.xml" />
        </mappers>

接下来就可以测试了，测试代码：

@Test
    	// insertEmp()起个名
    	public void insertEmp() {
        
    		Emp emp = new Emp(8988, "张三", "Java", 7790, new Date(2023, 10, 23), 10000.0, 99.0, 20);
    		// "emp.insertEmp" → "namespace的值.insertEmp方法名是映射文件中的id"
    		int i = session.insert("emp.insertEmp", emp);
    		System.out.println(i);
    	}

![在这里插入图片描述][1e49a46e68454518b337cfa77ef0ee46.png]

接下来**右键该 test 类测试**，点击运行方式 → **JUnit测试**  
![在这里插入图片描述][19d49c0d0bc0423aaa0c5b89773e0dde.png]

**他会运行前面带`@Test`的方法**  
![请添加图片描述][ea99e9b4f8e344b89f7a781fc651d4a9.png]

### 删除功能 ###

`#{}` 占位符中的名字 如果参数是 po 类型，那么名字必须是属性名，如果参数是基本类型或String，那么参数名字自定义

映射文件代码：

<delete id="deleteEmp" parameterType="int">
        	delete from emp
        	where empno = #{
        随便起名}
        </delete>

测试类代码：

@Test
    	public void deleteEmp() {
         
    		int i = session.delete("emp.deleteEmp",8966);
    		System.out.println(i); 
    	}

### 修改功能 ###

映射文件代码：

<update id="updateEmp" parameterType="com.mybatis.po.Emp">
        	update emp 
        	set ename=#{
        ename},job=#{
        job},mgr=#{
        mgr},hiredate=#{
        hiredate},sal=#{
        sal},comm=#{
        comm},Deptno=#{
        Deptno}
        	where empno = #{
        empno}
        </update>

测试类代码：

@Test
    	public void updateEmp() {
         
    		Emp emp = new Emp(8988,"enen","java全栈",7790,new Date(2003, 10, 13), 11000.0, 999.0, 20);
    		int i = session.update("emp.updateEmp",emp);
    		System.out.println(i);
    	}

### 查询功能 ###

#### \#\{\} 占位符 ####

映射文件代码：

<select id="queryEmps" parameterType="String" resultType="com.mybatis.po.Emp">
        	select * from emp 
        	where ename like concat('%',#{名字模糊查询},'%')
        </select>

测试类代码：

@Test
    	public void queryEmp() {
        
    		List<Emp> list = session.selectList("emp.queryEmps","T");
    		for (Emp emp : list) {
        
    			System.out.println(emp);
    		}
    	}

除了`#{}`外还有种占位符叫`${}`，现在用的比较少

#### $\{\} 占位符 ####

映射文件代码：

<select id="queryEmps" parameterType="String" resultType="com.mybatis.po.Emp">
        	select * from emp 
        	where ename like concat('%','${value}','%')
        </select>

测试类代码：

@Test 
    	public void queryEmps() {
        
    	// 查询部门名字中带 O 的
    		List<Emp> list = session.selectList("emp.queryEmps","O");
    		for (Emp emp : list) {
        
    			System.out.println(emp);
    		}
    	}

![在这里插入图片描述][6e2ee8a9c524497b8c0e474e21c9fe7b.png]

#### 两种占位符的区别❗ ####

`${}` 使用的是普通的 Statement 语句运行，运行效率低，采用的是SQL语句拼接的方式，可能发生SQL注入安全问题

`#{}` 使用的是 PreparedStatement 预编译语句，运行效率高，能够防止SQL注入，安全性高

### 映射文件总结❗ ###

1.  映射文件可以理解为dao类，里面写的就是SQL语句
2.  映射文件中的 `insert update delete select` 标记，理解为**dao类中的方法**
3.  `id` 属性理解为**方法名**， `parameterType` 属性理解为**参数**，`resultType` 属性理解为**方法返回值**（增删改不需要配置，因为只能是 int 类型）
4.  SQL语句中的具体数据要写成`#{}`占位符的写法，`#{属性名1},#{属性名2}`
5.  `#{}` 占位符中的名字 如果参数是 po 类型，那么名字必须是属性名，如果参数是基本类型或字符串，那么参数名字自定义
6.  `alt + /` 是提示

## mapper 代理方式实现CRUD ##

### mapper代理开发规范 ###

1.在同一个包中新建一个接口和与之同名的映射文件  
2.映射文件的namespace必须是接口的限定名  
3.映射文件中语句id必须和接口中方法名一致  
4.映射文件中语句parameterType必须和接口中方法参数一致  
5.映射文件中语句resultType必须和接口中方法返回值类型一致

--------------------

一个 mapper.xml 对应一个 mapper.java 接口，接口的实现类由MyBatis 自动生成

在数据库中新建客户表

drop table  if exists cust;
    
    CREATE TABLE cust (
       id INT PRIMARY KEY auto_increment,    # id自增
       name VARCHAR(50) NOT NULL,    # 姓名
       phone VARCHAR(20),      # 电话
       birthday DATE,          # 出生日期
       balance DOUBLE          # 余额
    );
    INSERT INTO cust (id, name, phone, birthday, balance) VALUES (1, '张三', '13611111111', '1990-01-01', 1000.00);
    
    INSERT INTO cust (id, name, phone, birthday, balance) VALUES (2, '李四', '13722222222', '1995-02-02', 2000.00);
    
    INSERT INTO cust (id, name, phone, birthday, balance) VALUES (3, '王五', '13833333333', '1985-03-03', 3000.00);

main/java内新建 po 包及其Java类

public class Cust {
        
    	private Integer id;
    	private String name;
    	private String phone;
    	private Date birthday;
    	private double balance;
    	// 自动生成 Getter、Setter、toString()、有参无参方法
    }

接着在main/java内新建Cust 接口及 `.xml` 文件

在CustMapper.xml 文件中，`namespace`**是接口的限定名**

在mybatis-config.xml文件中的配置：

<typeAliases>
        	<package name="com.mybatis.po"/>
        </typeAliases>
        
    	
    
        
        <mappers>
        		
        		<package name="com.mybatis.mapper"/>
        </mappers>

### 增加功能 ###

首先在接口中定义方法：

int insertCust(Cust cust);

Customers.xml 文件代码：

<insert id="insertCust" parameterType="Cust">	
       		insert into cust(id,name,phone,birthday,balance)
       		values (#{id},#{name},#{phone},#{birthday},#{balance})
       </insert>

测试代码：

@Test
    	public void insertCust() {
        
    		// 得到mapper接口实现类对象
    		CustMapper mapper = session.getMapper(CustMapper.class);
    		// 主键是自增的，所以id可以为空
    		Cust cust = new Cust(null,"张三", "15794612345", new Date(2003-8-03),20.5);
    		// 调用接口中定义的方法
    		int i = mapper.insertCust(cust);
    		System.out.println(i);
    	}

![在这里插入图片描述][0f5df6717ad542a08698c938220dc508.png]  
增加后怎么拿到主键呢？

在映射文件中：加上查询主键值

<insert id="insertCust" parameterType="Cust">
       
       <selectKey keyProperty="id" resultType="int" order="AFTER">
       
       	select last_insert_id() from dual
       </selectKey>	
       		insert into cust(id,name,phone,birthday,balance)
       		values (#{
        id},#{
        name},#{
        phone},#{
        birthday},#{
        balance})
       </insert>

测试代码加上：

System.out.println("增加的主键值是："+cust.getId());

![在这里插入图片描述][57516e1a6a204b3397cb589881d0dd45.png]

### 删除功能 ###

首先在接口中定义方法：

int deleteCust(int id);

映射文件 CustMapper.xml 中：

<delete id="deleteCust" parameterType="int">
       		delete from cust
       		where id = #{
        int类型随便起名}
       </delete>

测试代码：

@Test
    	public void deleteCustomers() {
        
    		CustMapper mapper = session.getMapper(CustMapper.class);
    		int i = mapper.deleteCust(3);
    		System.out.println(i);
    	}

![在这里插入图片描述][15da794ebd7144f8a0d9cc9f5b8b8a97.png]

### 修改功能 ###

首先在接口中定义方法：

int updateCust(Cust cust);

映射文件 CustMapper.xml 中：

<update id="updateCust" parameterType="Cust">
       		update cust
       		set name = #{name}, phone = #{phone}, birthday = #{birthday}, balance = #{balance}
       		where id = #{id}
       </update>

测试代码：

@Test
    	public void updateCust() {
        
    		CustMapper mapper = session.getMapper(CustMapper.class);
    		Cust cust = new Cust(5,"李四", "15846012345", new Date(2013-8-03),1320.5);
    		int i = mapper.updateCust(cust);
    		System.out.println(i);
    	}

![在这里插入图片描述][7bf7e657c3594004bfd5bd5bbd49f934.png]

### 查询功能 ###

首先在接口中定义方法：

// id查询
    	Cust queryCustById(int id);
    	// 名字和电话的模糊查询
    	List<Cust> queryCusts(Cust cust);

映射文件 CustMapper.xml 中：

<select id="queryCustById" parameterType="int" resultType="Cust">
       		select * from cust
       		where id = #{
        随便起名}
       </select>
       <select id="queryCusts" parameterType="Cust" resultType="Cust">
       		select * from cust
       		where name like concat('%',#{
        name},'%')
       		and phone like concat('%',#{
        phone},'%')
       </select>

测试代码：

@Test
    	public void query() {
        
    		CustMapper mapper = session.getMapper(CustMapper.class);		
    		mapper.queryCustById(6);
    		Cust cust = new Cust(null,"四", "2345", null,130020.5);
    		mapper.queryCusts(cust);
    	}

重点看控制台输出语句是否正确  
![在这里插入图片描述][c0aa8e5932054eaa9f03c99cc7130f51.png]

--------------------

[mybatis]: https://mybatis.org/mybatis-3/zh/index.html
[1d365b97574d409f9d55983944e56618.png]: https://img-blog.csdnimg.cn/1d365b97574d409f9d55983944e56618.png
[75c45460c9094c5996683e16d31e4861.png]: https://img-blog.csdnimg.cn/75c45460c9094c5996683e16d31e4861.png
[34c7f795145c4ac18554b4449f4cc1fe.png]: https://img-blog.csdnimg.cn/34c7f795145c4ac18554b4449f4cc1fe.png
[06c5da35409a417aa4602aaf352447cf.png]: https://img-blog.csdnimg.cn/06c5da35409a417aa4602aaf352447cf.png
[1e49a46e68454518b337cfa77ef0ee46.png]: https://img-blog.csdnimg.cn/1e49a46e68454518b337cfa77ef0ee46.png
[19d49c0d0bc0423aaa0c5b89773e0dde.png]: https://img-blog.csdnimg.cn/19d49c0d0bc0423aaa0c5b89773e0dde.png
[ea99e9b4f8e344b89f7a781fc651d4a9.png]: https://img-blog.csdnimg.cn/ea99e9b4f8e344b89f7a781fc651d4a9.png
[6e2ee8a9c524497b8c0e474e21c9fe7b.png]: https://img-blog.csdnimg.cn/6e2ee8a9c524497b8c0e474e21c9fe7b.png
[0f5df6717ad542a08698c938220dc508.png]: https://img-blog.csdnimg.cn/0f5df6717ad542a08698c938220dc508.png
[57516e1a6a204b3397cb589881d0dd45.png]: https://img-blog.csdnimg.cn/57516e1a6a204b3397cb589881d0dd45.png
[15da794ebd7144f8a0d9cc9f5b8b8a97.png]: https://img-blog.csdnimg.cn/15da794ebd7144f8a0d9cc9f5b8b8a97.png
[7bf7e657c3594004bfd5bd5bbd49f934.png]: https://img-blog.csdnimg.cn/7bf7e657c3594004bfd5bd5bbd49f934.png
[c0aa8e5932054eaa9f03c99cc7130f51.png]: https://img-blog.csdnimg.cn/c0aa8e5932054eaa9f03c99cc7130f51.png