打造自己的.NET Core项目模板

前言

每个人都有自己习惯的项目结构,有人的喜欢在项目里面建解决方案文件夹;有的人喜欢传统的三层命名;有的人喜欢单一,简单的项目一个csproj就搞定。。

反正就是萝卜青菜,各有所爱。

可能不同的公司对这些会有特定的要求,也可能会随开发自己的想法去实践。

那么,问题就来了。如果有一个新项目,你会怎么去创建?

可能比较多的方式会是下面三种:

  • 简单粗暴型,打开VS就是右键添加,然后引入一堆包,每个项目添加引用。

  • 脚本型,基于dotnet cli,创建解决方案,创建项目,添加包,添加项目引用。

  • 高大上型,VS项目模板,直接集成到VS上面了。

以前我也是基于dotnet cli写好了sh或ps的脚本,然后用这些脚本来生成新项目。

但是呢,这三种方式,始终都有不尽人意的地方。

因为建好的都是空模板,还要做一堆复杂的操作才可以让项目“正常”的跑起来。比如,这个公共类要抄过来,那个公共类要抄过来。。。这不是明摆着浪费时间嘛。。。

下面介绍一个小办法来帮大家省点时间。

基于dotnet cli创建自己的项目模板,也就是大家常说的脚手架。

dotnet cli项目模板预热

开始正题之前,我们先看一下dotnet cli自带的一些模板。

640?wx_fmt=png

可以看到种类还是很多的,由于工作大部分时间都是在写WebAPI,所以这里就用WebAPI来写个简单的模板。

下面我们就基于dotnet cli写一个自己的模板。

编写自己的模板

既然是模板,就肯定会有一个样例项目。

下面我们建一个样例项目,大致成这样,大家完全可以按照自己习惯来。

640?wx_fmt=png

这其实就是一个普通的项目,里面添加了NLog,Swagger,Dapper等组件,各个项目的引用关系是建好的。

该有的公共类,里面也都包含了,好比宇内分享的那个WebHostBuilderJexusExtensions。

640?wx_fmt=png

下面是这个模板跑起来的效果。

640?wx_fmt=png

就是一个简单的Swagger页面。

现在样例已经有了,要怎么把这个样例变成一个模板呢?

答案就是template.json

在样例的根目录创建一个文件夹.template.config,同时在这个文件夹下面创建template.json

示例如下:

{    "author": "Catcher Wong", //必须    "classifications": [ "Web/WebAPI" ], //必须,这个对应模板的Tags    "name": "TplDemo", //必须,这个对应模板的Templates    "identity": "TplDemoTemplate", //可选,模板的唯一名称    "shortName": "tpl", //必须,这个对应模板的Short Name    "tags": {      "language": "C#" ,      "type":"project"},    "sourceName": "TplDemo",  // 可选,要替换的名字    "preferNameDirectory": true  // 可选,添加目录  
}

在这里,有几个比较重要的东西,一个是shortName,一个是sourceName

  • shortName,简写,偷懒必备,好比能写 -h 就绝对不写 --help

  • sourceName,这是个可选的字段,它的值会替换指定的项目名,正常是把项目名赋值在这里。如果不指定,创建的项目就和样例项目保持一致。

在写完template.json之后,还需要安装一下这个模板到我们的cli中。

使用 dotnet new -i进行模板的安装。

下面是安装示例。

dotnet new -i ./content/TplDemo

这里要注意的是,与.template.config文件夹同级的目录,都会被打包进模板中。

在执行安装命令之后,就可以看到我们的模板已经安装好了。

640?wx_fmt=png

这个时候已经迫不及待的想来试试这个模板了。

先来看看这个模板的帮助信息。

dotnet new tpl -h

640?wx_fmt=png

因为我们目前还没有设置参数,所以这里显示的是还没有参数。

下面来创建一个项目试试。

640?wx_fmt=gif

从创建一个项目,到运行起来,很简单,效果也是我们预期的。

下面来看看,新建的这个HelloTpl这个项目的目录结构和我们的模板是否一样。

640?wx_fmt=png

可以看到,除了名字,其他的内容都是一样的。

是不是感觉又可以少复制粘贴好多代码了。

虽说,现在建项目,已经能把一个大的模板完整的copy出来了,但是始终不是很灵活!

可能有小伙伴会问,明明已经很方便了呀,为什么还会说它不灵活呢?

且听我慢慢道来。

如果说这个模板是个大而全的模板,包含了中间件A,中间件B,中间件C等N个中间件!

而在建新项目的时候,已经明确了只用中间件A,那么其他的中间件对我们来说,可能就没有太大的存在意义!

很多时候,不会想让这些多余的文件出现在代码中,有没有办法来控制呢?

答案是肯定的!可以把不需要的文件排除掉就可以了。

文件过滤

模板项目中有一个RequestLogMiddleware,就用它来做例子。

640?wx_fmt=jpeg

我们只需要做下面几件事就可以了。

第一步,在template.json中添加过滤

加入一个名字为EnableRequestLog的symbol。同时指定源文件

{    "author": "Catcher Wong",//others...    "symbols":{//是否启用RequestLog这个Middleware      "EnableRequestLog": {        "type": "parameter", //它是参数        "dataType":"bool", //bool类型的参数        "defaultValue": "false" //默认是不启用}},    "sources": [{          "modifiers": [{                  "condition": "(!EnableRequestLog)", //条件,由EnableRequestLog参数决定                  "exclude": [ //排除下面的文件                    "src/TplDemo/Middlewares/RequestLogMiddleware.cs",                    "src/TplDemo/Middlewares/RequestLogServiceCollectionExtensions.cs" ]}]}]    }

第二步,在模板的代码中做一下处理

主要是Startup.cs,因为Middleware就是在这里启用的。

    using System;    //other using...using TplDemo.Core;#if (EnableRequestLog)    using TplDemo.Middlewares;#endif/// <summary>/// /// </summary>public class Startup{        public void Configure(IApplicationBuilder app, IHostingEnvironment env)        {            //other code....#if (EnableRequestLog)//request Logapp.UseRequestLog();#endif            app.UseMvc(routes =>{routes.MapRoute(name: "default",template: "{controller=Home}/{action=Index}/{id?}");});}}

这样的话,只要EnableRequestLog是true,那么就可以包含这两段代码了。

下面更新一下已经安装的模板。

这个时候再去看它的帮助信息,已经可以看到我们加的参数了。

640?wx_fmt=png

下面先建一个默认的(不启用RequestLog)

dotnet new tpl -n NoLog

这个命令等价于

dotnet new tpl -n WithLog -E false

下面是建好之后的目录结构和Startup.cs

640?wx_fmt=png

可以看到RequestLog相关的东西都已经不见了。

再建一个启用RequestLog的,看看是不是真的起作用了。

dotnet new tpl -n WithLog -E true

640?wx_fmt=png

可以看到,效果已经出来了。

下面在介绍一个比较有用的特性。动态切换,这个其实和上面介绍的内容相似。

动态切换

直接举个例子来说明吧。

假设我们的模板支持MSSQL, MySQL, PgSQL和SQLite四种数据库操作

在新建一个项目的时候,只需要其中一种,好比说要建一个PgSQL的,肯定就不想看到其他三种。

这里不想看到,有两个地方,一个是nuget包的引用,一个是代码。

上一小节是对某个具体的功能进行了开关的操作,这里有了4个,我们要怎么处理呢?

我们可以用类型是choice的参数来完成这个操作。

修改template.json,加入下面的内容

{  "author": "Catcher Wong",//others  "symbols":{    "sqlType": {      "type": "parameter",      "datatype": "choice",      "choices": [{          "choice": "MsSQL",          "description": "MS SQL Server"},{          "choice": "MySQL",          "description": "MySQL"},{          "choice": "PgSQL",          "description": "PostgreSQL"},{          "choice": "SQLite",          "description": "SQLite"}],      "defaultValue": "MsSQL",      "description": "The type of SQL to use"},  "MsSQL": {      "type": "computed",      "value": "(sqlType == \"MsSQL\")"},    "MySQL": {      "type": "computed",      "value": "(sqlType == \"MySQL\")"},    "PgSQL": {      "type": "computed",      "value": "(sqlType == \"PgSQL\")"},    "SQLite": {      "type": "computed",      "value": "(sqlType == \"SQLite\")"}}
}

看了上面的JSON内容之后,相信大家也知道个所以然了。有一个名为sqlType的参数,它有几中数据库选择,默认是MsSQL。

还另外定义了几个计算型的参数,它的取值是和sqlType的值息息相关的。

MsSQL,MySQL,PgSQL和SQLite这4个参数也是我们在代码里要用到的!!

修改csproj文件,让它可以根据sqlType来动态引用nuget包,我们加入下面的内容

<ItemGroup Condition="'$(MySQL)' == 'True' ">  <PackageReference Include="MySqlConnector" Version="0.47.1" /></ItemGroup><ItemGroup Condition="'$(PgSQL)' == 'True' ">  <PackageReference Include="Npgsql" Version="4.0.3" /></ItemGroup><ItemGroup Condition="'$(SQLite)' == 'True' ">  <PackageReference Include="Microsoft.Data.Sqlite" Version="2.1.0" /></ItemGroup>

同样的,代码也要做相应的处理

#if (MsSQL)using System.Data.SqlClient;#elif (MySQL)using MySql.Data.MySqlClient;#elif (PgSQL)using Npgsql;#else using Microsoft.Data.Sqlite;#endifprotected DbConnection GetDbConnection()    {#if (MsSQL)            return new SqlConnection(_connStr);#elif (MySQL)            return new MySqlConnection(_connStr);#elif (PgSQL)             return new NpgsqlConnection(_connStr);#else              return new SqliteConnection(_connStr);#endif              }

修改好之后,同样要去重新安装这个模板,安装好之后,就可以看到sqlType这个参数了。

640?wx_fmt=png

下面分别创建一个MsSQL和PgSQL的项目,用来对比和验证。

先后执行

dotnet new tpl -n MsSQLTest -s MsSQL 
dotnet new tpl -n PgSQLTest -s PgSQL

然后打开对应的csproj

640?wx_fmt=png

可以看到,PgSQL的,添加多了NPgsql这个包。而MsSQL的却没有。

同样的,DapperRepositoryBase也是一样的效果。在创建Connection对象的时候,都根据模板来生成了。

640?wx_fmt=png

当然这个是在我们自己本地安装的模板,其他人是没有办法使用的。

如果想公开,可以发布到nuget上面去。如果是在公司内部共享,可以搭建一个内部的nuget服务,将模板上传到内部服务器里面去。

下面是一些可以开箱即用的模板:

https://dotnetnew.azurewebsites.net/

总结

有一个自己的项目模板(脚手架),还是很方便的。

一建生成自己需要的东西,减少了不必要的代码复制,可以将更多精力放在业务实现上。

在平时还是要有一些积累,当积累足够丰富之后,我们的脚手架可能就会变得十分强大。

参考文档

dotnet new下面默认的模板 https://github.com/aspnet/Templating

templating的源码 https://github.com/dotnet/templating

template.json的说明 https://github.com/dotnet/templating/wiki/Reference-for-template.json

dotnet cli的文档 https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet?tabs=netcore21

最后是文中的示例代码 https://github.com/catcherwong/Demos/tree/master/src/Template 

原文地址:https://www.cnblogs.com/catcher1994/p/10061470.html


.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com

640?wx_fmt=jpeg

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/318635.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

不止代码:合唱队列(动态规划)

文章目录题目描述解析1.n^2^朴素算法2.队列nlogn算法代码3.二维DP&#xff08;n^2^)代码thanks for reading!题目描述 五一到了&#xff0c;PKU-ACM队组织大家去登山观光&#xff0c;队员们发现山上一个有N个景点&#xff0c;并且决定按照顺序来浏览这些景点&#xff0c;即每次…

#6029. 「雅礼集训 2017 Day1」市场(势能,区间除)

#6029. 「雅礼集训 2017 Day1」市场 用线段树维护数列&#xff0c;区间上维护最大最小值&#xff0c;区间和还有标记&#xff0c;修改时&#xff0c;区间加直接做&#xff0c;而区间除时&#xff0c;递归到线段树上某一区间&#xff0c;如果这一操作等价于区间加&#xff08;也…

牛客题霸 [容器盛水问题] C++题解/答案

牛客题霸 [容器盛水问题] C题解/答案 题目描述 给定一个整形数组arr&#xff0c;已知其中所有的值都是非负的&#xff0c;将这个数组看作一个容器&#xff0c;请返回容器能装多少水。 具体请参考样例解释 题解&#xff1a; 我们找出容器的左右边界&#xff0c;选择边界更低…

超好用的C#控制台应用模板

默认模板之缺在工作学习中&#xff0c;我们经常需要创建一些简单的控制台应用(Console App)去验证某个想法&#xff0c;或者作为小工具交付给其他同事。通常我们的选择是 Visual Studio 自带的 Console App 模板&#xff0c;这个经典模板只有预设好的 csproj 文件和空荡荡的 Ma…

Loj#3026-「ROIR 2018 Day1」管道监控【Trie,费用流】

正题 题目链接:https://loj.ac/p/3026 题目大意 给出nnn个点的一棵外向树&#xff0c;然后mmm个字符串和费用表示你每次可以花费这个费用覆盖路径字符串和给出字符串相等的路径&#xff0c;求覆盖所有边的最小花费&#xff08;可以重复覆盖&#xff09; 输出方案 1≤n≤500,…

不止代码:区间圆数(ybtoj-数位DP)

文章目录题目描述解析理解万岁&#xff01;代码题目描述 解析 一寸山河一寸血 理解万岁&#xff01; 首先&#xff0c;这题统计[l,r]的个数&#xff0c;可以用[1,r]-[1,l-1]来实现 接下来就是如何统计出[1,n]的个数了 首先&#xff0c;用dp[pos][s0]来表示一个二进制pos位有s…

P3224 [HNOI2012]永无乡(并查集+权值线段树合并/平衡树)

[HNOI2012]永无乡 Code1 权值线段树天然支持merge&#xff0c;线段树上二分求第k小 #include<bits/stdc.h>using namespace std; using lllong long; template <class Tint> T rd() {T res0;T fg1;char chgetchar();while(!isdigit(ch)) {if(ch-) fg-1;chgetcha…

牛客题霸 [没有重复项数字的所有排列] C++题解/答案

牛客题霸 [没有重复项数字的所有排列] C题解/答案 题目描述 给出一组数字&#xff0c;返回该组数字的所有排列 例如&#xff1a; [1,2,3]的所有排列如下 [1,2,3],[1,3,2],[2,1,3],[2,3,1],[3,1,2], [3,2,1]. &#xff08;以数字在数组中的位置靠前为优先级&#xff0c;按字典…

.NET Core 2.2 新增部分功能使用尝鲜

前言美国当地时间12月4日&#xff0c;微软2019开发者大会中发布了一系列的重磅消息&#xff0c;包含了软硬件和开源社区的各种好消息是铺天盖地&#xff0c;作为一名普通的开发者&#xff0c;我第一时间下载了 .NET Core 2.2 的源码&#xff0c;针对发布说明逐条浏览&#xff0…

不止代码:机器分配(动态规划)

题目描述 解析 头疼 什么破题 就是一个dp寻找最优性决策的常规题 但是要输出过程&#xff0c;可以使用递归输出 但是&#xff01; 这题数据的意思是&#xff1a;存在a[i]a[i1]的情况&#xff0c;且在不影响利润的情况下&#xff0c;机器要尽可能的用完 这河里吗 可能是机器多了…

P7599-[APIO2021]雨林跳跃【二分,倍增,ST表】

正题 题目链接:https://www.luogu.com.cn/problem/P7599 题目大意 nnn棵树&#xff0c;在某棵树上时可以选择向左右两边第一棵比它高的树跳&#xff0c;现在qqq次询问从[A,B][A,B][A,B]中某个点出发跳到[C,D][C,D][C,D]中某个点的最少次数。 1≤n≤21051\leq n\leq 2\times 10…

2021中国大学生程序设计竞赛(CCPC)- 网络选拔赛 GCD on Sequence(线段树)

https://blog.csdn.net/qq_45863710/article/details/120121607 对于每个左端点 l 维护尚未确定 v 值的最大的右端点 mx[l] #include<bits/stdc.h>using namespace std; using lllong long; const int N100010; vector<int> vec[N]; int n,a[N],p[N]; ll ans[N]; …

牛客题霸 [ 验证IP地址] C++题解/答案

牛客题霸 [ 验证IP地址] C题解/答案 题目描述 编写一个函数来验证输入的字符串是否是有效的 IPv4 或 IPv6 地址 IPv4 地址由十进制数和点来表示&#xff0c;每个地址包含4个十进制数&#xff0c;其范围为 0 - 255&#xff0c; 用(".")分割。比如&#xff0c;172.1…

不止代码:洛谷P1064 金明的预算方案+P2014选课(依赖背包)

文章目录题目描述总结解析解法1解法2代码解法3代码题目描述 金明的预算方案 选课 金明今天很开心&#xff0c;家里购置的新房就要领钥匙了&#xff0c;新房里有一间金明自己专用的很宽敞的房间。更让他高兴的是&#xff0c;妈妈昨天对他说&#xff1a;“你的房间需要购买哪些物…

Docker最全教程——从理论到实战(六)

本篇教程持续编写了3个星期左右并且一直在完善、补充具体的细节和实践&#xff0c;预计全部完成需要1到2个月的时间。由于编写的过程中极其费时&#xff0c;并且还需要配合做一些实践&#xff08;有些实践存在一些坑&#xff0c;而且极其费时费事&#xff09;。因此目前产出的速…

P4332-[SHOI2014]三叉神经树【LCT】

正题 题目链接:https://www.luogu.com.cn/problem/P4332 题目大意 给出nnn个点的一棵有根三叉树&#xff0c;保证每个点的儿子个数为333或者000&#xff0c;每个叶子有一个权值000或111&#xff0c;每个非叶子节点的权值是它儿子中权值较多的那个&#xff0c;每次修改一个叶子…

牛客题霸 [ 环形链表的约瑟夫问题] C++题解/答案

牛客题霸 [ 环形链表的约瑟夫问题] C题解/答案 题目描述 据说著名犹太历史学家 Josephus 有过以下故事&#xff1a;在罗马人占领乔塔帕特后&#xff0c;39 个犹太人与 Josephus 及他的朋友躲到一个洞中&#xff0c;39 个犹太人决定宁愿死也不要被敌人抓到&#xff0c;于是决定…

2016 Multi-University Training Contest 1 1004 GCD(ST表+二分)

GCD 注意观察gcd⁡(al,al1,...,ar)\gcd(a_{l},a_{l1},...,a_{r})gcd(al​,al1​,...,ar​)&#xff0c;当lll固定不动的时候&#xff0c;rl...nrl...nrl...n时&#xff0c;我们可以容易的发现,随着rrr的増大&#xff0c;gcd⁡(al,al1,...,ar)\gcd(a_{l},a_{l1},...,a_{r})gcd(…

警卫站岗(树上dp)

题目描述 五一来临&#xff0c;某地下超市为了便于疏通和指挥密集的人员和车辆&#xff0c;以免造成超市内的混乱和拥挤&#xff0c;准备临时从外单位调用部分保安来维持交通秩序。 已知整个地下超市的所有通道呈一棵树的形状&#xff1b;某些通道之间可以互相望见。总经理要求…

.NET Core实战项目之CMS 第八章 设计篇-内容管理极简设计全过程

写在前面上一篇文章.NET Core实战项目之CMS 第七章 设计篇-用户权限极简设计全过程中我带着大家进行了权限部分的极简设计&#xff0c;也仅仅是一个基本的权限设计。不过你完全可以基于这套权限系统设计你的更复杂的权限系统&#xff0c;当然更复杂的权限系统要根据你的业务来进…