Mybatis
1、第一个mybatis程序
1.1、搭建环境
第一步:创建一个maven项目
第二步:导入mybatis所需要的依赖
<dependencies>
<dependency>
<!--mysql依赖-->
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--mybatis依赖-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!--junit依赖-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
</dependency>
</dependencies>
1.2、创建一个模块
配置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>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&useSSL=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
编写mybatis工具类
package com.wang.utils;
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 java.io.IOException;
import java.io.InputStream;
//mybatis工具类
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static{
try {
//使用mybatis第一步:获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = null;
inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。
// SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
// 你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
1.3、编写代码
-
实体类
package com.wang.entity; public class User { private int id; private String name; private int age; private String pwd; public User() { } public User(int id, String name, int age, String pwd) { this.id = id; this.name = name; this.age = age; this.pwd = pwd; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public String getPwd() { return pwd; } public void setPwd(String pwd) { this.pwd = pwd; } @Override public String toString() { return "User{" + "id=" + id + ", name='" + name + '\'' + ", age=" + age + ", pwd='" + pwd + '\'' + '}'; } }
-
mapper接口
package com.wang.mapper; import com.wang.entity.User; import java.util.List; public interface UserMapper { List<User> getUserList(); }
-
接口实现类,用impl转换为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.wang.mapper.UserMapper"> <select id="getUserList" resultType="com.wang.entity.User"> select * from mybatis.user </select> </mapper>
1.4、测试
注意一:org.apache.ibatis.binding.BindingException: Type interface com.wang.mapper.UserMapper is not known to the MapperRegistry.
出现该异常的原因是未把mapper配置在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">
<!--mybatis核心配置类-->
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!--每一个mapper都需要在mybatis核心配置类中注册-->
<mappers>
<mapper resource="com/wang/mapper/UserMapper.xml"/>
</mappers>
</configuration>
注意二:maven导出资源问题 java.lang.ExceptionInInitializerError
解决方法:在pxm.xml文件中加入maven文件过滤
<!--在build中配置resources,来防止资源导出失败的问题-->
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
测试代码
package com.wang.mapper;
import com.wang.entity.User;
import com.wang.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
public class UserMapperTest {
@Test
public void test(){
//第一步:获得sqlSession对象
SqlSession session = MybatisUtils.getSqlSession();
//第二步:执行sql
//方式一:getMapper 推荐使用
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
// //方式二:不推荐使用
// List<User> userList = session.selectList("com.wang.mapper.UserMapper.getUserList");
for (User user : userList) {
System.out.println(user);
}
//第三步:关闭sqlSession
session.close();
}
}
2、CRUD
2.1、namespace
mapper的namespace属性必须与mapper/dao接口中的包名一致
<mapper namespace="com.wang.mapper.UserMapper">
<!--查询所有用户-->
<select id="getUserList" resultType="com.wang.entity.User">
select * from mybatis.user
</select>
<!--插入用户-->
<insert id="insertUser" parameterType="com.wang.entity.User">
insert into mybatis.user(id, name, age, pwd) values (#{id}, #{name}, #{age}, #{pwd})
</insert>
</mapper>
2.2、insert
-
编写接口
//插入user int insertUser(User user);
-
编写对应mapper中的sql语句
<!--插入用户--> <insert id="insertUser" parameterType="com.wang.entity.User"> insert into mybatis.user(id, name, age, pwd) values (#{id}, #{name}, #{age}, #{pwd}) </insert>
-
测试
@Test public void insertTest(){ //第一步:获得sqlSession对象 SqlSession sqlSession = MybatisUtils.getSqlSession(); //第二步:执行sql getMapper UserMapper mapper = sqlSession.getMapper(UserMapper.class); int i = mapper.insertUser(new User(4, "黎明", 20, "123123")); if (i > 0){ System.out.println("插入成功"); } //第三步:提交事务 sqlSession.commit(); //第四步:关闭sqlSession sqlSession.close(); }
2.3、update
-
编写接口
//修改user int updateUser(User user);
-
编写对应mapper的sql语句
<!--修改用户--> <update id="updateUser" parameterType="com.wang.entity.User"> update mybatis.user set `name` = #{name}, `age` = #{age}, `pwd` = #{pwd} where `id` = #{id} </update>
-
测试
@Test public void updateTest(){ //第一步:获得sqlSession对象 SqlSession sqlSession = MybatisUtils.getSqlSession(); //第二步:执行sql getMapper UserMapper mapper = sqlSession.getMapper(UserMapper.class); mapper.updateUser(new User(4, "李连杰",19,"147258369")); //第三步:提交事务 sqlSession.commit(); //第四步:关闭sqlSession sqlSession.close(); }
2.4、select
-
编写接口
//根据id查询user User getUserById(int id);
-
编写对应mapper的sql语句
<!--查询用户--> <select id="getUserById" parameterType="int" resultType="com.wang.entity.User"> select * from mybatis.user where `id` = #{id} </select>
-
测试
@Test public void selectTest(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = mapper.getUserById(2); System.out.println(user); //查询用户数据不需要提交事务 sqlSession.close(); }
2.5、delete
-
编写接口
//根据id删除user int deleteUserById(int id);
-
编写对应mapper的sql语句
<!--删除用户--> <delete id="deleteUserById" parameterType="int"> delete from mybatis.user where `id` = #{id} </delete>
-
测试
@Test public void deleteTest(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); int i = mapper.deleteUserById(1); if (i > 0){ System.out.println("删除成功"); } //提交事务 sqlSession.commit(); sqlSession.close(); }
2.6、注意点
- 增加、删除、修改数据时要使用==commit()==方法提交事务
- mapper.xml中增加的select、insert、update、delete等方法必须有对应的方法实现,要不会报==java.lang.ExceptionInInitializerError==
- 查询数据不需要使用commit()方法
mapper
的id属性必须要与mapper接口中的方法名相同- select 元素的属性:
- ==id:==在命名空间中唯一的标识符,可以被用来引用这条语句
- ==parameterType:==将会传入这条语句的参数的类全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
- ==resultType:==期望从这条语句中返回结果的类全限定名或别名。 注意,如果返回的是集合,那应该设置为集合包含的类型,而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。
- Insert, Update, Delete 元素的属性:
- ==id:==在命名空间中唯一的标识符,可以被用来引用这条语句
- ==parameterType:==将会传入这条语句的参数的类全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
- keyProperty:(仅适用于 insert 和 update)指定能够唯一识别对象的属性,MyBatis 会使用 getGeneratedKeys 的返回值或 insert 语句的 selectKey 子元素设置它的值,默认值:未设置(
unset
)。如果生成列不止一个,可以用逗号分隔多个属性名称。 - keyColumn:(仅适用于 insert 和 update)设置生成键值在表中的列名,在某些数据库(像 PostgreSQL)中,当主键列不是表中的第一列的时候,是必须设置的。如果生成列不止一个,可以用逗号分隔多个属性名称。
3、核心配置详解
即对mybatis-config.xml文件的详解
配置的顺序必须遵循:先后顺序,可以没有该配置但有的话必须放到相应的位置
properties > settings > typeAliases > typeHandlers > objectFactory > objectWrapperFactory > reflectorFactory > plugins > environments > databaseIdProvider > mappers
3.1、属性(properties)
属性可以在外部进行配置,并可以进行动态替换。既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。
<!--属性配置-->
<properties resource="db.properties"/>
如果一个属性在不只一个地方进行了配置,MyBatis 将按照下面的顺序来加载:
- 首先读取在 properties 元素体内指定的属性。
- 然后根据 properties 元素中的 resource 属性读取类路径下属性文件,或根据 url 属性指定的路径读取属性文件,并覆盖之前读取过的同名属性。
- 最后读取作为方法参数传递的属性,并覆盖之前读取过的同名属性。
因此,通过方法参数传递的属性具有最高优先级,resource/url 属性中指定的配置文件次之,最低优先级的则是 properties 元素中指定的属性。
3.2、设置(settings)
是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。
3.3、环境配置(environments)
MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中, 现实情况下有多种理由需要这么做。
不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
如果你想连接两个数据库,就需要创建两个 SqlSessionFactory 实例,每个数据库对应一个。
<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>
注意一些关键点:
- 默认使用的环境 ID(比如:default=“development”)。
- 每个 environment 元素定义的环境 ID(比如:id=“development”)。
- 事务管理器的配置(比如:type=“JDBC”)。
- 数据源的配置(比如:type=“POOLED”)。
事务管理器(transactionManager)
MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]")默认为JDBC
数据源(dataSource)
三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]")默认为POOLED
3.4、类型别名(typeAliases)
类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
两种实现方式:
-
方法一:使用typeAlias标签将实体类命名为自定义的名称(实体类较少时建议使用)
<typeAliases> <typeAlias type="com.wang.entity.User" alias="User"/> </typeAliases>
-
方法二:指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean。自动扫描包,实体名字自动映射成实体类类名首字母小写(实体类较多时建议使用)
<typeAliases> <package name="com.wang"/> </typeAliases>
但该方法不能自定义名称,如果需要自定义,则需要在实体类增加@Alias(“自定义名称”)实现
3.5、映射器(mappers)
MapperRegistry:注册绑定我们写的Mapper文件
-
方法一:使用相对于类路径的资源引用(推荐使用)
<!-- 使用相对于类路径的资源引用 --> <mapper resource="com/wang/mapper/UserMapper.xml"/>
-
方法二:使用映射器接口实现类的完全限定类名
<!-- 使用映射器接口实现类的完全限定类名 --> <mapper class="com.wang.mapper.UserMapper"/>
-
方法三:将包内的映射器接口实现全部注册为映射器
<!--将包内的映射器接口实现全部注册为映射器--> <package name="com.wang"/>
针对方法二和方法三必须注意两点:
- 接口和mapper配置文件名称必须相同
- 接口和mapper配置文件必须在同一个包下
3.6、作用域(Scope)和生命周期
生命周期和作用域错误的使用会导致严重的并发问题
-
SqlSessionFactoryBuilder
- 一旦创建了 SqlSessionFactory,就不再需要它了。
- SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)
-
SqlSessionFactory
- SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
- SqlSessionFactory 的最佳作用域是应用作用域。
- 最简单的就是使用单例模式或者静态单例模式。
- 可以简单想象为:连接池
-
SqlSession
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
- 每次收到 HTTP 请求,就可以打开一个 SqlSession,返回一个响应后,就关闭它。即用完就关闭。
- 连接到连接池的一个请求。