MyBatis 是一款标准的 ORM 框架,被广泛的应用于各企业开发中。MyBatis 支持普通的 SQL 查询,存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的 JDBC 代码和参数的手工设置以及对结果集的检索封装。MaBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJO(Plain Old Java Objects,普通的 Java 对象)映射成数据库中的记录。
对象关系映射(Object Relational Mapping,ORM)模式是一种为了解决面向对象与关系数据库存在的互不匹配的现象的技术。简单的说,ORM 是通过使用描述对象和数据库之间映射的元数据,将程序中的对象自动持久化到关系数据库中。
优点:
缺点:
MyBatis 的工作流程如下:
首先在pom文件中添加依赖:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
application.yml 添加相关配置:
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=true
username: root
password: root
mybatis:
type-aliases-package: com.mutest.model
config-location: classpath:mybatis/mybatis-config.xml
mapper-locations: classpath:mappers/*.xml
这些配置都是什么含义呢?
Spring Boot 启动时数据源会自动注入到 SqlSessionFactory 中,使用 SqlSessionFactory 构建 SqlSessionFactory,再自动注入到 Mapper 中,最后我们直接使用 Mapper 即可。
在启动类中添加 @MapperScan 注解,value定义路径,Spring Boot 启动的时候会自动加载该路径下的 Mapper。
@SpringBootApplication
@MapperScan(value = "com.mutest.dao")
public class MutestApplication {
public static void main(String[] args) {
SpringApplication.run(MutestApplication.class, args);
}
}
或者不使用@MapperScan 注解,而是直接在 Mapper 类上面添加注解 @Mapper,出于方便考虑,建议使用前者。
数据库数据:
DROP TABLE IF EXISTS `users`;
CREATE TABLE `users` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键id',
`user_name` varchar(32) DEFAULT NULL COMMENT '用户名',
`password` varchar(32) DEFAULT NULL COMMENT '密码',
`age` int DEFAULT NULL,
`sex` enum('MALE','FEMALE'),
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
创建表对应的实体类:
import lombok.Data;
import com.example.demo.enums.UserSexEnum;
/**
* @author guozhengMu
* @version 1.0
* @date 2019/8/23 17:47
* @description user表对应的实体类
* @modify
*/
@Data
public class User {
private Long id;
private String userName;
private String password;
private int age;
private UserSexEnum sex;
}
sex的枚举类:
public enum UserSexEnum {
MALE, FEMALE
}
实体类的数据类型要和数据库字段一一对应:
在resources目录下新建mybatis文件夹,新建mybatis-config.xml配置文件(路径和文件名和yml配置文件配置的信息保持一致)。该文件主要配置常用的 typeAliases,设置类型别名,为 Java 类型设置一个短的名字。它只和 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>
<typeAliases>
<typeAlias alias="Integer" type="java.lang.Integer"/>
<typeAlias alias="Long" type="java.lang.Long"/>
<typeAlias alias="HashMap" type="java.util.HashMap"/>
<typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap"/>
<typeAlias alias="ArrayList" type="java.util.ArrayList"/>
<typeAlias alias="LinkedList" type="java.util.LinkedList"/>
</typeAliases>
</configuration>
1、指明对应文件的 Mapper 类地址:
<mapper namespace="com.example.demo.dao.UserMapper">
2、配置表结构和类的对应关系:
<resultMap id="UserMap" type="com.example.demo.model.User">
<result column="user_name" property="userName"/>
<result column="sex" property="sex" javaType="com.example.demo.enums.UserSexEnum"/>
</resultMap>
3、编写具体的sql语句
<select id="getUserList" resultMap="UserMap">
SELECT *
FROM test.users
</select>
4、编写 Dao 层的代码
public interface UserMapper {
List<User> getUserList();
}
注意:这里的方法名需要和 XML 配置中的 id 属性一致,不然会找不到方法去对应执行的 SQL。
5、controller层代码
@RestController
@RequestMapping(value = "/test")
public class TestController {
@Autowired
private UserMapper userMapper;
@GetMapping("/mybatis")
public List<User> test() {
return userMapper.getUserList();
}
}
在Idea中,这块的注解经常会报“could not autowire”,这是 Idea 的误报。可以选择降低 Autowired 检测的级别,不要提示就好。 在 File – Settings – Editor – Inspections 选项中使用搜索功能找到 Autowiring for Bean Class,将 Severity 的级别由之前的 error 改成 warning 即可。
启动项目,浏览器输入:http://localhost:8096/test/mybatis,返回结果:
[{"id":1,"userName":"xiaohong","password":"123456","age":30,"sex":"MALE"}]
MyBatis XML 有一个特点是可以复用 XML,比如我们公用的一些 XML 片段可以提取出来,在其他 SQL 中去引用。例如:
<sql id="Base_Column_List" >
id, userName, passWord, user_sex, nick_name
</sql>
<select id="getUserList" resultMap="UserMap" >
SELECT
<include refid="Base_Column_List" />
FROM test.users
</select>
当我们修改数据库数据时,可能对一行数据的部分字段进行修改,但具体修改哪些字段并不能事先确定,这时候就需要用到动态sql语句了,加入if标签进行一个非空判断:
<update id="updateUser" parameterType="com.neo.model.User" >
UPDATE users
SET
<if test="userName != null">userName = #{userName},</if>
<if test="password != null">passWord = #{passWord},</if>
1 = 1
WHERE
id = #{id}
</update>
附上包含增删改查的完整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.example.demo.dao.UserMapper">
<resultMap id="UserMap" type="com.example.demo.model.User">
<result column="user_name" property="userName"/>
<result column="sex" property="sex" javaType="com.example.demo.enums.UserSexEnum"/>
</resultMap>
<sql id="Base_Column_List">
id, userName, password, age, sex
</sql>
<select id="getUserList" resultMap="UserMap">
SELECT
<include refid="Base_Column_List"/>
FROM test.users
</select>
<select id="getUser" parameterType="Long" resultMap="UserMap">
SELECT
<include refid="Base_Column_List"/>
FROM users
WHERE id = #{id}
</select>
<insert id="addUser" parameterType="com.example.demo.model.User">
INSERT INTO
test.users
(user_name, password, age, sex)
VALUES
(#{userName}, #{password}, #{age}, #{userSex})
</insert>
<update id="updateUser" parameterType="com.example.demo.model.User">
UPDATE
test.users
SET
<if test="userName != null">user_name = #{userName},</if>
<if test="passWord != null">password = #{passWord},</if>
age = #{age}
WHERE
id = #{id}
</update>
<delete id="deleteUser" parameterType="Long">
DELETE FROM
test.users
WHERE
id = #{id}
</delete>
</mapper>
与之相对应的dao层代码:
public interface UserMapper {
List<User> getUserList();
User getUser(Long id);
void addUser(User user);
void updateUser(User user);
void deleteUser(Long id);
}