一.概述
什么是MyBatis
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。iBATIS一词来源于“internet”和“abatis”的 组合
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。
MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。
MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
二.MyBatis的搭建过程
1.准备一个数据库
CREATE DATABASE `mybatis`;
USE `mybatis`;
CREATE TABLE `user`(
`id` INT(20) NOT NULL,
`name` VARCHAR(30) DEFAULT NULL,
`pwd` VARCHAR(30) DEFAULT NULL,
PRIMARY KEY(`id`)
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `user`(`id`,`name`,`pwd`)
VALUES (1,'刘恒','123456'),(2,'长鸣轩','123456'),(3,'加流域','123456');
2.导包,核心配置中加入MyBatis的依赖
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<dependency> //注释框架,简化代码量
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.8</version>
</dependency>
3.配置文件编写 mybatis-config.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="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
4.编写一个工具类操作数据库
package 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;
public class MyBatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
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 getSession(){
return sqlSessionFactory.openSession();
}
}
5. 配置了一个实体类,引入了Lombok
package pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private int id;
private String name;
private String pwd;
}
6.持久层的操作接口
package mapper;
import pojo.User;
import java.util.List;
// 操作用户的接口类
public interface UserMapper {
List<User> getUserList();
}
7.编写SQL,使用配置文件 UserMapper.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">
<!-- 原来我们都是编写具体的执行sql -->
<mapper namespace="mapper.UserMapper">
<select id="getUserList" resultType="pojo.User">
select * from user;
</select>
</mapper>
8.将UserMapper.xml配置文件注册到Mybatis的配置文件中
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
9.编写测试类进行运行
import mapper.UserMapper;
import pojo.User;
import utils.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import java.util.List;
public class Test {
public static void main(String[] args) {
// 如何获取接口
// 1、 获取SqlSession, 执行sql使用的
SqlSession session = MyBatisUtils.getSession();
// 2、通过 session.getMapper(Class ) 获得接口
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
for (User user : userList) {
System.out.println(user);
}
}
}
三.CURD增删改查
1.查询select
(1)通过id 查询用户 User selectById(int id);
- 在接口中编写:
User selectById(int id);
- 编写对应的mapper中的sql语句
<select id="selectById" resultMap="bojo.User" >
select *from user where id=#{id};</select>
- 测试
@Test
public void getUserById() {
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById(1);
System.out.println(user);
sqlSession.close();
}
(2)通过用户名和密码查询用户
- 在接口中编写:
User selectByUsernamePwd(@Param("name") String name, @Param("pwd") String pwd);
- 编写对应的mapper中的sql语句
<select id="selectByUsernamePwd" resultType="pojo.User">
select *from user where name =#{name} and pwd =#{pwd}
</select>
- 测试
import mapper.UserMapper;
import org.apache.log4j.Logger;
import pojo.User;
import utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
class Test {
public static void main(String[] args) {
Logger logger = Logger.getLogger(Test.class);
SqlSession session = MybatisUtils.getSession();
UserMapper mapper = session.getMapper(UserMapper.class);
User user1 = mapper.selectByUsernamePwd("刘恒","123456");
System.out.println(user1);
}
}
2.Insert增加
增加一个新用户
- 在接口中编写:
int addUser(User user);
- 编写对应的mapper中的sql语句
<insert id="addUser" parameterType="pojo.User">
insert into mybatis.user (id, name, pwd) values (#{id},#{name},#{pwd});
</insert>
- 编写测试类
3.修改update
修改用户信息
- 在接口中编写:
int updateUser(User user);
- 编写对应的mapper中的sql语句
<update id="updateUser" parameterType="pojo.User">
update mybatis.user set name=#{name},pwd=#{pwd} where id = #{id} ;
</update>
- 测试
4.删除Delete
删除一个用户
- 在接口中编写:
int deleteUserByID(int id)
- 编写对应的mapper中的sql语句
<delete id="deleteUserByID" parameterType="int">
delete from mybatis.user where id = #{id};
</delete>
- 测试
注意:
增删改需要提交事务!
增删改,标签一定要对应,参数类型必须要写
增删改不用写返回值,查询,必须写返回值,集合、泛型中的内容(具体的对象)
四.字段名与属性名不一致,正确输出的解决办法
1.用as,将属性名改为正确的字段名
<select id="selectById" resultType="pojo.User">
select id,name,pwd as password from user where id=#{id};
</select>
2.resultMap结果集映射
<!--结果集映射-->
<resultMap id="UserMap" type="pojo.User>
<!--column数据库中的字段,property实体类中的属性-->
<result column="id" property="id"/>
<result column="name" property="name"/>
<result column="pwd" property="password"/>
</resultMap>
<select id="getUserById" resultMap="UserMap">
select * from mybatis.user where id = #{id}
</select>
注意:
当属性名为主键时,result可以用id替换
column数据库中的字段,property实体类中的属性
五.配置解析
1.配置文件
注意:配置文档中的顺序符合上图
2.环境配置(environments)
<environments default="development">
<!--environments标签元素可以有多套配置-->
<environment id="development">
<!--transactionManager事务管理器-->
<transactionManager type="JDBC"/>
<!--dataSource数据源配置-->
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
3.属性(properties)
我们可以通过properties属性来实现引用配置文件 这些属性都是可外部配置且可动态替换的,既可以在典型的 Java 属性文件中配置,亦可通过 properties 元素的子元素来传递。
- 编写一个配置文件 db.properties
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis? useSSL=true&useUnicode=true&characterEncoding=utf8
username=root
password=123456
- 配置db.properties 让配置文件读取
<properties resource="db.properties" ></properties>
- 在核心配置中environment映入
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
4.typeAliases
包的别名配置
<typeAliases>
<package name="pojo"></package> //指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean
<!--<typeAlias type="pojo.User" alias="user"></typeAlias>为 Java 类型设置一个短的名字。-->
</typeAliases>
5.映射器(mappers)
MapperRegistry:注册绑定我们的Mapper文件;
(1)方式一
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册!-->
<mappers>
<mapper resource="Mapper/UserMapper.xml"/>//资源对应的路径
</mappers>
(2)方式二:使用class文件绑定注册
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册!-->
<mappers>
<mapper class="Mapper.UserMapper"/>//接口对应的路径
</mappers>
注意:前提是UserMapper接口和UserMapper.xml在同一个包下
(3)方式三:扫描包
<mappers>
<package name="Mapper"/>
</mappers>