分享改进彻底定制本身的代码生成器

时间 2019-11-07

标签分享改进彻底定制本身代码成器繁體版

原文原文链接

codesmith确实是款不错的工具可是它并不开源对于一些有本身特殊需求的用户只能本身另想其余解决方案例如我说想作一个web版本的代码生成器或者说用户没有c#基础git

这里开源一个以前作过的工具当初的目的主要是解决在框架当中局部更新的问题
由于在大部分orm框架当中都是简单的获取一个实体而后这个实体某个值而后更新的时候仍是传入这个改变的实体不过严格意义上来讲在你传入更新实体的时候它的其余字段说不定已经被其余请求更新过了因此致使你的此次更新会覆盖掉别人的更新固然也会有同一字段的问题不过这里不深刻讨论该问题重点在代码生成上github

另一个意义就是让你们了解一下通常的代码生成器的工做流程以及实现方法web

Github地址 https://github.com/dubing/CodePorter数据库

使用方法很简单先输入数据库链接字符串下面会出现table和view，固然本身能够根据源代码加载更多的内容c#

我程序里主要生成实体层和数据处理层因此我提供了2个文本框一个是实体层的命名空间一个是数据处理层的命名的命名空间，这样就不用在模板里设置，能够在win界面或者web界面直接修改框架

选择好表和view而且设置好命名空间后点击启动左下角提示成功后就能够打开目录查看本身生成的文件ide

生成的实体文件工具

这里的PartiallyColumnAttribute主要就是用来解决局部更新问题，和代码生成自己无关联。学习

DA文件ui

    //------------------------------------
    //用途：表LitespeedActivity的数据处理类（工具自动生成）
    //做者：杜兵
    //时间：2015-03-11 05:43:32
    //-------------------------------------

    using System;
    using System.Data;
    using System.Data.Common;
    using Model.Service;
    using Ctrip.TMPay.Framework.Common;
    using Ctrip.TMPay.DataAccess.Common;

    namespace DataAccess.Service
    {
        public partial class LitespeedActivityDA : BaseDA<LitespeedActivityDA>
        {
            
            /// <summary>
            /// 根据主键获取LitespeedActivity
            ///</summary>
            ///< param name="serverName"></param>
            ///< returns></returns>
            public LitespeedActivityEntity GetLitespeedActivity(String serverName)
            {
                DbCommand dbCmd = DbObject.GetSqlStringCommand(SqlCommandConstants.LitespeedActivitySelectCommand);
                DbObject.AddInParameter(dbCmd, "@ServerName", DbType.String, serverName);
                LitespeedActivityEntity litespeedActivityEntity = null;
                using (IDataReader dataReader = DbObject.ExecuteReader(dbCmd))
                {
                    if (dataReader.Read())
                    {
                          litespeedActivityEntity = new LitespeedActivityEntity{
                              ServerName = DbFieldHelper.GetString(dataReader, "ServerName"),
                              ActivityID = DbFieldHelper.GetInt32(dataReader, "ActivityID"),
                              DatabaseID = DbFieldHelper.GetInt32(dataReader, "DatabaseID"),
                              ActivityTypeID = DbFieldHelper.GetInt32(dataReader, "ActivityTypeID"),
                              StartTime = DbFieldHelper.GetDateTime(dataReader, "StartTime"),
                              FinishTime = DbFieldHelper.GetDateTime(dataReader, "FinishTime"),
                              StatusTypeID = DbFieldHelper.GetInt32(dataReader, "StatusTypeID"),
                              DatabaseSize = DbFieldHelper.GetDouble(dataReader, "DatabaseSize"),
                              PercentCompleted = DbFieldHelper.GetInt32(dataReader, "PercentCompleted"),
                              ActivityDetail = DbFieldHelper.GetString(dataReader, "ActivityDetail"),
                              ErrorMessage = DbFieldHelper.GetString(dataReader, "ErrorMessage"),
                              ResultMessage = DbFieldHelper.GetString(dataReader, "ResultMessage"),
                              ReplicateID = DbFieldHelper.GetGuid(dataReader, "ReplicateID"),
                              LS = DbFieldHelper.GetByte(dataReader, "LS"),
                              PID = DbFieldHelper.GetInt32(dataReader, "PID"),
                              NativeSize = DbFieldHelper.GetDouble(dataReader, "NativeSize"),
                              BackupSize = DbFieldHelper.GetDouble(dataReader, "BackupSize"),
                              BackupTime = DbFieldHelper.GetDouble(dataReader, "BackupTime"),
                              AttachedNativeSize = DbFieldHelper.GetDouble(dataReader, "AttachedNativeSize"),
                              AttachedBackupSize = DbFieldHelper.GetDouble(dataReader, "AttachedBackupSize"),
                              AttachedBackupTime = DbFieldHelper.GetDouble(dataReader, "AttachedBackupTime"),
                              
                          };
                     }
                 }
                 return litespeedActivityEntity;
             }   
    
            /// <summary>
            /// 根据主键获取LitespeedActivity
            ///</summary>
            ///< param name="activityID"></param>
            ///< returns></returns>
            public LitespeedActivityEntity GetLitespeedActivity(Int32 activityID)
            {
                DbCommand dbCmd = DbObject.GetSqlStringCommand(SqlCommandConstants.LitespeedActivitySelectCommand);
                DbObject.AddInParameter(dbCmd, "@ActivityID", DbType.Int32, activityID);
                LitespeedActivityEntity litespeedActivityEntity = null;
                using (IDataReader dataReader = DbObject.ExecuteReader(dbCmd))
                {
                    if (dataReader.Read())
                    {
                          litespeedActivityEntity = new LitespeedActivityEntity{
                              ServerName = DbFieldHelper.GetString(dataReader, "ServerName"),
                              ActivityID = DbFieldHelper.GetInt32(dataReader, "ActivityID"),
                              DatabaseID = DbFieldHelper.GetInt32(dataReader, "DatabaseID"),
                              ActivityTypeID = DbFieldHelper.GetInt32(dataReader, "ActivityTypeID"),
                              StartTime = DbFieldHelper.GetDateTime(dataReader, "StartTime"),
                              FinishTime = DbFieldHelper.GetDateTime(dataReader, "FinishTime"),
                              StatusTypeID = DbFieldHelper.GetInt32(dataReader, "StatusTypeID"),
                              DatabaseSize = DbFieldHelper.GetDouble(dataReader, "DatabaseSize"),
                              PercentCompleted = DbFieldHelper.GetInt32(dataReader, "PercentCompleted"),
                              ActivityDetail = DbFieldHelper.GetString(dataReader, "ActivityDetail"),
                              ErrorMessage = DbFieldHelper.GetString(dataReader, "ErrorMessage"),
                              ResultMessage = DbFieldHelper.GetString(dataReader, "ResultMessage"),
                              ReplicateID = DbFieldHelper.GetGuid(dataReader, "ReplicateID"),
                              LS = DbFieldHelper.GetByte(dataReader, "LS"),
                              PID = DbFieldHelper.GetInt32(dataReader, "PID"),
                              NativeSize = DbFieldHelper.GetDouble(dataReader, "NativeSize"),
                              BackupSize = DbFieldHelper.GetDouble(dataReader, "BackupSize"),
                              BackupTime = DbFieldHelper.GetDouble(dataReader, "BackupTime"),
                              AttachedNativeSize = DbFieldHelper.GetDouble(dataReader, "AttachedNativeSize"),
                              AttachedBackupSize = DbFieldHelper.GetDouble(dataReader, "AttachedBackupSize"),
                              AttachedBackupTime = DbFieldHelper.GetDouble(dataReader, "AttachedBackupTime"),
                              
                          };
                     }
                 }
                 return litespeedActivityEntity;
             }   
    
            /// <summary>
            /// 全参数更新LitespeedActivity
            ///</summary>
            ///< param name="litespeedActivityEntity">LitespeedActivityEntity</param>
            ///< returns></returns>
            public BizResult<string> UpdateLitespeedActivity(LitespeedActivityEntity litespeedActivityEntity)
            {
                FillParams(litespeedActivityEntity);
                return PartiallyUpdateLitespeedActivity(litespeedActivityEntity);
            }    
    
            /// <summary>
            /// 部分参数更新LitespeedActivity
            ///</summary>
            ///< param name="litespeedActivityEntity">LitespeedActivityEntity</param>
            ///< returns></returns>
            public BizResult<string> PartiallyUpdateLitespeedActivity(LitespeedActivityEntity litespeedActivityEntity)
            {              
                 return ExecuteSP(SqlProcedureConstants.LitespeedActivityUpdateSpName, CheckUpdate, litespeedActivityEntity);
            }   
            
            /// <summary>
            /// 建立LitespeedActivity
            ///</summary>
            ///< param name="litespeedActivityEntity">LitespeedActivityEntity</param>
            ///< returns></returns>
            public BizResult<string> CreateLitespeedActivity(LitespeedActivityEntity litespeedActivityEntity)
            {
                 FillParams(litespeedActivityEntity);
                 return ExecuteSP(SqlProcedureConstants.LitespeedActivityInsertSpName, null, litespeedActivityEntity);
            }  
            
            /// <summary>
            /// 删除LitespeedActivity
            ///</summary>
            ///< param name="litespeedActivityEntity">LitespeedActivityEntity</param>
            ///< returns></returns>
            public BizResult<string> DeleteLitespeedActivity(LitespeedActivityEntity litespeedActivityEntity)
            {
                 FillPKParams(litespeedActivityEntity);
                 return ExecuteSP(SqlProcedureConstants.LitespeedActivityDeleteSpName, null, litespeedActivityEntity);
            }  
       }
    }

还有其余的一些文件就不一一列出了

原理很简单也是根据模板。不过和codesmith不一样的是我这里用的是xsl模板包括语法

基于xml的语法并不难就算不懂.net的人学习半个小时也能够本身定制模板了

举个例子

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output encoding="utf-8" method="text" indent="no"/>
  <xsl:variable name="BaseName" select="/DocumentElement/@BaseName"/>
  <xsl:variable name="BaseDbObject" select="/DocumentElement/@BaseDbObject"/>
  <xsl:variable name="DefaultNamespace" select="/DocumentElement/@DefaultNamespace"/>
  <xsl:variable name="DateTime" select="/DocumentElement/@DateTime"/>
  <xsl:variable name="SchemaTable" select="/DocumentElement/SchemaTable[translate(IsHidden,'TRUE','true')!='true']"/>
  <xsl:variable name="TableClassName">
    <xsl:value-of select="$BaseName"/>Table
  </xsl:variable>
  <xsl:template match="/">    //------------------------------------
    //用途：表<xsl:value-of select="$BaseDbObject"/>的实体类（工具自动生成）
    //做者：杜兵 
    //时间：<xsl:value-of select="$DateTime"/>
    //-------------------------------------

    using System;
    using System.Data;

    namespace <xsl:value-of select="$DefaultNamespace"/>
    {
        [Serializable]
        public partial class <xsl:value-of select="$BaseName"/>Entity : BaseEntity
        {<xsl:for-each select="$SchemaTable">  
          <xsl:variable name="PublicPropertyName">
            <xsl:value-of select="PropertyName"/>
          </xsl:variable>    
          <xsl:variable name="ShortDataType">
            <xsl:choose>
              <xsl:when test="ProviderDataType='System.Data.SqlTypes.SqlXml'">System.Xml.Linq.XElement</xsl:when>
              <xsl:otherwise>
                <xsl:value-of select="ShortDataType"/>
              </xsl:otherwise>
            </xsl:choose>
          </xsl:variable>
          <xsl:variable name="DbDataType">
            <xsl:choose>
              <xsl:when test="ProviderTypeName='SqlDbType.Timestamp'">rowversion</xsl:when>
              <xsl:when test="ProviderTypeName='SqlDbType.Variant'">Variant</xsl:when>
              <xsl:otherwise>
                <xsl:value-of select="DataTypeFullName"/>
              </xsl:otherwise>
            </xsl:choose>
          </xsl:variable>
          <xsl:variable name="Description">
            <xsl:value-of select="Description"/>
          </xsl:variable><xsl:variable name="DbType">
          <xsl:value-of select="DBDataTypeFullName"/>
        </xsl:variable>
          /// <summary>
          /// <xsl:value-of select="$Description"/>
          ///</summary>       
          [PartiallyColumnAttribute(DbType = <xsl:value-of select="$DbType"/> <xsl:choose><xsl:when test="AllowDBNull='false'">, CanBeNull = false</xsl:when><xsl:otherwise>, CanBeNull = true</xsl:otherwise></xsl:choose><xsl:if test="IsKey='true'">, IsPrimaryKey = true</xsl:if>)]
          public <xsl:value-of select="$ShortDataType"/><xsl:text> </xsl:text><xsl:value-of select="$PublicPropertyName"/> {  get; set; }</xsl:for-each> 
        }
    }
  </xsl:template>
</xsl:stylesheet>

　　这里代码里模板实现主要是解决局部更新的功能，你们能够根据本身不一样的需求来修改部分逻辑。

　　核心的配置文件在config下CodeSet.xml

　　主要的配置节点以下

  <generatorSettings>
    <ConstantsGenerator>
      <add key="DataSourceType" value="CodePorter.Core.DbTableSource"/>
      <add key="XslTemplate" value="CodePorter.Templates.SqlConstantsTemplate.xsl"/>
      <add key="TargetFile" value=".\Repository\SqlConstants.cs"/>
      <add key="BeginRegion" value="#region select command,#region sp name"/>
      <add key="EndRegion" value="#endregion,#endregion"/>
    </ConstantsGenerator>
    <BaseDbEntityGenerator>
      <add key="DataSourceType" value="CodePorter.Core.DbTableSource"/>
      <add key="XslTemplate" value="CodePorter.Templates.BaseDbEntityTemplate.xsl"/>
      <add key="TargetFile" value=".\Entity\BaseEntity.cs"/>
    </BaseDbEntityGenerator>
    <DbEntityGenerator>
      <add key="DataSourceType" value="CodePorter.Core.DbTableSource"/>
      <add key="XslTemplate" value="CodePorter.Templates.DbEntityTemplate.xsl"/>
      <add key="TargetFile" value=".\Entity\%BASENAME%Entity.cs"/>
    </DbEntityGenerator>
    <BaseDAGenerator>
      <add key="DataSourceType" value="CodePorter.Core.DbTableSource"/>
      <add key="XslTemplate" value="CodePorter.Templates.BaseDATemplate.xsl"/>
      <add key="TargetFile" value=".\Repository\BaseDA.cs"/>
    </BaseDAGenerator>
    <DAGenerator>
      <add key="DataSourceType" value="CodePorter.Core.DbTableSource"/>
      <add key="XslTemplate" value="CodePorter.Templates.DATemplate.xsl"/>
      <add key="TargetFile" value=".\Repository\%BASENAME%DA.cs"/>
    </DAGenerator>
  </generatorSettings>

　　细节比较多，可是经过源代码你们应该理解都没有问题，若是有不清楚的地方能够给我留言。后续会放出更多之前作过的工具。

但愿对你们有帮助。

分享改进 彻底定制本身的代码生成器

分享改进彻底定制本身的代码生成器