概要
过度
我们前面介绍了 JDBC 的基本使用方法和 Spring 对 JDBC 的包装,我们发现以下特点:
- Spring 对第三方框架的包装说到底只是对第三方框架API的合理封装
- Spring 的封装通过接管第三方的一些对象生命周期,尽可能降低项目代码量,同时提供更贴近 Spring 普通 Bean 的使用方式。
我们前面介绍了 JDBC ,实现了 Java 项目连接数据库的基本需求。但是很多时候在代码行中写 SQL ,是一件非常难受的事情,因为我们对它的生命就是一个 String , 但是对数据库的理解告诉我们,它是用来执行的,有意义、可解读的语言。你说难受不难受。
所以为了将 SQL 尽量抽离出去,又有两个方向框架出现:将 SQL 从代码抽离的 MyBatis;自动生成 SQL 的ORM;
我们本文主要介绍 MyBatis的基本使用,并提供 mybatis-spring 的阅读思路。
内容简介
MyBatis是apache的一个数据库连接框架,前身是IBatis。。。。。。。。巴拉巴拉。。。。
以上就是对此框架的基本介绍。
本文主要介绍一下 MyBatis 的使用方法和 mybatis-spring 的使用方法,同时为下一篇文章介绍 spring 的封住那个逻辑提供切入点。
所属环节
Spring 对第三方框架的封装。
上下环节
上文: Spring 框架基本介绍
下文: 无
MyBatis
引入
我们在文章最开始已经讲过了,MyBatis就是用来将SQL从代码中抽离的框架。我们原来使用 JDBC 的思路是:
- 自己拼装成可执行的SQL
- 丢到
Statement
中执行- 拿到结果拼装成POJO
而MyBatis框架致力于将SQL的拼装过程抽离,使代码更纯净,他的使用思路是:
- 通过XML配置SQL拼装规则及结果映射规则
- 将XML逻辑和具体的一个接口关联上
- 用户可以通过调用这个接口,从而实现对应的数据库操作
我的理解,就是通过配置把 SQL 拼装、结果拼装给抽出去了。
使用示例
首先,配置MyBatis的配置项:
<?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>
<settings>
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
<!--环境配置,连接的数据库,这里使用的是MySQL-->
<environments default="mysql">
<environment id="mysql">
<!--指定事务管理的类型,这里简单使用Java的JDBC的提交和回滚设置-->
<transactionManager type="JDBC"/>
<!--dataSource 指连接源配置,POOLED是JDBC连接对象的数据源连接池的实现-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:/"/>
<property name="username" value=""/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
<mappers>
<!--这是告诉Mybatis区哪找持久化类的映射文件,对于在src下的文件直接写文件名,
如果在某包下,则要写明路径,如:com/mybatistest/config/User.xml-->
<mapper resource="UserMapper.xml"/>
</mappers>
</configuration>
这里指定了数据源的信息和一些具体的Mapper配置文件的地址,还可以指定一些MyBatis的映射策略,比如这里的mapUnderscoreToCamelCase
会自动将 Java 的驼峰命名和数据库表中的下划线连接命名的列名对应。
我们接下来要配置暴露出去的接口:
public interface UserMapper {
Long insertUser(User user);
User getById(Long id);
}
到这里我们基本确定了要提供的两个功能,然后在xml配置文件中配置SQL拼接规则和结果映射:
<?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="mapper.UserMapper">
<select id="getById" parameterType="long" resultType="domain.User">
select * from form where form_id = #{id}
</select>
<insert id="insertUser" parameterType="domain.User"
useGeneratedKeys="true" keyColumn="form_id" keyProperty="formId">
INSERT INTO learn.form (creator, is_deleted, modifier, business_id, form_name, template_id, creation_code)
VALUES (#{formId},#{isDeleted},#{modifier},#{businessId},#{formName},#{templateId},#{creationCode})
</insert>
</mapper>
至此,配置全部结束,运行代码如下:
public static void main(String args[]){
// 加载资源文件及初始化 SqlSessionFactory
String resource = "MyBatis-config.xml";
Reader reader = null;
try {
reader = Resources.getResourceAsReader(resource);
} catch (IOException e) {
e.printStackTrace();
}
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
// 创建SqlSession,执行SQL
SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = new User();
user.setBusinessId(123L);
user.setCreator("lipengcheng1995");
user.setModifier("lipengcheng1995");
user.setTemplateId(456L);
user.setFormName("just a test 1");
Long insertResult = userMapper.insertUser(user);
System.out.println("插入成功,返回的结果为:"+insertResult);
System.out.println("参数为:"+JSON.toJSONString(user));
User queryResult = userMapper.getById(user.getFormId());
System.out.println(JSON.toJSONString(queryResult));
sqlSession.commit();// TODO 这个必须有,否则写不进去
sqlSession.close();// 关闭数据库连接
}
总结
上面是MyBatis的基本使用方法。很容易发现它的优点:
封装的底层函数中省去了拼接、POJO的繁琐操作,整体代码非常清晰
但是我们还是发现:MyBatis在使用时有很多前后对模版式代码。例如读配置文件、生成SqlSessionFactory
、打开SqlSession
、提交修改、关闭SqlSession
等等。
根据我们前面对 Spring 封装 JDBC 的经验,我们很容易想到 Spring 的两个改造点:
- 模版式代码能通过配置托管给Spring框架的尽量托管:例如读配置文件、生成
SqlSessionFactory
、打开SqlSession
、提交修改、关闭SqlSession
等。- 我们既然封装了
Mapper
的接口,最好还是能使它的获取和普通 Spring Bean 一样。
MyBatis-Spring
引入
上面我们介绍了 MyBatis 基本的使用方法。(注意,这里只介绍使用思路,不介绍它的所有特点及可配置项,毕竟本文不是 MyBatis API 查询文档)
接下来介绍 Spring 管理的 MyBatis 使用方法。
使用示例
基本用法
首先,Spring框架,先放Spring的东西:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<!-- 1、声明数据源对象:C3P0连接池 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<!-- 加载jdbc驱动 -->
<property name="driverClass" value="com.mysql.cj.jdbc.Driver"/>
<!-- jdbc连接地址 -->
<property name="jdbcUrl" value="jdbc:mysql://104.248.236.89:3306/learn"/>
<!-- 连接数据库的用户名 -->
<property name="user" value="lpc_test"/>
<!-- 连接数据库的密码 -->
<property name="password" value="12345aA)"/>
<!-- 数据库的初始化连接数 -->
<property name="initialPoolSize" value="3"/>
<!-- 数据库的最大连接数 -->
<property name="maxPoolSize" value="10"/>
<!-- 数据库最多执行的事务 -->
<property name="maxStatements" value="100"/>
<!-- 连接数量不够时每次的增量 -->
<property name="acquireIncrement" value="2"/>
</bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:MyBatis-config.xml"/>
<property name="dataSource" ref="dataSource"/>
</bean>
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface" value="mapper.UserMapper"/>
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
</beans>
这里进行了数据源的配置、sqlSessionFactory
的配置、封装的Mapper
Bean的配置。其中依旧使用了MyBatis配置的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>
<settings>
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
<mappers>
<!--这是告诉Mybatis区哪找持久化类的映射文件,对于在src下的文件直接写文件名,
如果在某包下,则要写明路径,如:com/mybatistest/config/User.xml-->
<mapper resource="UserMapper.xml"/>
</mappers>
</configuration>
这里将数据源抽出去了,严格意义上这里的配置都能抽出去,后面我们再介绍,这里保留是为了说明在这里配置也可以。
其中UserMapper
接口和User
类没有变化,我们使用的函数如下:
public static void main(String args[]){
// 加载Spring
ApplicationContext ac = new ClassPathXmlApplicationContext("spring-mybatis.xml");
UserMapper userMapper = ac.getBean("userMapper",UserMapper.class);
User user = new User();
user.setBusinessId(123L);
user.setCreator("lipengcheng1995");
user.setModifier("lipengcheng1995");
user.setTemplateId(456L);
user.setFormName("just a test 1");
Long insertResult = userMapper.insertUser(user);
System.out.println("插入成功,返回的结果为:"+insertResult);
System.out.println("参数为:"+JSON.toJSONString(user));
User queryResult = userMapper.getById(user.getFormId());
System.out.println(JSON.toJSONString(queryResult));
}
这是基本用法,但是我们很纠结的一个问题是:
我们在单纯使用MyBatis时,在Mapper.xml注册一下,然后就可以正常用
sqlSession
生成可用的Mapper实例了;但是在Spring中,我们为了能像一个普通Bean一样使用Mapper实例,专门注册了一个Bean ,这就有个问题了——如果你有100个Mapper,要注册100个Bean吗???
高级特性
上面的Spring的xml,我们不在专门一个一个的将Mapper注册成Bean,我们在包下扫描,自动注册
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="mapper"/>
</bean>
总结
其实感觉Spring做了两件事:
- 托管了配置读取、
SqlSessionFactory
生成、SqlSession
生命周期 - 提供接口将要用的Mapper实例以普通Bean形式注册
所以我们接下来要做的分析主要也有两个方面:
- 从Spring的xml配置类入手,看看它是怎么调用的MyBatis的API【包括配置读取、
SqlSessionFactory
生成、SqlSession
生命周期、Mapper实例生成】 - 作为扩展和知识积累,看看Spring是如何扫描包动态注册BD的。
网友评论