Mybatis源码解析(一)

程序员文章站 2022-04-21 23:47:47

...

Mybatis

what is mybatis ?
MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

how to use mybatis ?

1.加入依赖
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

2.从 XML 中构建 SqlSessionFactory
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

3.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 default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

4.从 SqlSessionFactory 中获取 SqlSession

SqlSession session = sqlSessionFactory.openSession();
try {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
} finally {
  session.close();
}

5.POJO和mapper.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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

6.调用这个对应 Mapper 接口的方法
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

mybatis核心类的作用域（Scope）和生命周期

SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。
因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。
你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，
但是最好还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。

SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由对它进行清除或重建。
使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，
多次重建 SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。
因此 SqlSessionFactory 的最佳作用域是应用作用域。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，
因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。
也绝不能将 SqlSession 实例的引用放在任何类型的管理作用域中，比如 Servlet 架构中的 HttpSession。
如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。
换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。
这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。
下面的示例就是一个确保 SqlSession 关闭的标准模式：

SqlSession session = sqlSessionFactory.openSession();
try {
  // do work
} finally {
  session.close();
}


映射器实例（Mapper Instances）
映射器是一个你创建来绑定你映射的语句的接口。映射器接口的实例是从 SqlSession 中获得的。
因此从技术层面讲，任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。
尽管如此，映射器实例的最佳作用域是方法作用域。也就是说，映射器实例应该在调用它们的方法中被请求，
用过之后即可废弃。并不需要显式地关闭映射器实例，尽管在整个请求作用域（request scope）保持映射器实例也不会有什么问题，
但是很快你会发现，像 SqlSession 一样，在这个作用域上管理太多的资源的话会难于控制。所以要保持简单，
最好把映射器放在方法作用域（method scope）内。下面的示例就展示了这个实践：

SqlSession session = sqlSessionFactory.openSession();
try {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // do work
} finally {
  session.close();
}

简单测试一下

<dependencies>
  	<dependency>
  		<groupId>org.mybatis</groupId>
  		<artifactId>mybatis</artifactId>
  		<version>3.5.0</version>
	</dependency>
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
		<version>5.1.45</version>
	</dependency>
  </dependencies>


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

  <!-- 引入properties配置文件 -->
  <properties resource="db/db.properties" />
  
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="mapper/UserMapper.xml"/>
  </mappers>
</configuration>

//pojo
@Data
public class User {

	private String id;
	private String name;
	private Integer age;
	private Double money;

}
//dao
@Mapper
public interface UserMapper {
	User selectUserById(String id);

	void insertOne(User user);
}
//mapper.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="com.haha.mapper.UserMapper">
  <select id="selectUserById" resultType="com.haha.pojo.User">
    select * from User where id = #{id}
  </select>
  
  <insert id="insertOne" parameterType="com.haha.pojo.User">
  insert into User ( id, name, age, money ) 
  VALUES ( #{id}, #{name}, #{age}, #{money}  )
  </insert>
</mapper>

测试

public static void main(String[] args) throws Exception {
		String resource = "mybatis.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		log.info("sqlSessionFactory--{}", sqlSessionFactory);

		SqlSession session = sqlSessionFactory.openSession();
		UserMapper mapper = session.getMapper(UserMapper.class);
		User user = mapper.selectUserById("1");
		log.info("user--{}", user);

		user = new User();
		user.setId("1");
		user.setName("haha");
		user.setAge(26);
		user.setMoney(9999.99);
		mapper.insertOne(user);

		user = mapper.selectUserById("1");
		log.info("user--{}", user);
	}

21:10:05.387 [main] DEBUG org.apache.ibatis.logging.LogFactory - Logging initialized using 'class org.apache.ibatis.logging.slf4j.Slf4jImpl' adapter.
21:10:05.412 [main] DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
21:10:05.412 [main] DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
21:10:05.412 [main] DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
21:10:05.412 [main] DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
21:10:05.478 [main] INFO com.haha.test.Test1 - sqlSessionFacto[email protected]6500df86
21:10:05.499 [main] DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction - Opening JDBC Connection
21:10:06.199 [main] DEBUG org.apache.ibatis.datasource.pooled.PooledDataSource - Created connection 699780352.
21:10:06.199 [main] DEBUG org.apache.ibatis.transaction.jdbc.JdbcTransaction - Setting autocommit to false on JDBC Connection [[email protected]]
21:10:06.253 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - ==>  Preparing: select * from User where id = ? 
21:10:06.287 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - ==> Parameters: 1(String)
21:10:06.349 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - <==      Total: 0
21:10:06.349 [main] INFO com.haha.test.Test1 - user--null
21:10:06.350 [main] DEBUG com.haha.mapper.UserMapper.insertOne - ==>  Preparing: insert into User ( id, name, age, money ) VALUES ( ?, ?, ?, ? ) 
21:10:06.351 [main] DEBUG com.haha.mapper.UserMapper.insertOne - ==> Parameters: 1(String), haha(String), 26(Integer), 9999.99(Double)
21:10:06.452 [main] DEBUG com.haha.mapper.UserMapper.insertOne - <==    Updates: 1
21:10:06.453 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - ==>  Preparing: select * from User where id = ? 
21:10:06.453 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - ==> Parameters: 1(String)
21:10:06.507 [main] DEBUG com.haha.mapper.UserMapper.selectUserById - <==      Total: 1
21:10:06.507 [main] INFO com.haha.test.Test1 - user--User(id=1, name=haha, age=26, money=9999.99)

查询数据库，发现并没有真正添加
发现
SqlSession session = sqlSessionFactory.openSession();
…
@Override
public SqlSession openSession() {
return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}
false ---- 标识是否自动commit

mybatis是默认不自动提交事务的，需要手动指定

SqlSession session = sqlSessionFactory.openSession(true);

发现OK，数据库有记录了

源码—码云链接

上一篇： mybatis源码解析（一）

下一篇： redis源码分析之事务Transaction（下）

Mybatis源码解析(一)

Mybatis

简单测试一下

深入理解MyBatis中的一级缓存与二级缓存

mybatis实现一对一关联映射实例代码

SpringMVC源码解析之消息转换器HttpMessageConverter

解析Android开发优化之:对界面UI的优化详解(一)

Spring Boot整合mybatis并自动生成mapper和实体实例解析

Mybatis 插入一条或批量插入返回带有自增长主键记录的实例

怎么看一个网站源码是否值得使用？

Java实现一个简单的定时器代码解析

解析关于SQL语句Count的一点细节

Laravel源码解析之路由的使用和示例详解

Mybatis源码解析(一)

Mybatis

简单测试一下

深入理解MyBatis中的一级缓存与二级缓存

mybatis实现一对一关联映射实例代码

SpringMVC源码解析之消息转换器HttpMessageConverter

解析Android开发优化之:对界面UI的优化详解(一)

Spring Boot整合mybatis并自动生成mapper和实体实例解析

Mybatis 插入一条或批量插入 返回带有自增长主键记录的实例

怎么看一个网站源码是否值得使用？

Java实现一个简单的定时器代码解析

解析关于SQL语句Count的一点细节

Laravel源码解析之路由的使用和示例详解

Mybatis 插入一条或批量插入返回带有自增长主键记录的实例