哈喽大家好今天给大家带来一篇纯零基础、保姆级的 XML 映射文件学习教程。很多初学开发的小伙伴都会被 MyBatis、框架配置中的 XML 映射文件搞懵标签看不懂、语法不会写、报错找不到原因。其实 XML 映射文件没有想象中复杂它的核心本质只有一句话用XML文件实现「代码与底层操作的映射绑定」替代硬编码配置让程序更灵活、易维护。本文不堆砌晦涩理论从零讲解XML映射文件的作用、基础语法、核心标签、完整实操案例和常见坑点看完就能独立编写、读懂项目中的XML映射文件。一、先搞懂什么是XML映射文件1.1 基础概念XML可扩展标记语言是一种结构化标记语言专注于数据存储、配置描述、关系映射。而我们开发中常说的XML映射文件是指用于建立两层数据/逻辑关联的XML配置文件最典型、使用最多的场景就是MyBatis Mapper映射文件本文核心实操场景。1.2 核心作用为什么要用它在没有映射文件时我们操作数据库需要在Java代码中硬写SQL存在两大痛点代码耦合严重SQL语句嵌在Java代码里修改SQL需要改代码、重启项目维护成本极高大量SQL散落代码中排查问题、统一管理极其麻烦XML映射文件的出现完美解决了以上问题核心价值解耦分离Java业务代码 和 SQL语句完全分离各司其职统一管理一张表对应一个Mapper映射文件所有增删改查操作集中存放灵活适配支持动态SQL、参数映射、结果封装适配复杂业务场景简化开发无需手动封装数据库结果集自动完成字段与实体类属性映射二、前置基础XML必须遵守的语法规则零基础必看XML映射文件基于标准XML语法语法容错率极低一个符号错误就会导致项目报错新手务必牢记以下核心规则2.1 基础语法规范所有标签必须成对出现有开始标签就必须有结束标签如mapper/mapper自闭合标签除外标签名称严格大小写敏感Select和select是完全不同的标签属性值必须用引号包裹单/双引号均可推荐双引号标签嵌套必须规范禁止交叉嵌套文件第一行必须声明XML文档头固定格式不可修改2.2 标准XML文件头部固定模板所有MyBatis XML映射文件开头必须添加以下声明用于定义文档版本和编码格式?xml version1.0 encodingUTF-8? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd简单解释第二行是引入MyBatis的DTD约束作用是校验当前XML文件的标签合法性写错标签、非法属性会直接提示报错。三、XML映射文件核心结构与核心标签重点以开发最常用的MyBatis Mapper映射文件为例完整文件结构分为根标签 映射语句标签 辅助标签下面逐个拆解必学标签。3.1 根标签mapper全局核心mapper是整个映射文件的根标签所有SQL语句、映射规则都需要写在该标签内部。核心属性namespace唯一核心作用绑定对应的Java Mapper接口实现「接口方法」和「XML SQL」的映射关联要求必须和Mapper接口的全类名完全一致包名类名示例namespacecom.example.demo.mapper.UserMapper3.2 四大基础CRUD标签对应数据库增删改查四种操作是日常开发使用最多的标签1. select 查询语句用于数据库查询操作核心属性id对应Mapper接口中的抽象方法名必须完全一致parameterType传入参数的类型基本类型、实体类、集合可省略resultTypeSQL查询结果封装的类型实体类、基本类型简单查询必备resultMap自定义结果映射规则复杂字段映射必备优先级高于resultType2. insert 新增语句用于数据新增支持返回自增主键、批量插入。3. update 修改语句用于数据库数据更新操作。4. delete 删除语句用于数据库数据删除操作。3.3 核心映射标签解决字段不匹配问题开发中最常见的问题数据库字段名 和 Java实体类属性名不一致如数据库user_name实体类userName此时需要自定义映射。1. resultMap 自定义结果映射作用手动绑定数据库字段与实体类属性支持复杂映射、嵌套映射是企业级开发首选。核心子标签id映射主键字段提升查询效率result映射普通字段四、从零手写完整XML映射文件实操案例理论看完直接上手实操我们以User用户表为例从零完成「实体类-Mapper接口-XML映射文件」全套配置实现基础增删改查。4.1 准备工作1. 数据库user表字段id主键、user_name、user_age、user_email2. Java实体类User属性id、userName、userAge、userEmail驼峰命名与数据库下划线命名不一致4.2 完整XML映射文件代码创建UserMapper.xml映射文件完整可直接运行代码如下?xml version1.0 encodingUTF-8? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd !-- 根标签绑定对应Mapper接口全类名 -- mapper namespacecom.example.demo.mapper.UserMapper !-- 自定义结果映射解决数据库下划线字段与实体类驼峰属性不匹配 -- resultMap idUserResultMap typecom.example.demo.entity.User !-- 主键映射 -- id columnid propertyid/ !-- 普通字段映射column数据库字段property实体类属性 -- result columnuser_name propertyuserName/ result columnuser_age propertyuserAge/ result columnuser_email propertyuserEmail/ /resultMap !-- 1. 根据ID查询用户 -- select idgetUserById parameterTypeLong resultMapUserResultMap SELECT id,user_name,user_age,user_email FROM user WHERE id #{id} /select !-- 2. 新增用户 -- insert idaddUser parameterTypecom.example.demo.entity.User INSERT INTO user (user_name,user_age,user_email) VALUES (#{userName},#{userAge},#{userEmail}) /insert !-- 3. 修改用户信息 -- update idupdateUser parameterTypecom.example.demo.entity.User UPDATE user SET user_name #{userName},user_age #{userAge},user_email #{userEmail} WHERE id #{id} /update !-- 4. 根据ID删除用户 -- delete iddeleteUser parameterTypeLong DELETE FROM user WHERE id #{id} /delete /mapper4.3 配套Mapper接口对应XML映射XML中的id必须和接口方法名一一对应配套接口代码package com.example.demo.mapper; import com.example.demo.entity.User; import org.apache.ibatis.annotations.Param; public interface UserMapper { // 对应XML getUserById User getUserById(Long id); // 对应XML addUser int addUser(User user); // 对应XML updateUser int updateUser(User user); // 对应XML deleteUser int deleteUser(Long id); }五、核心语法详解#{} 和 ${} 的区别新手必踩坑在XML映射文件中参数占位符只有两种必须分清使用场景否则会出现SQL注入、查询失效问题5.1 #{} 预编译占位符推荐99%场景底层会生成预编译SQLPreparedStatement参数以占位符形式传入杜绝SQL注入风险安全性极高会自动给字符串加引号无需手动拼接适用场景所有普通参数查询、新增、修改、删除5.2 ${} 直接拼接占位符谨慎使用底层直接将参数拼接进SQL语句无预编译存在严重SQL注入风险不会自动加引号需要手动拼接适用场景动态排序、动态表名极少场景六、新手常见报错与避坑指南整理学习和开发中最高频的XML映射文件报错新手直接避坑6.1 映射绑定失败报错原因namespace与Mapper接口全类名不一致、方法id与接口方法名不匹配解决逐字核对包名、类名、方法名保证完全一致大小写敏感6.2 字段映射为空报错原因数据库下划线字段与实体类驼峰属性不匹配未配置resultMap或驼峰自动转换解决自定义resultMap映射或开启MyBatis驼峰命名自动转换6.3 XML语法报错报错原因标签未闭合、属性未加引号、标签大小写错误、交叉嵌套解决严格遵循XML语法复制标准模板编写减少手写错误6.4 参数绑定异常报错原因参数名写错、未指定参数类型、使用${}未手动加引号解决统一使用#{}核对参数名称复杂参数指定parameterType七、学习总结看完这篇教程你已经完成了XML映射文件的零基础入门核心知识点复盘XML映射文件的核心是解耦SQL与Java代码实现数据和逻辑的映射绑定必须遵守XML严格语法标签成对、大小写敏感、属性带引号核心结构namespace绑定接口 CRUD标签写SQL resultMap解决字段映射参数优先使用#{}杜绝SQL注入${}仅用于特殊动态场景开发核心原则方法名、id、映射关系一一对应
哈喽大家好今天给大家带来一篇纯零基础、保姆级的 XML 映射文件学习教程。很多初学开发的小伙伴都会被 MyBatis、框架配置中的 XML 映射文件搞懵标签看不懂、语法不会写、报错找不到原因。其实 XML 映射文件没有想象中复杂它的核心本质只有一句话用XML文件实现「代码与底层操作的映射绑定」替代硬编码配置让程序更灵活、易维护。本文不堆砌晦涩理论从零讲解XML映射文件的作用、基础语法、核心标签、完整实操案例和常见坑点看完就能独立编写、读懂项目中的XML映射文件。一、先搞懂什么是XML映射文件1.1 基础概念XML可扩展标记语言是一种结构化标记语言专注于数据存储、配置描述、关系映射。而我们开发中常说的XML映射文件是指用于建立两层数据/逻辑关联的XML配置文件最典型、使用最多的场景就是MyBatis Mapper映射文件本文核心实操场景。1.2 核心作用为什么要用它在没有映射文件时我们操作数据库需要在Java代码中硬写SQL存在两大痛点代码耦合严重SQL语句嵌在Java代码里修改SQL需要改代码、重启项目维护成本极高大量SQL散落代码中排查问题、统一管理极其麻烦XML映射文件的出现完美解决了以上问题核心价值解耦分离Java业务代码 和 SQL语句完全分离各司其职统一管理一张表对应一个Mapper映射文件所有增删改查操作集中存放灵活适配支持动态SQL、参数映射、结果封装适配复杂业务场景简化开发无需手动封装数据库结果集自动完成字段与实体类属性映射二、前置基础XML必须遵守的语法规则零基础必看XML映射文件基于标准XML语法语法容错率极低一个符号错误就会导致项目报错新手务必牢记以下核心规则2.1 基础语法规范所有标签必须成对出现有开始标签就必须有结束标签如mapper/mapper自闭合标签除外标签名称严格大小写敏感Select和select是完全不同的标签属性值必须用引号包裹单/双引号均可推荐双引号标签嵌套必须规范禁止交叉嵌套文件第一行必须声明XML文档头固定格式不可修改2.2 标准XML文件头部固定模板所有MyBatis XML映射文件开头必须添加以下声明用于定义文档版本和编码格式?xml version1.0 encodingUTF-8? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd简单解释第二行是引入MyBatis的DTD约束作用是校验当前XML文件的标签合法性写错标签、非法属性会直接提示报错。三、XML映射文件核心结构与核心标签重点以开发最常用的MyBatis Mapper映射文件为例完整文件结构分为根标签 映射语句标签 辅助标签下面逐个拆解必学标签。3.1 根标签mapper全局核心mapper是整个映射文件的根标签所有SQL语句、映射规则都需要写在该标签内部。核心属性namespace唯一核心作用绑定对应的Java Mapper接口实现「接口方法」和「XML SQL」的映射关联要求必须和Mapper接口的全类名完全一致包名类名示例namespacecom.example.demo.mapper.UserMapper3.2 四大基础CRUD标签对应数据库增删改查四种操作是日常开发使用最多的标签1. select 查询语句用于数据库查询操作核心属性id对应Mapper接口中的抽象方法名必须完全一致parameterType传入参数的类型基本类型、实体类、集合可省略resultTypeSQL查询结果封装的类型实体类、基本类型简单查询必备resultMap自定义结果映射规则复杂字段映射必备优先级高于resultType2. insert 新增语句用于数据新增支持返回自增主键、批量插入。3. update 修改语句用于数据库数据更新操作。4. delete 删除语句用于数据库数据删除操作。3.3 核心映射标签解决字段不匹配问题开发中最常见的问题数据库字段名 和 Java实体类属性名不一致如数据库user_name实体类userName此时需要自定义映射。1. resultMap 自定义结果映射作用手动绑定数据库字段与实体类属性支持复杂映射、嵌套映射是企业级开发首选。核心子标签id映射主键字段提升查询效率result映射普通字段四、从零手写完整XML映射文件实操案例理论看完直接上手实操我们以User用户表为例从零完成「实体类-Mapper接口-XML映射文件」全套配置实现基础增删改查。4.1 准备工作1. 数据库user表字段id主键、user_name、user_age、user_email2. Java实体类User属性id、userName、userAge、userEmail驼峰命名与数据库下划线命名不一致4.2 完整XML映射文件代码创建UserMapper.xml映射文件完整可直接运行代码如下?xml version1.0 encodingUTF-8? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd !-- 根标签绑定对应Mapper接口全类名 -- mapper namespacecom.example.demo.mapper.UserMapper !-- 自定义结果映射解决数据库下划线字段与实体类驼峰属性不匹配 -- resultMap idUserResultMap typecom.example.demo.entity.User !-- 主键映射 -- id columnid propertyid/ !-- 普通字段映射column数据库字段property实体类属性 -- result columnuser_name propertyuserName/ result columnuser_age propertyuserAge/ result columnuser_email propertyuserEmail/ /resultMap !-- 1. 根据ID查询用户 -- select idgetUserById parameterTypeLong resultMapUserResultMap SELECT id,user_name,user_age,user_email FROM user WHERE id #{id} /select !-- 2. 新增用户 -- insert idaddUser parameterTypecom.example.demo.entity.User INSERT INTO user (user_name,user_age,user_email) VALUES (#{userName},#{userAge},#{userEmail}) /insert !-- 3. 修改用户信息 -- update idupdateUser parameterTypecom.example.demo.entity.User UPDATE user SET user_name #{userName},user_age #{userAge},user_email #{userEmail} WHERE id #{id} /update !-- 4. 根据ID删除用户 -- delete iddeleteUser parameterTypeLong DELETE FROM user WHERE id #{id} /delete /mapper4.3 配套Mapper接口对应XML映射XML中的id必须和接口方法名一一对应配套接口代码package com.example.demo.mapper; import com.example.demo.entity.User; import org.apache.ibatis.annotations.Param; public interface UserMapper { // 对应XML getUserById User getUserById(Long id); // 对应XML addUser int addUser(User user); // 对应XML updateUser int updateUser(User user); // 对应XML deleteUser int deleteUser(Long id); }五、核心语法详解#{} 和 ${} 的区别新手必踩坑在XML映射文件中参数占位符只有两种必须分清使用场景否则会出现SQL注入、查询失效问题5.1 #{} 预编译占位符推荐99%场景底层会生成预编译SQLPreparedStatement参数以占位符形式传入杜绝SQL注入风险安全性极高会自动给字符串加引号无需手动拼接适用场景所有普通参数查询、新增、修改、删除5.2 ${} 直接拼接占位符谨慎使用底层直接将参数拼接进SQL语句无预编译存在严重SQL注入风险不会自动加引号需要手动拼接适用场景动态排序、动态表名极少场景六、新手常见报错与避坑指南整理学习和开发中最高频的XML映射文件报错新手直接避坑6.1 映射绑定失败报错原因namespace与Mapper接口全类名不一致、方法id与接口方法名不匹配解决逐字核对包名、类名、方法名保证完全一致大小写敏感6.2 字段映射为空报错原因数据库下划线字段与实体类驼峰属性不匹配未配置resultMap或驼峰自动转换解决自定义resultMap映射或开启MyBatis驼峰命名自动转换6.3 XML语法报错报错原因标签未闭合、属性未加引号、标签大小写错误、交叉嵌套解决严格遵循XML语法复制标准模板编写减少手写错误6.4 参数绑定异常报错原因参数名写错、未指定参数类型、使用${}未手动加引号解决统一使用#{}核对参数名称复杂参数指定parameterType七、学习总结看完这篇教程你已经完成了XML映射文件的零基础入门核心知识点复盘XML映射文件的核心是解耦SQL与Java代码实现数据和逻辑的映射绑定必须遵守XML严格语法标签成对、大小写敏感、属性带引号核心结构namespace绑定接口 CRUD标签写SQL resultMap解决字段映射参数优先使用#{}杜绝SQL注入${}仅用于特殊动态场景开发核心原则方法名、id、映射关系一一对应
