MicroCloud.AspNetCore 8.0.2.5

MicroCloud AspNetCore 组件

说明

MicroCloud AspNetCore 组件，提供 AspNetCore 的服务端功能的封装。

用法

可按照如下配置方式使用：

1. 通过nuget引用 MicroCloud.AspNetCore 程序集

Install-Package MicroCloud.AspNetCore

2. 在 appsettings.json 中 的 MicroCloud 节点下添加如下配置节点

{
   //Cors跨域策略
    "Cors": {
      "PolicyName": "MicroCloudAPI", //策略名称
      "AllowAnyHeader": true, //允许任意请求头
      "WithHeaders": [ "Authorization", "Accept", "Accept-Language" ], //允许的请求头，当 AllowAnyHeader = false 时生效
      "AllowAnyMethod": true, //允许任意方法
      "WithMethods": [ "POST", "PUT", "DELETE" ], //允许的方法，当 AllowAnyMethod = false 时生效
      "AllowCredentials": true, //允许跨域凭据，优先级高于 DisallowCredentials 设置
      "DisallowCredentials": false, //禁止跨域凭据
      "AllowAnyOrigin": true, //允许任意来源
      "WithOrigins": [ "https://localhost:44398", "http://127.0.0.1:5001" ], //允许的来源，当 AllowAnyOrigin = false 时生效
      "Enabled": true //设置跨源资源共享服务是否启用
    },
    //Mvc选项
    "Mvc": {
      "DefaultLanguage": "zh_CN", //默认语言，可实现AcceptLanguage请求语言的消息字符解析，语言文件存放于“configs/localization”路径下
      "IsLowercaseJsonProperty": false, //Json属性名称驼峰(lowerCase)写法设置，默认：false
      "IsLowercaseUrls": false, //URL驼峰(lowerCase)写法设置，默认：false
      "ReferenceLoopHandling": "Ignore", //循环引用处理："Error"、"Ignore"、"Serialize"，默认："Ignore"
      "NullValueHandling": "Include", //Null值处理："Include"、"Ignore"，默认："Include"
      "StringEnumConvert": false, //String与Enum类型转换，默认：false
      "StringLongConvert": true, //String与Long类型转换，默认：true
      "DateFormatHandling": "Iso", //日期时间格式化处理："Iso"、"Microsoft"，默认："Iso"
      "DateFormatString": "", //日期时间格式化字符串，例如："yyyy/MM/dd HH:mm:ss"，默认：""
      "DateTimeZoneHandling": "Local", //日期时间时区处理："Local"、"Utc"、Unspecified"、RoundtripKind"，默认："Local"
      "DateParseHandling": "DateTime" //日期时间解析处理："None"、"DateTime"、"DateTimeOffset"，默认："DateTime""
    },
    //宿主配置策略
    "Host": {
      //终结点
      "Endpoints": {
        "Http": {
          "Address": "", //IP地址（*或者不填默认本机任意IP）
          "Port": "38062", //监听端口
          "Enabled": true //是否启用
        },
        "Https": {
          "Address": "*", //IP地址（*或者不填默认本机任意IP）
          "Port": "38063", //监听端口
          //SSL证书（不为空时将使用HTTPS）
          "Certificate": {
            "Source": "File", //源（固定字符“File”）
            "Path": "Certificate\\MicroCloud.pfx", //证书路径
            "Password": "password" //证书密钥
          },
          "Enabled": true //是否启用
        }
      }
    },
    //SignalR实时通信配置
    //心跳监测机制：A. 以客户端为基准的机制。客户端配置：serverTimeoutInMilliseconds + 服务端端配置：keepAliveinterval，建议 serverTimeoutInMilliseconds 的值是 keepAliveinterval 的两倍，从而保证客户端不进入 onclose 回调，不掉线。
    //心跳监测机制：B. 以服务端为基准的机制。客户端配置：keepAliveIntervalInmillisecods + 服务端配置：clientTimeoutInterval，建议 clientTimeoutInterval 的值是 keepAliveIntervalInmillisecods 的两倍，从而保证不进服务器端的 OnDisconnectedAsync 回调，即不掉线。
    "SignalR": {
      //如果客户端在此时间间隔内未收到消息（包括保持活动状态），则服务器会将客户端视为已断开连接。默认超时为30秒。
      //由于实现方式的原因，客户端实际标记为断开连接可能需要更长的时间。建议值为 KeepAliveInterval 值的两倍。
      "ClientTimeoutInterval": 30,
      //如果客户端在此时间间隔内未发送初始握手消息，连接将关闭。 这是一种高级设置，只应在握手超时错误由于严重网络延迟而发生时进行修改。默认超时为15秒。
      //有关握手过程的详细信息，请参阅SignalR 集线器协议规范。
      "HandshakeTimeout": -1,
      //如果服务器未在此时间间隔内发送消息，则会自动发送 ping 消息，使连接保持打开状态。默认间隔为15秒。
      //更改 KeepAliveInterval时，请更改客户端上的 ServerTimeout/serverTimeoutInMilliseconds 设置。 建议的 ServerTimeout/serverTimeoutInMilliseconds 值为 KeepAliveInterval 值的两倍。
      "KeepAliveInterval": 15,
      "MaximumReceiveMessageSize": 51200, //单个传入集线器消息的最大消息大小。默认值为32KB。
      "StreamBufferCapacity": 1024, //客户端上载流的最大缓冲区大小。默认大小为10。
      "MessagePackEnabled": true, //启用MessagePack(支持二进制内容传输)
      "RoutePattern": "/signalr", //线路型式(用于挂载SignalR终结点)
      "Enabled": true //是否启用
    },
}

交流

QQ群号：863605868	微信号：SeonHu