C# .NET Socket
C# .NET Socket 简单实用框架
背景：
首先向各位前辈，大哥哥小姐姐问一声好~
这是我第一次写博客，目前为一个即将步入大四的学生，上学期在一家公司实习了半年，后期发现没有动力，而且由于薪水问题（废话嘛），于是跳槽到这家新的公司。
说到Socket，想必大家都或多或少有所涉及，从最初的计算机网络课程，讲述了tcp协议，而Socket就是对协议的进一步封装，使我们开发人员能够更加容易轻松的进行软件之间的通信。
这个星期刚好接受一个共享车位锁的项目，需要使用Socket与硬件进行通信控制，说白了也就是给锁发送指令，控制其打开或者关闭，再就是对App开放操作接口，使其方便测试以及用户的使用。这其中核心就是Socket的使用，再开发出这个功能之后，我发现使用起来很不方便，于是耗时2天抽象其核心功能并封装成框架，最后使用这个框架将原来的项目重构并上线，极大的提高了软件的可拓展性，健壮性，容错率。
个人坚信的原则：万物皆对象
好了，不废话了，下面进入正文
正文：
1、首先简单讲下C#中Socket的简单使用。
第一步：服务端监听某个端口
第二步：客户端向服务端地址和端口发起Socket连接请求
第三步：服务端收到连接请求后创建Socket连接，并维护这个连接队列。
第四步：客户端和服务端已经建立双工通信（即双向通信），客户端和服务端可以轻松方便的给彼此发送信息。
至于简单使用的具体实现代码全部被我封装到项目中了，如果需要学习简单的实现，可以看我的源码，也可以自行百度，有很多的教程
2、核心，框架的使用
其实，说其为框架，可能有点牵强，因为每个人对框架都有自己的理解，但是类库和框架又有什么本质区别呢？全部都是代码~哈哈，扯远了
首先，空说无凭，先放上所有的代码：
服务端源文件：
SocketServer.cs
using System;
using System.Collections.Generic;
using System.Net;
using System.Net.Sockets; namespace Coldairarrow.Util.Sockets
{
/// <summary>
/// Socket服务端
/// </summary>
public class SocketServer
{
#region 构造函数 /// <summary>
/// 构造函数
/// </summary>
/// <param name="ip">监听的IP地址</param>
/// <param name="port">监听的端口</param>
public SocketServer(string ip, int port)
{
_ip = ip;
_port = port;
} /// <summary>
/// 构造函数,监听IP地址默认为本机0.0.0.0
/// </summary>
/// <param name="port">监听的端口</param>
public SocketServer(int port)
{
_ip = "0.0.0.0";
_port = port;
} #endregion #region 内部成员 private Socket _socket = null;
private string _ip = "";
private int _port = 0;
private bool _isListen = true;
private void StartListen()
{
try
{
_socket.BeginAccept(asyncResult =>
{
try
{
Socket newSocket = _socket.EndAccept(asyncResult); //马上进行下一轮监听,增加吞吐量
if (_isListen)
StartListen(); SocketConnection newClient = new SocketConnection(newSocket, this)
{
HandleRecMsg = HandleRecMsg == null ? null : new Action<byte[], SocketConnection, SocketServer>(HandleRecMsg),
HandleClientClose = HandleClientClose == null ? null : new Action<SocketConnection, SocketServer>(HandleClientClose),
HandleSendMsg = HandleSendMsg == null ? null : new Action<byte[], SocketConnection, SocketServer>(HandleSendMsg),
HandleException = HandleException == null ? null : new Action<Exception>(HandleException)
}; newClient.StartRecMsg();
ClientList.AddLast(newClient); HandleNewClientConnected?.Invoke(this, newClient);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} #endregion #region 外部接口 /// <summary>
/// 开始服务，监听客户端
/// </summary>
public void StartServer()
{
try
{
//实例化套接字（ip4寻址协议，流式传输，TCP协议）
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
//创建ip对象
IPAddress address = IPAddress.Parse(_ip);
//创建网络节点对象包含ip和port
IPEndPoint endpoint = new IPEndPoint(address, _port);
//将 监听套接字绑定到 对应的IP和端口
_socket.Bind(endpoint);
//设置监听队列长度为Int32最大值(同时能够处理连接请求数量)
_socket.Listen(int.MaxValue);
//开始监听客户端
StartListen();
HandleServerStarted?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} /// <summary>
/// 所有连接的客户端列表
/// </summary>
public LinkedList<SocketConnection> ClientList { get; set; } = new LinkedList<SocketConnection>(); /// <summary>
/// 关闭指定客户端连接
/// </summary>
/// <param name="theClient">指定的客户端连接</param>
public void CloseClient(SocketConnection theClient)
{
theClient.Close();
} #endregion #region 公共事件 /// <summary>
/// 异常处理程序
/// </summary>
public Action<Exception> HandleException { get; set; } #endregion #region 服务端事件 /// <summary>
/// 服务启动后执行
/// </summary>
public Action<SocketServer> HandleServerStarted { get; set; } /// <summary>
/// 当新客户端连接后执行
/// </summary>
public Action<SocketServer, SocketConnection> HandleNewClientConnected { get; set; } /// <summary>
/// 服务端关闭客户端后执行
/// </summary>
public Action<SocketServer, SocketConnection> HandleCloseClient { get; set; } #endregion #region 客户端连接事件 /// <summary>
/// 客户端连接接受新的消息后调用
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; } /// <summary>
/// 客户端连接发送消息后回调
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; } /// <summary>
/// 客户端连接关闭后回调
/// </summary>
public Action<SocketConnection, SocketServer> HandleClientClose { get; set; } #endregion
}
}
using System;
using System.Net.Sockets;
using System.Text; namespace Coldairarrow.Util.Sockets
{
/// <summary>
/// Socket连接,双向通信
/// </summary>
public class SocketConnection
{
#region 构造函数 public SocketConnection(Socket socket,SocketServer server)
{
_socket = socket;
_server = server;
} #endregion #region 私有成员 private readonly Socket _socket;
private bool _isRec=true;
private SocketServer _server = null;
private bool IsSocketConnected()
{
bool part1 = _socket.Poll(1000, SelectMode.SelectRead);
bool part2 = (_socket.Available == 0);
if (part1 && part2)
return false;
else
return true;
} #endregion #region 外部接口 /// <summary>
/// 开始接受客户端消息
/// </summary>
public void StartRecMsg()
{
try
{
byte[] container = new byte[1024 * 1024 * 2];
_socket.BeginReceive(container, 0, container.Length, SocketFlags.None, asyncResult =>
{
try
{
int length = _socket.EndReceive(asyncResult); //马上进行下一轮接受，增加吞吐量
if (length > 0 && _isRec && IsSocketConnected())
StartRecMsg(); if (length > 0)
{
byte[] recBytes = new byte[length];
Array.Copy(container, 0, recBytes, 0, length); //处理消息
HandleRecMsg?.Invoke(recBytes, this, _server);
}
else
Close();
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
Close();
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
Close();
}
} /// <summary>
/// 发送数据
/// </summary>
/// <param name="bytes">数据字节</param>
public void Send(byte[] bytes)
{
try
{
_socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>
{
try
{
int length = _socket.EndSend(asyncResult);
HandleSendMsg?.Invoke(bytes, this, _server);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} /// <summary>
/// 发送字符串（默认使用UTF-8编码）
/// </summary>
/// <param name="msgStr">字符串</param>
public void Send(string msgStr)
{
Send(Encoding.UTF8.GetBytes(msgStr));
} /// <summary>
/// 发送字符串（使用自定义编码）
/// </summary>
/// <param name="msgStr">字符串消息</param>
/// <param name="encoding">使用的编码</param>
public void Send(string msgStr,Encoding encoding)
{
Send(encoding.GetBytes(msgStr));
} /// <summary>
/// 传入自定义属性
/// </summary>
public object Property { get; set; } /// <summary>
/// 关闭当前连接
/// </summary>
public void Close()
{
try
{
_isRec = false;
_socket.Disconnect(false);
_server.ClientList.Remove(this);
HandleClientClose?.Invoke(this, _server);
_socket.Close();
_socket.Dispose();
GC.Collect();
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} #endregion #region 事件处理 /// <summary>
/// 客户端连接接受新的消息后调用
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; } /// <summary>
/// 客户端连接发送消息后回调
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; } /// <summary>
/// 客户端连接关闭后回调
/// </summary>
public Action<SocketConnection, SocketServer> HandleClientClose { get; set; } /// <summary>
/// 异常处理程序
/// </summary>
public Action<Exception> HandleException { get; set; } #endregion
}
}
using System;
using System.Net;
using System.Net.Sockets;
using System.Text; namespace Coldairarrow.Util.Sockets
{
/// <summary>
/// Socket客户端
/// </summary>
public class SocketClient
{
#region 构造函数 /// <summary>
/// 构造函数,连接服务器IP地址默认为本机127.0.0.1
/// </summary>
/// <param name="port">监听的端口</param>
public SocketClient(int port)
{
_ip = "127.0.0.1";
_port = port;
} /// <summary>
/// 构造函数
/// </summary>
/// <param name="ip">监听的IP地址</param>
/// <param name="port">监听的端口</param>
public SocketClient(string ip, int port)
{
_ip = ip;
_port = port;
} #endregion #region 内部成员 private Socket _socket = null;
private string _ip = "";
private int _port = 0;
private bool _isRec=true;
private bool IsSocketConnected()
{
bool part1 = _socket.Poll(1000, SelectMode.SelectRead);
bool part2 = (_socket.Available == 0);
if (part1 && part2)
return false;
else
return true;
} /// <summary>
/// 开始接受客户端消息
/// </summary>
public void StartRecMsg()
{
try
{
byte[] container = new byte[1024 * 1024 * 2];
_socket.BeginReceive(container, 0, container.Length, SocketFlags.None, asyncResult =>
{
try
{
int length = _socket.EndReceive(asyncResult); //马上进行下一轮接受，增加吞吐量
if (length > 0 && _isRec && IsSocketConnected())
StartRecMsg(); if (length > 0)
{
byte[] recBytes = new byte[length];
Array.Copy(container, 0, recBytes, 0, length); //处理消息
HandleRecMsg?.Invoke(recBytes, this);
}
else
Close();
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
Close();
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
Close();
}
} #endregion #region 外部接口 /// <summary>
/// 开始服务，连接服务端
/// </summary>
public void StartClient()
{
try
{
//实例化 套接字 （ip4寻址协议，流式传输，TCP协议）
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
//创建 ip对象
IPAddress address = IPAddress.Parse(_ip);
//创建网络节点对象 包含 ip和port
IPEndPoint endpoint = new IPEndPoint(address, _port);
//将 监听套接字 绑定到 对应的IP和端口
_socket.BeginConnect(endpoint, asyncResult =>
{
try
{
_socket.EndConnect(asyncResult);
//开始接受服务器消息
StartRecMsg(); HandleClientStarted?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} /// <summary>
/// 发送数据
/// </summary>
/// <param name="bytes">数据字节</param>
public void Send(byte[] bytes)
{
try
{
_socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>
{
try
{
int length = _socket.EndSend(asyncResult);
HandleSendMsg?.Invoke(bytes, this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} /// <summary>
/// 发送字符串（默认使用UTF-8编码）
/// </summary>
/// <param name="msgStr">字符串</param>
public void Send(string msgStr)
{
Send(Encoding.UTF8.GetBytes(msgStr));
} /// <summary>
/// 发送字符串（使用自定义编码）
/// </summary>
/// <param name="msgStr">字符串消息</param>
/// <param name="encoding">使用的编码</param>
public void Send(string msgStr, Encoding encoding)
{
Send(encoding.GetBytes(msgStr));
} /// <summary>
/// 传入自定义属性
/// </summary>
public object Property { get; set; } /// <summary>
/// 关闭与服务器的连接
/// </summary>
public void Close()
{
try
{
_isRec = false;
_socket.Disconnect(false);
HandleClientClose?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
} #endregion #region 事件处理 /// <summary>
/// 客户端连接建立后回调
/// </summary>
public Action<SocketClient> HandleClientStarted { get; set; } /// <summary>
/// 处理接受消息的委托
/// </summary>
public Action<byte[], SocketClient> HandleRecMsg { get; set; } /// <summary>
/// 客户端连接发送消息后回调
/// </summary>
public Action<byte[], SocketClient> HandleSendMsg { get; set; } /// <summary>
/// 客户端连接关闭后回调
/// </summary>
public Action<SocketClient> HandleClientClose { get; set; } /// <summary>
/// 异常处理程序
/// </summary>
public Action<Exception> HandleException { get; set; } #endregion
}
}
上面放上的是框架代码，接下来介绍下如何使用
首先，服务端使用方式：
using Coldairarrow.Util.Sockets;
using System;
using System.Text; namespace Console_Server
{
class Program
{
static void Main(string[] args)
{
//创建服务器对象，默认监听本机0.0.0.0，端口12345
SocketServer server = new SocketServer(12345); //处理从客户端收到的消息
server.HandleRecMsg = new Action<byte[], SocketConnection, SocketServer>((bytes, client, theServer) =>
{
string msg = Encoding.UTF8.GetString(bytes);
Console.WriteLine($"收到消息:{msg}");
}); //处理服务器启动后事件
server.HandleServerStarted = new Action<SocketServer>(theServer =>
{
Console.WriteLine("服务已启动************");
}); //处理新的客户端连接后的事件
server.HandleNewClientConnected = new Action<SocketServer, SocketConnection>((theServer, theCon) =>
{
Console.WriteLine($@"一个新的客户端接入，当前连接数：{theServer.ClientList.Count}");
}); //处理客户端连接关闭后的事件
server.HandleClientClose = new Action<SocketConnection, SocketServer>((theCon, theServer) =>
{
Console.WriteLine($@"一个客户端关闭，当前连接数为：{theServer.ClientList.Count}");
}); //处理异常
server.HandleException = new Action<Exception>(ex =>
{
Console.WriteLine(ex.Message);
}); //服务器启动
server.StartServer(); while (true)
{
Console.WriteLine("输入:quit，关闭服务器");
string op = Console.ReadLine();
if (op == "quit")
break;
}
}
}
}
客户端使用方式：
using Coldairarrow.Util.Sockets;
using System;
using System.Text; namespace Console_Client
{
class Program
{
static void Main(string[] args)
{
//创建客户端对象，默认连接本机127.0.0.1,端口为12345
SocketClient client = new SocketClient(12345); //绑定当收到服务器发送的消息后的处理事件
client.HandleRecMsg = new Action<byte[], SocketClient>((bytes, theClient) =>
{
string msg = Encoding.UTF8.GetString(bytes);
Console.WriteLine($"收到消息:{msg}");
}); //绑定向服务器发送消息后的处理事件
client.HandleSendMsg = new Action<byte[], SocketClient>((bytes, theClient) =>
{
string msg = Encoding.UTF8.GetString(bytes);
Console.WriteLine($"向服务器发送消息:{msg}");
}); //开始运行客户端
client.StartClient(); while (true)
{
Console.WriteLine("输入:quit关闭客户端，输入其它消息发送到服务器");
string str = Console.ReadLine();
if (str == "quit")
{
client.Close();
break;
}
else
{
client.Send(str);
}
}
}
}
}
最后运行测试截图：
总结：
其最方便之处在于，将如何创建连接封装掉，使用人员只需关注连接后发送什么数据，接收到数据后应该如何处理，等等其它的很多事件的处理，这其中主要依托于匿名委托的使用，Lambda表达式的使用。
框架里面主要使用了异步通讯，以及如何控制连接，详细我就不多说了，大家应该一看就懂，我只希望能给大家带来便利，最后大家有任何问题、意见、想法，都可以给我留言。
最后，附上所有源码项目地址，若觉得有一定价值，还请点赞~
GitHub地址：https://github.com/Coldairarrow/Sockets
分类: C# .NET相关
C# .NET Socket的更多相关文章
- socket读写返回值的处理
在调用socket读写函数read(),write()时,都会有返回值.如果没有正确处理返回值,就可能引入一些问题 总结了以下几点 1当read()或者write()函数返回值大于0时,表示实际从缓冲 ...
- Socket聊天程序——Common
写在前面: 上一篇记录了Socket聊天程序的客户端设计,为了记录的完整性,这里还是将Socket聊天的最后一个模块--Common模块记录一下.Common的设计如下: 功能说明: Common模块 ...
- Socket聊天程序——客户端
写在前面: 上周末抽点时间把自己写的一个简单Socket聊天程序的初始设计和服务端细化设计记录了一下,周二终于等来毕业前考的软考证书,然后接下来就是在加班的日子度过了,今天正好周五,打算把客户端的详细 ...
- Socket聊天程序——服务端
写在前面: 昨天在博客记录自己抽空写的一个Socket聊天程序的初始设计,那是这个程序的整体设计,为了完整性,今天把服务端的设计细化记录一下,首页贴出Socket聊天程序的服务端大体设计图,如下图: ...
- Socket聊天程序——初始设计
写在前面: 可能是临近期末了,各种课程设计接踵而来,最近在csdn上看到2个一样问答(问题A,问题B),那就是编写一个基于socket的聊天程序,正好最近刚用socket做了一些事,出于兴趣,自己抽了 ...
- Java中的Socket的用法
Java中的Socket的用法 Java中的Socket分为普通的Socket和NioSocket. 普通Socket的用法 Java中的 ...
- Android Socket连接PC出错问题及解决
最近测试问题:Android 通过Socket链接电脑,ip和端口都是正确的,也在同一网段,可android端就是报异常如下: 解决办法:测试电脑的防火墙可能开着,在控制面板把防火墙打开即可.
- Linux下的C Socket编程 -- server端的继续研究
Linux下的C Socket编程(四) 延长server的生命周期 在前面的一个个例子中,server在处理完一个连接后便会立即结束掉自己,然而这种server并不科学啊,server应该是能够一直 ...
- Mono 3.2.3 Socket功能迎来一稳定的版本
由于兴趣自己业余时间一直在搞.net下面的通讯应用,mono的存在得以让.NET程序轻松运行在Linux之下.不过经过多尝试Socket相关功能在Mono下的表现并不理想.不管性能还是吞吐能力方面离我 ...
- Demo源码放送：打通B/S与C/S ！让HTML5 WebSocket与.NET Socket公用同一个服务端！
随着HTML5 WebSocket技术的日益成熟与普及,我们可以借助WebSocket来更加方便地打通BS与CS -- 因为B/S中的WebSocket可以直接连接到C/S的服务端,并进行双向通信.如 ...
随机推荐
- 运行 CMD 时，參数加引號常见问题
在调用 CMD 时.如脚本中用 WScript.Shell 调用. 假设參数中有包括空格的长路径名时,必需要加引號才干正确被识别. 是的,大家都知道要加引號.但怎么加却easy被误解.这个问题,不时地 ...
- LeetCode OJ Basic Calculator II
Basic Calculator II 题目 思路 和这个一样:Basic Calculator I 代码 class ExpressionTransformation { public: strin ...
- 跟着辛星用PHP的反射机制来实现插件
我的博文的前一篇解说了PHP的反射机制是怎么回事,假设读者还不清楚反射机制,能够搜索下或者看我的博文,都是不错的选择.我们開始解说一下怎么用PHP来实现插件机制.所谓插件机制.就是我们定义一个接口.即 ...
- Linux登录状态
1.hostname 显示主机名称.设置主机名称 1)显示主机名称 xiaohuang@xiaohuang-virtual-machine:~$ hostname xiaohuang-virtual- ...
- chocolatey 的安装与安装过程中的注意事项
安装的windows需求 Windows 7+ / Windows Server 2003+ PowerShell v2+ .NET Framework 4+ 注意:chocolatey的网站可能 ...
- C#创建子线程，子线程使用委托更新控件
一.背景 由于在窗体程序中通过点击一个button按键后需要更新TreeView控件的内容,由于等待时间比较长,主程序无法一起在那边等待,需要去处理其它的事情,所以就需要创建新的子线程来处理.因为主线 ...
- ios 获取手机信息（UIDevice、NSBundle、NSLocale）
iOS的SDK中提供了UIDevice.NSBundle,NSLocale. UIDevice UIDevice提供了多种属性.类函数及状态通知,帮助我们全方位了解设备状况. 从检測电池 ...
- Java开源电商项目比較
这里比較的都是国外的开源项目,备选项目有: Smilehouse Workspace.Pulse.Shopizer.ofbiz.bigfish.broadleaf 1.Smilehouse Works ...
- Java经典23种设计模式之行为型模式(二)
本文接着介绍行为型模式里的解释器模式.迭代器模式.中介者模式. 一.解释器模式Interpret 给定一个语言,定义它的文法的一种表示,并定义一个解释器,这个解释器使用该表示来解释语言的中的句子. 1 ...
- rocketmq事务消息入门介绍
说明 周五的时候发了篇:Rocketmq4.3支持事务啦!!!,趁着周末的时候把相关内容看了下,下面的主要内容就是关于RocketMQ事务相关内容介绍了. 说明: 今天这篇仅仅是入门介绍,并没有涉及到 ...