ASP.NET Core：使用Dapper和SwaggerUI来丰富你的系统框架
一、概述
1、用VS2017创建如下图的几个.NET Standard类库，默认版本为1.4，你可以通过项目属性进行修改，最高支持到1.6，大概五月份左右会更新至2.0，API会翻倍，很期待！
 |
排名分先后，这里简要说下我对各个类库职责的一个理解。
|
2、当然了，你还可以通过.NET Core Tool的cli命令来创建，前提是你的电脑上安装了.NET Core SDK。
dotnet new classlib -n Light.Repository //创建一个名字为Light.Repository的.NET Standard类库
更多创建类型请键入如下命令进行查看
dotnet new -all
红框内自上而下依次表示：
- 控制台应用程序
- 类库
- 微软自带的单元测试项目
- 引入XUnit框架的单元测试项目
- 空的ASP.NET Core
- ASP.NET Core MVC项目
- ASP.NET Core WebAPI项目
- 空的解决方案
二、引入Dapper
1、准备创建用户表的SQL脚本
USE [Light]
GO /****** Object: Table [dbo].[User] Script Date: 2017/3/27 22:40:08 ******/
SET ANSI_NULLS ON
GO SET QUOTED_IDENTIFIER ON
GO CREATE TABLE [dbo].[User](
[Id] [int] IDENTITY(10000,1) NOT NULL,
[UserName] [nvarchar](50) NOT NULL,
[Password] [nvarchar](50) NOT NULL,
[Gender] [bit] NOT NULL,
[Birthday] [datetime] NOT NULL,
[CreateUserId] [int] NOT NULL,
[CreateDate] [datetime] NOT NULL,
[UpdateUserId] [int] NOT NULL,
[UpdateDate] [datetime] NOT NULL,
[IsDeleted] [bit] NOT NULL,
CONSTRAINT [PK_User] PRIMARY KEY CLUSTERED
(
[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY] GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_UserName] DEFAULT ('') FOR [UserName]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_Password] DEFAULT ('') FOR [Password]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_Gender] DEFAULT ((0)) FOR [Gender]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_Birthday] DEFAULT (getdate()) FOR [Birthday]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_CreateUserId] DEFAULT ((0)) FOR [CreateUserId]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_CreateDate] DEFAULT (getdate()) FOR [CreateDate]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_UpdateUserId] DEFAULT ((0)) FOR [UpdateUserId]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_UpdateDate] DEFAULT (getdate()) FOR [UpdateDate]
GO ALTER TABLE [dbo].[User] ADD CONSTRAINT [DF_User_IsDeleted] DEFAULT ((0)) FOR [IsDeleted]
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'主键Id' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'Id'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'用户名' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'UserName'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'密码' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'Password'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'性别（0女，1男）' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'Gender'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'出生年月日' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'Birthday'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'创建人' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'CreateUserId'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'创建时间' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'CreateDate'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'更新人' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'UpdateUserId'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'更新时间' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'UpdateDate'
GO EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'标志是否删除（0未删除，1已删除）' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'User', @level2type=N'COLUMN',@level2name=N'IsDeleted'
GO
2、添加对应的User表实体
/// <summary>
/// 用户实体
/// </summary>
public class User : BaseModel
{
/// <summary>
/// 用户名
/// </summary>
public string UserName { get; set; } /// <summary>
/// 密码
/// </summary>
public string Password { get; set; } /// <summary>
/// 性别（0女，1男）
/// </summary>
public bool Gender { get; set; } /// <summary>
/// 出生年月日
/// </summary>
public DateTime Birthday { get; set; }
}
3、使用泛型针对每一个表定义基本的CRUD接口，然后IUserRepository继承它，如果需要其他的接口，后续往里边定义即可
/// <summary>
/// 基类业务接口定义
/// </summary>
public interface IBaseBusiness<T> where T : class
{
/// <summary>
/// 添加一个实体
/// </summary>
/// <param name="entity">要创建的实体</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
bool CreateEntity(T entity, string connectionString = null); /// <summary>
/// 根据主键Id获取一个实体
/// </summary>
/// <param name="id">主键Id</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
T RetriveOneEntityById(int id, string connectionString = null); /// <summary>
/// 获取所有实体
/// </summary>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
IEnumerable<T> RetriveAllEntity(string connectionString = null); /// <summary>
/// 修改一个实体
/// </summary>
/// <param name="entity">要修改的实体</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
bool UpdateEntity(T entity, string connectionString = null); /// <summary>
/// 根据主键Id删除一个实体
/// </summary>
/// <param name="id">主键Id</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
bool DeleteEntityById(int id, string connectionString = null);
}
4、主角进场。通过Nuget引入Dapper到Repository中，目前的版本为1.50.2
Install-Package Dapper
- Dapper是目前一款简洁、高效并且开源的ORM(实体对象关系映射)框架之一。
传送门：https://github.com/StackExchange/Dapper - 它不仅支持Sql Server，还适用于MySql，SqlLite，Oracle，PostgreSql等
- 默认使用参数化进行查询或者新增
- 支持存储过程
- 支持级联映射和多表映射
- 默认缓冲你所执行的SQL
a)、设置你的链接字符串和DbConnection
/// <summary>
/// 数据库配置
/// </summary>
public class DataBaseConfig
{
#region SqlServer链接配置
/// <summary>
/// 默认的Sql Server的链接字符串
/// </summary>
private static string DefaultSqlConnectionString = @"Data Source=.;Initial Catalog=Light;User ID=sa;Password=sa;";
public static IDbConnection GetSqlConnection(string sqlConnectionString = null)
{
if (string.IsNullOrWhiteSpace(sqlConnectionString))
{
sqlConnectionString = DefaultSqlConnectionString;
}
IDbConnection conn = new SqlConnection(sqlConnectionString);
conn.Open();
return conn;
}
#endregion
}
b)、实现IUserRepository定义的接口，使用Dapper进行操作数据
/// <summary>
/// 用户仓储
/// </summary>
/// <typeparam name="User"></typeparam>
public class UserRepository : IUserRepository
{
/// <summary>
/// 创建一个用户
/// </summary>
/// <param name="entity">用户</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
public bool CreateEntity(User entity, string connectionString = null)
{
using (IDbConnection conn = DataBaseConfig.GetSqlConnection(connectionString))
{
string insertSql = @"INSERT INTO [dbo].[User]
([UserName]
,[Password]
,[Gender]
,[Birthday]
,[CreateUserId]
,[CreateDate]
,[UpdateUserId]
,[UpdateDate]
,[IsDeleted])
VALUES
(@UserName
,@Password
,@Gender
,@Birthday
,@CreateUserId
,@CreateDate
,@UpdateUserId
,@UpdateDate
,@IsDeleted)";
return conn.Execute(insertSql, entity) > ;
}
} /// <summary>
/// 根据主键Id删除一个用户
/// </summary>
/// <param name="id">主键Id</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
public bool DeleteEntityById(int id, string connectionString = null)
{
using (IDbConnection conn = DataBaseConfig.GetSqlConnection(connectionString))
{
string deleteSql = @"DELETE FROM [dbo].[User]
WHERE Id = @Id";
return conn.Execute(deleteSql, new { Id = id }) > ;
}
} /// <summary>
/// 获取所有用户
/// </summary>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
public IEnumerable<User> RetriveAllEntity(string connectionString = null)
{
using (IDbConnection conn = DataBaseConfig.GetSqlConnection(connectionString))
{
string querySql = @"SELECT [Id]
,[UserName]
,[Password]
,[Gender]
,[Birthday]
,[CreateUserId]
,[CreateDate]
,[UpdateUserId]
,[UpdateDate]
,[IsDeleted]
FROM [dbo].[User]";
return conn.Query<User>(querySql);
}
} /// <summary>
/// 根据主键Id获取一个用户
/// </summary>
/// <param name="id">主键Id</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
public User RetriveOneEntityById(int id, string connectionString = null)
{
using (IDbConnection conn = DataBaseConfig.GetSqlConnection(connectionString))
{
string querySql = @"SELECT [Id]
,[UserName]
,[Password]
,[Gender]
,[Birthday]
,[CreateUserId]
,[CreateDate]
,[UpdateUserId]
,[UpdateDate]
,[IsDeleted]
FROM [dbo].[User]
WHERE Id = @Id";
return conn.QueryFirstOrDefault<User>(querySql, new { Id = id });
}
} /// <summary>
/// 修改一个用户
/// </summary>
/// <param name="entity">要修改的用户</param>
/// <param name="connectionString">链接字符串</param>
/// <returns></returns>
public bool UpdateEntity(User entity, string connectionString = null)
{
using (IDbConnection conn = DataBaseConfig.GetSqlConnection(connectionString))
{
string updateSql = @"UPDATE [dbo].[User]
SET [UserName] = @UserName
,[Password] = @Password
,[Gender] = @Gender
,[Birthday] = @Birthday
,[UpdateUserId] = @UpdateUserId
,[UpdateDate] = @UpdateDate
,[IsDeleted] = @IsDeleted
WHERE Id = @Id";
return conn.Execute(updateSql, entity) > ;
}
}
}
上面的代码所执行的方法Execute，Query，QueryFirstOrDefault其实都是IDbConnection的扩展方法，转到定义你也可以清楚的看到默认buffered缓存是开启的，并且都支持事务提交，同时还都对应各自的async异步方法
public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, bool buffered = true, int? commandTimeout = default(int?), CommandType? commandType = default(CommandType?));
这样一来，再也不用DataReader去一个一个属性赋值了，也不用SqlParameter一个一个去参数化了，Dapper全部帮你做了，你只需要关注你的业务SQL语句以及上下文的对象即可，是不是很清爽！
c)、接下来就是完成对上一部分仓储数据的调用。一方面是IBusiness的服务接口定义，另一方面则是Business的简单实现，因为暂时只是涉及到一个表的增查改删，所以具体的代码就不上了
d)、至于依赖注入模块，我直接使用的是Microsoft.Extensions.DependencyInjection，所有的服务由ServiceCollection服务容器进行管理，我们只需要将接口和它的实现类进行注册就行了
/// <summary>
/// 注入业务逻辑层
/// </summary>
public class BusinessInjection
{
public static void ConfigureBusiness(IServiceCollection services)
{
services.AddSingleton<IUserBusiness, UserBusiness>();
}
}
/// <summary>
/// 注入仓储层
/// </summary>
public class RepositoryInjection
{
public static void ConfigureRepository(IServiceCollection services)
{
services.AddSingleton<IUserRepository, UserRepository>();
}
}
三、引入SwaggerUI
简介：SwaggerUI是一款针对WebApi的可视化工具，同样我也称它是一款全自动的接口描述文档，并且可以很方便的帮助你测试你的接口，接下来我们一步一步的来把它添加进去。
1、向ASP.NET Core WebApi项目中添加Swashbuckle组件，打开包管理控制台，输入：
Install-Package Swashbuckle -Pre
记得加上后边的-Pre，表示安装最新版本，否则的话会默认下载稳定版本5.5.3（不支持Core）
当然了，你也可以包管理器进行安装，记得勾选“包括预发行版”，然后选择6.0.0-beta902进行安装
2、打开Startup文件，添加Swagger中间件并将他们注入到应用程序的管道中，同时也将我们自定义的服务加进去
/// <summary>
/// This method gets called by the runtime. Use this method to add services to the container.
/// </summary>
/// <param name="services"></param>
public void ConfigureServices(IServiceCollection services)
{
RepositoryInjection.ConfigureRepository(services);
BusinessInjection.ConfigureBusiness(services);
services.AddMvc();
services.AddSwaggerGen();
} /// <summary>
/// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
/// </summary>
/// <param name="app"></param>
/// <param name="env"></param>
/// <param name="loggerFactory"></param>
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
loggerFactory.AddConsole(Configuration.GetSection("Logging"));
loggerFactory.AddDebug(); app.UseMvc();
app.UseSwagger();
app.UseSwaggerUi();
}
3、打开launchSettings文件，修改launchUrl为“swagger/ui”
"profiles": {
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "swagger/ui",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"Light.Api": {
"commandName": "Project",
"launchBrowser": true,
"launchUrl": "swagger/ui",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"applicationUrl": "http://localhost:62116"
}
}
4、添加一个UserController，针对每一个服务增加一个REST风格的API接口。注意使用的HttpMethod方法。HttpGet表示获取对象，HttpPost表示创建对象，HttpPut表示修改对象，HttpDelete表示删除对象
/// <summary>
/// 用户控制器
/// </summary>
[Route("api/[controller]")]
public class UserController : Controller
{
private readonly IUserBusiness iUserBusiness;
/// <summary>
/// 构造函数注入服务
/// </summary>
/// <param name="userBusiness"></param>
public UserController(IUserBusiness userBusiness)
{
iUserBusiness = userBusiness;
} /// <summary>
/// 获取所有用户
/// </summary>
/// <returns></returns>
[HttpGet]
//[Route("AllUser")]
public IEnumerable<User> GetAllUser()
{
return iUserBusiness.RetriveAllEntity();
} /// <summary>
/// 根据主键Id获取一个用户
/// </summary>
/// <param name="id">主键Id</param>
/// <returns></returns>
[HttpGet("{id}")]
public User GetOneUser(int id)
{
return iUserBusiness.RetriveOneEntityById(id);
} /// <summary>
/// 新增用户
/// </summary>
/// <param name="user">用户实体</param>
/// <returns></returns>
[HttpPost]
public bool CreateUser([FromBody]User user)
{
return iUserBusiness.CreateEntity(user);
} /// <summary>
/// 修改用户
/// </summary>
/// <param name="id">主键Id</param>
/// <param name="user">用户实体</param>
/// <returns></returns>
[HttpPut("{id}")]
public bool UpdateUser(int id, [FromBody]User user)
{
user.Id = id;
return iUserBusiness.UpdateEntity(user);
} /// <summary>
/// 根据主键Id删除一个用户
/// </summary>
/// <param name="id">主键Id</param>
/// <returns></returns>
[HttpDelete("{id}")]
public bool DeleteUser(int id)
{
return iUserBusiness.DeleteEntityById(id);
}
}
5、大功告成，Ctrl+F5运行你的程序，并试着执行添加，修改和查询的Api，体验Swagger带给你的方便之处。
写在最后：这篇文章只是介绍了它们俩最简单最基本的用法，如果其中说法有误的，还望各位前辈多多指点，更多的内容还需要后续的继续积累和学习，加油！
ASP.NET Core：使用Dapper和SwaggerUI来丰富你的系统框架的更多相关文章
- ASP.NET Core API ——Dapper的使用
ASP.NET Core API ——Dapper的使用 简介:Dapper是一个ORM框架,负责数据库和程序语言之间的映射. 使用步骤: l 创建一个IDBConnection的接口对象 l 编 ...
- ASP .Net Core 使用 Dapper 轻型ORM框架
一:优势 1,Dapper是一个轻型的ORM类.代码就一个SqlMapper.cs文件,编译后就40K的一个很小的Dll. 2,Dapper很快.Dapper的速度接近与IDataReader,取列表 ...
- ASP.NET Core 使用 JWT 搭建分布式无状态身份验证系统
为什么使用 Jwt 最近,移动开发的劲头越来越足,学校搞的各种比赛都需要用手机 APP 来撑场面,所以,作为写后端的,很有必要改进一下以往的基于 Session 的身份认证方式了,理由如下: 移动端经 ...
- ASP.NET Core：部署项目到Ubuntu Server
概述 基于上一篇成功安装Ubuntu Server 16.10的基础上,接下来继续我们ASP.NET Core项目的部署之旅! 只是对于这些年整天和Windows打交道的我,初次使用Linux确实有点 ...
- 记一次使用Asp.Net Core WebApi 5.0+Dapper+Mysql+Redis+Docker的开发过程
#前言 我可能有三年没怎么碰C#了,目前的工作是在全职搞前端,最近有时间抽空看了一下Asp.net Core,Core版本号都到了5.0了,也越来越好用了,下面将记录一下这几天以来使用Asp.Net ...
- ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
- ASP.NET Core WebApi使用Swagger生成api
引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
- ASP.NET Core WebApi使用Swagger生成api说明文档
1. Swagger是什么? Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件 ...
- 【转】ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
原文链接:https://www.cnblogs.com/yilezhu/p/9241261.html 引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必 ...
随机推荐
- java 非缓冲与缓冲数据读取比较
首先不适用缓存技术,读取数据: //非缓冲计时 package com.swust; import java.io.*; /* *功能:创建一个程序,写10000个随机双精度的数到一个文件中,同时测试 ...
- stop总结
<!DOCTYPE html><html><head><meta charset="utf-8"><script src=&q ...
- 将apache的prefork改成worker
1. 检测apache正在使用哪个MPM? XXX@XXX-ThinkPad-Edge-E431:~$ apachectl -V | grep -i mpm Server MPM: prefork 2 ...
- Angular2 Service实践——实现简单音乐播放服务
引言: 如果说组件系统(Component)是ng2应用的躯体,那把服务(Service)认为是流通于组件之间并为其带来生机的血液再合适不过了.组件间通信的其中一种优等选择就是使用服务,在ng1里就有 ...
- [多线程] Web 项目中，少有涉及到的一次多线程编程的经验
如今框架横行,Spring 已经是非常成熟的容器体系,我们在日常开发 JavaWeb 的工作中,大多已经不需要考虑多线程的问题,这些问题都已经在Spring容器中实现,框架的意义就是让程序员们可以专注 ...
- where T：class的含义（ where约束）
public void Request<T>(List<T> EntityList) where T : class { } 这是参数类型约束,指定T必须是Class类型. ...
- 关于fibonacci数列用JS写的一点小优化
直接上代码 var month = prompt("请输入月数:") function fibobo(x) { //先定义一个已有前两项的数组,用来作缓存 var arr = [1 ...
- Asp.Net 常用工具类之加密——对称加密DES算法（2）
又到周末,下午博客园看了两篇文章,关于老跳和老赵的程序员生涯,不禁感叹漫漫程序路,何去何从兮! 转眼毕业的第三个年头,去过苏州,跑过上海,从一开始的凌云壮志,去年背起行囊默默回到了长沙准备买房,也想有 ...
- Filebeat issue 排查--single.go:140: ERR Connecting error publishing events (retrying): dial tcp ****:5044: i/o timeout
我个人用docker搭建了一套日志分析平台:ELK+Filebeat 在正常跑了半个多月之后,Kibana刷新日志时突然发现日志不在更新了,停在某个时刻,就再也没有新log. 首先我查看了elk,lo ...
- UI培训自学能学好吗
近年来UI设计师愈来愈红,成为行业热门,越来越多的人开始专注UI培训,也有一部分人在考虑,培训班一般价格不菲,我自学怎么样呢? UI设计是指人机交互过程中的一个界面设计,常用到的有 ps和ai两个工具 ...