分类 .Net 下的文章

Webapi路由添加namespace支持及Swagger的优化

  webapi开发中通常会使用Swagger UI来生成接口文档,关于Swagger的安装与集成已经有大量博客进行了记录,这里不再赘述。随着业务扩展,接口越来越多,使用了一段时间Swagger以后,感觉基本功能不太满足业务要求,于是研究了一番webapi和Swagger。
  webapi的默认路由模板最多支持:api/{controller}/{action}/{id},但我们想要在路由中加入命名空间,以此对接口进行业务划分,比如这样的:api/{namespace}/{action}/{id}。当接口较多时,文档一页会展示大量接口,眼睛都看花了,而且其中很多接口是早期项目中用到的,不需要频繁查看,这就需要用到swagger文档多版本管理功能。我查看了很多关于这两方面的博客,借鉴了部分前人的经验。由于部分博客存在随意复制粘贴的问题,内容不全且部分实现未经验证,花了我不少功夫。这里还是要感谢一下这些提供思路的博主。
  在进行改造整合的时候,我发现swagger对改造后的路由不太兼容,而且版本控制大多都是以路由来控制的,不能实现我想达到的效果。下面将逐一介绍路由和文档的改造。

webapi路由模板改造

  思路是自己实现一个IHttpControllerSelector,在路由中嵌入命名空间,这里参考了不是豆豆的博客。实现之后接口的请求路径就变成了api/{namespace}/{action}/{id},已经满足了使用需求,但swagger的支持效果不够好。不用swagger的小伙伴可以到此为止。为了让swagger显示的url更加美观,我稍作了修改,将路由模板的命名空间由namespace.controller的格式换成了namespace/controller的格式。实现之后,swagger的效果变成了这样:

直接修改路由模板的效果.png

  显然,这太不美观了,不仅每个控制器的名字都带上了controller,而且因为webapi对属性路由的支持,路由模板中的{namespace}被swagger当作了参数:

namespace被识别为参数.png

  于是开始对swagger进行改造。

- 阅读剩余部分 -

.net项目中配置log4net

  log4net是常用的日志工具,个人在.net项目中也经常使用,下面介绍在web项目和windows服务项目中分别配置log4net的过程。

一、web项目

1.在项目中安装log4net程序包

  在vs的解决方案管理器中选择需要添加log4net的项目,右击,然后在弹出菜单中点击“管理NuGet程序包”。

  接着在打开的NuGet包管理器中选择“浏览”标签页,在搜索框中输入log4net搜索。在搜索结果中选择Apache经典红色羽毛图标的包,然后安装。

2.添加log4net配置文件

  两种方案选择一种:

  方案1.早期的log4net包安装后会自动生成log4net.config配置文件,目前新版的程序包安装后不会自动生成配置文件了,所以就直接在web.config文件中添加log4net配置信息。打开项目的web.config文件,找到节点,在该节点下添加配置信息,具体xml代码如下:

<!--log4net日志配置信息,较为简单,需要更丰富和强大的功能可以去查找更详细的资料-->
  <log4net>   
    <root>
      <level value="ALL" />
      <appender-ref ref="SysAppender" />
    </root>
    <logger name="WebLogger">
      <level value="DEBUG" />
    </logger>
    <appender name="SysAppender" type="log4net.Appender.RollingFileAppender,log4net">
    <!--日志输出的路径:D:\Log\,根据需要替换为实际的路径-->
      <param name="File" value="D:\Log\" />
      <!--是否向日志文件中追加文本,日志一般一天一份,当天的日志都是追加到同一份文件中-->
      <param name="AppendToFile" value="true" />
      <!--创建新文件的方式,可选为Size(按文件大小),Date(按日期),Once(每启动一次创建一个文件),Composite(按日期及文件大小),默认为Composite-->
      <param name="RollingStyle" value="Date" />
      <!--文件名格式:Logs_年月日.txt,会根据日期自动变更-->
      <param name="DatePattern" value="&quot;Logs_&quot;yyyyMMdd&quot;.txt&quot;" />
      <!--文件名是否动态生成,上面已经指定了格式,这里设为false-->
      <param name="StaticLogFileName" value="false" />
       <!--每条日志具体内容的格式-->
      <layout type="log4net.Layout.PatternLayout,log4net">
      <!--此处指定的格式为:时间(年月日时分秒毫秒) [线程id] 日志级别 当前日志对象名称 - 程序中输出的日志信息 换行-->
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
      </layout>
    </appender>
  </log4net>

  方案2.也可以选择新建一个log4net.config文件,在该文件下添加配置内容,记得在上面给出的代码外层加上节点

- 阅读剩余部分 -