侧边栏壁纸
博主头像
黑色閃光w博主等级

行动起来,活在当下

  • 累计撰写 28 篇文章
  • 累计创建 14 个标签
  • 累计收到 152 条评论

目 录CONTENT

文章目录

Mybatis——持久层框架

黑色閃光w
2022-08-20 / 1 评论 / 2 点赞 / 1040 阅读 / 14214 字 / 正在检测是否收录...
温馨提示:
本文最后更新于 2023-09-12,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

前言

Mybatis框架作为一个Java数据持久层的框架,它几乎解决了所有JDBC所有的缺点,包括但不限于JDBC的硬编码,SQL语句难以变更,代码可读性差,以及操作繁琐等。本篇文章讲解如何通过Maven项目使用Mybatis框架。最重要的是Mybatis可以最大程度的防止SQL注入的发生,直接与1=1的风险说再见!

正文

使用前配置

首先使用Idea创建Maven项目image.png,构建系统选择Maven。
创建成功之后,等待Maven加载成功,我们就看到了熟悉的Maven项目结构。image.png
打开pom.xml文件,添加Mybatis依赖jar包的坐标,点击刷新后等待Maven下载。

<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>

可以看到,除了Mybatis和MySQL以来之外还有其他的坐标,那些是为了让Mybatis的控制台返回信息的代码有颜色划分,增加返回信息的可读性。同时需要在项目的resources目录下创建logback.xml的配置文件。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--
        CONSOLE :表示当前的日志信息是可以输出到控制台的。
    -->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%level] %blue(%d{HH:mm:ss.SSS}) %cyan([%thread]) %boldGreen(%logger{15}) - %msg %n</pattern>
        </encoder>
    </appender>

    <logger name="top.yn" level="DEBUG" additivity="false">
        <appender-ref ref="Console"/>
    </logger>


    <!--

      level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
     , 默认debug
      <root>可以包含零个或多个<appender-ref>元素,标识这个输出位置将会被本日志级别控制。
      -->
    <root level="DEBUG">
        <appender-ref ref="Console"/>
    </root>
</configuration>

至此,我们使用前的一些配置就已经完成了。

数据库

因为Mybatis是持久层框架,所以肯定要链接数据库,我们以以下这个数据表举例。
image.png

CREATE DATABASE mybatis;
USE mybatis;
DROP TABLE tb_brand;

CREATE TABLE tb_user(
	id int primary key auto_increment,
	brand_name varchar(20),
	company_name varchar(20),
	ordered int(11),
	description varchar(100),
	status int(11)
);

INSERT INTO `tb_brand`(`id`, `brand_name`, `company_name`, `ordered`, `description`, `status`) VALUES (1, 'Origin', 'EA', 20, '服务器还不如育碧', 0);
INSERT INTO `tb_brand`(`id`, `brand_name`, `company_name`, `ordered`, `description`, `status`) VALUES (2, 'Steam', 'Valve', 100, '不会数3', 1);
INSERT INTO `tb_brand`(`id`, `brand_name`, `company_name`, `ordered`, `description`, `status`) VALUES (3, 'Uplay', '育碧', 100, '土豆服务器', 1);

创建好数据库,我们就可以编写Mybatis代码了

配置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>
<!--    配置类型别名 -->
    <typeAliases>
        <package name="top.yn.pojo"/>
    </typeAliases>

<!--     多环境配置 -->
    <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"/>-->
                <!-- mysql-connector-java 6开始,连接时需要指定时区										serverTimezone。-->
                <!--  url设置一个serverTimezone的参数,值可以是GMT-8,也可以是							Asia/Shanghai,因为GMT-8需要转义连字符"-",-->
                <!--   所以转移后变成GMT%2B8,如果是Asia/Shanghai就无须做转换了-->

<!--                数据库连接地址-->
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;serverTimezone=Asia/Shanghai"/>
<!--                用户名-->
                <property name="username" value="root"/>
<!--                密码-->
                <property name="password" value="*******"/>

            </dataSource>
        </environment>
    </environments>
    <mappers>
        <!--加载sql语句映射文件-->
<!--        mapper代理 (包扫描) -->
        <package name="top/yn/mapper"/>
    </mappers>
</configuration>

值得注意的是<mappers>标签内的是SQL语句映射文件的路径,但是为了处理之后的开发可能会使用多种XML文件来映射不同的SQL语句的情况,所以我们使用包扫描的方式,路径则为放SQL语句映射文件的包路径。

编写SQL映射文件

SQL的映射文件分为两部分,第一部分是填写SQL语句的XML文件,第二部分是Java接口,这两部分的文件名必须一致,且原则上Mybatis要求这两个文件的引用必须相同,但是我们并不能破坏Maven的项目结构(配置文件放入resources目录下,而Java代码则需要放入java目录下),解决办法是在两个目录下创建相同的包,以达到两个文件的引用相同的目的。

java目录下创建top.yn.mapper软件包并创建BrandMapper接口类

值得注意的是,在java下创建的是软件包,目录的每一级通过.来连接。

package top.yn.mapper;

import top.yn.pojo.Brand;

import java.util.List;

public interface BrandMapper {
    List<Brand> selectAll();
}

top.yn.pojo目录下创建Brand的Java类

package top.yn.pojo;

public class Brand {
    // id 主键
    private Integer id;
    // 品牌名称
    private String brandName;
    // 企业名称
    private String companyName;
    // 排序字段
    private Integer ordered;
    // 描述信息
    private String description;         // 状态:0:禁用  1:启用
    // 权重
    private Integer status;

    // getter and setter

    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;
    }

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

    @Override
    public String toString() {
        return "Brand{" +
                "id=" + id +
                ", brandName='" + brandName + '\'' +
                ", companyName='" + companyName + '\'' +
                ", ordered=" + ordered +
                ", description='" + description + '\'' +
                ", status=" + status +
                '}';
    }
}

resources目录下创建top/yn/mapper目录并创建BrandMapper.xml配置文件

值得注意的是,在resources下创建的是目录,目录的每一级通过/来连接。

<?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="top.yn.mapper.BrandMapper">

    <!--    结果集映射 -->
    <resultMap id="BrandResult" type="brand">
        <result column="brand_name" property="brandName"/>
        <result column="company_name" property="companyName"/>
    </resultMap>

    <select id="selectAll" resultType="top.yn.pojo.Brand">
        select * from tb_brand;
    </select>
</mapper>

这里讲解,这三个文件的具体是干嘛的

BrandMapper.java

这个文件是接口,我们不需要创建类来实现这个接口中的方法,而是通过xml映射的方式实现接口的方法,在案例中我们定义了一个selectAll()的抽象方法,这个方法就映射着 BrandMapper.xml 这个文件中的 id 名为 selectAll 的一个select标签,select标签则是Mybatis框架用于填写查询SQl语句的标签。

Brand.java

这个类则是对返回的结果进行封装,这里面我们不难发现有着所有成员方法的getter&setter方法,并且重写了toString方法,将数据库返回的查询结果封装到Brand对象中。

BrandMapper.xml

这个配置文件则是整个项目的核心配置文件,有了它Java在知道你要进行数据库的什么查询,要执行什么SQL语句,Mybatis提供了所有DCL、DDL、DQL、DCL的对应标签,在这些标签中书写对应的SQL语句。
在案例中使用的是<select>查询标签,id属性则是这个SQL语句的全限定名称,与BrandMapper.java中的抽象方法名称一一对应。
resultMap则是结果集映射,什么是结果集映射呢,就是数据库中的字段命名规范和Java中的成员变量的命名规范不同,为了保持项目文件都遵循自己的命名规范,所以会将两个名称不相同的字段名称进行匹配,类似于取别名。如案例中的SQL命名规范company_name和Java命名规范companyName,实际上指向的同一个字段。这里是以select语句进行举例说明,当然我们也可以写成动态的,这个将在Mybatis进阶的文章中说明

至此所有的配置文件,映射文件的编写全部完成!

编写实现类

在java.top.yn的包路径下创建一个Java类,这个也是最后直接运行拥有main方法的Java代码。

package top.yn;

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 top.yn.mapper.BrandMapper;
import top.yn.pojo.Brand;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class doMain {
    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
        // 使用Mapper代理,来映射SQL语句
        BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
        // List列表对象 来接收返回值列表
        List<Brand> brands = brandMapper.selectAll();
        //打印 brands列表
        System.out.println(brands);



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

直接运行!
image.png
这里就出现了,数据库中查询到的所有数据,并按照我们写的Brand类进行封装,也按照重写的toString方法进行输出。

至此关于Mybatis的快速入门就全部结束!
这就是我们费了半天劲之后的成果:
image.png
Maven的项目结构看起来就很专业不是吗?

结语

Mybatis十分贴心的准备了中文的文档供大家查阅(呜呜呜!Apache他真的!我哭死!!!)
参考文档:Mybatis中文网

2

评论区