MyBatis 概述
MyBatis 是 apache 的一个开源项目 iBatis,2010 年这个项目由 apache software foundation 迁移到了 google code,并且改名为 MyBatis,2013 年 11 月 迁移到 Github。
MyBatis 是一个实现了数据持久化的开源框架,简单理解就是对 JDBC 进行封装。
MyBatis 的优点
- 与 JDBC 相比,减少了 50% 以上的代码量。
- MyBatis 是最简单的持久化框架,小巧而且简单易学。
- MyBatis 相当灵活,不会对应用程序或者数据库的现有设计强加任何影响,SQL 写在 XML 中,从程序代码中彻底分离,降低耦合度,便于统一管理和优化,并可重用。
- 提供 XML 标签,支持编写动态 SQL 语句。
- 提供映射标签,支持对象与数据库的 ORM 字段关系映射
MyBatis 的缺点
- SQL 语句的编写工作量较大,尤其是字段多、关联表多时,更是如此,对开发人员编写 SQL 语句的功底有一定要求。
- SQL 语句依赖于数据库,导致数据库移植性差,不能随意更换数据库。
MyBatis 核心接口和类
MyBatis 的开发方式
- 使用原生接口
- Mapper 代理实现自定义接口
MyBatis 如何使用
1、新建 maven 工程
2、导入依赖:mybatis、mysql-connector-java。设置resources
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.6</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
</build>
3、在数据库中创建表
USE mybatis;
CREATE TABLE t_account(
id int primary key auto_increment,
username varchar(11),
password varchar(11),
age int
)
4、新建数据表对应的实体类 Account
package com.xiaoxin.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Account {
private long id;
private String username;
private String password;
private int age;
}
5、创建 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>
<!-- 配置MyBatis运行环境 -->
<environments default="development">
<environment id="development">
<!-- 配置JDBC事务管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- POOLED配置JDBC数据源连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
6、使用原生接口的方式
①MyBatis 框架需要开发者自定义 SQL 语句,写在 Mapper.xml 文件中,实际开发中,会为每个实体类创建对应的 Mapper.xml,定义管理该对象数据的 SQL。
<?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.xiaoxin.mapper.AccountMapper">
<insert id="save" parameterType="com.xiaoxin.entity.Account">
insert into t_account(username, password, age) values(#{username}, #{password}, #{age})
</insert>
</mapper>
- namespace 通常设置为文件所在包+文件名的形式(推荐写法,并不是必须的)
- insert 标签表示执行添加操作
- select 标签表示执行查询操作
- update 标签表示执行更新操作
- delete 表示执行删除操作
- id 是实际调用 mybatis 方法时需要用到的参数
- parameterType 是调用对应方法时参数的数据类型
②在全局配置文件 config.xml 中注册 Account
<?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>
<!-- 配置MyBatis运行环境 -->
<environments default="development">
<environment id="development">
<!-- 配置JDBC事务管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- POOLED配置JDBC数据源连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 注册AccountMapper.xml -->
<mappers>
<mapper resource="com/xiaoxin/mapper/AccountMapper.xml"/>
</mappers>
</configuration>
③调用 mybatis 的原生接口来执行添加操作
package com.xiaoxin.test;
import com.xiaoxin.entity.Account;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
public class Test {
public static void main(String[] args) {
//加载MyBatis配置文件
InputStream inputStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);
SqlSession sqlSession = factory.openSession();
String statement = "com.xiaoxin.mapper.AccountMapper.save";
Account account = new Account(0L, "陈鑫", "123456", 24);
sqlSession.insert(statement, account);
sqlSession.commit();
}
}
7、使用 mapper 代理的方式【推荐】
① 自定义接口,定义相关的业务方法
package com.xiaoxin.repository;
import com.xiaoxin.entity.Account;
import java.util.List;
public interface AccountRepository {
public int save(Account account);
public int update(Account account);
public int deleteById(long id);
public List<Account> findAll();
public Account findById();
}
② 编写接口相对应的 Mapper.xml,定义接口方法对应的 SQL 语句。
Mapper.xml 中的 statement 标签可根据 SQL 执行的业务选择 insert、delete、update、select。
MyBatis 框架会根据规则自动创建接口实现类的代理对象。
规则:
- Mapper.xml 中 namespace 为接口的全类名。
- Mapper.xml 中 statement 的 id 为接口中对应的方法名。
- Mapper.xml 中 statement 的 parameterType 和接口中对应方法的参数类型一致。
- Mapper.xml 中 statement 的 resultType 和接口中对应方法的返回值类型一致。
<?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.xiaoxin.repository.AccountRepository">
<insert id="save" parameterType="com.xiaoxin.entity.Account">
insert into t_account(username, password, age) values(#{username}, #{password}, #{age})
</insert>
<update id="update" parameterType="com.xiaoxin.entity.Account">
update t_account set username=#{username}, password=#{password}, age=#{age} where id=#{id}
</update>
<delete id="deleteById" parameterType="long">
delete from t_account where id=#{id}
</delete>
<select id="findAll" resultType="com.xiaoxin.entity.Account">
select * from t_account
</select>
<select id="findById" resultType="com.xiaoxin.entity.Account" parameterType="long">
select * from t_account where id=#{id}
</select>
</mapper>
③ 在 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="mydev">
<environment id="mydev">
<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&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/xiaoxin/mapper/AccountMapper.xml"/>
<mapper resource="com/xiaoxin/repository/AccountRepository.xml"/>
</mappers>
</configuration>
④ 编写测试方法
package com.xiaoxin.test;
import com.xiaoxin.entity.Account;
import com.xiaoxin.repository.AccountRepository;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.util.List;
import java.io.InputStream;
import java.util.ListIterator;
public class Test2 {
public static void main(String[] args) {
InputStream inputStream = Test2.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);
SqlSession sqlSession = factory.openSession();
//获取实现接口的代理对象
AccountRepository accountRepository = sqlSession.getMapper(AccountRepository.class);
// accountRepository.save(new Account(0L, "陈小小鑫", "123433", 15));
Account accountId1 = accountRepository.findById(1);
accountId1.setPassword("456789");
accountRepository.update(accountId1);
List<Account> list = accountRepository.findAll();
for(Account account : list) {
System.out.println(account);
}
sqlSession.commit();
sqlSession.close();
}
}