Mybatis使用简单案例

一、Mybatis是什么

Mybatis是当前比较热门的ORM（Object Relational Mapping）框架，很好地解决了对象与关系型数据库中数据的交互工作。在原生Java开发中我们使用JDBC（Java Database Connectivity）与数据库数据进行交互，在此操作过程中开发人员需要频繁进行资源的申请与释放，而Mybatis框架几乎将这些操作进行去除或者简化，极大程度上简化了程序与数据库交互的过程，使得开发人员可以更简单地读取或者向数据库存储数据。类似的ORM框架还有Hibernate框架。

二、使用方式

Mybatis利用Java中对象代理的原理很好地实现了原生JDBC的简化，我们只需要通过特定的方式进行配置即可完成数据库交互任务，常用方式分为：1）XML配置文件；2）Annotation注解形式；

0.环境配置

无论使用哪种方式进行数据库交互，开发前提是在pom.xml文件中添加对应依赖：1）mybatis依赖；2）mysql依赖；

<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
	<artifactId>mybatis-spring-boot-starter</artifactId>
	<version>2.3.0</version>
</dependency>

<dependency>
	<groupId>com.mysql</groupId>
	<artifactId>mysql-connector-j</artifactId>
	<scope>runtime</scope>
</dependency>

1.XML形式

1）每个实体类对应mapper均有一个相应的xml文件mapper.xml，在该xml文件中进行相应数据库操作的配置，以及对象与数据库数据之间的映射关系的配置。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.northsmile.spring_web_demo.mapper.UserMapper">  <!--指定该xml文件对应的mapper接口-->
    <!--type表示为该map所构建的映射关系是哪个类与数据库表记录对应-->
    <resultMap id="userMap" type="com.northsmile.spring_web_demo.model.User">
        <id column="uid" property="uid"/>
        <result column="username" property="username"/>
        <result column="password" property="password"/>
        <result column="avatar_url" property="avatarUrl"/>  <!--此处列名与属性名不一致-->
    </resultMap>
    <!--
        id值为对应mapper文件中对应方法的方法名
        resultMap为该SQL语句对应每条记录所对应的对象，因为列名与属性名存在不一致，所以使用resultMap构建他们的映射关系
    -->
    <select id="selectAll" resultMap="userMap">
        select username,password,avatar_url from users
    </select>
</mapper>

此处也可以不用resultMap构建映射关系，直接使用resultType指定具体类，前提是这两种情况：

• 如果数据库表的列名与实体类的所有属性名一一对应；
• 可在sql语句中使用as为列名起别名，使得别名与对象属性名保持一致；

2）在application.properties文件中指定mybatis对应xml文件的路径；

mybatis.mapper-locations=classpath:/mapper/*.xml

测试结果：

@Mapper
public interface UserMapper {
    // 查询所有用户信息
    List<User> selectAll();

    // 新增用户信息
    void insert(User user);
}

2.Annotation注解形式

无需进行复杂配置，直接在mapper接口文件中对应方法上面添加对应注解并添加sql语句即可，实现效果一致。

@Mapper
public interface UserMapper {
    // 查询所有用户信息
    @Select("select username,password,avatar_url as avatarUrl from users")
    List<User> selectAll();

    // 新增用户信息
    @Insert("insert into users (username,password,avatar_url) values (#{username},#{password},#{avatarUrl})")
    void insert(User user);
}

3.优劣对比

方式	优点	缺点
XML配置形式	可表示特别复杂的SQL语句	配置繁琐
注解形式	配置简单，只需要在对应接口的方法上添加注解即可	无法表示特别复杂的SQL语句

结论：在需要执行的数据库操作较为简单（即SQL语句比较简单）时使用注解形式比较方便，反之如果SQL语句较为复杂且对象与数据库数据之间的映射关系较为复杂时，使用XML配置方式比较方便。

三、案例公共代码

启动类：

@SpringBootApplication
public class SpringWebDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringWebDemoApplication.class, args);
	}


	@Bean
	public CommandLineRunner runner(UserMapper userMapper){
		return new CommandLineRunner() {
			@Override
			public void run(String... args) throws Exception {
				User user=new User();
				user.setUsername("周杰伦");
				user.setPassword("0118");
				user.setAvatarUrl("images/jay.png");
				userMapper.insert(user);

				List<User> userList = userMapper.selectAll();
				for (User u:userList){
					System.out.println(u);
				}
			}
		};
	}
}

实体类：此处使用lombok依赖，自动帮所有属性添加对应的getter、setter方法

import lombok.Data;

/**
 * @author NorthSmile
 * @version 1.0
 * @date 2023/2/5&16:13
 * 实体类
 */
@Data
public class User {
    private Integer uid;
    private String username;
    private String password;
    private String avatarUrl;  // 头像URL
}