首页 > 代码库 > 一种利用JAVA注释支持多行字符串的方法
一种利用JAVA注释支持多行字符串的方法
从BeetlSql项目将SQL全放在Beetl模板里得到启发,又想到一个比较偏门的用法。以下代码实测通过,详见jSqlBox项目的test\examples\multipleLineSQL\SqlTemplateDemo.java源程序,此示例特殊点在于:运行时必须将此源程序拷贝一份在类根目录(或Maven管理的Resource目录下), 并将后缀".java"改为".sql"
public class SqlTemplateDemo extends TestBase {
//@formatter:off
public static class InsertUser extends SqlTemplate {
public InsertUser(Object name, Object address, Object age){
/* insert into
users
(username, address, age) */ empty(name,address,age);
/* values (?,?,?)*/
}
}
public static class FindUsers extends SqlTemplate {
public FindUsers(Object name, Object age){
/* select count(*)
from
users
where */
/* username=? */empty(name);
/* and age>? */empty(age);
/* order by username */
}
}
public static class GetUserCount extends SqlTemplate {
/* select count(*)
from users */
}
public static class SqlTemplateEndTag{}
@Test
public void doTest() {
Dao.executeInsert(new InsertUser("Tom","BeiJing",10).toString());
Dao.executeInsert(new InsertUser("Sam","ShangHai",20).toString());
Assert.assertEquals((Integer) 1, Dao.queryForInteger(new FindUsers("Sam",15).toString()));
Assert.assertEquals((Integer) 2, Dao.queryForInteger(new GetUserCount().toString()));
}
}
以上代码是利用Java源程序作为模板文件来统一放置SQL,以便于DBA管理。其优点在于:
1)没有引入第三方模板,直接用Java作为模板文件
2)支持多行字符串, 且没有引入IDE插件或Maven编译插件等,通用性好。
3)支持Java方法和模板混用,模板负责存储SQL,Java负责赋值(利用ThreadLocal),互不干拢。
4)public static class的类名即为SQL ID,便于重命名重构和SQL的快速定位(Ctrl+鼠标左键即可),这是文本方式模板无法做到的,后者必须用文本搜索功能才能定位SQL。
缺点是:
1)每次模板更改后,还必须手工拷贝一份同样的文件放在类根目录作为资源文件
2)因为SQL写在注释中, 所以必须利用标记 //@formatter:off 来关闭IDE(我用Eclipse)的格式化功能,防止IDE误格式化。
3)从安全角度出发,模板文件中要注意不要放入除SQL以外的内容。
以上方法主要应用于SQL模板,但是其它场合如需要用到Java支持多行字符串的,也可以借签。
一种利用JAVA注释支持多行字符串的方法
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。