TCP Socket通信是一种比较常用的基于连接的网络通信方式。本文通过Java实现TCP Socket通信,并将其用于计算机端、Android手机端,同时做到代码规范化,实现代码最大化复用。
本文代码可在GitHub下载,建议对照源码阅读文章 https://github.com/jzj1993/JavaTcpSocket
TCP连接的建立
客户端和服务器间通过三次握手建立TCP连接。在Java中,连接建立完成后,服务器端和客户端分别获取到一个Socket实例,之后就可以通过这个Socket实例进行通信。服务器端和客户端使用不同的方法获取Socket实例。
服务器端
在服务器端,通过ServerSocket
实现对指定端口的监听,代码如下。其中port
为int
型端口数值,取值0~65535
,0~1024
为系统保留端口,这里取值1234
。如果发生错误将会抛出异常。
int port = 1234;
ServerSocket server = new ServerSocket(port);
通过ServerSocket.accept()
方法接受客户端连接。这个方法是阻塞的,从调用时开始监听端口,直到客户端连接建立时,执行结束并返回Socket实例。连接建立失败会抛出异常。
Socket socket = server.accept();
客户端
客户端直接通过实例化的形式,产生Socket实例。实例化的过程中,尝试连接指定的服务器主机。连接成功则实例化完成,连接失败则抛出异常。hostIP
为主机的IP地址,port
为端口号,和服务器主机监听的端口号保持一致。
String hostIP = "127.0.0.1";
int port = 1234;
Socket socket = new Socket(hostIP, port);
连接的建立过程
以上代码的执行顺序是:
- 服务器端实例化ServerSocket:
new ServerSocket(port);
- 服务器端执行
accept()
,监听指定端口,此方法阻塞等待客户端连接:server.accept();
- 客户端实例化Socket实例,尝试连接服务器:
new Socket(hostIP, port);
- TCP三次握手成功,服务器端的
accept()
返回Socket实例,同时客户端的Socket实例化成功。
Socket的读写
以收发字符串为例来说明Socket的读写。
向Socket对象写入数据,则会发送至TCP连接的另一方。这个操作在服务器端和客户端是一样的。可通过获取Socket的输出流来写入UTF8格式编码的字符串,代码如下。写入完成后,就会被发送到连接的另一端。
private DataOutputStream out;
out = new DataOutputStream(socket.getOutputStream());
String s = "Test";
out.writeUTF(s);
out.flush();
在接收端,通过获取Socket的输入流,就可以读取字符串数据,代码如下。readUTF()
方法是阻塞的,直到对方发送完一个字符串,该方法才会执行结束并返回收到的字符串。如果连接中断,或强制关闭Socket的输入流,即执行socket.shutdownInput()
,该方法会抛出异常。
private DataInputStream in;
in = new DataInputStream(socket.getInputStream());
String s = in.readUTF();
在建立了TCP连接后,由于无法确定对方的数据发送时间,为了保证及时接收到数据,通过一个新线程不断调用in.readUTF()
方法读取数据(相当于轮询法);并在接收到数据后回调相关函数,对数据进行处理。
TCP连接的断开
TCP Socket连接是双向的,通过四次挥手的方式断开,双方分别调用Socket.close()
方法断开连接。连接断开的过程中,一般一方A先断开连接,另一方B发现A断开连接后,也断开连接。为方便表述,将先断开连接的一方A称为“主动断开连接”;后断开的一方B,则为“被动断开连接”。
在一方B阻塞执行in.readUTF()
方法时,如果对方A主动断开Socket连接,这个方法会抛出异常。从而在B处理异常时,可以被动的断开这边的连接。
为保证主动断开连接的一方不会阻塞在in.readUTF()
方法中,需要先执行socket.shutdownInput()
。所以主动断开连接的代码如下。
socket.shutdownInput();
in.close();
socket.close();
被动断开连接的一方,在捕获到in.readUTF()
的异常后,断开Socket连接。
try {
String s = in.readUTF();
} catch (IOException e) {
// 连接被断开(被动)
try {
in.close();
socket.close();
in = null;
socket = null;
} catch (IOException e) {
e.printStackTrace();
}
}
SocketTransceiver的实现
考虑到在服务器端和客户端,Socket对象的操作是完全一样的,所以实现了一个SocketTransceiver
(收发器),实现对Socket的直接操作,其他代码则通过SocketTransceiver
间接操作Socket对象实现数据收发、断开连接等。
SocketTransceiver
实现的功能有:
- 开启新线程不断查询Socket是否收到数据;
- 将字符串、文件等类型的数据进行打包,并通过Socket发送;
- 从Socket接收数据,并自动解析出数据(字符串、文件等),接收完成后回调相应的方法;
- 在发生错误、连接被动断开时,自动断开连接并进行相关处理,并回调相应方法。
SocketTransceiver.class
使用抽象类实现,回调方法是抽象的,实例化时对抽象方法进行实现,处理回调。完整代码见附件。
TcpServer的实现
TcpServer为TCP Socket服务器端程序。为了让服务器能同时接受并处理来自多个客户端的TCP连接请求:
- TcpServer中用一个监听线程对端口进行监听,即阻塞执行
server.accept()
方法,等待接受客户端连接; - 服务器端每次与一个客户端建立连接,即
accept()
方法执行结束并返回一个Socket对象,就会用一个SocketTransceiver
对这个Socket进行操作; - 连接建立后,监听线程再次执行
server.accept()
方法,继续监听端口并等待下一个连接; - 服务器端有一个
List<SocketTransceiver>
,保存当前连接的每个客户端对应的SocketTransceiver
对象,在需要时可取出并进行操作。
TcpServer.class
的完整代码见附件。
TcpClient的实现
TcpClient为TCP Socket客户端程序。主要工作是进行Socket的连接,并利用SocketTransceiver
对Socket进行操作。TcpClient.class
的完整代码见附件。
桌面服务器端的测试代码
完成了上面这三个主要的类,服务器端的实现就非常容易了。服务器端需要使用SocketTransceiver.class
、TcpServer.class
两个类。
服务器端编写了一个桌面版本,测试代码ClsMainServer.class
在工程SocketServer-Desktop
中,详见附件。在测试代码中,实现了一个服务器程序,监听端口1234
并接受客户端连接,每次接收到客户端主动发送的数据,就将数据原样返回给这个客户端。
桌面客户端的测试代码
客户端需要使用SocketTransceiver.class
、TcpClient.class
两个类。
客户端的桌面版本测试代码ClsMainClient.class
在工程SocketClient-Desktop
中,详见附件。在测试代码中,实现了两个客户端,并交替向服务器发送数据。客户端直接连接本机服务器端,IP地址为127.0.0.1
。
安卓客户端的实现
同样的代码还可以直接用于安卓客户端。安卓客户端编写了一个简单的界面,输入IP和端口可进行连接,同时可以输入字符串发送至服务器端,另外会将接收到的数据显示出来。
安卓端程序的实现,要注意几点:
- 网络操作代码不能在主线程(即UI线程)中执行
- 界面操作不能在非UI线程执行,回调中不能直接执行刷新界面的代码,可以通过向UI线程的
Handler
发送Runnable
对象进行操作,即Handler.post(Runnable
方法。
r) - 需要在
AndroidManifest.xml
中添加网络访问权限<uses-permission
android:name="android.permission.INTERNET" />
测试可用的代码详见附件中的工程SocketClient-Android
。
网络连接相关问题
如果代码编译通过,但是测试不能正常运行,则有可能为网络连接配置相关问题。
- 电脑和手机之间的网络连接方式
- 电脑共享Wifi,用手机连接
- 手机电脑连在一个局域网
- 确保IP地址与端口设置正确
确保程序中的IP地址和端口设置正确。服务器端代码只需设置端口,最好不要处于
0~1024
之间,并避免端口被系统其它程序占用;在客户端,使用的端口和服务器相同,IP地址设置如下:- 如果客户端和服务器是在同一个设备上,IP地址可以直接用
127.0.0.1
,也可以用服务器任意网卡的IP地址 - 如果服务器和客户端处于同一个局域网,IP地址用服务器连接到该局域网的网卡的IP地址
- 如果客户端连接到服务器共享的Wifi网络,IP地址用服务器共享Wifi的无线网卡的IP地址
- 如果客户端和服务器是在同一个设备上,IP地址可以直接用
- 防火墙设置
在Windows中,需要设置防火墙允许程序访问网络。通常在软件第一次访问网络时,会弹出窗口提示是否允许程序访问网络,勾选允许并点击确定即可。也可以在控制面板设置:控制面板 --> 系统和安全 --> Windows 防火墙 --> 允许程序或功能通过Windows防火墙 --> 更改设置 --> 勾选Java后面的选框并确认即可,如图。
- 尝试用管理员权限运行Eclipse
如果仍然不能连接,可以尝试用管理员权限运行Eclipse。
代码测试
Eclipse窗口操作技巧
- 默认情况下,多个程序同时在命令行输出时,Eclipse的Console会自动切换到最后输出字符串的程序,点击图钉形状的按钮如图,可以让Console不再切换。
- 点击右侧的加号按钮,下拉菜单中选择
New Console View
,可以新建一个Console命令行窗口,设置每个窗口显示不同程序输出的内容。 - 点击Console中的红色方形按钮可以停止程序的运行。
测试
将工程SocketServer-Desktop
和SocketClient-Desktop
导入Eclipse中,先执行服务器端,再执行客户端。如果先执行客户端,会提示连接失败。
桌面客户端程序启动后会创建两个TcpClient
客户端实例同时连接服务器,并交替发送数据。客户端连接和发送数据时,服务器端会输出相应的提示信息。
停止服务器端程序,客户端会提示连接中断,并中止程序执行;停止客户端程序,服务器端会提示客户端断开连接。
将安卓版的Client编译并安装到手机,连接网络让安卓端和计算机端在同一个局域网中。让服务器端程序启动,再点击安卓端的“连接”按钮进行连接,如果网络错误、服务器未启动等原因,安卓端会提示“连接失败”。如果连接成功,服务端会输出客户端连接的提示信息。
同样,可以在安卓客户端向服务器发送数据,服务器会将数据原样返回。
执行结果如图。
本文首发自我的个人主页,转载请注明来源:http://www.hainter.com/java-tcp-socket