java中的mybatis使用selectOne java mybatis

文章目录

• 1.1 Mybatis概述

• 1.1.1 Mybatis概念
• 1.1.2 JDBC 缺点
• 1.1.3 Mybatis 优化

• 1.2 Mybatis快速入门
• 1.3 Mapper代理开发

• 1.3.1 Mapper代理开发概述
• 1.3.2 使用Mapper代理要求
• 1.3.2 SQL映射文件加载的三种方式
• 1.3.3 案例代码实现

• 1.4 核心配置文件

• 1.4.1 多环境配置
• 1.4.2 类型别名

• 1.5 安装 MyBatisX 插件
• 1.5 IDEA中MyBatisX自动生成mapper和pojo

---

1.1 Mybatis概述

Mybatis：数据访问层的框架，包装了JDBC所有实现功能的一个小项目。

1.1.1 Mybatis概念

MyBatis 是一款优秀的持久层框架，用于简化 JDBC 开发
MyBatis 本是 Apache 的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis ，2013年11月迁移到Github。
官网：https://mybatis.net.cn/
Mybatis（轻量级框架）； hibernate（重量性框架） 16年前很火（一统天下）

持久层：把数据存储到mysql中，或者从mysql中读取数据

• 负责将数据到保存到数据库的那一层代码。
  开发中我们会将操作数据库的Java代码作为持久层，而Mybatis就是对jdbc代码进行了封装。
• JavaEE三层架构：表现层、业务层、持久层

框架： （买的精装房） （简化开发）

• 框架就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型
• 在框架的基础之上构建软件编写更加高效、规范、通用、可扩展

1.1.2 JDBC 缺点

下面是 JDBC 代码，我们通过该代码分析都存在什么缺点：

• 硬编码

• 注册驱动、获取连接
  上图标1的代码有很多字符串，而这些是连接数据库的四个基本信息，以后如果要将Mysql数据库换成其他的关系型数据库的话，这四个地方都需要修改，如果放在此处就意味着要修改我们的源代码。
• SQL语句
  上图标2的代码。如果表结构发生变化，SQL语句就要进行更改。这也不方便后期的维护。

• 操作繁琐

• 手动设置参数
• 手动封装结果集
  上图标4的代码是对查询到的数据进行封装，而这部分代码是没有什么技术含量，而且特别耗费时间的。

1.1.3 Mybatis 优化

• 硬编码可以配置到配置文件
• 操作繁琐的地方mybatis都自动完成

下图是持久层框架的使用占比：

1.2 Mybatis快速入门

mybatis 实现步骤：

1.创建数据库表
2.导入依赖
3.导入mybatis 核心配置文件 -- 》 （配置数据库连接信息）
4.编写mapper.xml 配置文件  --- 》（编写sql脚本）
5.编码实现
	1.想办法获得SqlSessionFactory对象
	2. 通过工厂生成一个 SqlSession对象
	3. 使用SqlSession来执行sql语句

需求：查询user表中所有的数据

• 创建user表，添加数据

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

• 创建模块，导入坐标
  在创建好的模块中的 pom.xml 配置文件中添加依赖的坐标

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

注意：还需要在项目的 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="com.xxx" level="DEBUG" additivity="false">
        <appender-ref ref="Console"/>
    </logger>


    <root level="DEBUG">
        <appender-ref ref="Console"/>
    </root>
</configuration>

• 编写 MyBatis 核心配置文件 – > 替换连接信息 解决硬编码问题
  在模块下的 resources 目录下创建mybatis的配置文件 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:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
       <!--加载sql映射文件-->
       <mapper resource="UserMapper.xml"/>
    </mappers>
</configuration>

• 编写 SQL 映射文件 --> 统一管理sql语句，解决硬编码问题
  在模块的 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">

<mapper namespace="test">
    <select id="selectAll" resultType="com.xxx.pojo.User">
        select * from tb_user;
    </select>
</mapper>

• 编码

• 在 com.xxx.pojo 包下创建 User类

public class User {
    private int id;
    private String username;
    private String password;
    private String gender;
    private String addr;
    
    //省略了 setter 和 getter
}

• 在 com.xxx 包下编写 MybatisDemo 测试类

public class MyBatisDemo {

    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"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
        System.out.println(users);
        //4. 释放资源
        sqlSession.close();
    }
}

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

在入门案例映射配置文件中存在表报红的情况。

• 产生的原因：Idea和数据库没有建立连接，不识别表信息，但是它并不影响程序的执行。
• 解决方式：在Idea中配置MySQL数据库连接。

IDEA中配置MySQL数据库连接

• 点击IDEA右边框的 Database ，在展开的界面点击 + 选择 Data Source ，再选择 MySQL

• 在弹出的界面进行基本信息的填写：用户名、密码、数据库名
• 点击完成后就能展开看到如下界面
  而此界面就和 navicat 工具一样可以进行数据库的操作。也可以编写SQL语句

1.3 Mapper代理开发

1.3.1 Mapper代理开发概述

之前我们写的代码是基本使用方式，它也存在硬编码的问题，如下：MyBatisDemo中

//3. 执行sql
List<User> users = sqlSession.selectList("test.selectAll"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
System.out.println(users);

这里调用 selectList() 方法传递的参数是映射配置文件中的对应的UserMapper.xml中的namespace.id值,这样写也不便于后期的维护。
如果使用 Mapper 代理方式（如下面代码）则不存在硬编码问题。

//取UserMapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List<User> users = userMapper.selectAll();

---

通过上面的描述可以看出 Mapper 代理方式的目的：

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

Mybatis 官网也是推荐使用 Mapper 代理的方式。

1.3.2 使用Mapper代理要求

使用Mapper代理方式，必须满足以下3点要求：

• 第1点：定义与SQL映射文件同名的Mapper接口，并且将Mapper接口和SQL映射文件放置在同一目录下。

• 如下图：在编译完成之后，UserMapper和UserMapper.xml会在同一个文件夹内，他俩的层级和包名都相同。
• 注意：在resources中创建包时输入com.xxx.mapper会创建名为此的一个文件夹，需要输入com\xxx\mapper才能分层。

• 第2点：设置SQL映射文件的namespace属性为Mapper接口全限定名

• UserMapper.xml更改namespace

<?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="com.xxx.mapper.UserMapper">
    <select id="selectAll" resultType="com.xxx.pojo.User">
        select * from tb_user;
    </select>
</mapper>

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

---

注意：UserMapper.xml已经更改了路径，需要在mybatis-config.xml中重新设置映射文件。

1.3.2 SQL映射文件加载的三种方式

如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载，包扫描用得最多，不管多少个映射文件也只需要一行。

• 1.使用相对于类路径的资源引用：需要相对路径
• 2.使用映射器接口实现类的完全限定类名：要求“同一目录下”
• 3.使用包扫描将包内的映射器接口实现全部注册为映射器：要求“同一目录下”且“名称相同”

---

mybatis-config.xml 最终代码如下：

<!-- SQL 映射 查找xml的位置,加载sql映射文件-->
    <mappers>
        <!-- 使用相对于类路径的资源引用 -->
        <!--<mapper resource="com/xxx/mapper/UserMapper.xml" />-->
        
        <!-- 使用映射器接口实现类的完全限定类名 -->
        <!--<mapper class="com.xxx.mapper.UserMapper"/>-->

        <!-- 将包内的映射器接口实现全部注册为映射器 -->
        <package name="com.xxx.mapper"/>
    </mappers>

1.3.3 案例代码实现

• 在 com.xxx.mapper 包下创建 UserMapper接口，代码如下：

public interface UserMapper {
    List<User> selectAll();
    User selectById(int id);
}

• 在 resources 下创建 com/xxx/mapper 目录，并在该目录下创建 UserMapper.xml 映射配置文件

<!--
    namespace:名称空间。必须是对应接口的全限定名
-->
<mapper namespace="com.xxx.mapper.UserMapper">
    <select id="selectAll" resultType="com.xxx.pojo.User">
        select *
        from tb_user;
    </select>
</mapper>

• 在 com.xxx 包下创建 MybatisDemo2 测试类，代码如下：

/**
 * 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
        //3.1 获取UserMapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = userMapper.selectAll();

        System.out.println(users);
        //4. 释放资源
        sqlSession.close();
    }
}

注意：

如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载。也就是将核心配置文件的加载映射配置文件的配置修改为

<mappers>
    <!--加载sql映射文件-->
    <!-- <mapper resource="com/xxx/mapper/UserMapper.xml"/>-->
    <!--Mapper代理方式-->
    <package name="com.xxx.mapper"/>
</mappers>

1.4 核心配置文件

我们可以通过查询官网看可以配置的内容，MyBatis中文网

1.4.1 多环境配置

在核心配置文件的 environments 标签中其实是可以配置多个 environment ，使用 id 给每段环境起名，在 environments 中使用 default='环境id' 来指定使用哪儿段配置。我们一般就配置一个 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:///mybatis?useSSL=false"/>
            <property name="username" value="root"/>
            <property name="password" value="1234"/>
        </dataSource>
    </environment>

    <environment id="test">
        <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="1234"/>
        </dataSource>
    </environment>
</environments>

1.4.2 类型别名

在映射配置文件中的 resultType 属性需要配置数据封装的类型（类的全限定名）。而每次这样写是特别麻烦的，Mybatis 提供了 类型别名(typeAliases) 可以简化这部分的书写。

首先需要现在核心配置文件mybatis-config.xml中配置类型别名，也就意味着给pojo包下所有的类起了别名（别名就是类名），不区分大小写。
注意：要放在configuration标签内的前部分。

<typeAliases>
    <!--name属性的值是实体类所在包-->
    <package name="com.xxx.pojo"/> 
</typeAliases>

通过上述的配置，我们就可以简化映射配置文件中 resultType 属性值的编写

<mapper namespace="com.xxx.mapper.UserMapper">
    <select id="selectAll" resultType="User">
        select * from tb_user;
    </select>
</mapper>

1.5 安装 MyBatisX 插件

• MybatisX 是一款基于 IDEA 的快速开发插件，为效率而生。
• 主要功能

• XML映射配置文件 和 接口方法 间相互跳转
• 根据接口方法生成 statement

• 安装方式
  点击 file ，选择 settings下的Plugins ，在搜索框输入MyBatisX安装，安装后需要重启IDEA
• 插件效果
  红色头绳的表示映射配置文件，蓝色头绳的表示mapper接口。
  在mapper接口点击红色头绳的小鸟图标会自动跳转到对应的映射配置文件，在映射配置文件中点击蓝色头绳的小鸟图标会自动跳转到对应的mapper接口。也可以在mapper接口中定义方法，自动生成映射配置文件中的 statement ，在报红处按Alt+回车

1.5 IDEA中MyBatisX自动生成mapper和pojo

1. 项目连接好对应数据库
2. 选中对应数据库表右键->MybatisX-Generator（注意：低版本IDEA右键没有）
3. 配置
4. 如果pom.xml中没有加入Lombok依赖，需要添加。

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
    <scope>provided</scope>
</dependency>