MyBatis代理开发与核心配置文件

一、MyBatis简介

1、什么是MyBatis?

MyBatis 是一款优秀的持久层框架,用于简化JDBC开发。
MyBatis 本是 Apache 的一个开源项目iBatis, 2010年这个项目由apache softwarefoundation迁移到了google code,并且改名为MyBatis。2013年11月迁移到Github
官网: https://mybatis.org/mybatis-3/zh/index.html

持久层
负责将数据到保存到数据库的那一层代码JavaEE三层架构:表现层(用来做页面展示)、业务层(用来做逻辑处理)、持久层

框架
框架就是一个半成品软件,是一套可重用的、通用的、软件基础代码模型
在框架的基础之上构建软件编写更加高效、规范、通用、可扩展。
如石膏上色,石膏模板就是半成品,相当于框架。

2、JDBC的缺点
因为JDBC存在一些缺点,所以使用MyBatis对JDBC进行一些完善。
1、硬编码

  1. 注册驱动,获取连接
  2. SQL语句

2、操作繁琐

  1. 手动设置参数
  2. 手动封装结果集

3、MyBatis简化

MyBatis免除了几乎所有JDBC代码以及设置参数和获取结果集的工作。
1、硬编码:将字符串信息写到配置文件中;
2、操作繁琐:自动完成

二、MyBatis 快速入门

(一)查询user表中所有数据

1、创建user表,添加数据

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','男','西安');

SELECT * FROM tb_user;

在这里插入图片描述

2、创建模块,导入坐标

在IDEA中创建一个Maven项目
使用Maven来构建项目,则需将下面的依赖代码置于pom.xml文件中,版本可以改一下:

<dependencies>

        <!--mybatis依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.41</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-log4j12</artifactId>
            <version>1.7.25</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>

把logback配置文件复制到目录下:
在这里插入图片描述
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="com.itheima" 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>

3、编写MyBatis 核心配置文件–>替换连接信息解决硬编码问题
mybatis-config.xml文件
修改数据库连接信息
在这里插入图片描述

4、编写SQL映射文件–>统一管理sql语句,解决硬编码问题
新建一个映射文件,如果是user表则命名为UserMapper.xml。
这里的namespace是名称空间,随便写一个但不能不写:
在这里插入图片描述

先创建一个user实体类,内容先不写,操作见“定义POJO类”

有很多标签,比如< select>< /select>就是查询,除此之外还有< update> </ update>等
以下图为例,id是查询语句的唯一标识,resultType是返回结果包装类型,这里定义的是user类
在这里插入图片描述

Mapper文件写完后,需要把映射文件加载到mybatis-config.xml核心配置文件中:
在这里插入图片描述
此时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>
    
    <!--
    environments:配置数据库连接环境信息。可以配置多个environment,通过default属性切换不同的environment
    -->
    <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://localhost:3306/db1?serverTimezone=GMT"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
        
    </environments>
    <mappers>
        <!--加载sql映射文件-->
        <mapper resource="UserMapper.xml"/>

    </mappers>


</configuration>

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

    <!--statement-->

    <select id="selectAll" resultType="com.itmybatis.pojo.User">
        select * from tb_user;
    </select>

</mapper>

5、编码

1)定义POJO类
创建一个user实体类
在这里插入图片描述
定义属性,与数据库中相对应,添加setter、getter、tostring

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)加载核心配置文件,获取SqlSessionFactory对象
创建一个类
在这里插入图片描述

//1、加载核心配置文件,获取SqlSessionFactory对象
        String resource = "mybatis-config.xml"; //定义配置文件
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

3)获取SqlSession对象,执行SQL语句

//2、获取SqlSession对象,执行SQL语句
        SqlSession sqlSession = sqlSessionFactory.openSession();

        //3、执行sql
        List<User> users = sqlSession.selectList("test.selectAll");

        System.out.println(users);

4)释放资源

sqlSession.close();

核心配置文件MyBatisDemo内容:

package com.itmybatis;

import com.itmybatis.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 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();
    }
}

(二)解决SQL映射文件的警告提示

产生原因:ldea和数据库没有建立连接,不识别表信息

解决方式:在ldea中配置MySQL数据库连接

点击右侧Database面板——加号——Data Source——MySQL
在这里插入图片描述
输入用户名、密码、需要连接的数据库名,点Test Connection(可能会提示需要下载一个Driver Files),出现绿色对号即连接成功
在这里插入图片描述
在Database面板里可以看到连接的数据库及信息
在这里插入图片描述
点击像笔一样的按钮,可对这个表进行操作。
在这里插入图片描述

三、Mapper 代理开发

//3、执行sql
        List<User> users = sqlSession.selectList("test.selectAll");

在上述代码中,仍存在硬编码的问题。此外,如果有多个SQL语句,就会存在多个id,来回找非常不方便。Mapper 代理开发就是解决这个问题。

(一)Mapper 代理开发的目的:

1、解决原生方式中的硬编码
2、简化后期执行SQL

(二)Mapper 代理开发规则:

1、定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放置在同一目录下!

  • UserMapper.xml就是SQL映射文件

在这里插入图片描述

  • 定义与SQL映射文件(UserMapper.xml)同名的Mapper接口;

接口一般放在单独的一个包,包名是mapper,接口名是UserMapper,选择Interface,才是接口:
在这里插入图片描述
创建成功:
在这里插入图片描述

  • 将Mapper接口和SQL映射文件放置在同一目录下

第一种方法,直接把UserMapper.xml拖到mapper包里,但这样不好,因为我们要把java代码和配置文件分开,SQL映射文件就应该放到resources目录下。

第二种方法!!!
在resources下面创建一个与mapper一样的包结构。而resources下不能new package,只有new directory,此时如果使用“.”(com.itmybatis.mapper),会看成是一个名称,不会来分隔包名和类名。要用/来分割(com/itmybatis/mapper),再把UserMapper.xml拖到新创建的目录下,编译。

虽然在IDEA中仍显示是一个文件夹名,并没有分层:
在这里插入图片描述
但在项目目录的target里,已经成功显示俩个文件在同一目录下:

在这里插入图片描述

2、设置SQL映射文件的namespace属性为Mapper接口全限定名,就不能随便写了
在这里插入图片描述

3、在Mapper 接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
在这里插入图片描述
SQL映射文件中select有一个id叫selectAll,那么Mapper 接口中就要有一个方法,名称为selectAll;
SQL映射文件中没有参数,那么Mapper 接口中就不需要参数;
SQL映射文件中返回值类型是user,那么Mapper 接口中返回值类型就要是user。

在接口中就要写:
在这里插入图片描述
需要注意的是,上述语句只是返回一个值,适用于增删改(是否执行成功),如果是返回一个集合(查询),那么就要用List
在这里插入图片描述
具体使用哪一种,需要根据SQL语句判断。

4、编码

1.通过SqISession的getMapper方法获取Mapper接口的代理对象

因为UserMapper.xml位置改变,mybatis-config.xml中加载sql映射文件的路径就要改变:
在这里插入图片描述
复制一下UserMapper.xml路径粘贴到mybatis-config.xml中加载sql映射文件中:
在这里插入图片描述
在这里插入图片描述

//3.1 通过SqISession的getMapper方法获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

2.调用对应方法完成sql的执行

//3.2 调用对应方法完成sql的执行
        List<User> users = userMapper.selectAll();

MyBatisDemo2内容:


/**
 * MyBatis代理开发
 */

public class MyBatisDemo2 {
    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");

        //3.1 通过SqISession的getMapper方法获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        //3.2 调用对应方法完成sql的执行
        List<User> users = userMapper.selectAll();


        System.out.println(users);

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

四、MyBatis 核心配置文件——mybatis-config.xml

(一)environments:配置数据库连接环境信息。

可以配置多个environment,通过default属性切换不同的environment。

比如以下代码中,连接了两个数据库,第一个id是development,第二个id是test,默认使用的是第一个。
在这里插入图片描述
(二)类型别名(typeAliases)

比如在这个里面返回值类型太长,包名+类名,很麻烦,我们可以把这个返回值类型设置为使用它的别名
在这里插入图片描述
在mybatis-config.xml中添加以下代码,意思是要扫描名为com.itmybatis.pojo的包。

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

相当于给pojo下的实体类起了一个别名,这个别名默认就是类名,且不区分大小写,也不用再加包名,所以在写返回类型的时候可以直接写类名:
在这里插入图片描述

另外需要注意,配置各个标签时,要遵循先后顺序。
比如上述typeAliases就不能放到environments后面。
在这里插入图片描述

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值