mybatis源码解读(一)——初始化环境

时间:2024-12-25 12:36:44

  本系列博客将对mybatis的源码进行解读,关于mybatis的使用教程,可以查看我前面写的博客——传送门

  为了便于后面的讲解,我们这里首先构造一个统一环境。也可以参考mybatis官网

1、数据库建表

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`user_id` int(32) NOT NULL COMMENT '用户id',
`user_name` varchar(64) default NULL COMMENT '用户姓名',
`user_age` int(3) default NULL COMMENT '用户年龄',
PRIMARY KEY (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

2、项目的目录结构

  mybatis源码解读(一)——初始化环境

  相关配置的版本如下:

  JDK:1.8

  maven:3.3.9

  mybatis:3.4.3

3、pom文件

 <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <groupId>com.ys</groupId>
<artifactId>MybatisDemo</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.3</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency> <dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.30</version>
</dependency> </dependencies> <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins> <resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build> </project>

  分别在pom文件中添加mybatis包,mysql数据库连接包,Junit测试包。

  注意:由于我使用的编译器是 IDEA,这里必须在pom文件中配置对resource资源目录下的xml 文件的访问,否则,IEDA会读取不到resource目录下的配置文件。

4、资源文件配置

  ①、jdbc.properties

 jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatisTest?useUnicode=true&characterEncoding=utf-8
jdbc.username=root
jdbc.password=root

  ②、mybatsi-configuration.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> <!-- 加载数据库属性文件 -->
<properties resource="jdbc.properties">
</properties>
<!-- 可以配置多个运行环境,但是每个 SqlSessionFactory 实例只能选择一个运行环境 一、development:开发模式 二、work:工作模式 -->
<environments default="development">
<!--id属性必须和上面的default一样 -->
<environment id="development">
<transactionManager type="JDBC" />
<!--dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象源 -->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
</environments> <mappers>
<mapper resource="com/ys/mapper/userMapper.xml"/>
</mappers>
</configuration>

5、pojo 类

  前面我们创建了 user 表,这里创建其实体类。

 package com.ys.po;

 import java.io.Serializable;

 public class User implements Serializable{

     public User() {
super();
}
public User(Integer id, String name, Integer age) {
super();
this.id = id;
this.name = name;
this.age = age;
}
private Integer id;
private String name;
private Integer age;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
} }

  注意:根据阿里巴巴的最新编码规范,实体类中的属性不要写基本数据类型,必须使用包装类型。比如 int 类型的 id,我们应该写成其包装类 Integer 类型。

  原因:比如显示成交总额涨跌情况,即正负 x %, x 为基本数据类型,调用的 RPC 服务,调用不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。

6、mapper 文件

 <?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.ys.po.userMapper">
<resultMap id="BaseResultMap" type="com.ys.po.User">
<id column="user_id" property="id" jdbcType="INTEGER"></id>
<result column="user_name" property="name" jdbcType="VARCHAR" />
<result column="user_age" property="age" jdbcType="INTEGER" />
</resultMap> <sql id="Base_Column_List">
user_id, user_name, user_age
</sql> <!-- 根据id查询 user 表数据 -->
<select id="selectUserById" resultMap="BaseResultMap" parameterType="java.lang.Integer">
select
<include refid="Base_Column_List" />
from user where user_id = #{id,jdbcType=INTEGER}
</select> <!-- 查询 user 表的所有数据 -->
<select id="selectUserAll" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from user
</select> <!-- 向 user 表插入一条数据 -->
<insert id="insertUser" parameterType="com.ys.po.User" >
insert into
user(<include refid="Base_Column_List" />)
value(#{id,jdbcType=INTEGER},#{name,jdbcType=VARCHAR},#{age,jdbcType=INTEGER})
</insert> <!-- 根据 id 更新 user 表的数据 -->
<update id="updateUserById" parameterType="com.ys.po.User">
update user set
user_name=#{name,jdbcType=VARCHAR} where user_id=#{id,jdbcType=INTEGER}
</update> <!-- 根据 id 删除 user 表的数据 -->
<delete id="deleteUserById" parameterType="java.lang.Integer">
delete from
user where user_id=#{id,jdbcType=INTEGER}
</delete>
</mapper>

7、测试类

 package com.ys.test;

 import java.io.InputStream;
import java.util.List; import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test; import com.ys.po.User; public class MybatisTest {
private static final String NAME_SPACE = "com.ys.po.userMapper";
private static SqlSessionFactory sqlSessionFactory; static{
InputStream inputStream = MybatisTest.class.getClassLoader().getResourceAsStream("mybatis-configuration.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}
/**
* 查询单个记录
*/
@Test
public void testSelectOne(){
SqlSession session = sqlSessionFactory.openSession();
User user = session.selectOne(NAME_SPACE+".selectUserById", 1);
System.out.println(user);
session.close(); } /**
* 查询多个记录
*/
@Test
public void testSelectList(){
SqlSession session = sqlSessionFactory.openSession();
List<User> listUser = session.selectList(NAME_SPACE+".selectUserAll");
if(listUser != null){
System.out.println(listUser.size());
}
session.close();
} /**
* 插入一条记录
*/
@Test
public void testInsert(){
SqlSession session = sqlSessionFactory.openSession();
User user = new User(2,"zhangsan",22);
session.insert(NAME_SPACE+".insertUser", user);
session.commit();
session.close();
} /**
* 更新一条记录
*/
@Test
public void testUpdate(){
SqlSession session = sqlSessionFactory.openSession();
User user = new User(2,"lisi",22);
session.update(NAME_SPACE+".updateUserById", user);
session.commit();
session.close();
} /**
* 删除一条记录
*/
@Test
public void testDelete(){
SqlSession session = sqlSessionFactory.openSession();
session.delete(NAME_SPACE+".deleteUserById", 2);
session.commit();
session.close();
} }

8、测试结果

  出现5条绿色的横杆,然后去数据库查看相应的结果。

  mybatis源码解读(一)——初始化环境

9、总结

  这个demo没什么好说的,不懂的看我前面的新手使用教程即可,这是最原始的mybatis开发方式。后面会通过这个例子深入源码分析。