从 0 开始手写一个 Mybatis 框架，三步搞定！

news2024/11/15 21:22:34

MyBatis框架的核心功能其实不难，无非就是动态代理和jdbc的操作，难的是写出来可扩展，高内聚，低耦合的规范的代码。本文完成的Mybatis功能比较简单，代码还有许多需要改进的地方，大家可以结合Mybatis源码去动手完善。

一、Mybatis框架流程简介

在手写自己的Mybatis框架之前，我们先来了解一下Mybatis，它的源码中使用了大量的设计模式，阅读源码并观察设计模式在其中的应用，才能够更深入的理解源码（ref：Mybatis源码解读-设计模式总结 Mybatis源码解读-设计模式总结 – 蚂蚁学Python）。我们对上图进行分析总结：

1、mybatis的配置文件有2类

mybatisconfig.xml，配置文件的名称不是固定的，配置了全局的参数的配置，全局只能有一个配置文件。

Mapper.xml  配置多个statemement，也就是多个sql，整个mybatis框架中可以有多个Mappe.xml配置文件。

2、通过mybatis配置文件得到SqlSessionFactory。

3、通过SqlSessionFactory得到SqlSession，用SqlSession就可以操作数据了。 

4、SqlSession通过底层的Executor（执行器），执行器有2类实现：

 

基本实现

带有缓存功能的实现

5、MappedStatement是通过Mapper.xml中定义statement生成的对象。

6、参数输入执行并输出结果集，无需手动判断参数类型和参数下标位置，且自动将结果集映射为Java对象

HashMap，KV格式的数据类型

Java的基本数据类型

POJO，java的对象

一、梳理自己的Mybatis的设计思路

根据上文Mybatis流程，我简化了下，分为以下步骤：

 

1、读取xml文件，建立连接

从图中可以看出，MyConfiguration负责与⼈交互。待读取xml后，将属性和连接数据库的操作封装在MyConfiguration对象中供后面的组件调用。本文将使用dom4j来读取xml文件，它具有性能优异和非常方便使用的特点。

2、创建SqlSession，搭建Configuration和Executor之间的桥梁

我们经常在使用框架时看到Session，Session到底是什么呢？一个Session仅拥有一个对应的数据库连接。类似于一个前段请求 Request，它可以直接调用exec(SQL)来执行SQL语句。从流程图中的箭头可以看出，MySqlSession的成员变量中必须得有 MyExecutor和MyConfiguration去集中做调配，箭头就像是一种关联关系。我们自己的MySqlSession将有一个getMapper方法，然后使用动态代理生成对象后，就可以做数据库的操作了。

3、创建Executor，封装JDBC操作数据库

Executor是一个执行器，负责SQL语句的生成和查询缓存（缓存还没完成）的维护，也就是jdbc的代码将在这里完成，不过本文只实现了单表，有兴趣的同学可以尝试完成多表。

4、创建MapperProxy，使用动态代理生成Mapper对象

我们只是希望对指定的接口生成一个对象，使得执行它的时候能运行一句sql罢了，而接口无法直接调用方法，所以这里使用动态代理生成对象，在执行时还是回到MySqlSession中调用查询，最终由MyExecutor做JDBC查询。这样设计是为了单一职责，可扩展性更强。

三、实现自己的Mybatis

工程文件及目录：

首先，新建一个maven项目，在pom.xml中导入以下依赖：

​

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www......">

<modelVersion>4.0.0</modelVersion>

<groupId>com.liugh</groupId>

<artifactId>liugh-mybatis</artifactId>

<version>0.0.1-SNAPSHOT</version>

<packaging>jar</packaging>

<properties>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

<maven.compiler.source>1.8</maven.compiler.source>

<maven.compiler.target>1.8</maven.compiler.target>

<java.version>1.8</java.version>

</properties>

<dependencies>

<!-- 读取xml⽂件 -->

<dependency>

<groupId>dom4j</groupId>

<artifactId>dom4j</artifactId>

<version>1.6.1</version>

</dependency>

<!-- MySQL -->

<dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

<version>5.1.29</version>

</dependency>

</dependencies>

</project>

​

创建我们的数据库xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<database>
<property name="driverClassName">com.mysql.jdbc.Driver</property>
<property name="url">jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf8</property>
<property name="username">root</property>
<property name="password">123456</property>
</database>

然后在数据库创建test库，执行如下SQL语句：

CREATE TABLE `user` (
`id` varchar(64) NOT NULL,
`password` varchar(255) DEFAULT NULL,
`username` varchar(255) DEFAULT NULL, PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
INSERT INTO `test`.`user` (`id`, `password`, `username`) VALUES ('1', '123456', 'liugh');

创建User实体类，和UserMapper接口和对应的xml文件:

package com.liugh.bean;

public class User {
private String id;
private String username;
private String password;
//省略get set toString⽅法...
}


package com.liugh.mapper; 

import com.liugh.bean.User; 
public interface UserMapper {
public User getUserById(String id);
}


<?xml version="1.0" encoding="UTF-8"?>
<mapper nameSpace="com.liugh.mapper.UserMapper">
<select id="getUserById" resultType ="com.liugh.bean.User"> select * from user where id = ?
</select>
</mapper>

基本操作配置完成，接下来我们开始实现MyConfiguration：

/**
* 读取与解析配置信息，并返回处理后的Environment
*/
public class MyConfiguration {
private static ClassLoader loader = ClassLoader.getSystemClassLoader();

/**
* 读取xml信息并处理
*/
public Connection build(String resource){
try {
InputStream stream = loader.getResourceAsStream(resource);
本操作配置完成，接下来我们开始实现MyConfiguration：
 
SAXReader reader = new SAXReader();
Document document = reader.read(stream); Element root = document.getRootElement(); return evalDataSource(root);
} catch (Exception e) {
throw new RuntimeException("error occured while evaling xml " + resource);
}
}
private Connection evalDataSource(Element node) throws ClassNotFoundException {
if (!node.getName().equals("database")) {
throw new RuntimeException("root should be <database>");
}
String driverClassName = null; String url = null;
String username = null; String password = null;
//获取属性节点
for (Object item : node.elements("property")) {
Element i = (Element) item; String value = getValue(i);
String name = i.attributeValue("name");
if (name == null || value == null) {
throw new RuntimeException("[database]: <property> should contain name and value");
}
//赋值
switch (name) {
case "url" : url = value; break;
case "username" : username = value; break; case "password" : password = value; break;
case "driverClassName" : driverClassName = value; break;
default : throw new RuntimeException("[database]: <property> unknown name");
}
}

Class.forName(driverClassName); Connection connection = null;
try {
//建⽴数据库链接
connection = DriverManager.getConnection(url, username, password);
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return connection;
}

//获取property属性的值,如果有value值,则读取 没有设置value,则读取内容
private String getValue(Element node) {
return node.hasContent() ? node.getText() : node.attributeValue("value");
}
@SuppressWarnings("rawtypes")
public MapperBean readMapper(String path){ MapperBean mapper = new MapperBean(); try{
InputStream stream = loader.getResourceAsStream(path); SAXReader reader = new SAXReader();
Document document = reader.read(stream); Element root = document.getRootElement();
mapper.setInterfaceName(root.attributeValue("nameSpace").trim());   //把mapper节点的nameSpace值存为接口名
List<Function> list = new ArrayList<Function>(); //用来存储方法的List
for(Iterator rootIter = root.elementIterator();rootIter.hasNext();) {//遍历根节点下所有⼦节点
Function fun = new Function(); //⽤来存储⼀条⽅法的信息
Element e = (Element) rootIter.next(); String sqltype = e.getName().trim();
String funcName = e.attributeValue("id").trim(); String sql = e.getText().trim();
String resultType = e.attributeValue("resultType").trim(); fun.setSqltype(sqltype);
fun.setFuncName(funcName); Object newInstance=null;
try {
newInstance = Class.forName(resultType).newInstance();
} catch (InstantiationException e1) { e1.printStackTrace();
} catch (IllegalAccessException e1) {
e1.printStackTrace();
} catch (ClassNotFoundException e1) { e1.printStackTrace();
}
fun.setResultType(newInstance); fun.setSql(sql);
list.add(fun);
}
mapper.setList(list);
} catch (DocumentException e) { e.printStackTrace();
}
return mapper;
}
}

用面向对象的思想设计读取xml配置后：

package com.liugh.config;

import java.util.List;
public class MapperBean {
private String interfaceName; //接⼝名
private List<Function> list; //接⼝下所有⽅法
//省略 get set⽅法...
}

Function对象包括sql的类型、方法名、sql语句、返回类型和参数类型。

package com.liugh.config;

public class Function { private String sqltype; private String funcName; private String sql;
private Object resultType;
private String parameterType;
//省略 get set⽅法
}

接下来实现我们的MySqlSession,首先的成员变量里得有Excutor和MyConfiguration，代码的精髓就在getMapper的方法里

package com.liugh.sqlSession; 
import java.lang.reflect.Proxy; 
public class MySqlsession {
private Excutor excutor= new MyExcutor();

private MyConfiguration myConfiguration = new MyConfiguration();

public <T> T selectOne(String statement,Object parameter){
return excutor.query(statement, parameter);
}

@SuppressWarnings("unchecked")  public <T> T getMapper(Class<T> clas){
//动态代理调⽤
return (T)Proxy.newProxyInstance(clas.getClassLoader(),new Class[]{clas},
new MyMapperProxy(myConfiguration,this));
}

}

紧接着创建Excutor和实现类：

package com.liugh.sqlSession;

public interface Excutor {
public <T> T query(String statement,Object parameter);
}

MyExcutor中封装了JDBC的操作：

public class MyExcutor implements Excutor{

private MyConfiguration xmlConfiguration = new MyConfiguration();

@Override
public <T> T query(String sql, Object parameter) { Connection connection=getConnection(); ResultSet set =null;
PreparedStatement pre =null;
try {
pre = connection.prepareStatement(sql);
//设置参数
pre.setString(1, parameter.toString());
set = pre.executeQuery(); User u=new User();
//遍历结果集
while(set.next()){ u.setId(set.getString(1)); u.setUsername(set.getString(2)); u.setPassword(set.getString(3));
}
return (T) u;
} catch (SQLException e) { e.printStackTrace();
}finally{ try{
if(set!=null){ set.close();
}if(pre!=null){
pre.close();
}if(connection!=null){ connection.close();
}
}catch(Exception e2){ e2.printStackTrace();
}
}
return null;
}
private Connection getConnection() {
try {
Connection connection =xmlConfiguration.build("config.xml");
return connection;
} catch (Exception e) { e.printStackTrace();
}
return null;
}

MyMapperProxy代理类完成xml方法和真实方法对应，执行查询：

public class MyMapperProxy implements InvocationHandler{ private MySqlsession mySqlsession;
private MyConfiguration myConfiguration;

public MyMapperProxy(MyConfiguration myConfiguration,MySqlsession mySqlsession) { this.myConfiguration=myConfiguration;
this.mySqlsession=mySqlsession;
}

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { MapperBean readMapper = myConfiguration.readMapper("UserMapper.xml");
//是否是xml⽂件对应的接⼝
if(!method.getDeclaringClass().getName().equals(readMapper.getInterfaceName())){ return null;
}
List<Function> list = readMapper.getList(); if(null != list || 0 != list.size()){
for (Function function : list) {
//id是否和接⼝⽅法名⼀样
if(method.getName().equals(function.getFuncName())){
return  mySqlsession.selectOne(function.getSql(), String.valueOf(args[0]));
}
}
}
return null;
}
}

到这里，就完成了自己的Mybatis框架，我们测试一下：

public class TestMybatis {

public static void main(String[] args) { MySqlsession sqlsession=new MySqlsession();
UserMapper mapper = sqlsession.getMapper(UserMapper.class); User user = mapper.getUserById("1");
System.out.println(user);
}
}

执行结果：

查询一个不存在的用户试试：

到这里我们就大功告成了

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1227342.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

打开游戏提示xapofx1_5.dll丢失如何修复？xapofx1_5.dll缺失的修复教程分享

打开游戏提示xapofx1_5.dll丢失如何修复？xapofx1_5.dll缺失的修复教程分享

xapofx1_5.dll是一个重要的Windows系统文件&#xff0c;它主要负责处理图形渲染和多媒体功能。如果在计算机中找不到xapofx1_5.dll&#xff0c;可能会导致程序无法正常运行。下面是关于xapofx1_5.dll丢失的4个修复方法以及xapofx1_5.dll的作用和丢失原因的介绍。 一、xapofx1_…
阅读更多...
MySQL 教程 1.2

MySQL 教程 1.2

上期教程网友笔记整理 MySQL 重置密码 如果你忘记 MySQL 密码&#xff0c;可以通过修改 my.cnf 文件添加 skip-grant-tables 来重置密码&#xff0c;步骤如下&#xff1a; 1、打开 my.cnf 配置文件&#xff0c;找到 [mysqld] &#xff0c;然后在该行下面添加以下参数&#x…
阅读更多...
基于STM32CubeMX和keil采用RTC时钟周期唤醒和闹钟实现LED与BEEP周期开关

基于STM32CubeMX和keil采用RTC时钟周期唤醒和闹钟实现LED与BEEP周期开关

文章目录 前言1. RTC概念1.1 RTC的时钟信号源1.2 预分频器1.3 实时时钟与日历数据1.4 周期性自动唤醒1.5 可编程闹钟 2. RTC相关中断3. STM32CubeMX配置3.1 时钟配置3.2 引脚配置3.3 RTC配置3.3.1 模式选择3.3.2 RTC基本参数配置3.3 中断配置 4. 代码编写总结 前言 RTC的功能有…
阅读更多...
数据结构与算法之美学习笔记：22 | 哈希算法（下）：哈希算法在分布式系统中有哪些应用？

数据结构与算法之美学习笔记：22 | 哈希算法（下）：哈希算法在分布式系统中有哪些应用？

目录 前言应用五&#xff1a;负载均衡应用六&#xff1a;数据分片应用七&#xff1a;分布式存储解答开篇 & 内容小结 前言 本节课程思维导图 今天&#xff0c;我们再来看剩余三种应用&#xff1a;负载均衡、数据分片、分布式存储。你可能已经发现&#xff0c;这三个应用都…
阅读更多...
volatile 无法保证原子性 案例展示

volatile 无法保证原子性 案例展示

volatile 无法保证原子性 在 Java 中&#xff0c;原子性是指一个操作是不可中断的&#xff0c;要么都执行要么都不执行。 但是 volatile 修饰的变量&#xff0c;只是保证了从主内存加载到工作内存的值是最新的&#xff0c;并不能保证对变量的操作是原子性的 变量的写操作和读…
阅读更多...
在线生成含logo的彩色二维码工具

在线生成含logo的彩色二维码工具

具体请前往&#xff1a;在线二维码生成工具--可生成指定大小和颜色的彩色二维码图片,并支持Logo
阅读更多...
arcgis属性表十进制度转换成度分秒格式--转换坐标注记法

arcgis属性表十进制度转换成度分秒格式--转换坐标注记法

1、有一组点数据&#xff0c;如下&#xff1a; 2、为其添加XY坐标&#xff0c;如下&#xff1a; 打开属性表&#xff0c;可得到对应点的XY的十进制度坐标&#xff0c;如下&#xff1a; 3、将十进制度转换成度分秒格式&#xff0c;如下&#xff0c;使用转换坐标注记法工具&#…
阅读更多...
支付、结算、对账流程

支付、结算、对账流程

1、支付过程概览 2、微信支付流程 以微信支付为例，用户使用北京银行，商户收款银行为工行银行，列出机构名 用户在商户处选购商品或服务，选择使用微信支付进行付款。用户打开微信支付，输入支付密码或进行指纹识别等身份验证。微信支付系统将支付请求发送给北京银行。北京银行…
阅读更多...
Java Web 实战 20 - HTTP PK HTTPS ? HTTPS 大获全胜 ?

Java Web 实战 20 - HTTP PK HTTPS ? HTTPS 大获全胜 ?

HTTP VS HTTPS 一 . HTTPS1.1 臭名昭著的运营商劫持1.2 加密是什么 ?1.3 HTTPS 的加密过程对称加密非对称加密引入 "证书" 机制 1.4 HTTP VS HTTPS Hello , 大家好 , 好久没有更新 JavaWeb 模块的内容了 . 博主这篇文章主要给大家讲解一下 HTTPS 以及与 HTTP 的区别…
阅读更多...
“新KG”视点 | 知识图谱与大语言模型协同模式探究

“新KG”视点 | 知识图谱与大语言模型协同模式探究

OpenKG 大模型专辑 导读 知识图谱和大型语言模型都是用来表示和处理知识的手段。大模型补足了理解语言的能力&#xff0c;知识图谱则丰富了表示知识的方式&#xff0c;两者的深度结合必将为人工智能提供更为全面、可靠、可控的知识处理方法。在这一背景下&#xff0c;OpenKG组织…
阅读更多...
laravel-admin导出excel全部，表中无id列导出失败

laravel-admin导出excel全部，表中无id列导出失败

laravel-admin导出excel时&#xff0c;导出全部数据&#xff0c;但是表中没有id字段&#xff0c;然后就无法导出excel&#xff1b; 就直接显示 一开始我也很着急&#xff0c;弄了半天还是不行&#xff0c;然后重写还是有问题 最后发现底层代码排序是按照id排序的orderBy(id, a…
阅读更多...
贝锐蒲公英助力智慧楼宇，实现自控系统远程运维、数据实时监测

贝锐蒲公英助力智慧楼宇，实现自控系统远程运维、数据实时监测

在智慧楼宇系统中&#xff0c;存在着多套不同的系统&#xff0c;比如&#xff1a;智能照明控制、智能空调控制、智能安防监控等。在实际应用中&#xff0c;除了需要打通楼内各个系统实现智能联动&#xff0c;如何实现各地多楼宇的数据实时互通构建智慧楼宇生态系统也是需要解决…
阅读更多...
webservice笔记

webservice笔记

1&#xff0c;简介 webservice&#xff0c;是一种跨编程语言和跨操作系统平台的远程调用技术。 webservice三要素&#xff1a;soap、wsdl、uddi2&#xff0c;服务端 2.1创建项目 2.2 编写服务类&#xff0c;并发布服务 import com.test.service.impl.HelloServiceImpl; impo…
阅读更多...
el-form动态表单添加校验规则

el-form动态表单添加校验规则

0 效果 1 代码
阅读更多...
文件重命名最佳实践：如何确保文件名的准确性和一致性

文件重命名最佳实践：如何确保文件名的准确性和一致性

在日常生活和工作中&#xff0c;经常需要处理大量的文件&#xff0c;包括电子文件和纸质文件。文件重命名是为了更好地组织和管理这些文件&#xff0c;以方便查找和使用。然而&#xff0c;重命名文件并不是一件简单的事情&#xff0c;它需要遵循一定的最佳实践以确保文件名的准…
阅读更多...
基环树(pseudotree)入门

基环树(pseudotree)入门

目录 无向基环树找环&#xff0c;[题目](https://www.luogu.com.cn/problem/P8655)拓扑排序找环并查集找环dfs找环 内向基环树[2876. 有向图访问计数](https://leetcode.cn/problems/count-visited-nodes-in-a-directed-graph/description/)[2127. 参加会议的最多员工数](https…
阅读更多...
公司内部网络架设悟空CRM客户管理系统 cpolar无需公网IP实现内网,映射端口外网访问

公司内部网络架设悟空CRM客户管理系统 cpolar无需公网IP实现内网,映射端口外网访问

1、什么是内网穿透&#xff1f; 内网穿透&#xff0c;即内网映射&#xff0c;内网IP端口映射到外网的过程。是一种主动的操作&#xff0c;需要本人一些内网的权限。比如在公司自己电脑&#xff0c;将办公OA发布到互联网&#xff0c;然后提供外网在家或出差在外连接访问。 可以…
阅读更多...
动态改标题

动态改标题

<el-dialog :title"showTitle" :visible"showDialog" close"close"> </el-dialog>使用计算属性 computed: {showTitle() {//这里根据点击的是否有具体点击的那个id来判断return this.form.id ? "编辑部门" : "新增部…
阅读更多...
Linux：安装软件的两种方式rpm和yum

Linux：安装软件的两种方式rpm和yum

一、rpm方式 1、简单介绍 RPM是RedHat Package Manager的缩写&#xff0c;它是Linux上打包和安装的工具。通过rpm打包的文件扩展名是.RPM。这个安装包就类似Windows系统中的.exe文件。rpm工具实现Linux上软件的离线安装。 2、软件相关信息的查询命令 查询Linux系统上所有已…
阅读更多...
docker的基本使用以及使用Docker 运行D435i

docker的基本使用以及使用Docker 运行D435i

1.一些基本的指令 1.1 容器 要查看正在运行的容器&#xff1a; sudo docker ps 查看所有的容器&#xff08;包括停止状态的容器&#xff09; sudo docker ps -a 重新命名容器 sudo docker rename <old_name> <new_name> <old_name> 替换为你的容器名称…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023