• .net6项目模板搭建教程

    1.集成log4net

    安装如下扩展依赖即可，已经包含了log4net依赖：

    Microsoft.Extensions.Logging.Log4Net.AspNetCore

     

    添加日志配置文件：

    日志配置文件属性设置为始终复制：

    注入服务：

    1. #region 注入log4net日志服务
    2.  
    3. builder.Logging.AddLog4Net("Config/log4net.config");
    4.  
    5. #endregion

    此时集成完毕。 

    2.集成automapper

    安装如下依赖，此版本已经合并扩展依赖。

    AutoMapper

    编写配置映射类：

    代码如下:

    1. using AutoMapper;
    2. using DataApi.Model.Dto;
    3. using DataApi.Model.Entity;
    4.  
    5. namespace DataApi.Extension
    6. {
    7.     /// 
    8.     /// 映射描述类
    9.     /// 
    10.     public class AutoMapperProfile : Profile
    11.     {
    12.         /// 
    13.         /// 构造函数
    14.         /// 
    15.         public AutoMapperProfile()
    16.         {
    17.             //部门
    18.             CreateMap();
    19.         }
    20.     }
    21. }

     注册服务：

    1. #region 注入AutoMapper服务
    2.  
    3. builder.Services.AddAutoMapper(typeof(AutoMapperProfile));
    4.  
    5. #endregion

    使用过程如下：

    1. [HttpGet]
    2. [Route("list")]
    3. public async Task GetSysDepts()
    4. {
    5.     List sysDepts = await _sysDeptRepository.GetListAsync(opt => opt.DeptId == 100);
    6.     return ApiResult.Success(_mapper.Map>(sysDepts));
    7. }

     对应的实体类和dto如下：

    3.响应json时间本地化 

    安装如下依赖：

    Microsoft.AspNetCore.Mvc.NewtonsoftJson

    更改响应时间格式：

    1. #region 更改响应时间格式
    2.  
    3. builder.Services.AddControllers()
    4.     .AddNewtonsoftJson(options =>
    5.     {
    6.         //更改响应时间格式
    7.         options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
    8.     });
    9.  
    10. #endregion

    4.集成跨域

    注入服务：

    1. #region 注入跨域服务
    2.  
    3. builder.Services.AddCors(options =>
    4. {
    5.     options.AddPolicy("Cors", policy => policy.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod());
    6. });
    7.  
    8. #endregion

    添加跨域中间件：

    1. # region 跨域中间件
    2.  
    3. app.UseCors("Cors");
    4.  
    5. #endregion

     

    5.集成sqlsugar

    安装如下依赖：

    SqlSugarCore

    创建仓储：

    1. using SqlSugar;
    2.  
    3. namespace DataApi.Repository
    4. {
    5.     /// 
    6.     /// 仓储类
    7.     /// 
    8.     /// T
    9.     public class Repository<T> : SimpleClient<T> where T : class, new()
    10.     {
    11.         /// 
    12.         /// 构造函数
    13.         /// 
    14.         /// ISqlSugarClient
    15.         public Repository(ISqlSugarClient db)
    16.         {
    17.             base.Context = db;
    18.         }
    19.     }
    20. }

     执行扩展方法：

    1. #region 注入Sqlsugar服务
    2.  
    3. builder.Services.AddSqlSugarExt("MySql");
    4.  
    5. #endregion
    6. #region 注入泛型仓储
    7.  
    8. builder.Services.AddScoped(typeof(Repository<>));
    9.  
    10. #endregion

    编写扩展类：

    1. using DataApi.Common;
    2. using SqlSugar;
    3. using System.Data;
    4.  
    5. namespace DataApi.Extension
    6. {
    7.     /// 
    8.     /// SqlSugar扩展类
    9.     /// 
    10.     public static class SqlSugarExt
    11.     {
    12.         /// 
    13.         /// 扩展方法
    14.         /// 
    15.         /// 容器
    16.         /// 数据库类型
    17.         public static void AddSqlSugarExt(this IServiceCollection services, string sqlType = "MySql")
    18.         {
    19.             //注册SqlSugar
    20.             services.AddSingleton(s =>
    21.             {
    22.                 //配置实例
    23.                 var configuration = s.GetRequiredService();
    24.  
    25.                 //日志实例
    26.                 var logger = s.GetRequiredService>();
    27.  
    28.                 SqlSugarScope sqlSugar = new SqlSugarScope(new ConnectionConfig
    29.                 {
    30.                     //数据库类型
    31.                     DbType = ToolHelper.GetDbType(sqlType),
    32.                     //连接字符串
    33.                     ConnectionString = configuration.GetConnectionString(sqlType),
    34.                     //自动关闭连接
    35.                     IsAutoCloseConnection = true
    36.                 },
    37.                 db =>
    38.                 {
    39.                     //单例参数配置,所有上下文生效
    40.                     db.Aop.OnLogExecuting = (sql, pars) =>
    41.                     {
    42.                         //输出sql
    43.                         logger.LogInformation(sql);
    44.                         if (pars != null)
    45.                         {
    46.                             //输出参数
    47.                             logger.LogInformation(string.Join(",", pars.Select(p => p.ParameterName + "：" + p.Value)));
    48.                         }
    49.                     };
    50.                 });
    51.  
    52.                 return sqlSugar;
    53.             });
    54.         }
    55.     }
    56. }

     

    获取dbtype:

    1. using SqlSugar;
    2.  
    3. namespace DataApi.Common
    4. {
    5.     /// 
    6.     /// 工具帮助类
    7.     /// 
    8.     public class ToolHelper
    9.     {
    10.         /// 
    11.         /// GetDbType
    12.         /// 
    13.         /// string
    14.         /// DbType
    15.         public static DbType GetDbType(string sqlType)
    16.         {
    17.             DbType dbType = DbType.MySql;
    18.  
    19.             switch (sqlType)
    20.             {
    21.                 case "SqlServer":
    22.                     dbType = DbType.SqlServer;
    23.                     break;
    24.                 case "MySql":
    25.                     dbType = DbType.MySql;
    26.                     break;
    27.                 case "Dm":
    28.                     dbType = DbType.Dm;
    29.                     break;
    30.                 case "Oracle":
    31.                     dbType = DbType.Oracle;
    32.                     break;
    33.                 case "PostgreSQL":
    34.                     dbType = DbType.PostgreSQL;
    35.                     break;
    36.                 case "Sqlite":
    37.                     dbType = DbType.Sqlite;
    38.                     break;
    39.             }
    40.  
    41.             return dbType;
    42.         }
    43.     }
    44. }

     

    跟datalink保持一致，只支持6种数据库。

    6.jwt及swagger完整配置

    安装如下依赖：

    1. Microsoft.AspNetCore.Authentication.JwtBearer
    2. Swashbuckle.AspNetCore.Filters

    编写API版本类：

    1. namespace DataApi.Common
    2. {
    3.     /// 
    4.     /// Api版本枚举
    5.     /// 
    6.     public enum ApiVersion
    7.     {
    8.         /// 
    9.         /// V1版本
    10.         /// 
    11.         V1 = 1,
    12.  
    13.         /// 
    14.         /// V2版本
    15.         /// 
    16.         V2
    17.     }
    18. }

     

    jwt配置类编写如下：

    1. namespace DataApi.Common
    2. {
    3.     /// 
    4.     /// Jwt配置
    5.     /// 
    6.     public class JwtSetting
    7.     {
    8.         /// 
    9.         /// 密钥
    10.         /// 
    11.         public string SecurityKey { get; set; } = string.Empty;
    12.  
    13.         /// 
    14.         /// 签发者
    15.         /// 
    16.         public string? Issuer { get; set; }
    17.  
    18.         /// 
    19.         /// 签收者
    20.         /// 
    21.         public string? Audience { get; set; }
    22.  
    23.         /// 
    24.         /// 过期时间
    25.         /// 
    26.         public int ExpiredTime { get; set; }
    27.     }
    28. }

     

     appsettings.json配置内容如下：

    1. {
    2.   "Logging": {
    3.     "LogLevel": {
    4.       "Default": "Information",
    5.       "Microsoft.AspNetCore": "Warning"
    6.     }
    7.   },
    8.   "AllowedHosts": "*",
    9.   "ConnectionStrings": {
    10.     //MySql
    11.     "MySql": "Server=127.0.0.1;Database=dmp;Port=3306;Uid=root;Pwd=wong123456;Allow User Variables=True;",
    12.     //SqlServer
    13.     "SqlServer": "Data Source=43.143.48.100;Initial Catalog=ALEAN;User Id=sa;Password=ghy520WXF;"
    14.   },
    15.   //Jwt配置
    16.   "JwtSetting": {
    17.     //密钥
    18.     "SecurityKey": "7k5yOxSMHVdYjs61gkgUY3W9DHbgk7tokaZlP3QIlfk34D1H7jYEOcLybClW1aKl",
    19.     //签发者
    20.     "Issuer": "DataApi",
    21.     //签收者
    22.     "Audience": "DataApi",
    23.     //过期时间,单位秒,默认24小时
    24.     "ExpiredTime": 86400
    25.   }
    26. }

     

    注入配置：

    1. #region 注入Jwt服务
    2.  
    3. builder.AddJwtExt();
    4.  
    5. #endregion
    6.  
    7. #region 注入Swagger服务
    8.  
    9. builder.AddSwaggerExt();
    10.  
    11. #endregion
    12.  
    13. #region 注入Jwt配置
    14.  
    15. builder.Services.Configure(builder.Configuration.GetSection("JwtSetting"));
    16.  
    17. #endregion
    18. # region SwaggerUI配置
    19.  
    20. if (app.Environment.IsDevelopment() || app.Environment.IsProduction())
    21. {
    22.     app.UseSwaggerExt();
    23. }
    24.  
    25. #endregion
    26. # region 认证中间件
    27.  
    28. app.UseAuthentication();
    29.  
    30. #endregion

    jwtAuth扩展：

    1. using DataApi.Common;
    2. using Microsoft.AspNetCore.Authentication.JwtBearer;
    3. using Microsoft.IdentityModel.Tokens;
    4. using System.Text;
    5.  
    6. namespace DataApi.Extension
    7. {
    8.     /// 
    9.     /// Jwt扩展类
    10.     /// 
    11.     public static class JwtAuthExt
    12.     {
    13.         /// 
    14.         /// 扩展方法
    15.         /// 
    16.         /// WebApplicationBuilder
    17.         public static void AddJwtExt(this WebApplicationBuilder builder)
    18.         {
    19.             #region 注入认证服务
    20.  
    21.             builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer(options =>
    22.             {
    23.                 JwtSetting jwtSetting = builder.Configuration.GetSection("JwtSetting").Get();
    24.                 options.TokenValidationParameters = new TokenValidationParameters()
    25.                 {
    26.                     //是否验证Issuer
    27.                     ValidateIssuer = true,
    28.                     ValidIssuer = jwtSetting.Issuer,
    29.  
    30.                     //是否验证Audience
    31.                     ValidateAudience = true,
    32.                     ValidAudience = jwtSetting.Audience,
    33.  
    34.                     //是否验证失效时间
    35.                     ValidateLifetime = true, //默认含300s容错时间
    36.  
    37.                     //是否验证SecurityKey
    38.                     ValidateIssuerSigningKey = true,
    39.                     IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtSetting.SecurityKey))
    40.                 };
    41.             });
    42.  
    43.             #endregion
    44.         }
    45.     }
    46. }

    swagger扩展：

    1. using DataApi.Common;
    2. using Microsoft.OpenApi.Models;
    3. using Swashbuckle.AspNetCore.Filters;
    4. using System.Reflection;
    5. using System.Text;
    6.  
    7. namespace DataApi.Extension
    8. {
    9.     /// 
    10.     /// Swagger扩展类
    11.     /// 
    12.     public static class SwaggerExt
    13.     {
    14.         /// 
    15.         /// 扩展方法
    16.         /// 
    17.         /// WebApplicationBuilder
    18.         public static void AddSwaggerExt(this WebApplicationBuilder builder)
    19.         {
    20.             builder.Services.AddSwaggerGen(options =>
    21.             {
    22.                 //遍历所有版本,展示文档信息
    23.                 typeof(ApiVersion).GetEnumNames().ToList().ForEach(version =>
    24.                 {
    25.                     //添加文档介绍
    26.                     options.SwaggerDoc(version, new OpenApiInfo()
    27.                     {
    28.                         Title = "DataApi",
    29.                         Version = version,
    30.                         Description = $"数据接口服务：【{version}】版本"
    31.                     });
    32.                 });
    33.  
    34.                 //获取xml文件名称
    35.                 string xmlApiFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    36.                 //显示控制器注释
    37.                 options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlApiFileName), true);
    38.  
    39.                 //根据action名称进行排序
    40.                 options.OrderActionsBy(o => o.RelativePath);
    41.  
    42.                 //开启加权小锁
    43.                 options.OperationFilter();
    44.                 //options.OperationFilter();
    45.  
    46.                 // 在header中添加token，传递到后台
    47.                 //options.OperationFilter();
    48.  
    49.                 //添加安全定义
    50.                 options.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
    51.                 {
    52.                     Description = "在下框中输入Jwt授权Token：Bearer Token",
    53.                     Name = "Authorization",
    54.                     In = ParameterLocation.Header,
    55.                     Type = SecuritySchemeType.ApiKey,
    56.                     BearerFormat = "JWT",
    57.                     Scheme = "Bearer"
    58.                 });
    59.  
    60.                 //添加安全要求
    61.                 options.AddSecurityRequirement(new OpenApiSecurityRequirement()
    62.                 {
    63.                     {
    64.                         new OpenApiSecurityScheme()
    65.                         {
    66.                             Reference = new OpenApiReference()
    67.                             {
    68.                                 Type = ReferenceType.SecurityScheme,
    69.                                 Id = "Bearer"
    70.                             }
    71.                         },
    72.                         new string[]{}
    73.                     }
    74.                 });
    75.  
    76.                 options.SchemaFilter();
    77.             });
    78.         }
    79.  
    80.         /// 
    81.         /// 扩展方法
    82.         /// 
    83.         /// WebApplication
    84.         public static void UseSwaggerExt(this WebApplication app)
    85.         {
    86.             app.UseSwagger();
    87.             //版本切换
    88.             app.UseSwaggerUI(options =>
    89.             {
    90.                 typeof(ApiVersion).GetEnumNames().ToList().ForEach(version =>
    91.                 {
    92.                     options.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"【{version}】版本");
    93.                 });
    94.             });
    95.         }
    96.     }
    97. }
    1. using Microsoft.OpenApi.Any;
    2. using Microsoft.OpenApi.Models;
    3. using Swashbuckle.AspNetCore.SwaggerGen;
    4.  
    5. namespace DataApi.Extension
    6. {
    7.     /// 
    8.     /// DateTimeSchemaFilter
    9.     /// 
    10.     public class DateTimeSchemaFilter : ISchemaFilter
    11.     {
    12.         public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    13.         {
    14.             if (context.Type == typeof(DateTime) || context.Type == typeof(DateTime?))
    15.             {
    16.                 schema.Default = new OpenApiString(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")); //设置为当前时间
    17.             }
    18.         }
    19.     }
    20. }

     

    7.响应结果封装

     

    1. using Newtonsoft.Json;
    2. using System.Net;
    3.  
    4. namespace DataApi.Common
    5. {
    6.     /// 
    7.     /// 封装响应数据
    8.     /// 
    9.     public class ApiResult
    10.     {
    11.         /// 
    12.         /// 状态码
    13.         /// 
    14.         public HttpStatusCode Code { get; set; }
    15.  
    16.         /// 
    17.         /// 消息
    18.         /// 
    19.         public string? Message { get; set; }
    20.  
    21.         /// 
    22.         /// 数据
    23.         /// 
    24.         public object? Data { get; set; }
    25.  
    26.         /// 
    27.         /// 无参构造函数
    28.         /// 
    29.         public ApiResult()
    30.         {
    31.         }
    32.  
    33.         /// 
    34.         /// 带参构造函数
    35.         /// 
    36.         /// 状态码
    37.         /// 消息
    38.         /// 数据
    39.         public ApiResult(HttpStatusCode code, string message, object data)
    40.         {
    41.             Code = code;
    42.             Message = message;
    43.             Data = data;
    44.         }
    45.  
    46.         /// 
    47.         /// 序列化对象
    48.         /// 
    49.         /// json字符串
    50.         public string ToJson()
    51.         {
    52.             return JsonConvert.SerializeObject(this);
    53.         }
    54.  
    55.         /// 
    56.         /// Success标志
    57.         /// 
    58.         /// 数据
    59.         /// ApiResult
    60.         public static ApiResult Success(object data)
    61.         {
    62.             return new ApiResult(HttpStatusCode.OK, "操作成功", data);
    63.         }
    64.  
    65.         /// 
    66.         /// Error标志
    67.         /// 
    68.         /// 消息
    69.         /// ApiResult
    70.         public static ApiResult Error(string message)
    71.         {
    72.             return new ApiResult(HttpStatusCode.OK, message, "Error");
    73.         }
    74.  
    75.         /// 
    76.         /// Unauthorized标志
    77.         /// 
    78.         /// ApiResult
    79.         public static ApiResult Unauthorized()
    80.         {
    81.             return new ApiResult(HttpStatusCode.Unauthorized, "Unauthorized", "Unauthorized");
    82.         }
    83.  
    84.         /// 
    85.         /// Forbidden标志
    86.         /// 
    87.         /// ApiResult
    88.         public static ApiResult Forbidden()
    89.         {
    90.             return new ApiResult(HttpStatusCode.Forbidden, "Forbidden", "Forbidden");
    91.         }
    92.     }
    93. }

     

  • 相关阅读:
    spring使用@Value标签读取.properties文件的中文乱码问题的解决
    Nginx与Spring Boot的错误模拟实践：探索502和504错误的原因
    华为OD机考：0036-0037-最多组团数--作业总时长
    大学生必看！这些关乎你“钱途”的内容你一定要知道NISP一级证书
    【记录】PyCharm 安装 preprocess 模块（库）|| 在 PyCharm 中安装 preprocess 失败，故而在 终端 安装
    电子电路仿真（Matlab代码实现）
    sqlserver 语句执行了多长时间
    巧用count与count()
    springboot导入spring-boot-maven-plugin插件报错及打包项目到服务器上运行(手动导入加自动导入方法)-详细
    Java 常用API的运用，效率及技巧
  • 原文地址：https://blog.csdn.net/qq_16284479/article/details/137973117