AppFramework1.0数据库访问组件使用说明(七)SqlTemplate与SqlMap的使用

最新推荐文章于 2024-09-28 10:15:31 发布

AppFramework

最新推荐文章于 2024-09-28 10:15:31 发布

阅读量1.5k

点赞数

文章标签：数据库 parameters object sql sqlserver ibatis

本文链接：https://blog.csdn.net/AppFramework/article/details/1944492

版权

1.1 SqlTemplate与SqlMap的使用

1.1.1 SqlTemplate原理

在早期做过报表系统开发的都知道，众多的查询条件和复杂的统计逻辑都直接硬编码在程序里，程序代码与SQL代码交织在一起，程序文件变得冗长杂乱，时间久了就变得难以维护。SqlTemplate是AppFramework提供的一种可视化、结构化的动态SQL语法，其代码为XML格式，从程序中剥离出来编写在.DaoGen文件里，很好地实现程序代码与SQL代码的分离，是一种全新的数据库编程模式。

AppFramework的SqlTemplate仿照IBatis的动态SQL语法，参数两端用“#”或“$”作标志。以“#”作标志的参数将生成参数化SQL，开发者不需要处理单引号转义；而以“$”作标志的参数将生成文本化的SQL，开发者要自己处理单引号转义，注意在编写“in ('a','b','c')”这种查询条件时，参数一定要用“$”作标志符，

例如：

USER_NO in ($IDs$)

而参数值则要赋值为："'a','b','c'"。

在运行时，IDBSession会把SqlTemplate与传入的参数值进行绑定，最后得到完整的SQL语句并传给ADO.NET执行。目前参数值的载体仅支持IDictionary<string, object>对象，这一点与IBatis相比略有不足。

通过AppFramework.Tools.CodeGenPlugin代码生成器，可以把.DaoGen文件里配置好的模板生成对应的XxxSqlMap类，而XxxSqlMap类则派生于SqlMap。可以简单地用下图描述它们的关系：

生成的代码通常在XXX.Model命名空间下，例如：

/// <summary>

///

/// </summary>

public class GetBasUserListSqlMap : SqlMap

{

/// <summary>

/// 获取内部 SQL 模板

/// </summary>

public static SqlTemplate GetBasUserListSqlTemplate = new SqlTemplate(@"<statement id=""GetBasUserList""><dynamic prepend="" "" append="""" seprator=""and""><isNotNull property=""UserName""> upper(NAME) like #UserName# </isNotNull><isNotNull property=""CreatedTimeBegin""> created_time >= #CreatedTimeBegin# </isNotNull></dynamic></statement>");

/// <summary>

/// 获取 SQL 模板

/// </summary>

public override SqlTemplate Template

{

get

{

return GetBasUserListSqlTemplate;

}

/// <summary>

/// 获取或设置 UserName 参数值

/// </summary>

public object UserName

{

set

{

if (value != null && value.ToString().Trim().Length > 0)

{

_parameters["UserName "] = value;

}

/// <summary>

/// 获取或设置 CreatedTimeBegin 参数值

/// </summary>

public object CreatedTimeBegin

{

set

{

if (value != null && value.ToString().Trim().Length > 0)

{

_parameters["CreatedTimeBegin"] = value;

}

/// <summary>

/// 获取绑定参数

/// </summary>

public override IDictionary<string, object> Parameters

{

get

{

return _parameters;

}

private IDictionary<string, object> _parameters = new Dictionary<string, object>(7);

}

1.1.2 用SqlTemplate语法详解

SqlTemplate的XML代码编写在.DaoGen文件里，其语法与IBatis的动态Sql配置文件语法相似，但要简单实用得多。有关标签和属性说明如下：

标签	属性	说明
statement		此节点定义一个SqlTemplate，可以放在Map节点下，也可以放在Map/MapItem节点下。无论放在哪里，效果都是一样的。放在Map/MapItem节点下表示SqlTemplate与这个MapItem是相关的，仅起到归类的作用。
	id	用于全局唯一标识statement。
dynamic		此节点定义一个动态代码块。
	prepend	如果此块有非空动态项，则再块的头部插入代码。
	append	如果此块有非空动态项，则再块的尾部插入代码。
	seprator	非空动态项之间的间隔代码。例如：AND 或 OR
isNotNull		此节点定义一个动态项。
	property	指定此动态项与哪个参数值绑定。如果参数集合里没有找到指定名称的参数，或参数值为null或空串，则不会输出此动态项所定义的SQL。