XiaoFeng.Net 网络库使用
网络库介绍
XiaoFeng.Net网络库包含了 SocketServer,SocketClient,WebSocketServer,WebSocketClient四个类库
SocketServer 网络服务端同时支持Socket客户端连接，WebSocket客户端，浏览器WebSocket连接
SocketCleint 网络客户端
WebSocketServer WebSocket服务端仅支持WebSocket客户端连接或浏览器WebSocket连接
WebSocketClient WebSocket客户端
SocketServer 服务端
WebSocketServer 除了实例化参数不一样其它属性和SocketServer是一样的，因为WebSocketServer就是继承了SocketServer
var c = new SocketServer(8011);
//SSL证书
c.Certificate = new X509Certificate2(@"E:\\d.pfx", "7092734", X509KeyStorageFlags.MachineKeySet);
c.SslProtocols= System.Security.Authentication.SslProtocols.Tls12;
//是否启动定时向客户端发送pong功能
c.IsPong = false;
c.PongTime = 30;
c.OnStart += (o, e) =>
{
//项目启动后触发当前事件
w("项目启动.");
};
c.OnAuthentication += (c, m, e) =>
{
//认证事件
//对应Authentication认证委托，认证失败后会触发当前事件
};
c.Authentication = c =>
{
//认证方法
//在这里判断客户端是否是我们合法的客户端请求连接 return false 表示拒绝连接请求 return true 表示接受连接请求
return true;
};
c.OnStop += (c, e) =>
{
//项目停止后触发的事件
w("项目停止.");
};
//下边OnMessage,OnMessageByte两个事件在实际工作中根据自己的需求用其中一个事件即可
c.OnMessage += (c, m, e) =>
{
//接收到消息后触发当前事件
w($"接收到消息[{c.EndPoint}](text):{m}");
//向当前客户端发送接收到的消息
c.Send(m);
};
c.OnMessageByte += (c, m, e) =>
{
//接收到消息后触发当前事件
w($"接收到消息[{c.EndPoint}](bytes):{m.GetString()}");
//向当前客户端发送接收到的消息
c.Send(m);
};
c.OnError += (c, e) =>
{
//服务端出错触发当前事件
w("出错:" + e.Message);
};
c.OnNewConnection += (c, e) =>
{
//有新的客户端连接请求触发当前事件
w($"新连接[{c.EndPoint}]");
};
c.OnDisconnected += (c, e) =>
{
//客户端断开连接后触发当前事件
w($"断开连接[{c.EndPoint}]");
};
c.OnClientError += (c,ip, e) =>
{
//处理客户端出错时触发当前事件
w($"客户端出错[{c.EndPoint}]:{e.Message}");
};
//启动
c.Start();
//其它方法及属性
//当前连接的客户端
var clients = c.Clients;
//添加黑名单 添加进黑名单的IP 通过这个IP的客户端都拒绝连接服务端
c.AddBlack("192.138.1.2");
//移除黑名单
c.RemoveBlack("192.168.1.2");
Console.WriteLine();
SocketClient 客户端
WebSocketClient也是继承于SocketClient 所以它的属性和SocketClient也是一样的。
下边直接上代码
var ws = new SocketClient("127.0.0.1", 8011);
//是否启动定时ping功能
ws.IsPing = false;
ws.PingTime = 30;
ws.OnMessage += (c, m, e) =>
{
w("接收到消息(text):" + m);
};
ws.OnMessageByte += (c, m, e) =>
{
w("接收到消息(bytes):" + m.GetString());
};
ws.OnClientError += (c,ip, e) =>
{
w("出错:" + e.Message);
};
ws.OnStart += async (c, e) =>
{
w("已启动");
//await ws.SendAsync("消息").ConfigureAwait(false);
};
ws.OnStop += (c, e) =>
{
w("已停止");
};
ws.Start();
Console.ReadLine();
WebSocketClient还有一个单独的属性WebSocketRequestOptions 它是一个请示配置类看它的完整代码
////// public String Authorization { get => this[HttpRequestHeader.Authorization]; set => this[HttpRequestHeader.Authorization] = value; } ////// WebSocketClient请求配置 /// public class WebSocketRequestOptions { #region 构造器 /// /// 无参构造器 /// public WebSocketRequestOptions() { this.WebHeader = new WebHeaderCollection(); this[HttpRequestHeader.Connection] = "Upgrade"; this[HttpRequestHeader.Pragma] = "no-cache"; this["Sec-WebSocket-Extensions"] = "permessage-deflate; client_max_window_bits"; this["Sec-WebSocket-Version"] = "13"; this[HttpRequestHeader.Upgrade] = "websocket"; this[HttpRequestHeader.UserAgent] = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36"; this[HttpRequestHeader.AcceptEncoding] = (AcceptEncodingType.GZIP | AcceptEncodingType.DEFLATE | AcceptEncodingType.BR).ToLower(); this[HttpRequestHeader.CacheControl] = "no-cache"; this[HttpRequestHeader.AcceptLanguage] = "zh-CN,zh;q=0.9"; } #endregion #region 属性 /// /// 获取请求头值 /// /// 头key /// 请求头值 public String this[HttpRequestHeader header] { get => this.Get(header); set => this.Set(header, value); } ////// 获取请求头值 /// /// 头key /// 请求头值 public String this[HttpResponseHeader header] { get => this.Get(header); set => this.Set(header, value); } ////// 获取请求头值 /// /// key /// 请求头值 public String this[String key] { get => this.Get(key); set => this.Set(key, value); } ////// 请求地址 /// private Uri _Uri; /// /// 请求地址 /// public Uri Uri { get => this._Uri; set { this._Uri = value; this[HttpRequestHeader.Host] = value.Host + ":" + value.Port; } } /// /// 请求类型 或 /// public HttpMethod Method { get; set; } = HttpMethod.Get; /// /// Http协议版本 1.0,1.1,2.0,3.0 /// public HttpVersionX HttpVersion { get; set; } = HttpVersionX.Version11; /// /// Host 标头，指定要请求的资源的主机名和端口号。 /// public String Host => this[HttpRequestHeader.Host]; /// /// Connection 标头，指定特定连接所需的选项。指定客户端和服务器之间的连接类型，如 keep-alive、close 等。 /// public String Connection => this[HttpRequestHeader.Connection]; /// /// Pragma 标头，指定特定于实现的指令，这些指令可应用到请求/响应链上的任意代理。用来包含实现特定的指令。 /// public String Pragma => this[HttpRequestHeader.Pragma]; /// /// 源头 /// public String Origin { get => this["Origin"]; set => this["Origin"] = value; } /// /// 客户端支持的扩展列表 /// public String SecWebSocketExtensions { get => this["Sec-WebSocket-Extensions"]; set => this["Sec-WebSocket-Extensions"] = value; } /// /// 请求标识key /// public String SecWebSocketKey { get => this["Sec-WebSocket-Key"]; set => this["Sec-WebSocket-Key"] = value; } /// /// WebSocket版本 /// public String SecWebSocketVersion => this["Sec-WebSocket-Version"]; /// /// Upgrade 标头，指定客户端支持的其他通信协议。向服务器指定某种传输协议以便服务器进行转换。 /// public String Upgrade => this[HttpRequestHeader.Upgrade]; /// /// User-Agent 标头，指定有关客户端代理的信息。标识浏览器的详细信息，包括名称、版本、操作系统等。 /// public String UserAgent { get => this[HttpRequestHeader.UserAgent]; set => this[HttpRequestHeader.UserAgent] = value; } /// /// Accept-Charset 标头，指定响应可接受的内容编码。指定客户端可以接受的压缩编码类型 /// public AcceptEncodingType AcceptEncoding { get => this[HttpRequestHeader.AcceptEncoding].ToUpper().ToCast<AcceptEncodingType>(); set => this[HttpRequestHeader.AcceptEncoding] = value.ToLower(); } /// /// Cache-Control 标头，指定请求/响应链上所有缓存控制机制必须服从的指令。如 no-cache、max-age 等。 /// public String CacheControl => this[HttpRequestHeader.CacheControl]; /// /// Accept-Langauge 标头，指定用于响应的首选自然语言。。 /// public String AcceptLanguage { get => this[HttpRequestHeader.AcceptLanguage]; set => this[HttpRequestHeader.AcceptLanguage] = value; } /// /// Referer 标头，指定可从中获取请求 URI 的资源 URI。 /// public String Referer { get => this[HttpRequestHeader.Referer]; set => this[HttpRequestHeader.Referer] = value; } /// /// From 标头，指定控制请求的用户代理的用户的 Internet 电子邮件地址。 /// public String From { get => this[HttpRequestHeader.From]; set => this[HttpRequestHeader.From] = value; } /// /// Authorization 标头，指定客户端提供的以向服务器验证自身身份的凭据。 凭证是 (用户名:密码)的base64 /// /// /// 假设用户名为jacky密码为eelf.cn则代码就是 ///Convert.ToBase64String(Encoding.UTF8.GetBytes("jacky:eelf.cn"))/// ////// 则上面的帐号密码输出为以下 /// /// Authorization: Basic amFja3k6ZWVsZi5jbg== ////// Proxy-Authorization 标头，指定客户端提供的以向代理验证自身身份的凭据。 /// /// /// 设置参照 属性设置 /// public String ProxyAuthorization { get => this[HttpRequestHeader.ProxyAuthorization]; set => this[HttpRequestHeader.ProxyAuthorization] = value; } /// /// Cookie 标头，指定向服务器提供的 cookie 数据。 /// public String Cookie { get => this[HttpRequestHeader.Cookie]; set => this[HttpRequestHeader.Cookie] = value; } /// /// Content-Encoding 标头，指定应用到随附的正文数据的编码。 /// public String ContentEncoding { get => this[HttpRequestHeader.ContentEncoding]; set => this[HttpRequestHeader.ContentEncoding] = value; } /// /// Content-Language 标头，指定随附的正文数据的自然语言。 /// public String ContentLangauge { get => this[HttpRequestHeader.ContentLanguage]; set => this[HttpRequestHeader.ContentLanguage] = value; } /// /// Content-MD5 标头，指定随附的正文数据的 MD5 摘要，以便提供端到端消息完整性检查。 由于 MD5 出现冲突问题，Microsoft 建议使用基于SHA256 或更高版本的安全模型。 /// public String ContentMd5 { get => this[HttpRequestHeader.ContentMd5]; set => this[HttpRequestHeader.ContentMd5] = value; } /// /// 自定义协议标头。 /// private WebHeaderCollection WebHeader { get; set; } #endregion #region 方法 /// /// 设置协议标头信息 /// /// 协议标头key /// 协议标头value public void Set(string key, string value) { if (key.IsNullOrEmpty()) return; if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Set(key, value); } /// /// 设置协议标头信息 /// /// 协议标头key /// 协议标头value public void Set(HttpRequestHeader header, string value) { if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Set(header, value); } /// /// 设置协议标头信息 /// /// 协议标头 key /// 协议标头 value public void Set(HttpResponseHeader header, string value) { if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Set(header, value); } /// /// 添加协议标头信息 /// /// 协议标头 key /// 协议标头 value public void Add(string key, string value) { if (key.IsNullOrEmpty()) return; if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Add(key, value); } /// /// 添加协议标头信息 /// /// 协议标头 key /// 协议标头 value public void Add(HttpRequestHeader header, string value) { if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Add(header, value); } /// /// 添加协议标头信息 /// /// 协议标头 key /// 协议标头 value public void Add(HttpResponseHeader header, string value) { if (this.WebHeader == null) this.WebHeader = new WebHeaderCollection(); this.WebHeader.Add(header, value); } /// /// 获取协议标头数据 /// /// 协议标头 key /// 协议标头值 public string Get(HttpRequestHeader header) { if (this.WebHeader == null) return String.Empty; return this.WebHeader[header]; } ////// 获取协议标头数据 /// /// 协议标头 key /// 协议标头值 public string Get(string key) { if (this.WebHeader == null) return String.Empty; return this.WebHeader[key]; } ////// 获取响应协议标头数据 /// /// 响应协议标头key /// 响应协议标头数据 public string Get(HttpResponseHeader header) { if (this.WebHeader == null) return String.Empty; return this.WebHeader[header]; } ////// 转成协议标头字符串 /// /// 合并协议标头字符串 public override string ToString() { var sbr = new StringBuilder(); sbr.AppendLine($"{this.Method} {this.Uri?.PathAndQuery} HTTP/{((float)this.HttpVersion) / 10F}"); sbr.Append(this.WebHeader.ToString()); return sbr.ToString(); } #endregion }
从上边的代码可以看出来，所有http请求的头基本上都有，如果自定义的头信息怎么办，那么就用当前配置的Add方法来添加。
开源地址：XiaoFeng