详解C#代码文件生成扩展代码文件

开发 后端
本文着重讲解用C#代码文件生成扩展代码文件,并且详细讲了在数据持久层里是采用XML结合IVsSingleFileGenerator来生成相关实体类的方法。

看到这标题的朋友可能搞不懂到底在搞什么,不过不要紧有兴趣的朋友可以先了解一下IVsSingleFileGenerator到底是用来做什么用的《实现自定义的VsSingleFileGenerator 》;在vs.net里提供一个IVsSingleFileGenerator接口可以方便地为项目文件生成附属文件,如刚才那文章提到的根据XML文件自动生成一个附属的C#代码文件;当然这个IVsSingleFileGenerator并不只是针对XML文件,可以是随便为任何项目文件生成附属文件你只要在文件属性中设置相关Custom Tools就可以了.

为什么在这里我提出在代码文件的基础上再生相关的代码附属文件呢,为什么不直接在原代码文件写完整就可以了;原因很简单因为手写代码是没有电脑来得快,最主要一个原因是基于XML的IVsSingleFileGenerator在某方面不好所以才采用基于代码文件的方式作为代码描述模板.用XML描述在现情况碰到的问题,在我的数据持久层里是采用XML结合IVsSingleFileGenerator来生成相关实体类的.

内容大概如下:


<SmarkDatamodels xmlns="http://SmarkData.cn/model.xsd" >
<Class Name="Customer" Table="vp_Customer">
<ID Name="CustomerID" Type="System.Int64"/>
<Property Name="UserName" Type="System.String" Comment="用户名"/>
<Property Name="UserPWD" Type="System.String" Comment="用户密码"/>
<Property Name="CustomerType" Type="System.Int32" Comment="客户类型"/>
<Property Name="CustomerName" Type="System.String" Comment="自定义名"/>
<Property Name="Sex" Type="System.Boolean" Comment="性别"/>
<Property Name="Region" Type="System.String" Comment="地区"/>
<Property Name="City" Type="System.String" Comment="城市"/>
<Property Name="IDCard" Type="System.String" Comment="身份证号"/>
<Property Name="EMail" Type="System.String" Comment="电子邮件"/>
<Property Name="Phone" Type="System.String" Comment="电话"/>
</Class>
</SmarkDatamodels>
VsSingleFileGenerator会根据XML生成以下相关实体:
/// <summary>
/// 用户名
/// </summary>
public virtual string UserName {
get {
return this.mUserName;
}
set {
this.mUserName = value;
this.EntityState.FieldChange("UserName");
}
}
/// <summary>
/// 用户密码
/// </summary>
public virtual string UserPWD {
get {
return this.mUserPWD;
}
set {
this.mUserPWD = value;
this.EntityState.FieldChange("UserPWD");
}
}
/// <summary>
/// 客户类型
/// </summary>
public virtual int CustomerType {
get {
return this.mCustomerType;
}
set {
this.mCustomerType = value;
this.EntityState.FieldChange("CustomerType");
}
}

VsSingleFileGenerator有个不好的地方就是当主文件修改后会重新生成附属文件,这样就导致你无法修改代码文件.如果想为某些属性成员添加Attribute来处理一些功能基本是没办法的.

如添加成员数据验证:

[NotNull]
[Length("5","16","用户名长度必须在5-16个字符内!")]
public string UserName
{
get;
set;
}

即使能解决VsSingleFileGenerator生成附属文件冲突问题;但也要面对另一个问题,就如何扩展XML来处理这些扩展呢,添加XMLSchema扩展描述规则,重写VsSingleFileGenerator代码生成部份;这样下来没多久我估计自己会疯了....

实际情况添加不同Attribute来扩展辅助功能是很常见的事情,就一个验证来说根据实际情况就有很多情况,类构造方式也不一样.就针对这些情况来扩展XMLSchema和重写VsSingleFileGenerator带来的工作量就不用说了,还有一个问题就是XML并不能提供类型编译的保证这样对XML的质量是很难保证.

经过了一段时间的思考发现为什么不直接用代码作为原模板呢,这样就能得到IDE的支持,强在编译器的支持下保证类型输入规则的有效性.以下是本人实现的简单生成模型:

[Table]
interface IUser
{
[ID]
string UserName { get; set; }
string BirthDate { get; set; }
string Region { get; set; }
string Remark { get; set; }
}

生成的相关代码

[Table]
[Serializable]
public class User:Smark.Data.Mappings.DataObject
{
[ID]
public string UserName { get{ return mUserName;}
set{mUserName=value;EntityState.FieldChange("UserName");} }
private string mUserName;
public static Smark.Data.FieldInfo userName = new Smark.Data.FieldInfo("User","UserName");
public string BirthDate { get{ return mBirthDate;}
set{mBirthDate=value;EntityState.FieldChange("BirthDate");} } 
private string mBirthDate;
public string Region { get{ return mRegion;}
set{mRegion=value;EntityState.FieldChange("Region");} }
private string mRegion;
public string Remark { get{ return mRemark;}
set{mRemark=value;EntityState.FieldChange("Remark");} }
private string mRemark;
}
}

这样的话即使我们如何给属性添加Attribute都不会带来代码上的修改,VsSingleFileGenerator只对属性作一个模板生成其他内容搬过来就可以了:)

WPS的排版真是没有WORD的好...估计我不会用.

【编辑推荐】

  1. C#在WinForm开发中Label换行方法
  2. C#中使用多线程访问Winform问题解决方案
  3. 如何使用C#代码实现DataTemplate
责任编辑:彭凡 来源: cnblogs
相关推荐

2009-09-02 14:06:14

C#文件传送

2009-08-18 13:35:06

C#枚举文件

2009-08-12 18:29:06

C#读取TXT文件

2009-09-02 17:12:06

C#关机代码

2009-09-01 10:37:51

C#项目代码C#代码规范

2009-09-07 06:48:13

C#透明窗体

2009-08-24 18:06:36

源程序代码C#读取XML文件

2009-08-13 09:34:55

C#读写ini文件

2009-08-18 17:05:08

C#操作xml文件

2009-08-28 14:34:47

C# Global.a

2009-08-13 09:58:55

C#读取配置文件

2009-09-01 11:25:08

C#读取Word文件

2009-08-24 15:58:00

Visual C#生成

2023-09-04 11:46:09

C#动态代码

2016-12-30 09:23:06

Linux代码文件

2011-08-24 17:15:33

Lua源代码文件

2009-07-17 17:11:47

Ruby生成JVM代码

2009-08-26 11:53:56

C#打印文本文件

2009-09-01 16:49:56

C#文件上传下载

2009-09-01 18:35:53

C#判断文件存在
点赞
收藏

51CTO技术栈公众号