走进JavaWeb技术世界14通过项目逐步深入了解Mybatis一

30次阅读

共计 13676 个字符，预计需要花费 35 分钟才能阅读完成。

微信公众号【黄小斜】大厂程序员，互联网行业新知，终身学习践行者。关注后回复「Java」、「Python」、「C++」、「大数据」、「机器学习」、「算法」、「AI」、「Android」、「前端」、「iOS」、「考研」、「BAT」、「校招」、「笔试」、「面试」、「面经」、「计算机基础」、「LeetCode」等关键字可以获取对应的免费学习资料。

                     ​

通过项目逐步深入了解 Mybatis（一）

2017-06-12/)

文章导航

Mybatis 和 SpringMVC 通过订单商品案例驱动

官方中文地址：http://www.mybatis.org/mybatis-3/zh/

官方托管地址：https://github.com/mybatis/mybatis-3

本项目全部代码地址：https://github.com/zhisheng17/mybatis

如果觉得不错的话，欢迎给个 star，如果你想完善这个项目的话，你也可以 fork 后修改然后推送给我。

基础知识：

对原生态 jdbc 程序（单独使用 jdbc 开发）问题总结

1、环境

​ java 环境：jdk1.8.0_77

​ 开发工具：IDEA 2016.1

​ 数据库：MySQL 5.7

2、创建数据库

​ mybatis_test.sql

​ Tables：items、orderdetail、orders、user

3、JDBC 程序

​ 使用 JDBC 查询 MySQL 数据库中用户表的记录

​ 代码：

394041424344454647484950515253545556575859606162636465666768697071727374757677787980package cn.zhisheng.mybatis.jdbc;/** * Created by 10412 on 2016/11/27. */import java.sql.*;/** * 通过单独的 jdbc 程序来总结问题 */public class JdbcTest{public static void main(String[] args) {// 数据库连接 Connection connection = null; // 预编译的 Statement，使用预编译的 Statement 可以提高数据库性能 PreparedStatement preparedStatement = null; // 结果集 ResultSet resultSet = null; try { // 加载数据库驱动 Class.forName("com.mysql.jdbc.Driver"); // 通过驱动管理类获取数据库链接 connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis_test?characterEncoding=utf-8", "root", "root"); // 定义 sql 语句 ? 表示占位符（在这里表示 username）String sql = "select * from user where username = ?"; // 获取预处理 statement preparedStatement = connection.prepareStatement(sql); // 设置参数，第一个参数为 sql 语句中参数的序号（从 1 开始），第二个参数为设置的参数值 preparedStatement.setString(1, "王五"); // 向数据库发出 sql 执行查询，查询出结果集 resultSet = preparedStatement.executeQuery(); // 遍历查询结果集 while(resultSet.next()) {System.out.println(resultSet.getString("id")+""+resultSet.getString("username")); } } catch (Exception e) {e.printStackTrace(); }finally{// 释放资源 if(resultSet!=null) {try { resultSet.close(); } catch (SQLException e) {// TODO Auto-generated catch block e.printStackTrace(); } } if(preparedStatement!=null) {try { preparedStatement.close(); } catch (SQLException e) {// TODO Auto-generated catch block e.printStackTrace(); } } if(connection!=null) {try { connection.close(); } catch (SQLException e) {// TODO Auto-generated catch block e.printStackTrace(); } } } }}

4、问题总结

  • 数据库连接，使用时就创建，不使用立即释放，对数据库频繁连接开启和关闭，造成数据库资源的浪费，影响数据库性能。

    解决方法：使用数据库连接池管理数据库连接。

  • 将 sql 语句 硬编码 到 java 代码中，如果 sql 语句需要修改，那么就需要重新编译 java 代码，不利于系统的维护。

    设想：将 sql 语句配置在 xml 配置文件中，即使 sql 语句发生变化，也不需要重新编译 java 代码。

  • 向 preparedStatement 中设置参数，对占位符号位置和设置参数值，硬编码在 java 代码中，同样也不利于系统的维护。

    设想：将 sql 语句、占位符、参数值配置在 xml 配置文件中。

  • 从 resultSet 中遍历结果集数据时，存在硬编码，将获取表的字段进行硬编码，不利于系统维护。

    设想：将查询的结果集自动映射成 java 对象。

Mybatis 框架原理（掌握）

1、Mybatis 是什么？

​ Mybatis 是一个持久层的架构，是 appach 下的顶级项目。

​ Mybatis 原先是托管在 googlecode 下，再后来是托管在 Github 上。

​ Mybatis 让程序员将主要的精力放在 sql 上，通过 Mybatis 提供的映射方式，自由灵活生成（半自动，大部分需要程序员编写 sql）满足需要 sql 语句。

​ Mybatis 可以将向 preparedStatement 中的输入参数自动进行 输入映射 ，将查询结果集灵活的映射成 java 对象。（ 输出映射）

2、Mybatis 框架

注解：

  • SqlMapConfig.xml（Mybatis 的全局配置文件，名称不定）配置了数据源、事务等 Mybatis 运行环境
  • Mapper.xml 映射文件（配置 sql 语句）
  • SqlSessionFactory（会话工厂）根据配置文件配置工厂、创建 SqlSession
  • SqlSession（会话）面向用户的接口、操作数据库（发出 sql 增删改查）
  • Executor（执行器）是一个接口（基本执行器、缓存执行器）、SqlSession 内部通过执行器操作数据库
  • Mapped Statement（底层封装对象）对操作数据库存储封装，包括 sql 语句、输入参数、输出结果类型
    ​

Mybatis 入门程序

1、需求

实现以下功能：

  • 根据用户 id 查询一个用户信息
  • 根据用户名称模糊查询用户信息列表
  • 添加用户
  • 更新用户
  • 删除用户

2、环境

java 环境：jdk1.8.0_77

开发工具：IDEA 2016.1

数据库：MySQL 5.7

Mybatis 运行环境（jar 包）

MySQL 驱动包

其他依赖包

3、log4j.properties

在 classpath 下创建 log4j.properties 如下：

1234567# Global logging configuration# 在开发环境日志级别要设置为 DEBUG、生产环境要设置为 INFO 或者 ERRORlog4j.rootLogger=DEBUG, stdout# Console output...log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

Mybatis 默认使用 log4j 作为输出日志信息。

4、工程结构

5、SqlMapConfig.xml

配置 Mybatis 的运行环境、数据源、事务等

1011121314151617181920<?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> <!-- 和 spring 整合后 environments 配置将废除 --> <environments default="development"> <environment id="development"> <!-- 使用 jdbc 事务管理, 事务由 Mybatis 控制 --> <transactionManager type="JDBC" /> <!-- 数据库连接池, 由 Mybatis 管理，数据库名是 mybatis_test，Mysql 用户名 root，密码 root --> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver" /> <property name="url" value="jdbc:mysql://localhost:3306/mybatis_test?characterEncoding=utf-8" /> <property name="username" value="root" /> <property name="password" value="root" /> </dataSource> </environment> </environments></configuration>

6、创建 po 类

Po 类作为 mybatis 进行 sql 映射使用，po 类通常与数据库表对应，User.java 如下：

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657package cn.zhisheng.mybatis.po;import java.util.Date;/** * Created by 10412 on 2016/11/28. */public class User{private int id; private String username; // 用户姓名 private String sex; // 性别 private Date birthday; // 生日 private String address; // 地址 //getter and setter public int getId() {return id;} public void setId(int id) {this.id = id;} public String getUsername() { return username;} public void setUsername(String username) {this.username = username;} public Date getBirthday() { return birthday;} public void setBirthday(Date birthday) {this.birthday = birthday;} public String getSex() { return sex;} public void setSex(String sex) {this.sex = sex;} public String getAddress() { return address;} public void setAddress(String address) {this.address = address;}}

7、根据用户 id（主键）查询用户信息

  • 映射文件

    • User.xml（原在 Ibatis 中命名）在 Mybatis 中命名规则为 xxxmapper.xml
    • 在映射文件中配置 sql 语句

    User.xml

    123456<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="test"></mapper>

    namespace：命名空间，对 sql 进行分类化管理，用于隔离 sql 语句，后面会讲另一层非常重要的作用。

    ​

    在 User.xml 中加入

    23456789101112<!-- 通过 select 执行数据库查询 id: 标识映射文件中的 sql 将 sql 语句封装到 mappedStatement 对象中，所以 id 称为 Statement 的 id #{}：表示占位符 #{id}：其中的 id 表示接收输入的参数，参数名称就是 id，如果输入参数是简单类型，那么 #{}中的参数名可以任意，可以是 value 或者其他名称 parameterType：表示指定输入参数的类型 resultType：表示指定 sql 输出结果的所映射的 java 对象类型 --><!-- 根据 id 获取用户信息 --> <select id="findUserById" parameterType="int" resultType="cn.zhisheng.mybatis.po.User"> select * from user where id = #{id} </select>

    User.xml 映射文件已经完全写好了，那接下来就需要在 SqlMapConfig.xml中加载映射文件 User.xml

    1234<!-- 加载映射文件 --> <mappers> <mapper resource="sqlmap/User.xml"/> </mappers>

    ​

  • 编写程序
  • MybatisFirst.java
22324252627282930313233343536373839404142434445package cn.zhisheng.mybatis.first;import cn.zhisheng.mybatis.po.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 org.junit.Test;import java.io.IOException;import java.io.InputStream; /*** Created by 10412 on 2016/11/28.*/public class MybatisFirst{// 根据 id 查询用户信息，得到用户的一条记录 @Test public void findUserByIdTest() throws IOException {//Mybatis 配置文件 String resource = "SqlMapConfig.xml"; // 得到配置文件流 InputStream inputStream = Resources.getResourceAsStream(resource); // 创建会话工厂, 传入 Mybatis 的配置文件信息 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 通过工厂得到 SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); // 通过 SqlSession 操作数据库 // 第一个参数：映射文件中 Statement 的 id，等于 = namespace + "." + Statement 的 id // 第二个参数：指定和映射文件中所匹配的 parameterType 类型的参数 //sqlSession.selectOne 结果与映射文件中所匹配的 resultType 类型的对象 User user = sqlSession.selectOne("test.findUserById", 1); System.out.println(user); // 释放资源 sqlSession.close();}}

然后运行一下这个测试，发现结果如下就代表可以了：

8、根据用户名称模糊查询用户信息列表

  • 映射文件

    依旧使用 User.xml 文件，只不过要在原来的文件中加入

    123456789<!-- 自定义条件查询用户列表 resultType：指定就是单条记录所映射的 java 对象类型 ${}: 表示拼接 sql 串，将接收到的参数内容不加修饰的拼接在 sql 中 使用 ${}拼接 sql，会引起 sql 注入 ${value}：接收输入参数的内容，如果传入类型是简单类型，${}中只能够使用 value--> <select id="findUserByUsername" parameterType="java.lang.String" resultType="cn.zhisheng.mybatis.po.User"> select * from user where username like '%${value}%' </select>

  • 编写程序

    依旧直接在刚才那个 MybatisFirst.java 中加入测试代码：

    3141516171819202122232425262728// 根据用户名称模糊查询用户信息列表 @Test public void findUserByUsernameTest() throws IOException { //Mybatis 配置文件 String resource = "SqlMapConfig.xml"; // 得到配置文件流 InputStream inputStream = Resources.getResourceAsStream(resource); // 创建会话工厂, 传入 Mybatis 的配置文件信息 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 通过工厂得到 SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); // 通过 SqlSession 操作数据库 // 第一个参数：映射文件中 Statement 的 id，等于 = namespace + "." + Statement 的 id // 第二个参数：指定和映射文件中所匹配的 parameterType 类型的参数 //selectList 查询结果可能多条 //list 中的 user 和映射文件中 resultType 所指定的类型一致 List<User> list = sqlSession.selectList("test.findUserByUsername", "小明"); System.out.println(list); // 释放资源 sqlSession.close();}

同样测试一下findUserByUsernameTest，如果运行结果如下就代表没问题：

提示：

通过这个代码可以发现，其中有一部分代码是冗余的，我们可以将其封装成一个函数。

1234567public void createSqlSessionFactory() throws IOException { // 配置文件 String resource = "SqlMapConfig.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); // 使用 SqlSessionFactoryBuilder 从 xml 配置文件中创建 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); }

注意：

1、#{} 和 ${} 的区别

  • #{}表示一个占位符号，通过 #{} 可以实现 preparedStatement 向占位符中设置值，自动进行 java 类型和 jdbc 类型转换，#{} 可以有效防止 sql 注入。#{} 可以接收简单类型值或 pojo 属性值（通过 OGNL 读取对象中的值，属性. 属性. 属性.. 方式获取对象属性值）。如果 parameterType 传输单个简单类型值，#{}括号中可以是 value 或其它名称。
  • ${} 表示拼接 sql 串，通过 ${} 可以将 parameterType 传入的内容拼接在 sql 中且不进行 jdbc 类型转换，${}可以接收简单类型值或 pojo 属性值（（通过 OGNL 读取对象中的值，属性. 属性. 属性.. 方式获取对象属性值）），如果 parameterType 传输单个简单类型值，${}括号中只能是 value。

2、parameterType 和 resultType 区别

  • parameterType：指定输入参数类型，mybatis 通过 ognl 从输入对象中获取参数值拼接在 sql 中。
  • resultType：指定输出结果类型，mybatis 将 sql 查询结果的一行记录数据映射为 resultType 指定类型的对象。

3、selectOne 和 selectList 区别

  • selectOne 查询一条记录来进行映射，如果使用 selectOne 查询多条记录则抛出异常：

    org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to bereturned by selectOne(), but found: 3 at

  • selectList 可以查询一条或多条记录来进行映射。

9、添加用户

  • 映射文件

    在 User.xml 中加入：

    12345678<!-- 添加用户 --> <insert id="insetrUser" parameterType="cn.zhisheng.mybatis.po.User" > <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer"> select LAST_INSERT_ID() </selectKey> insert into user(username, birthday, sex, address) values(#{username}, #{birthday}, #{sex}, #{address}) </insert>

    注意:

    • selectKey 将主键返回，需要再返回
    • 添加 selectKey 实现将主键返回
    • keyProperty: 返回的主键存储在 pojo 中的哪个属性
    • order：selectKey 的执行顺序，是相对与 insert 语句来说，由于 mysql 的自增原理执行完 insert 语句之后才将主键生成，所以这里 selectKey 的执行顺序为 after
    • resultType: 返回的主键是什么类型
    • LAST_INSERT_ID(): 是 mysql 的函数，返回 auto_increment 自增列新记录 id 值。

然后在 MybatisFirst.java 中写一个测试函数，代码如下

1112131415161718192021@Test public void insetrUser() throws IOException, ParseException { //Mybatis 配置文件 String resource = "SqlMapConfig.xml"; // 得到配置文件流 InputStream inputStream = Resources.getResourceAsStream(resource); // 创建会话工厂, 传入 Mybatis 的配置文件信息 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 通过工厂得到 SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); User user = new User(); SimpleDateFormat sdf = new SimpleDateFormat ("yyyy-MM-dd"); user.setUsername("田志声"); user.setSex("男"); user.setBirthday(sdf.parse("2016-11-29")); user.setAddress("江西南昌"); sqlSession.insert("test.insetrUser", user); sqlSession.commit(); // 释放资源 sqlSession.close(); }

然后 run 一下，如果出现的结果如下，那么就是成功了。

同时数据库也能查询到刚插入的用户信息：

10、自增主键返回 与 非自增主键返回

  • MySQL 自增主键：执行 insert 提交之前自动生成一个自增主键，通过 MySQL 函数获取到刚插入记录的自增主键：LAST_INSERT_ID()，是在 insert 函数之后调用。

  • 非自增主键返回：使用 MySQL 的 uuid() 函数生成主键，需要修改表中 id 字段类型为 String，长度设置为 35 位，执行思路：先通过 uuid() 查询到主键，将主键输入到 sql 语句中；执行 uuid() 语句顺序相对于 insert 语句之前执行。

    刚才那个插入用户的地方，其实也可以通过 uuid() 来生成主键，如果是这样的话，那么我们就需要在 User.xml 中加入如下代码：

    123456789<!-- 使用 MySQL 的 uuid()生成主键 执行过程：首先通过 uuid()得到主键，将主键设置到 user 对象的 id 属性中 其次执行 insert 时，从 user 对象中取出 id 属性值 --><selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String"> select uuid()</selectKey>insert into user(id, username, birthday, sex, address) values(#{id}, #{username}, #{birthday}, #{sex}, #{address})

  • Oracle 使用序列生成主键

    首先自定义一个序列且用于生成主键，selectKey 使用如下：

    12345678<insert id="insertUser" parameterType="cn.itcast.mybatis.po.User"> <selectKey resultType="java.lang.Integer" order="BEFORE" keyProperty="id"> SELECT 自定义序列.NEXTVAL FROM DUAL </selectKey>insert into user(id,username,birthday,sex,address) values(#{id},#{username},#{birthday},#{sex},#{address})</insert>

    ​

11、删除用户

前面说了这么多了，这里就简单来说明下：

在 User.xml 文件中加入如下代码：

1234<!-- 删除用户 --> <delete id="deleteUserById" parameterType="int"> delete from user where user.id = #{id} </delete>

在 MybatisFirst.java 文件中加入如下代码：

4151617181920212223242526272829// 删除用户 @Test public void deleteUserByIdTest() throws IOException { //Mybatis 配置文件 String resource = "SqlMapConfig.xml"; // 得到配置文件流 InputStream inputStream = Resources.getResourceAsStream(resource); // 创建会话工厂, 传入 Mybatis 的配置文件信息 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 通过工厂得到 SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); // 通过 SqlSession 操作数据库 // 第一个参数：映射文件中 Statement 的 id，等于 = namespace + "." + Statement 的 id // 第二个参数：指定和映射文件中所匹配的 parameterType 类型的参数 sqlSession.delete("test.deleteUserById", 26); // 提交事务 sqlSession.commit(); // 释放资源 sqlSession.close(); }

测试结果如下：

之前的数据库 user 表查询结果：

执行完测试代码后，结果如下：

12、更新用户信息

在 User.xml 中加入如下代码：

123456789<!-- 根据 id 更新用户 需要输入用户的 id 传入用户要更新的信息 parameterType 指定 user 对象，包括 id 和更新信息，id 必须存在 #{id}：从输入对象中获取 id 属性值 --><update id="updateUserById" parameterType="cn.zhisheng.mybatis.po.User"> update user set username = #{username}, birthday = #{birthday}, sex = #{sex}, address = #{address} where user.id = #{id} </update>

然后在 MybatisFirst.java 中加入

819202122232425262728293031323334353637// 根据 id 更新用户信息 @Test public void updateUserByIdTest() throws IOException, ParseException { //Mybatis 配置文件 String resource = "SqlMapConfig.xml"; // 得到配置文件流 InputStream inputStream = Resources.getResourceAsStream(resource); // 创建会话工厂, 传入 Mybatis 的配置文件信息 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 通过工厂得到 SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); // 为了设置生日的日期输入 SimpleDateFormat sdf = new SimpleDateFormat ("yyyy-MM-dd"); User user = new User(); // 根据 id 更新用户信息 user.setId(24); user.setUsername("张四风"); user.setBirthday(sdf.parse("2015-01-12")); user.setSex("女"); user.setAddress("上海黄埔"); // 通过 SqlSession 操作数据库 // 第一个参数：映射文件中 Statement 的 id，等于 = namespace + "." + Statement 的 id // 第二个参数：指定和映射文件中所匹配的 parameterType 类型的参数 sqlSession.update("test.updateUserById", user); // 提交事务 sqlSession.commit(); // 释放资源 sqlSession.close(); }

测试结果如下：

查看数据库，id 为 24 的用户信息是否更新了：

啊，是不是很爽，所有的需求都完成了。

没错，这只是 Mybatis 的一个简单的入门程序，简单的实现了对数据库的增删改查功能，通过这个我们大概可以了解这个编程方式了。

期待接下来的 Mybatis 高级知识文章吧！

一位阿里 Java 工程师的技术小站。作者黄小斜，专注 Java 相关技术：SSM、SpringBoot、MySQL、分布式、中间件、集群、Linux、网络、多线程，偶尔讲点 Docker、ELK，同时也分享技术干货和学习经验，致力于 Java 全栈开发！（关注公众号后回复”Java“即可领取 Java 基础、进阶、项目和架构师等免费学习资料，更有数据库、分布式、微服务等热门技术学习视频，内容丰富，兼顾原理和实践，另外也将赠送作者原创的 Java 学习指南、Java 程序员面试指南等干货资源）

正文完
发表至： java
2019-08-16
 0
作为一技术人员面试前都需要做哪些准备
LayUI页面元素
Dart基础系统学习
关于java:JAVA-IO流中字符串编码不一致问题