在 Java 中如何更高效地存储和管理 SQL 语句？

【编者按】还在为管理 Java 代码中的 SQL 语句而烦恼吗？让 Zemian 帮你摆脱困境吧！本文系 OneAPM 工程师编译整理

注意：使用java.util.Properties#loadFromXML其实会更简单！



如果使用的是普通的、没有任何外部类库的 Java JDBC，那么就必须得自己去管理 SQL 语句。很不幸的是，Java String 并不支持多行结构，所以开发者必须使用许多引号+连接符来拼接语句，这会使得 SQL 语句非常难于阅读和管理。同时，这也使得维护和测试（尝试从 Java 代码中 Copy 一条 SQL 语句到 SQL 客户端运行）更加困难。如果能保证整条 SQL 语句完好无缺，又避免了 Java 的干扰，那该有多好啊！

这里有个快速解决方案，把 SQL 查询语句存储在 XML 的 CDATA 里面：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sqlMap>
<sqls>
<entry>
<key>getUser</key>
<value><![CDATA[
SELECT *
FROM USERS
WHERE ID = ?
]]></value>
</entry>
<entry>
<key>getSpecialCodeByUserId</key>
<value><![CDATA[
SELECT u.EMAIL, p.ID as PROFILEID, p.SPECIALCODE, a.MANAGERID
FROM USERS u
LEFT JOIN PROFILE p ON p.USERID = u.ID
LEFT JOIN ACCOUNT a ON a.PROFILEID = p.ID
WHERE u.ID = ?  ]]></value>
</entry>  </sqls>
</sqlMap>

如果现在再去读 SQL 语句，开发者可以利用内建的 JAXB。

import javax.xml.bind.annotation.XmlRootElement;
import java.util.HashMap;
import java.util.Map;
@XmlRootElement
public class SqlMap {
Map<String, String> sqls = new HashMap<>();
public Map<String, String> getSqls() {
return sqls;
}
public void setSqls(Map<String, String> sqls) {
this.sqls = sqls;
}
public String getSql(String name) {
return sqls.get(name);
}
public static SqlMap load(String name) throws Exception {
String xml = Utils.loadString(name);
SqlMap sqlMap = unmarshallXML(xml );
return sqlMap;
}
}

原文链接：How to Store and Manage SQL Statements More Effectively With Java

OneAPM for Java 能够深入到所有 Java 应用内部完成应用性能管理和监控，包括代码级别性能问题的可见性、性能瓶颈的快速识别与追溯、真实用户体验监控、服务器监控和端到端的应用性能管理。想阅读更多技术文章，请访问 OneAPM 官方博客。