在MyBatis等框架的开发场景中,我们经常会把SQL语句写在XML配置文件的标签内,IDEA默认的代码格式化功能不会对这类嵌入在XML中的SQL做针对性排版,很容易出现SQL换行混乱、缩进不统一的问题,影响代码可读性。

方法一:调整IDEA内置的XML格式化设置
IDEA本身提供了针对XML中嵌入语言的处理配置,我们可以通过以下步骤开启对XML内SQL的格式化支持:
- 打开IDEA的设置面板,Windows用户按
Ctrl+Alt+S,Mac用户按Cmd+, - 在左侧导航栏找到
Editor->Code Style->XML - 切换到
Other标签页,找到Injected language fragment相关配置项 - 勾选
Format injected fragments选项,保存设置即可
完成设置后,当你在XML文件中选中包含SQL的代码块,按下默认的格式化快捷键Ctrl+Alt+L(Windows)或Cmd+Opt+L(Mac),IDEA就会自动识别XML中的SQL片段并进行格式化。
方法二:为XML中的SQL设置专属格式化快捷键
如果觉得每次都要选中片段再格式化比较麻烦,可以自定义一个专属快捷键,快速触发XML内SQL的格式化:
步骤1:打开快捷键设置
进入Settings -> Keymap,在搜索框输入Format Injected Code Fragment,找到对应的操作项。
步骤2:绑定自定义快捷键
右键点击该操作项,选择Add Keyboard Shortcut,设置一个你习惯的快捷键组合,比如Ctrl+Shift+Alt+L,保存后就可以在编辑XML中的SQL时直接按下该快捷键完成格式化。
方法三:使用插件增强格式化能力
如果内置功能无法满足你的格式化需求,可以安装SQL Formatter插件来辅助处理:
- 打开IDEA的插件市场,搜索
SQL Formatter并安装重启 - 安装完成后,在XML文件中选中需要格式化的SQL代码块
- 右键选择
Format SQL选项,插件会自动按照SQL的语法规则对选中的内容进行排版
该插件支持多种SQL方言的配置,你可以在插件的设置中调整缩进、关键字大小写等格式化规则,适配不同的项目规范。
格式化示例
以下是格式化前后的代码对比,格式化前的XML中SQL代码:
<select id="queryUser" resultType="User">
select id,user_name,age,email from user where age > #{minAge} and user_name like concat('%',#{name},'%') order by id desc
</select>
格式化后的代码:
<select id="queryUser" resultType="User">
SELECT
id,
user_name,
age,
email
FROM
user
WHERE
age > #{minAge}
AND user_name LIKE CONCAT('%', #{name}, '%')
ORDER BY
id DESC
</select>
注意事项
- 如果格式化后SQL的关键字大小写不符合项目规范,可以在
Code Style->SQL的设置中调整关键字的大小写规则 - 部分复杂的动态SQL标签(比如<if>、<foreach>)可能会干扰格式化效果,遇到这种情况可以手动调整局部缩进
- 修改格式化设置后,建议重启IDEA让配置完全生效,避免出现设置不生效的问题