JavaWeb-MyBatis（上）

原创

reload

发布于 2024-03-07 21:12:09

2260

发布于 2024-03-07 21:12:09

文章被收录于专栏：Java后端

学完项目管理工具Maven后，继续学习MyBatis。我们都知道，JDBC是一个与数据库连接相关的API，最开始学习数据库连接都是从JDBC开始学起，但是其也有缺点，比如硬编码和操作繁琐等等。而今天学习的MyBatis就是专门为简化JDBC开发而设计的。

一、MyBatis概述

1、MyBatis开发基础

MyBatis是一款优秀的持久层框架，用于简化JDBC开发。

持久层：所谓持久层，即负责将数据到保存到数据库的那一层代码。JavaEE三层架构分别为表现层、业务层、持久层，每层架构对应的具体功能后面讲框架的时候也会学到。
框架：简单理解，就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型，在框架的基础之上构建软件编写更加高效、规范、通用、可扩展。

官网: https://mybatis.org/mybatis-3/ ，官方文档对于我们学习MyBatis具有很大的帮助和参考意义，如下翻译成中文。

2、MyBatis和JDBC

任何一个新技术的出现很大程度上都是为了解决或改善之前技术存在的痛点。引入MyBatis也是，因此，来看一下MyBatis和JDBC之间的比较。

2.1 JDBC缺点

1）硬编码

硬，即不可变或很难改变的意思，即字符串。硬编码，简单理解就是很多字符串信息写入代码，后续发生变动时改动量太大，代码维护性差。JDBC有以下地方体现硬编码。

1.注册驱动，获取连接
// 注册驱动
Class.forName("com.mysql.jdbc.Driver"); // 将类加载进内存 (可以省略)
// 获取连接
String url="jdbc:mysql:///db1?useSSL=false";
String username="root";
String password="123456";
Connection conn = DriverManager.getConnection(url, username, password);

2.SQL语句，如
String sql="SELECT * FROM `account`";

2）操作繁琐

手动设置参数
手动封装结果集

2.2 MyBatis优点

1）配置文件---->解决硬编码问题

2）自动完成---->解决手动操作繁琐问题

MyBatis官方介绍：MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。

二、MyBatis快速入门

不清楚的可参考官方文档：https://mybatis.org/mybatis-3/getting-started.html ，里面有详细说明。

1、案例

直接上手代码，以查询user表中所有数据为例。

1）创建user表，添加数据

打开Navicat，连接MySQL，并在当前连接下通过新建查询的方式创建数据库、表以及插入数据。

对应的代码如下

create database mybatis;
use mybatis;

drop table if exists tb_user;

create table tb_user(
	id int primary key auto_increment,
	username varchar(20),
	password varchar(20),
	gender char(1),
	addr varchar(30)
);

INSERT INTO tb_user VALUES (1, 'zhangsan', '123', '男', '北京');
INSERT INTO tb_user VALUES (2, '李四', '234', '女', '天津');
INSERT INTO tb_user VALUES (3, '王五', '11', '男', '西安');

创建插入完成后，即可查询表中数据

2）创建模块，导入坐标

新建一个mybatis-demo的Maven项目，在pom.xml文件中导入所需坐标。

对于坐标，需要用到什么就导入什么。

<?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>itweb</groupId>
    <artifactId>mybatis-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <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>5.1.46</version>
        </dependency>

        <!--junit 单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>

        <!-- 添加slf4j日志api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.20</version>
        </dependency>
        <!-- 添加logback-classic依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- 添加logback-core依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>

    </dependencies>
</project>

3）编写MyBatis核心配置文件(mybatis-config.xml)

替换连接信息解决硬编码问题（核心两步如下）
1.数据库连接信息
2.加载sql映射文件

在resources目录下新建一个mybatis-config.xml文件

对应代码如下

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://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:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载sql映射文件-->
    <mappers>
    <!--由于mybatis-config.xml与UserMapper.xml同级，所以直接写名称-->
        <mapper resource="UserMapper.xml"/>
    </mappers>
</configuration>

4）编写SQL映射文件(XxxMapper.xml)

统一管理sql语句，解决硬编码问题
编写sql查询及增删改语句（名称空间namespace和id，类模块resultType） id有selectAll等

在resources目录下新建一个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:名称空间
-->
<mapper namespace="test">
    
    <select id="selectAll" resultType="com.itweb.pojo.User">
        select * from tb_user;
    </select>
</mapper>

5）编码

第一，定义POJO实体类（Xxx类），两个要点如下

1.封装所有与数据库同名的属性
2.提供get、set方法和重写toString方法

在java目录下新建一个User类(com.itweb.pojo.User)

package com.itweb.pojo;
// 处理属性字段时，alt + 鼠标左键 整列编辑
public class User {
    private Integer id;
    private String username;
    private String password;
    private String gender;
    private String addr;
    // 提供get、set方法（鼠标右键快捷生成）
    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;
    }
    // 提供重写toString方法（鼠标右键快捷生成）
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", gender='" + gender + '\'' +
                ", addr='" + addr + '\'' +
                '}';
    }
}

第二，加载核心配置文件，获取SqISessionFactory对象

第三，获取 SqlSession对象，执行SQL语句

第四，释放资源

在java目录下新建一个MyBatisDemo类(com.itweb.MyBatisDemo)，以上三步对应的代码如下

package com.itweb;

import com.itweb.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;

public class MyBatisDemo {
    public static void main(String[] args) throws IOException {
        // 1.加载核心配置文件，获取 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");
        System.out.println(users);

        // 4.释放资源
        sqlSession.close();
    }
}

运行结果如下

总结：项目结构及相关步骤回顾梳理

结合项目结构来梳理项目的相关步骤流程，一图以蔽之，如下。

2、解决SQL映射文件的警告提示

SQL映射文件里的表名爆红，是警告提示而非错误。

产生原因：Idea 和数据库没有建立连接，不识别表信息

解决方式：在 Idea 中配置 MySQL 数据库连接

连接成功后如下图

由此可见IDEA功能十分强大，只要数据库连接成功，以后就能非常方便的在IDEA中编写数据库代码了。

三、Mapper代理开发

1、目的

1）解决原生方式中的硬编码

2）简化后期执行SQL

2、步骤

1）定义与SQL映射文件同名的Mapper接口，并且将Mapper接口（如UserMapper.class接口）和SQL映射文件（如UserMapper.xml）放置在同一目录下

注：在resources目录下创建分层的包要用 / 而不是 .

2）设置SQL映射文件的namespace属性为Mapper接口全限定名(如com.itweb.mapper.UserMapper)

3）在Mapper接口中定义方法，方法名就是SQL映射文件中sql语句的id，并保持参数类型和返回值类型一致

（以上三步对应下图）

4）编码

1.通过SqlSession的getMapper方法获取Mapper接口的代理对象
2.调用对应方法完成sql的执行

注：如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载

四、MyBatis核心配置文件

参考官方文档：https://mybatis.org/mybatis-3/configuration.html

1、类型别名(typeAliasess)

<typeAliases>
  <package name="com.itweb.pojo"/>
</typeAliases>

注：配置各个标签时，需要遵守前后顺序

其他更多的可以参考官方文档自行学习，不再赘述。

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

java