MyBatis 中使用XML映射文件
什么是XML映射
使用注解的映射SQL的问题:
- 长SQL需要折行,不方便维护
- 动态SQL查询拼接复杂
- 源代码中的SQL,不方便与DBA协作
MyBatis建议使用XML文件映射SQL才能最大化发挥MySQL的功能
- 统一管理SQL, 方便协作
- 不需要 “ ” + 等语法,方便“长”SQL
- 方便处理动态SQL连接
参考连接: https://mybatis.org/mybatis-3/zh/sqlmap-xml.html
HelloWorld
开发步骤:
- 创建项目(不要使用Spring Boot 3!), 选择依赖:
-
配置application.properties, 设置数据库连接
spring.datasource.url=jdbc:mysql://localhost:3306/bootdb?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true spring.datasource.username=root spring.datasource.password=root # 设定 mapper xml 文件的位置, classpath 就是指 resources 位置 mybatis.mapper-locations=classpath:mappers/*.xml # 查看MyBatis执行的SQL logging.level.cn.tedu.boot2209.mapper=debug
-
创建文件夹 /resources/mappers
-
添加一个XML文件,文件从doc.canglaoshi.org 下载
-
改名为 DemoMapper.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"> <!-- namespace 的值设定为被映射的包名.类名 --> <mapper namespace="cn.tedu.boot2209.mapper.DemoMapper"> <!-- select 元素用于映射查询语句到方法, id值必须和mapper接口中的方法名一致! 需要设定返回值类型resultType,类型与方法返回值类型一致 select 元素中定义SQL,SQL查询结果将自动映射到方法返回值, 不要使用分号结尾!!--> <select id="hello" resultType="java.lang.String"> SELECT 'Hello World!' </select> </mapper>
-
-
创建mapper.DemoMapper接口:
- 接口名和 xml文件的namespace 一致
- 方法名和xml文件的select元素的id一致
- 方法返回值类型和 resultType 的值一致
/** * 编写Mapper接口,用于映射SQL语句 */ @Mapper public interface DemoMapper { String hello(); }
-
编写MyBatis配置文件 config.MyBatisConfig
- 包名、文件名,没有限制!
- 文件中使用 MapprScan 扫描 Mapper包:
/** * 创建一个配置文件,MyBatisConfig * 在配置文件中,启动Mapper接口扫描功能 * Mapper 接口扫描功能会自动创建 Mapper接口的实现对象(使用的JDK动态代理技术) */ @MapperScan(basePackages = "cn.tedu.boot2209.mapper") @Configuration public class MyBatisConfig { }
-
测试案例: 测试结果说明,SQL被执行了,方法返回了SQL语句的结果
@SpringBootTest public class DemoMapperTests { @Autowired DemoMapper demoMapper; @Test void test(){ String str = demoMapper.hello(); System.out.println(str); } }
Spring Boot 中的配置类(配置文件)
@Configuration 用于声明新的配置文件类。
Spring Boot 中的主配置文件,就是Spring Boot 的启动类,可以作为配置文件使用。如果将全部配置信息放到主配置文件,就会很混乱。一般在开发中,将配置文件分开放置,相关的放到一起。
- MyBatis 放到一个文件中
- 安全配置放到一个文件中
- … …
创建一个配置包 config 管理全部的配置,然后创建MyBatis的配置类, 配置类需要标注 @Configuration
/**
* 创建一个配置文件,MyBatisConfig
* 在配置文件中,启动Mapper接口扫描功能
* Mapper 接口扫描功能会自动创建 Mapper接口的实现对象(使用的JDK动态代理技术)
*/
@MapperScan(basePackages = "cn.tedu.boot2209.mapper")
@Configuration
public class MyBatisConfig {
}
MyBatis XML映射文件工作原理
关于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">
<mapper namespace=