.NET Core自定义项目模板的全过程
前言:
前面介绍 自定义项目模板 中介绍了一种简单的方式——通过创建项目导出为项目模板方式实现。本次将采用dotenet cil(手脚架)来创建项目模板。
那么,我们首先看下当前dotnet 支持的项目模板:
可以看到当前dotnet中已经提供了很多模板项目,那么如何根据项目开发的积累内容通过dotnet cli创建一个自己的项目来提升开发效率呢?
1、实现自定义项目模板
自定义模板项目模板肯定就需要模板实现,本次就使用使用之前文章中项目结构作为模板项目来实现自定义项目模板
接下跟着步骤来创建模板项目
创建模板配置文件
在项目根文件夹中创建文件夹:.template.config 并在目录下创建 template.json。如下图:
定义项目模板相关信息
修改template.json内容为以下内容:
{ "author": "cwsheng", //必须 "classifications": [ "Web/WebAPI" ], //必须,这个对应模板的Tags "name": "ApiTmp", //必须,这个对应模板的Templates "identity": "ApiTemplate", //可选,模板的唯一名称 "shortName": "apitmp", //必须,这个对应模板的Short Name "tags": { "language": "C#" , "type":"project" }, "sourceName": "ApiTemplate", // 可选,要替换的名字 "preferNameDirectory": true // 可选,添加目录 }
注意:shortName和sourceName
- author:模板作者
- classifications:模板特征标识。上文举例的配置是因为我自定义的模板包括了console和webapi。
- identity:此模板的唯一名称
- name:用户看到的模板名称
- shortName:短名称。当使用CLI命令创建模板项目时,使用短名称将利于使用。
- sourceName:模板替换的关键文本,使用时需要注意,要选择合适的替换文本,不然容易误伤代码。
项目模板安装
接下来进入项目目录,将这个模板安装到cli中。使用dotnet new -i
进行模板的安装。
dotnew new -i TempDemo
卸载项目模板:
dotnet new -u 模板目录
使用命令创建项目:
dotnet new apiTmp -n Test -o .
apiTmp:是模板配置文件中指定的shortName。
-n:指定的是将项目中出现的所有文本MyJob
替换为Test
,因为配置中sourceName是ApiTemplate,可按需配置。
-o:指定的是生成项目输出目录,上述命令生成项目输出到当前目录。
结果如下图:
此通过dotnet cli创建项目模板已完成,但仅仅这样完全不能满足日常工作需求。
如:A项目需要日志记录,但B项目不需要日志记录;A项目需要制定PG数据库作为存储方式,B项目需要制定MySQL作为存储方式。
那么这些问题能否在项目创建时根据设置而满足项目需求呢?
2、模板项目进阶用法
文件过滤:根据参数过滤制定文件和代码内容
a) 定义参数:在template.json中添加以下内容:EnableAuditLog-参数名称
{ //…… "symbols": { //是否使用审计日志功能 "EnableAuditLog": { "type": "parameter", //它是参数 "dataType": "bool", //bool类型的参数 "defaultValue": "false" //默认是不启用 } }, "sources": [ { "modifiers": [ { "condition": "(!EnableAuditLog)", //条件,由EnableAuditLog参数决定 "exclude": [ //排除下面的文件 "AuditLogDemo/Fliters/AuditLogActionFilter.cs" ] } ] } ] }
b) 取消审计日志生效位置:
c) 重新生成模板,查看当前模板支持的参数:
d) 创建项目检查设置是否生效:
选择执行:根据变量值选择程序集引用
a) 添加参数:DbType指定选项数据库类型
"symbols": { //数据源类型"DbType": { "type": "parameter", //它是参数 "datatype": "choice", //选项类型 "choices": [ //选项取值 { "choice": "MsSQL", "description": "MS SQL Server" }, { "choice": "MySQL", "description": "MySQL" }, { "choice": "PgSQL", "description": "PostgreSQL" }, { "choice": "SQLite", "description": "SQLite" }, { "choice": "None", "description": "None" } ], "defaultValue": "None", "description": "The type of SQL to use" }, "MsSQL": { "type": "computed", "value": "(DbType == \"MsSQL\")" }, "MySQL": { "type": "computed", "value": "(DbType == \"MySQL\")" }, "PgSQL": { "type": "computed", "value": "(DbType == \"PgSQL\")" }, "SQLite": { "type": "computed", "value": "(DbType == \"SQLite\")" }, "None": { "type": "computed", "value": "(DbType == \"None\")" } }
b) 修改项目文件:根据条件选择对应程序集
<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <TargetFramework>netcoreapp3.1</TargetFramework> </PropertyGroup> <ItemGroup Condition="'$(None)'!='True'"> <PackageReference Include="Microsoft.EntityFrameworkCore" Version="3.1.8" /> </ItemGroup> <ItemGroup Condition="'$(SQLite)' == 'True'"> <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="3.1.8" /> </ItemGroup> <ItemGroup Condition="'$(MsSQL)' == 'True'"> <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.8" /> </ItemGroup> <ItemGroup Condition="'$(PgSQL)' == 'True'"> <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="3.1.4" /> </ItemGroup> </Project>
c) 使用数据库处,同步处理
#if (!None) //审计日志存储 services.AddDbContext<AuditLogDBContent>(options => { string conn = Configuration.GetConnectionString("LogDB"); #if Sqlite options.UseSqlite(conn, options => { options.MigrationsAssembly("AuditLogDemo"); }); #endif #if PgSQL options.UseNpgsql(conn); #endif #if MsSQL options.UseSqlServer(conn); #endif }); #endif
d) 更新模板后,查看已生成了对应参数
e) 创建项目查看生效情况:
//不使用数据库 dotnet new apiTmp -n AA -D None //使用PG数据库 dotnet new apiTmp -n BB -D PgSQL
可以看到项目引用和程序代码都根据传入参数生成了。
3、项目模板打包发布
好东西当然不能只给自己使用,而应该怎么将生成的模板给大家使用呢?——Nuget 包发布
a)在模板根目录创建一个nuspec文件:apiTmp.nuspec
<?xml version="1.0" encoding="utf-8"?> <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd"> <metadata> <id>apiTmp</id> <version>1.0.0</version> <description> WebApi Template </description> <authors>cwshegn</authors> <packageTypes> <packageType name="Template" /> </packageTypes> </metadata> </package>
b)使用Nuget Pack 命令打包
nuget pack apiTmp.nuspec -OutputDirectory .
c) 发布到nuget服务,给小伙伴们下载使用
总结:
通过dotnet cli 创建的模板项目,能更方便的根据项目需求生成对应的项目结构,提升开发效率。
可以动手把积累的好项目打包成一个模板项目给小伙伴们使用
参考:
https://devblogs.microsoft.com/dotnet/how-to-create-your-own-templates-for-dotnet-new/
https://github.com/dotnet/dotnet-template-samples
https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new
https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools
到此这篇关于.NET Core自定义项目模板的文章就介绍到这了,更多相关.NET Core自定义项目模板内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 这篇文章主要为大家详细介绍了ASP.NET购物车的实现过程,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-22
- 这篇文章主要介绍了.NET Core下使用Kafka的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 这篇文章主要给大家介绍了关于C#创建自定义控件及添加自定义属性和事件使用的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用C#具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧...2020-06-25
- 在开发过程中,使用Visual Studio的断点调试功能可以很方便帮我们调试发现程序存在的错误,同样Visual Studio也支持对SQL Server里面的存储过程进行调试,下面就让我们看看具体的调试方法。...2021-09-22
- 本文实例讲述了JS实现自定义简单网页软键盘效果。分享给大家供大家参考,具体如下:这是一款自定义的简单点的网页软键盘,没有使用任何控件,仅是为了练习JavaScript编写水平,安全性方面没有过多考虑,有顾虑的可以不用,目的是学...2015-11-08
- 这篇文章主要介绍了Win10 IIS 安装及.net 4.5及Win10安装IIS并配置ASP.NET 4.0的方法,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了Vue 组件复用多次自定义参数操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-27
- 为了增强android应用的用户体验,我们可以在一些Button按钮上自定义动态的设置一些样式,比如交互时改变字体、颜色、背景图等。 今天来看一个通过重写Button来动态实...2016-09-20
- 下面我们来看一篇关于Android自定义WebView网络视频播放控件开发例子,这个文章写得非常的不错下面给各位共享一下吧。 因为业务需要,以下代码均以Youtube网站在线视...2016-10-02
- 这篇文章主要介绍了详解.NET Core 3.0 里新的JSON API,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 自定义一个jquery模态窗口插件,将它集成到现有平台框架中时,它只能在mainFrame窗口中显示,无法在顶层窗口显示. 解决这个问题的办法: 通过以下代码就可能实现在顶层窗口弹窗 复制代码 代码如下: $(window.top.documen...2014-05-31
- 这篇文章主要介绍了自定义feignClient的常见坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-20
- 今天小编就为大家分享一篇pytorch 自定义卷积核进行卷积操作方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-05-06
- 这篇文章主要介绍了.net数据库操作框架SqlSugar的简单入门,帮助大家更好的理解和学习使用.net技术,感兴趣的朋友可以了解下...2021-09-22
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
这篇文章主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22- 这篇文章主要介绍了记一次EFCore类型转换错误及解决方案,帮助大家更好的理解和学习使用asp.net core,感兴趣的朋友可以了解下...2021-09-22
PHP YII框架开发小技巧之模型(models)中rules自定义验证规则
YII的models中的rules部分是一些表单的验证规则,对于表单验证十分有用,在相应的视图(views)里面添加了表单,在表单被提交之前程序都会自动先来这里面的规则里验证,只有通过对其有效的限制规则后才能被提交,可以很有效地保证...2015-11-24- 这篇文章主要介绍了jquery自定义插件开发之window的实现过程的相关资料,需要的朋友可以参考下...2016-05-09
- 这篇文章主要介绍了C#自定义事件监听实现方法,涉及C#事件监听的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25
- ZXing是一个开放源码的,用Java实现的多种格式的1D/2D条码图像处理库,它包含了联系到其他语言的端口。这篇文章主要给大家介绍了.NET C#利用ZXing生成、识别二维码/条形码的方法,文中给出了详细的示例代码,有需要的朋友们可以参考借鉴。...2020-06-25