从零开始编写自己的C#框架(12)——T4模板在逻辑层中的应用(一)(附源码)
对于T4模板很多朋友都不太熟悉,它在项目开发中,会帮我们减轻很大的工作量,提升我们的开发效率,减少出错概率。所以学好T4模板的应用,对于开发人员来说是非常重要的。
园子里对于T4模板的介绍与资料已经太多了,所以在这里我就不再详细讲述基础知识了,只是说说T4模板在本框架中的具体应用与实践。
一、创建逻辑层项目
二、添加引用
将之前添加的三个项目添加到引用
三、创建T4模板放置的文件夹,并命名为SubSonic
四、将Solution.DataAccess项目中SubSonic文件夹下的MultipleOutputHelper.ttinclude、Settings.ttinclude、SQLServer.ttinclude以及项目根目录下的App.config四个文件复制到逻辑层对应的位置里,详见下图
五、SubSonic文件夹里创建Test.tt模板文件,用来练习T4模板的实践
六、编写T4模板实例,练习模板的使用
1、练习一
我们先添加几行代码
<#@ template language="C#" debug="false" hostspecific="True" #>
<#@ output extension=".cs" encoding="utf-8" #>
<#@ include file="SQLServer.ttinclude" #> using System; namespace <#=Namespace#> { }
<#@ template language="C#" debug="false" hostspecific="True" #>是T4模板指令,说明使用的语言是C#,不开启debug模式,并将名为 Host 的属性添加到由文本模板生成的类中
<#@ output extension=".cs" encoding="utf-8" #>是T4模板的输出指令,限制当前模板生成的文件扩展名为.cs,存储格式为utf-8
<#@ include file="SQLServer.ttinclude" #>这是模板的工具类文件,使用 Include 指令在其他文本模板中包含此文件,本行代码主要功能是将SQL操作的工具类(函数)包含到代码
using System; 这是输出在cs文件中显示的文本信息,具体功能大家一看就明白了,不再解释
namespace <#=Namespace#> 创建命名空间名称,因为SQLServer.ttinclude文件里使用了<#@ include file="Settings.ttinclude" #>,将SubSonic3.0模板的配置信息也同时读取了进来,所以可以直接使用Settings.ttinclude中设置的变量,用它来作为命名空间名称,详见下图
也就是说,如果你想在模板中使用一些你想要的变量的话,可以在这些工具类或配置文件中进行定义
点击保存后生成Test.cs文件内容:
2、练习二
通过练习一,我们明白了T4模板生成代码的简单原理,那么我们增加些实用的内容来看看模板运行的效果
先上代码
<#@ template debug="false" hostspecific="True" language="C#" #>
<#@ output extension=".cs" encoding="utf-8" #>
<#@ include file="SQLServer.ttinclude" #> using System; namespace <#=Namespace#> {
<#
var tables = LoadTables();
//遍历所有表
foreach(var tbl in tables){
#> public class <#=tbl.CleanName#>Table {
/// <summary>
/// 表名
/// </summary>
public static string TableName {
get{
return "<#=tbl.CleanName#>";
}
}
}
<#
}
#>
}
var tables = LoadTables(); LoadTables()是SQLServer.ttinclude工具类中的函数,功能是获取数据库中所有表和字段(已修改了该文件的代码,可以获取到所有表与视图)
foreach(var tbl in tables) 遍历所有表
<#=tbl.CleanName#> 读取表名称
public class <#=tbl.CleanName#>Table 用表名称+Table 做为类名
点击保存后生成Test.cs文件内容:
3、练习三
通过上面练习,我们可以看到使用很简单的几行代码,就可以非常方便的生成我们想要的代码,减少我们复制粘贴的操作,当然上面生成的东西太简单了,我们想通过本模板生成的类来减少强编码,那么就需要获取所有字段名称出来
<#@ template debug="false" hostspecific="True" language="C#" #>
<#@ output extension=".cs" encoding="utf-8" #>
<#@ include file="SQLServer.ttinclude" #> using System; namespace <#=Namespace#> {
<#
var tables = LoadTables();
//遍历所有表
foreach(var tbl in tables){
#> public class <#=tbl.CleanName#>Table {
/// <summary>
/// 表名
/// </summary>
public static string TableName {
get{
return "<#=tbl.CleanName#>";
}
} //新增代码,循环遍历表中的所有字段,创建相应的函数
<#
foreach(var col in tbl.Columns){
#>
/// <summary>
/// <#=Replace(col.Description) #>
/// </summary>
public static string <#= col.Name #>{
get{
return "<#= col.Name #>";
}
} <#
}
#> }
<#
}
#>
}
foreach(var col in tbl.Columns) 遍历表中所有字段,获取字段结构
<#=Replace(col.Description) #> 本代码中通过col.Description来获取字估注释,Replace函数是将字段注释(说明)里的换行符替换成对应格式
<#= col.Name #> 获取字段名称
点击保存后生成Test.cs文件内容:
4、练习四
用完上面的练习是不是感觉很简单呢。对于数据表比较少的情况下,这种生成是完全没有问题的,但表多了以后都放在一个文件里,在DEBUG调试时就会出问题了,主要原因是代码行数过大,所以我们有另外一种解决办法,就是分文件生成
先上代码(为了让大家更好的理解,会将前面例子中的一些内容删除掉)
<#@ 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+".cs");
#>
using System; namespace <#=Namespace#> { } <#
// 输出文件结束
manager.EndBlock();
} //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件
manager.Process(true);
#>
<#@ include file="MultipleOutputHelper.ttinclude"#> 生成多文件工具类
var manager = Manager.Create(Host, GenerationEnvironment); 创建多文件生成实体
foreach(var tbl in tables) 遍历所有表,这个放在using的前面,是因为每个单独文件生成后都需要有using
其他新增内容在代码中都有详细注释了,所以这里不再说明
点击保存后生成Test.cs文件内容:
再来个完整的模板代码
<#@ 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+".cs");
#>
using System; namespace <#=Namespace#> { public class <#=tbl.CleanName#>Table {
/// <summary>
/// 表名
/// </summary>
public static string TableName {
get{
return "<#=tbl.CleanName#>";
}
} <#
foreach(var col in tbl.Columns){
#>
/// <summary>
/// <#=Replace(col.Description) #>
/// </summary>
public static string <#= col.Name #>{
get{
return "<#= col.Name #>";
}
} <#
}
#>
} } <#
// 输出文件结束
manager.EndBlock();
} //if(!ExcludeTables.Contains(tbl.Name)) 判断结束 }// end foreach // 执行编译,生成文件
manager.Process(true);
#>
点击保存后生成Test.cs文件内容:
下载地址:
版权声明:
本文由AllEmpty原创并发布于博客园,欢迎转载,未经本人同意必须保留此段声明,且在文章页面明显位置给出原文链接,否则保留追究法律责任的权利。如有问题,可以通过1654937@qq.com 联系我,非常感谢。
发表本编内容,只要主为了和大家共同学习共同进步,有兴趣的朋友可以加加Q群:327360708 ,大家一起探讨。
更多内容,敬请观注博客:http://www.cnblogs.com/EmptyFS/
从零开始编写自己的C#框架(12)——T4模板在逻辑层中的应用(一)(附源码)的更多相关文章
- 从零开始编写自己的C#框架(14)——T4模板在逻辑层中的应用(三)
原本关于T4模板原想分5个章节详细解说的,不过因为最近比较忙,也不想将整个系列时间拉得太长,所以就将它们整合在一块了,可能会有很多细节没有讲到,希望大家自己对着代码与模板去研究. 本章代码量会比较大, ...
- 从零开始编写自己的C#框架(13)——T4模板在逻辑层中的应用(二)
最近这段时间特忙,公事私事,忙得有时都没时间打开电脑了,这两周只能尽量更新,以后再将章节补回来. 直接进入主题,通过上一章节,大家明白了怎么使用模板类编写T4模板,本章进的是一些简单技巧的应用 1.首 ...
- 手把手教你基于SqlSugar4编写一个可视化代码生成器(生成实体,以SqlServer为例,文末附源码)
在开发过程中免不了创建实体类,字段少的表可以手动编写,但是字段多还用手动创建的话不免有些浪费时间,假如一张表有100多个字段,手写有些不现实. 这时我们会借助一些工具,如:动软代码生成器.各种ORM框 ...
- 从零开始编写自己的C#框架(1)——前言
记得十五年前自学编程时,拿着C语言厚厚的书,想要上机都不知道要用什么编译器来执行书中的例子.十二年前在大学自学ASP时,由于身边没有一位同学和朋友学习这种语言,也只能整天混在图收馆里拼命的啃书.而再后 ...
- 从零开始编写自己的C#框架 ---- 系列文章
目录: 从零开始编写自己的C#框架(1)——前言从零开始编写自己的C#框架(2)——开发前的准备工作从零开始编写自己的C#框架(3)——开发规范从零开始编写自己的C#框架(4)——文档编写说明从零开始 ...
- 从零开始编写自己的C#框架(17)——Web层后端首页
后端首页是管理员登陆后进入的第一个页面,主要是显示当前登陆用户信息.在线人数.菜单树列表.相关功能按键和系统介绍.让管理员能更方便的找到息想要的内容. 根据不同系统的需要,首页会显示不同的内容,比如显 ...
- 从零开始编写自己的C#框架(26)——小结
一直想写个总结,不过实在太忙了,所以一直拖啊拖啊,拖到现在,不过也好,有了这段时间的沉淀,发现自己又有了小小的进步.哈哈...... 原想框架开发的相关开发步骤.文档.代码.功能.部署等都简单的讲过了 ...
- 从零开始编写自己的C#框架(25)——网站部署
导航 1.关掉访问保护 2.发布网站 3.复制网站到服务器 4.添加新网站 5.设置网站访问权限 6.设置文件夹访问权限 7.控制可更新文件夹执行权限 8.设置“应用程序池”.net版本与模式 9.附 ...
- 从零开始编写自己的C#框架(15)——Web层后端登陆功能
对于一个后端管理系统,最重要内容之一的就是登陆页了,无论是安全验证.用户在线记录.相关日志记录.单用户或多用户使用帐号控制等,都是在这个页面进行处理的. 1.在解决方案中创建一个Web项目,并将它设置 ...
随机推荐
- Spark踩坑记——Spark Streaming+Kafka
[TOC] 前言 在WeTest舆情项目中,需要对每天千万级的游戏评论信息进行词频统计,在生产者一端,我们将数据按照每天的拉取时间存入了Kafka当中,而在消费者一端,我们利用了spark strea ...
- Java初始化过程
这篇文章主要讲解Java在创建对象的时候,初始化的顺序.主要从以下几个例子中讲解: 继承关系中初始化顺序 初始化块与构造器的顺序 已经加载过的类的初始化顺序 加载父类,会不会加载子类 创建子类对象会不 ...
- Python标准模块--Unicode
1 模块简介 Python 3中最大的变化之一就是删除了Unicode类型.在Python 2中,有str类型和unicode类型,例如, Python 2.7.6 (default, Oct 26 ...
- [原] Cgroup CPU, Blkio 测试
关于Cgroup的简单测试 [toc] 简单介绍Cgroup (如果对cgroup熟悉可以忽略) 一般情况下,cgroup挂载到一个虚拟文件目录,然后可以通过文件系统的API对其操作. ># m ...
- 张小龙宣布微信小程序1月9日发布,并回答了大家最关心的8个问题
2016 年 12 月 28 日,张小龙在微信公开课 PRO 版的会场上,宣布了微信小程序的正式发布时间. 微信小程序将于 2017 年 1 月 9 号正式上线. 同时他解释称,小程序就像PC时代的网 ...
- BPM Domino集成解决方案
一.需求分析 Lotus Notes/Domino是IBM的协同办公平台,在国内有广泛的用户. 但由于推出年头较早.采用文档数据库等特点, 导致其流程集成能力弱.统计分析难.不支持移动办公等问题,很多 ...
- GitHub管理代码-随笔
公司一直用的SVN进行项目管理,平时便自己折腾了下Git,这里做下GitHub的最简单的记录... 在git上创建仓库等就免谈了,网上也有好多教程,直接从创建之后记录: 在github的readme文 ...
- Atitit.研发团队的管理原则---立长不立贤与按资排辈原则
Atitit.研发团队的管理原则---立长不立贤与按资排辈原则 1. 组织任命原则概述1 2. 历史的角度看,大部分组织使用的立长不立贤原则1 3. 论资排辈 立长不立贤原则1 3.1. 资格和辈分是 ...
- MySQL数据库罕见的BUG——Can't get hostname for your address
在连接mysql jdbc时候,抛出了 com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException: Communicat ...
- MySQL常见面试题
1. 主键 超键 候选键 外键 主 键: 数据库表中对储存数据对象予以唯一和完整标识的数据列或属性的组合.一个数据列只能有一个主键,且主键的取值不能缺失,即不能为空值(Null). 超 键: 在关系中 ...