Mybatis简介
- MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。
- iBATIS一词来源于“internet”和“abatis”的组合,是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects(DAOs)
Mybatis使用
导入依赖
- 创建Maven工程
- 导入相关依赖
<!--导入依赖-->
<dependencies>
<!--MySql驱动-->
<dependency>
<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.2</version>
</dependency>
<!--测试-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
</dependency>
</dependencies>
核心配置文件
- 在
resources
目录下创建mybatis-config.xml
配置文件进行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?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
</configuration>
- 也可以再创建一个
db.properties
,再在mybatis-config.xml
中引入值
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
username=root
password=root
<?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="db.properties"/>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!--引入db.properties的值-->
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
</configuration>
pojo
- 创建与数据库相对应的实体类
测试
- 根据官方问档的操作,提取出了一个工具类,来获得
SqlSession
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
// 获取sqlSessionFactory
try {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
// 获取SqlSession对象
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
- 编写操作数据库的mapper接口和对应的xml文件
public interface UserMapper {
// 获取所有用户
List<User> getUsers();
}
<?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.diana.dao.UserMapper">
<select id="getUsers" resultType="com.diana.pojo.User">
select * from user
</select>
</mapper>
- 将
mapper.xml
文件加入到核心配置文件mybatis-config.xml
中去
<mappers>
<mapper resource="com/diana/dao/UserMapper.xml"/>
</mappers>
- 编写测试的代码
@Test
publicvoid test(){
// 获取SqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
// 获取mapper接口
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List<User> users = userMapper.getUsers();
// 遍历输出
for (User user : users) {
System.out.println(user);
}
// 记得关闭
sqlSession.close();
}
遇到的问题
找不到mybatils-config.xml:java.io.IOException: Could not find resource mybatis-config.xml
原因是编译下的classes文件下找不到 mybatis-config.xml
解决的办法是在pom.xml
文件中加入
<!--在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>
=============================================================
- 注意在增删改操作的时候要提交事务
sqlSession.commit();
- sql语句传参时除了将对象传递过去,还可以使用
map
进行传参。使用map
传参可以不用保持与对象属性名的一致,也可用在数据库字段过多的情况下使用或者传特殊的参数,比如
// 测试分页
List<User> getUserLimit(Map<String, Integer> map);
<select id="getUserLimit" parameterType="map" resultMap="user">
select * from user limit #{startIndex}, #{pageSize}
</select>
// 分页测试
@Test
public void test1(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 使用map传参
HashMap<String, Integer> map = new HashMap<>();
map.put("startIndex", 0);
map.put("pageSize", 2);
List<User> users = mapper.getUserLimit(map);
for (User user : users) {
System.out.println(user);
}
sqlSession.close();
}
- 模糊查询
// 模糊查询
List<User> getUsersLike(String value);
<select id="getUsersLike" parameterType="String" resultType="com.diana.pojo.User">
select * from user where username like #{value}
</select>
@Test
publicvoid test1(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 模糊查询
List<User> usersLike = userMapper.getUsersLike("%李%");
for (User user : usersLike) {
System.out.println(user);
}
sqlSession.close();
}
Mybatis配置文件
类型别名
- 类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。例如:
<typeAliases>
<typeAlias alias="User" type="com.diana.User"/>
</typeAliases>
- 自动扫描该包下的类,且用类的首字母小写为别名,比如:
<typeAliases>
<package name="com.diana.pojo"/>
</typeAliases>
- 如果扫描包后想自定义别名可使用注解
@Alias
@Alias("userOne")
public class User{
...
}
日志工厂
- 在settings标签中配置
<settings>
<!--日志工厂-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
- logImpl 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING
- 使用LOG4J 时,先导入依赖,再配置
log4j.properties
ResultMap结果集映射
- 当数据库的字段与实体类的属性名不一致的时候可以使用
ResultMap
来指定两者的关系。比如:数据库的字段为password
,实体类的属性名对应为pwd
<mapper namespace="com.diana.dao.UserMapper">
<!--结果集映射 column为数据库字段 property为实体类属性-->
<resultMap id="UserMapper" type="user">
<result column="password" property="pwd"/>
</resultMap>
<!--使用resultMap-->
<select id="getUserById" resultMap="UserMapper">
select * from user where id=#{id}
</select>
</mapper>
- 复杂字段还可已使用
association
表示对象,collection
表示集合