从零开始编写自己的C#框架(13)——T4模板在逻辑层中的应用(二)
2014-06-17 12:55
751 查看
原文:从零开始编写自己的C#框架(13)——T4模板在逻辑层中的应用(二)
最近这段时间特忙,公事私事,忙得有时都没时间打开电脑了,这两周只能尽量更新,以后再将章节补回来。
直接进入主题,通过上一章节,大家明白了怎么使用模板类编写T4模板,本章进的是一些简单技巧的应用
1、首先创建一个Test2.tt模板
2、然后修改模板内容为下面代码
这些代码与上一章最后面的那个差不多,只是修改了输出文件名、命名空间、类名、类属性(partial)和一个单例获取函数
运行模板,测试看看效果
从上面添加函数的方法可以看出,对于常用的函数,都可以在模板中进行添加后,直接生成出来,这样就减少了程序员很大的工作量了
3、用上面方法确实可以解决很大部分的问题,但对于一些特殊的函数直接这样写就不行了,比如我们想生成一个删除指定外键Id的函数,由于有的表有外键有的没有,那么就要用上一些简单的判断来处理了
运行模板,测试看看效果
4、同理,我们可以通过判断,生成获取指定名称的字段值和生成删除图片函数等,这些都可以根据你的需要去生成
运行模板,测试看看效果
5、有时候我们会存在一些特殊的需求,有些表或字段要进行过滤操作,这时我们就可以使用一些简单的过滤判断处理
比如我们对于Manager_Id与Manager_Name这两个字段是不需要生成对应函数的,那么我们就可以加个过滤处理
首先在Settings.ttinclude文件中创建一个字符串数组变量,并赋值
然后在模板中的循环语句中添加判断
运行模板,测试看看效果
对比第4点的图就可以看到,已经少了两个函数了
而表名过滤,在上一章节的内容中已经包含了,请看下图
只要在Settings.ttinclude文件中的ExcludeTables变量中添加你想过滤的表名称就可以了
当然我们还可以写出更多的扩展,这些需要发挥你的想象力,生成更多常用函数,使你从复制粘贴中解放出来,当然函数有变动时,也只需要改一下模板就可以了,方便快捷
6、对于常用功能来说,前面的生成方式都可以解决,但有时候有些功能直接生成的方式解决不了,那么父类(基类)与虚函数的运用可以帮我们解决很多程序调用的问题。
比如我们使用IIS缓存,在对记录进行添加、删除与修改操作时,必须同步删除缓存。看到这个需求,可能有的朋友就会说,这很简单啊,直接生成一个缓存删除函数就可以了。是的,这是一种处理方法,但还会存在很多特殊情况,有些时候,我们在自定义函数中也会用到一些缓存,这些缓存并不存在模板中,那么想要模板里的程序在清空模板缓存后,也能自动帮我们清除自定义缓存的话该怎么实现呢?不可能要让我们在相关程序调用的方法中手动添加吧,如果调用的地方太多的话,就很容易忘记了。而我们有一种比较好的解决方式,那就是使用父类(基类),在基类中实现一个删除缓存的虚函数,模板类继承基类后,可以在那些执行添加、删除与修改的函数中直接调用虚函数,而对于这些个性化的删除操作,我们只需要使用override修饰符重写该函数,就可以实现自动删除缓存的功能了。
具体操作方法请看下面步骤:
首先创建一个基类
创建一个虚函数
然后再模板中让模板类继承基类,并实现添加、修改与删除方法,在方法中调用删除缓存函数
运行模板,测试看看效果
然后我们创建一个与模版中同名的类
实现虚函数
这样模板函数在执行相关操作时,如果我们重写了清空缓存这个函数,那么程序就会自动执行清空缓存函数了,而对于那些不需要该功能的类则没有任何影响
这里要注意的是,我们的模板类与这个自定义类都有一个统一的修饰符partial
大家先消化上面内容,才好理解下一章节中模板调用内容,下章会将写好的模板函数全部贴出来,让大家直接一步到位,生成Web层所需要的绝大部分调用函数,减少这一部分不必要的编码工作。
下载地址:
T4模板在逻辑层中的应用(二).rar
版权声明:
本文由AllEmpty原创并发布于博客园,欢迎转载,未经本人同意必须保留此段声明,且在文章页面明显位置给出原文链接,[b]否则保留追究法律责任的权利。如有问题,可以通过1654937@qq.com 联系我,非常感谢。[/b]
发表本编内容,只要主为了和大家共同学习共同进步,有兴趣的朋友可以加加Q群:327360708 ,大家一起探讨。
更多内容,敬请观注博客:http://www.cnblogs.com/EmptyFS/
最近这段时间特忙,公事私事,忙得有时都没时间打开电脑了,这两周只能尽量更新,以后再将章节补回来。
直接进入主题,通过上一章节,大家明白了怎么使用模板类编写T4模板,本章进的是一些简单技巧的应用
1、首先创建一个Test2.tt模板
2、然后修改模板内容为下面代码
这些代码与上一章最后面的那个差不多,只是修改了输出文件名、命名空间、类名、类属性(partial)和一个单例获取函数
<#@ template debug="false" hostspecific="True" language="C#" #> <#@ output extension=".cs" encoding="utf-8" #> <#@ include file="SQLServer.ttinclude" #> <#@ include file="MultipleOutputHelper.ttinclude"#> <# //获取所有表与视图 var tables = LoadTables(); //创建多文件生成实体 var manager = Manager.Create(Host, GenerationEnvironment); //遍历所有表 foreach(var tbl in tables){ //判断当前表名是否是禁用名称(禁用的名称可以在Settings.ttinclude文件的ExcludeTables字符串数据中进行添加) if(!ExcludeTables.Contains(tbl.Name)) { // 设置输出的文件名 manager.StartNewFile(tbl.ClassName+"Bll.cs"); #> using System; namespace Solution.Logic { public partial class <#=tbl.CleanName#>Bll { #region 单例模式 //定义单例实体 private static <#=tbl.Name#>Bll _<#=tbl.Name#>Bll = null; /// <summary> /// 获取本逻辑类单例 /// </summary> /// <returns></returns> public static <#=tbl.Name#>Bll GetInstence() { if (_<#=tbl.Name#>Bll == null) { _<#=tbl.Name#>Bll = new <#=tbl.Name#>Bll(); } return _<#=tbl.Name#>Bll; } #endregion } } <# // 输出文件结束 manager.EndBlock(); } //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件 manager.Process(true); #>
运行模板,测试看看效果
从上面添加函数的方法可以看出,对于常用的函数,都可以在模板中进行添加后,直接生成出来,这样就减少了程序员很大的工作量了
3、用上面方法确实可以解决很大部分的问题,但对于一些特殊的函数直接这样写就不行了,比如我们想生成一个删除指定外键Id的函数,由于有的表有外键有的没有,那么就要用上一些简单的判断来处理了
<#@ template debug="false" hostspecific="True" language="C#" #> <#@ output extension=".cs" encoding="utf-8" #> <#@ include file="SQLServer.ttinclude" #> <#@ include file="MultipleOutputHelper.ttinclude"#> <# //获取所有表与视图 var tables = LoadTables(); //创建多文件生成实体 var manager = Manager.Create(Host, GenerationEnvironment); //遍历所有表 foreach(var tbl in tables){ //判断当前表名是否是禁用名称(禁用的名称可以在Settings.ttinclude文件的ExcludeTables字符串数据中进行添加) if(!ExcludeTables.Contains(tbl.Name)) { // 设置输出的文件名 manager.StartNewFile(tbl.ClassName+"Bll.cs"); #> using System; using Solution.DataAccess.DataModel; using Solution.DataAccess.DbHelper; namespace Solution.Logic { public partial class <#=tbl.CleanName#>Bll { #region 单例模式 //定义单例实体 private static <#=tbl.Name#>Bll _<#=tbl.Name#>Bll = null; /// <summary> /// 获取本逻辑类单例 /// </summary> /// <returns></returns> public static <#=tbl.Name#>Bll GetInstence() { if (_<#=tbl.Name#>Bll == null) { _<#=tbl.Name#>Bll = new <#=tbl.Name#>Bll(); } return _<#=tbl.Name#>Bll; } #endregion <# foreach(var col in tbl.Columns){ //判断字段名称中是否包含“_Id”这个字符串,且字段类型为int或long的,则生成对应的删除函数 if (col.CleanName.IndexOf("_Id") >= 0 && (col.SysType == "int" || col.SysType == "long")) { #> #region 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int id) { //删除 <#=tbl.Name#>.Delete(x => x.<#=col.CleanName#> == id); } /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int[] id) { if (id == null) return; //将数组转为逗号分隔的字串 var str = string.Join(",", id); //设置Sql语句 var sql = "delete from <#=tbl.Name#> where <#=col.CleanName#> in (" + str + ")"; //删除 var deleteHelper = new DeleteHelper(); deleteHelper.Delete(sql); } #endregion <# } } #> } } <# // 输出文件结束 manager.EndBlock(); } //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件 manager.Process(true); #>
运行模板,测试看看效果
4、同理,我们可以通过判断,生成获取指定名称的字段值和生成删除图片函数等,这些都可以根据你的需要去生成
<#@ template debug="false" hostspecific="True" language="C#" #> <#@ output extension=".cs" encoding="utf-8" #> <#@ include file="SQLServer.ttinclude" #> <#@ include file="MultipleOutputHelper.ttinclude"#> <# //获取所有表与视图 var tables = LoadTables(); //创建多文件生成实体 var manager = Manager.Create(Host, GenerationEnvironment); //遍历所有表 foreach(var tbl in tables){ //判断当前表名是否是禁用名称(禁用的名称可以在Settings.ttinclude文件的ExcludeTables字符串数据中进行添加) if(!ExcludeTables.Contains(tbl.Name)) { // 设置输出的文件名 manager.StartNewFile(tbl.ClassName+"Bll.cs"); #> using System; using Solution.DataAccess.DataModel; using Solution.DataAccess.DbHelper; namespace Solution.Logic { public partial class <#=tbl.CleanName#>Bll { #region 单例模式 //定义单例实体 private static <#=tbl.Name#>Bll _<#=tbl.Name#>Bll = null; /// <summary> /// 获取本逻辑类单例 /// </summary> /// <returns></returns> public static <#=tbl.Name#>Bll GetInstence() { if (_<#=tbl.Name#>Bll == null) { _<#=tbl.Name#>Bll = new <#=tbl.Name#>Bll(); } return _<#=tbl.Name#>Bll; } #endregion <# foreach(var col in tbl.Columns){ //判断字段名称中是否包含“_Id”这个字符串,且字段类型为int或long的,则生成对应的删除函数 if (col.CleanName.IndexOf("_Id") >= 0 && (col.SysType == "int" || col.SysType == "long")) { #> #region 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int id) { //删除 <#=tbl.Name#>.Delete(x => x.<#=col.CleanName#> == id); } /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int[] id) { if (id == null) return; //将数组转为逗号分隔的字串 var str = string.Join(",", id); //设置Sql语句 var sql = "delete from <#=tbl.Name#> where <#=col.CleanName#> in (" + str + ")"; //删除 var deleteHelper = new DeleteHelper(); deleteHelper.Delete(sql); } #endregion <# } //判断字段名称中是否包含“Name”这个字符串,且字段类型为string else if (col.CleanName.IndexOf("Name") >= 0 && col.SysType == "string") { #> #region 获取<#=col.CleanName #>字段值 /// <summary> /// 获取<#=col.CleanName #>字段值 /// </summary> /// <param name="pkValue">主键Id</param> /// <returns></returns> public string Get<#=col.CleanName #>(int pkValue) { //从数据库中查询 var model = <#=tbl.Name#>.SingleOrDefault(x => x.Id == pkValue); return model == null ? "" : model.<#=col.CleanName #>; } #endregion <# } //判断字段名称中是否包含“Img”这个字符串,且字段类型为string else if (col.CleanName.IndexOf("Img") >= 0 && col.SysType == "string") { #> #region 删除<#=col.CleanName #>字段存储的对应图片 /// <summary>删除<#=col.CleanName #>字段存储的对应图片</summary> /// <param name="pkValue">主键Id</param> public void Del<#=col.CleanName #>(int pkValue) { try { //添加删除语句 } catch (Exception e) { //出现异常,保存出错日志信息 //添加保存出错日志语句 } } #endregion <# } } #> } } <# // 输出文件结束 manager.EndBlock(); } //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件 manager.Process(true); #>
运行模板,测试看看效果
5、有时候我们会存在一些特殊的需求,有些表或字段要进行过滤操作,这时我们就可以使用一些简单的过滤判断处理
比如我们对于Manager_Id与Manager_Name这两个字段是不需要生成对应函数的,那么我们就可以加个过滤处理
首先在Settings.ttinclude文件中创建一个字符串数组变量,并赋值
然后在模板中的循环语句中添加判断
运行模板,测试看看效果
对比第4点的图就可以看到,已经少了两个函数了
而表名过滤,在上一章节的内容中已经包含了,请看下图
只要在Settings.ttinclude文件中的ExcludeTables变量中添加你想过滤的表名称就可以了
当然我们还可以写出更多的扩展,这些需要发挥你的想象力,生成更多常用函数,使你从复制粘贴中解放出来,当然函数有变动时,也只需要改一下模板就可以了,方便快捷
6、对于常用功能来说,前面的生成方式都可以解决,但有时候有些功能直接生成的方式解决不了,那么父类(基类)与虚函数的运用可以帮我们解决很多程序调用的问题。
比如我们使用IIS缓存,在对记录进行添加、删除与修改操作时,必须同步删除缓存。看到这个需求,可能有的朋友就会说,这很简单啊,直接生成一个缓存删除函数就可以了。是的,这是一种处理方法,但还会存在很多特殊情况,有些时候,我们在自定义函数中也会用到一些缓存,这些缓存并不存在模板中,那么想要模板里的程序在清空模板缓存后,也能自动帮我们清除自定义缓存的话该怎么实现呢?不可能要让我们在相关程序调用的方法中手动添加吧,如果调用的地方太多的话,就很容易忘记了。而我们有一种比较好的解决方式,那就是使用父类(基类),在基类中实现一个删除缓存的虚函数,模板类继承基类后,可以在那些执行添加、删除与修改的函数中直接调用虚函数,而对于这些个性化的删除操作,我们只需要使用override修饰符重写该函数,就可以实现自动删除缓存的功能了。
具体操作方法请看下面步骤:
首先创建一个基类
创建一个虚函数
然后再模板中让模板类继承基类,并实现添加、修改与删除方法,在方法中调用删除缓存函数
<#@ template debug="false" hostspecific="True" language="C#" #> <#@ output extension=".cs" encoding="utf-8" #> <#@ include file="SQLServer.ttinclude" #> <#@ include file="MultipleOutputHelper.ttinclude"#> <# //获取所有表与视图 var tables = LoadTables(); //创建多文件生成实体 var manager = Manager.Create(Host, GenerationEnvironment); //遍历所有表 foreach(var tbl in tables){ //判断当前表名是否是禁用名称(禁用的名称可以在Settings.ttinclude文件的ExcludeTables字符串数据中进行添加) if(!ExcludeTables.Contains(tbl.Name)) { // 设置输出的文件名 manager.StartNewFile(tbl.ClassName+"Bll.cs"); #> using System; using System.Linq.Expressions; using Solution.DataAccess.DataModel; using Solution.DataAccess.DbHelper; namespace Solution.Logic { public partial class <#=tbl.CleanName#>Bll : LogicBase { #region 单例模式 //定义单例实体 private static <#=tbl.Name#>Bll _<#=tbl.Name#>Bll = null; /// <summary> /// 获取本逻辑类单例 /// </summary> /// <returns></returns> public static <#=tbl.Name#>Bll GetInstence() { if (_<#=tbl.Name#>Bll == null) { _<#=tbl.Name#>Bll = new <#=tbl.Name#>Bll(); } return _<#=tbl.Name#>Bll; } #endregion #region 添加与编辑<#=tbl.Name#>表记录 /// <summary> /// 添加与编辑<#=tbl.Name#>记录 /// </summary> /// <param name="model"><#=tbl.Name#>表实体</param> public void Save(<#=tbl.Name#> model) { try { //保存 model.Save(); //删除缓存 DelCache(); //添加用户访问记录 //UseLogBll.GetInstence().Save("{0}" + (model.Id == 0 ? "添加" : "编辑") + "<#=tbl.Name#>记录成功,ID为【" + model.Id + "】"); } catch (Exception e) { //var result = "执行<#=tbl.Name#>Bll.Save()函数出错!"; //出现异常,保存出错日志信息 //CommonBll.WriteLog(result, e, false); } } #endregion #region 删除<#=tbl.Name#>表记录 /// <summary> /// 删除<#=tbl.Name#>表记录 /// </summary> /// <param name="id">记录的主键值</param> public void Delete(int id) { //设置Sql语句 var sql = "delete from <#=tbl.Name#> where Id = " + id; //删除 var deleteHelper = new DeleteHelper(); deleteHelper.Delete(sql); //删除缓存 DelCache(); //添加用户操作记录 //UseLogBll.GetInstence().Save("{0}删除了<#=tbl.Name#>表id为【" + id + "】的记录!"); } /// <summary> /// 删除<#=tbl.Name#>表记录 /// </summary> /// <param name="id">记录的主键值</param> public void Delete(int[] id) { if (id == null) return; //将数组转为逗号分隔的字串 var str = string.Join(",", id); //设置Sql语句 var sql = "delete from <#=tbl.Name#> where Id in (" + str + ")"; //删除 var deleteHelper = new DeleteHelper(); deleteHelper.Delete(sql); //删除缓存 DelCache(); //添加用户操作记录 //UseLogBll.GetInstence().Save("{0}删除了<#=tbl.Name#>表id为【" + str + "】的记录!"); } /// <summary> /// 获取数据表中的某个值——从数据库中查询,如果使用了缓存,删除成功后会清空本表的所有缓存记录,然后重新加载进缓存 /// </summary> /// <param name="expression">条件语句</param> /// <returns></returns> public void Delete(Expression<Func<<#=tbl.Name#>, bool>> expression) { //执行删除 <#=tbl.Name#>.Delete(expression); //删除缓存 DelCache(); //添加用户操作记录 //UseLogBll.GetInstence().Save(page, "{0}删除了<#=tbl.Name#>表记录!"); } #endregion <# foreach(var col in tbl.Columns) { //进行过滤判断,指定的字段名称不做处理 if (ExcludeFields.Contains(col.CleanName)) continue; //判断字段名称中是否包含“_Id”这个字符串,且字段类型为int或long的,则生成对应的删除函数 if (col.CleanName.IndexOf("_Id") >= 0 && (col.SysType == "int" || col.SysType == "long")) { #> #region 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int id) { //删除 <#=tbl.Name#>.Delete(x => x.<#=col.CleanName#> == id); } /// <summary> /// 删除<#=tbl.Name#>表指定<#=col.CleanName#>的字段值记录 /// </summary> /// <param name="id">记录的主键值</param> public void DeleteBy<#=col.CleanName#>(int[] id) { if (id == null) return; //将数组转为逗号分隔的字串 var str = string.Join(",", id); //设置Sql语句 var sql = "delete from <#=tbl.Name#> where <#=col.CleanName#> in (" + str + ")"; //删除 var deleteHelper = new DeleteHelper(); deleteHelper.Delete(sql); } #endregion <# } //判断字段名称中是否包含“Name”这个字符串,且字段类型为string else if (col.CleanName.IndexOf("Name") >= 0 && col.SysType == "string") { #> #region 获取<#=col.CleanName #>字段值 /// <summary> /// 获取<#=col.CleanName #>字段值 /// </summary> /// <param name="pkValue">主键Id</param> /// <returns></returns> public string Get<#=col.CleanName #>(int pkValue) { //从数据库中查询 var model = <#=tbl.Name#>.SingleOrDefault(x => x.Id == pkValue); return model == null ? "" : model.<#=col.CleanName #>; } #endregion <# } //判断字段名称中是否包含“Img”这个字符串,且字段类型为string else if (col.CleanName.IndexOf("Img") >= 0 && col.SysType == "string") { #> #region 删除<#=col.CleanName #>字段存储的对应图片 /// <summary>删除<#=col.CleanName #>字段存储的对应图片</summary> /// <param name="pkValue">主键Id</param> public void Del<#=col.CleanName #>(int pkValue) { try { //添加删除语句 } catch (Exception e) { //出现异常,保存出错日志信息 //添加保存出错日志语句 } } #endregion <# } } #> } } <# // 输出文件结束 manager.EndBlock(); } //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件 manager.Process(true); #>
运行模板,测试看看效果
然后我们创建一个与模版中同名的类
实现虚函数
这样模板函数在执行相关操作时,如果我们重写了清空缓存这个函数,那么程序就会自动执行清空缓存函数了,而对于那些不需要该功能的类则没有任何影响
这里要注意的是,我们的模板类与这个自定义类都有一个统一的修饰符partial
大家先消化上面内容,才好理解下一章节中模板调用内容,下章会将写好的模板函数全部贴出来,让大家直接一步到位,生成Web层所需要的绝大部分调用函数,减少这一部分不必要的编码工作。
下载地址:
T4模板在逻辑层中的应用(二).rar
版权声明:
本文由AllEmpty原创并发布于博客园,欢迎转载,未经本人同意必须保留此段声明,且在文章页面明显位置给出原文链接,[b]否则保留追究法律责任的权利。如有问题,可以通过1654937@qq.com 联系我,非常感谢。[/b]
发表本编内容,只要主为了和大家共同学习共同进步,有兴趣的朋友可以加加Q群:327360708 ,大家一起探讨。
更多内容,敬请观注博客:http://www.cnblogs.com/EmptyFS/
相关文章推荐
- 从零开始编写自己的C#框架(13)——T4模板在逻辑层中的应用(二)
- 从零开始编写自己的C#框架(12)——T4模板在逻辑层中的应用(一)(附源码)
- 从零开始编写自己的C#框架(14)——T4模板在逻辑层中的应用(三)
- 从零开始编写自己的C#框架(14)——T4模板在逻辑层中的应用(三)
- 从零开始编写自己的C#框架(12)——T4模板在逻辑层中的应用(一)(附源码)
- 从零开始编写自己的C#框架(3)——开发规范
- 从零开始编写自己的C#框架(5)——三层架构介绍
- 从零开始编写自己的C#框架(5)——三层架构介绍
- 从零开始编写自己的C#框架(10)——项目实施计划与甘特图
- 从零开始编写自己的C#框架(10)——项目实施计划与甘特图
- 从零开始编写自己的C#框架(7)——需求分析
- 从零开始编写自己的C#框架(2)——开发前准备工作
- 从零开始编写自己的C#框架(1)——前言
- 从零开始编写自己的C#框架(3)——开发规范(转)
- 从零开始编写自己的C#框架(7)——需求分析
- 从零开始编写自己的C#框架(8)——后台管理系统功能设计
- 从零开始编写自己的C#框架(2)——开发前准备工作
- 从零开始编写自己的C#框架——框架学习补充说明
- 从零开始编写自己的C#框架(8)——后台管理系统功能设计
- 从零开始编写自己的C#框架(11)——创建解决方案