Graceful Java Programming 优雅Java编程 之Socket Client

   老久没有动手写Socket程序了，今天应同事的要求上了一段程序。

这是一段很简单与C++编写的服务端通讯的java客户端，咋一看上去，没有任何问题。

貌似没有问题的程序

	public static String sendSynMsg(String ipAddr, byte[] datas) throws Exception{
		//解析服务器地址和端口号
		int dotPos = ipAddr.indexOf(':');
		String ip = ipAddr.substring(0, dotPos).trim();
		int port = Integer.parseInt(ipAddr.substring(dotPos+1).trim());
		InetSocketAddress endpoint = new InetSocketAddress(ip , port);
		
		Socket socket = null;
		OutputStream out = null;
		InputStream in = null;
		try	{		
			socket = new Socket();
			//设置发送逗留时间2秒
			socket.setSoLinger(true, 2); 
			//设置InputStream上调用 read()阻塞超时时间2秒
			socket.setSoTimeout(2000);
			//设置socket发包缓冲为32k；
			socket.setSendBufferSize(32*1024);
			//设置socket底层接收缓冲为32k
			socket.setReceiveBufferSize(32*1024);
			//关闭Nagle算法.立即发包
			socket.setTcpNoDelay(true);
			//连接服务器
			socket.connect(endpoint);
			//获取输出输入流
			out = socket.getOutputStream();
			in = socket.getInputStream();
			//输出请求			
			out.write(datas);
			out.flush();
			//接收应答
			BufferedReader br = new BufferedReader( new InputStreamReader(in) , 4096);
			StringWriter received = new StringWriter(4096);
			char[] charBuf = new char[4096];
			int size = 0;
			while ((size = br.read(charBuf)) > 0){
				received.write(charBuf, 0, size);
			}
			return received.toString();
			
		} finally {
			if (out != null) {
				try {
					out.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}
			if (in != null) {
				try {
					in.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}		
			if (socket != null) {
				try {
					socket.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}
		}				
	}

但实际的调试中，总是报Read TimeOut异常！！排查原因后发现，数据是接收到了，只是size = br.read(charBuf)不会返回-1（java doc中的说明是读取到结束时size会返回-1）。
对于编写服务器端程序的C++程序员而言，他们通常会在通讯结束的时候，在数据的尾部加上一个\0的结束字符。因此，我们针对此做了修正

出问题的程序段

    while ((size = br.read(charBuf)) > 0){
        received.write(charBuf, 0, size);
    }

修改后的正确写法

  char lastChar = 0;
  do {
      size = br.read(charBuf , 0 , 4096);
      lastChar = charBuf[size-1];
      if(lastChar == 0){
          //去除尾部的\0字符
          received.write(charBuf, 0, size - 1);
      }
  }while(lastChar != 0);

最终的完整程序段：

	private static String sendSynMsg(String ipAddr, byte[] datas) throws Exception{
		//解析服务器地址和端口号
		int dotPos = ipAddr.indexOf(':');
		String ip = ipAddr.substring(0, dotPos).trim();
		int port = Integer.parseInt(ipAddr.substring(dotPos+1).trim());
		InetSocketAddress endpoint = new InetSocketAddress(ip , port);
		
		Socket socket = null;
		OutputStream out = null;
		InputStream in = null;
		try	{		
			socket = new Socket();
			//设置发送逗留时间2秒
			socket.setSoLinger(true, 2); 
			//设置InputStream上调用 read()阻塞超时时间2秒
			socket.setSoTimeout(2000);
			//设置socket发包缓冲为32k；
			socket.setSendBufferSize(32*1024);
			//设置socket底层接收缓冲为32k
			socket.setReceiveBufferSize(32*1024);
			//关闭Nagle算法.立即发包
			socket.setTcpNoDelay(true);
			//连接服务器
			socket.connect(endpoint);
			//获取输出输入流
			out = socket.getOutputStream();
			in = socket.getInputStream();
			//输出请求			
			out.write(datas);
			out.flush();
			//接收应答
			BufferedReader br = new BufferedReader( new InputStreamReader(in) , 4096);
			StringWriter received = new StringWriter(4096);
			char[] charBuf = new char[4096];
			int size = 0;
			char lastChar = 0;
			do {
				size = br.read(charBuf , 0 , 4096);
				lastChar = charBuf[size-1];
				if(lastChar == 0){
					received.write(charBuf, 0, size - 1);
				}
				//System.out.println(received.toString());
			}while(lastChar != 0);
			
			return received.toString();
			
		} finally {
			if (out != null) {
				try {
					out.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}
			if (in != null) {
				try {
					in.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}		
			if (socket != null) {
				try {
					socket.close();
				} catch(Exception ex) {
					ex.printStackTrace();
				}
			}
		}				
	}

程序中的关键点：
1. 不直接使用new Socket(String ip , int port)的构造函数，而是设置了socket的环境参数后再连接

2.设置发送逗留时间 socket.setSoLinger(true, 2); 这个参数是socket发送数据时的超时，如果对方在固定时间内不接受，则关闭socket。与socket.setSoTimeout(2000)不同，这个是设置InputStream上调用 read()阻塞超时时间。

3.socket.setTcpNoDelay(true);关闭Nagle算法。这使得在调用out.flush();时总能第一时间的发送数据包（这个适用于你的数据包是完整的一次性发送的前提）。

4.根据应用协议的实际大小，优化你的接收和发送缓冲，这两个参数可以有效提高网络通信的效率。

5.使用char的数组配合StringWriter作为接收数据的写入，这个比使用readLine方法实现更优雅。

一点小经验，和大家分享 。

评论

47 楼 tianyidan 2010-01-29  

多谢分享，看了这么多的回复，收益颇多。

46 楼 xuyan2680 2009-09-15  

  char lastChar = 0;
  do {
      size = br.read(charBuf , 0 , 4096);
      lastChar = charBuf[size-1];
      if(lastChar == 0){
          //去除尾部的\0字符
          received.write(charBuf, 0, size - 1);
      }
  }while(lastChar != 0);

也遇到了类似的问题。这样确实可以解决

45 楼 linliangyi2007 2009-02-18  

没天理啊，好心找雷劈，写个帖子还被评新手贴，倒扣10分。无语

44 楼 linliangyi2007 2009-02-17  

wandou 写道

socket的tcp协议，是按照流来抽象的。所谓流，就是与发送的时间和次数无关的，只和发送字节序无关。
比如发送"ABC",是一次发出"ABC",还是分三次发出"A","B"，"C",即使这A,B，C都处在三个报文中，对于接收端来讲都是没有区别的。
如果分三次发出，对于接收端的read函数会怎么样？它一般会在读到A的时候，返回1次，读到B的时候，返回1次，读到C的时候返回1次。每次返回长度都是1个字节。所以，对这种情况，就应该读到所有的字节，才返回。
这些都是一些处理socket的基本常识。跟代码是否优雅无关。
楼主的代码，似乎竭力想把一个完整的报文一次发出，这个概念就是错误的。就算1个字节1个字节的发，服务端的程序也应该能处理，否则服务端的程序就是错误的。因为在网络不正常的时候，可能会采用较小的报文。比如，当前双方的通讯速度是5个字节/秒，那tcp协议栈就不会一下子发出一个1000字节的报文。

谢谢，第一次有人这么清晰理论的解释了“流”，受教了！一段非常简单的程序，能得到大家的关注，让某人我收益良多！

至于“优雅”更多是出于我对java的喜爱，我的有一系列的blog都用“优雅java编程”来起头的，哈哈，大家就不用在这上面较真了。

43 楼 wandou 2009-02-17  

socket的tcp协议，是按照流来抽象的。所谓流，就是与发送的时间和次数无关的，只和发送字节序无关。
比如发送"ABC",是一次发出"ABC",还是分三次发出"A","B"，"C",即使这A,B，C都处在三个报文中，对于接收端来讲都是没有区别的。
如果分三次发出，对于接收端的read函数会怎么样？它一般会在读到A的时候，返回1次，读到B的时候，返回1次，读到C的时候返回1次。每次返回长度都是1个字节。所以，对这种情况，就应该读到所有的字节，才返回。
这些都是一些处理socket的基本常识。跟代码是否优雅无关。
楼主的代码，似乎竭力想把一个完整的报文一次发出，这个概念就是错误的。就算1个字节1个字节的发，服务端的程序也应该能处理，否则服务端的程序就是错误的。因为在网络不正常的时候，可能会采用较小的报文。比如，当前双方的通讯速度是5个字节/秒，那tcp协议栈就不会一下子发出一个1000字节的报文。

42 楼 linliangyi2007 2009-02-17  

luanma 写道

难道不是么？

开始一堆的socket参数设置，其实不同的应用场景有不同的设置，这个跟优雅无关。

使用char读数据，charset也完全是跟c服务器要一致，如果优雅，应该使用一个通用的解决方案。其实这个问题还有c以0结尾的问题，都属于通讯协议的设计问题。似乎跟优雅也无关吧。

把这些东西扒掉，就剩下建立连接，最简单的读写数据，然后关闭连接。这不是hello world，还是啥？

原来是这样啊，看来兄弟的要求很高，无话可说了。

java原来就是以简单为优雅的，程序结构清晰，逻辑越简单约好。
我发贴要说的都在贴的最后说了，这个贴本来就不是给高手准备的，怠慢了，呵呵！

41 楼 bachmozart 2009-02-17  

成抬杠贴了

40 楼 luanma 2009-02-17  

难道不是么？

开始一堆的socket参数设置，其实不同的应用场景有不同的设置，这个跟优雅无关。

使用char读数据，charset也完全是跟c服务器要一致，如果优雅，应该使用一个通用的解决方案。其实这个问题还有c以0结尾的问题，都属于通讯协议的设计问题。似乎跟优雅也无关吧。

把这些东西扒掉，就剩下建立连接，最简单的读写数据，然后关闭连接。这不是hello world，还是啥？

39 楼 andot 2009-02-17  

luanma 写道

也就是一socket版的hello world，哪里优雅了？

非 hello world 的代码贴上十几屏，你愿意读吗？

38 楼 linliangyi2007 2009-02-17  

bachmozart 写道

我的理解:

socket传输本身是byte字节流,socket底层发送单位是segment,对端判断是否发送完毕的方法是:

1.对端关闭连接,这种情况很好判断,我只记得非阻塞IO
Java中 read返回 -1    ,  如果本次没有读到数据返回 0
C中    read返回  0    ,  如果本次没有读到数据得到一个EWOULDBLOCK 或EAGAIN错误,read返回 -1

2.通过协议判断,二进制协议可以参照CMPP,SGIP看看,文本协议可以参照Memcached的
该读几个字节结束在协议中都是规定好的

至于字符占多少字节什么的,跟Socket没有任何关系,传输层的东西和表示层的东西怎么能一起考虑呢

正解！！我正怀疑java中read出的-1是不是因为对方关闭了输出端链路造成的，你的说法印证了我的猜测（偷懒了，没有自己做试验，哈哈）

第二点中说的协议，也正是我上述说的content length的判断方式，跟字符编码无关！
跟楼上的英雄所见啊，哈哈！


这里再次重申，我的demo程序中只需要读取标准ascii码，才写成了read char的方式，这是在正确的场合恰当使用java
api的做法！！！

37 楼 linliangyi2007 2009-02-17  

djsl6071 写道

其实楼上有位仁兄回复得不错，楼主说他急了些，没看后面你的回复，但我倒觉得他是指出了你回复里的一些问题。

使用char传输，字节长度是不同的，但java的charset支持针对各种常见编码字符集转换来获得正确的String（当然，如果你并不是文本，那甚至不需要考虑这个），java中之所以倾向使用byte，是因为要支持多种字符集编码方式，增加了coder可能出错地处理了字符的可能性，而byte作为原始方式就能便于修改，并同不同的字符集编码方式快速转换对接。

http中有Content-length，但是你的传输只是基于tcp，并不一定是http，所以长度设置并不一定可用是吧。这是很没法子的，我不肯定基于\0的识别方式能够有效判断传输结束，除非加上一个关键条件，那就是C++服务器上发送的每个数值都是2bytes的，这样是你用char接收的原因吧，但不指定inputstream的charset方式，read到的char却不一定就是服务器发送过来的两两字节对应，因为charset编码会按特定方式解码byte字节数组，补码返回char，这个过程中\0可能作为实际字符的一部分而被忽略。

我同意你说的对java charset的顾虑，但我之所以会直接使用java的read方法，本身就有应用的默认条件的。我们的通讯中只会传输英文和数字，不出现非标准ascii的字符。在这样的前提下为什么不直接使用java默认的api呢，否则就是对java api的浪费了。

还有你对content-length的理解太片面了，你一下子就说到了http，实际上很多基于TCP的通讯协议有自己的报文格式，里面都有固定的长度描述字段的。如果你做过一些短信网关类似的通讯，就经常有这样的协议。

第三，有你说的\0字符因为charset编码被忽略也是不正确的，在实验中，我们打印出了这个标准的ascii字符，它可是ascii编码的第一个字符啊。可以确定的是，它没有因为编码而被忽略。

36 楼 bachmozart 2009-02-17  

我的理解:

socket传输本身是byte字节流,socket底层发送单位是segment,对端判断是否发送完毕的方法是:

1.对端关闭连接,这种情况很好判断,我只记得非阻塞IO
Java中 read返回 -1    ,  如果本次没有读到数据返回 0
C中    read返回  0    ,  如果本次没有读到数据得到一个EWOULDBLOCK 或EAGAIN错误,read返回 -1

2.通过协议判断,二进制协议可以参照CMPP,SGIP看看,文本协议可以参照Memcached的
该读几个字节结束在协议中都是规定好的

至于字符占多少字节什么的,跟Socket没有任何关系,传输层的东西和表示层的东西怎么能一起考虑呢

35 楼 djsl6071 2009-02-17  

其实楼上有位仁兄回复得不错，楼主说他急了些，没看后面你的回复，但我倒觉得他是指出了你回复里的一些问题。

使用char传输，字节长度是不同的，但java的charset支持针对各种常见编码字符集转换来获得正确的String（当然，如果你并不是文本，那甚至不需要考虑这个），java中之所以倾向使用byte，是因为要支持多种字符集编码方式，增加了coder可能出错地处理了字符的可能性，而byte作为原始方式就能便于修改，并同不同的字符集编码方式快速转换对接。

http中有Content-length，但是你的传输只是基于tcp，并不一定是http，所以长度设置并不一定可用是吧。这是很没法子的，我不肯定基于\0的识别方式能够有效判断传输结束，除非加上一个关键条件，那就是C++服务器上发送的每个数值都是2bytes的，这样是你用char接收的原因吧，但不指定inputstream的charset方式，read到的char却不一定就是服务器发送过来的两两字节对应，因为charset编码会按特定方式解码byte字节数组，补码返回char，这个过程中\0可能作为实际字符的一部分而被忽略。

34 楼 bachmozart 2009-02-16  

luanma 写道

也就是一socket版的hello world，哪里优雅了？

何必说这样的话呢,人家愿意分享心得本来就是好事,你如果有什么见解或经验,完全可以写出来呀,撂下这么一句话让人看着实在不舒服,分享有错吗?

33 楼 linliangyi2007 2009-02-16  

luanma 写道

也就是一socket版的hello world，哪里优雅了？

请问，socket的非hello world版，在java上要怎么写呢！？

32 楼 luanma 2009-02-16  

也就是一socket版的hello world，哪里优雅了？

31 楼 linliangyi2007 2009-02-13  

unsid 写道

linliangyi2007 写道

danielzhan 写道

我做过的一个项目正好相反,是Java的服务端和C++的客户端通讯.
对于Java的Server,大家有什么建议.

在网络通信方面，最终的处理跟语言的干系不大，还是看双方的通信协议是怎样的，一切以通讯协议的特点出发吧。

虽然是这样，但是不同语言还是有各自的最佳实践方式和管用技巧，这个又是不尽相同，不了解语言特性就会走弯路

恩，一个新思维，受教了。
大家都来谈谈啊！尤其是做C和C++的高手们，不要吝啬你们的知识啊

30 楼 unsid 2009-02-13  

linliangyi2007 写道

danielzhan 写道

我做过的一个项目正好相反,是Java的服务端和C++的客户端通讯.
对于Java的Server,大家有什么建议.

在网络通信方面，最终的处理跟语言的干系不大，还是看双方的通信协议是怎样的，一切以通讯协议的特点出发吧。

虽然是这样，但是不同语言还是有各自的最佳实践方式和管用技巧，这个又是不尽相同，不了解语言特性就会走弯路

29 楼 linliangyi2007 2009-02-12  

danielzhan 写道

我做过的一个项目正好相反,是Java的服务端和C++的客户端通讯.
对于Java的Server,大家有什么建议.

在网络通信方面，最终的处理跟语言的干系不大，还是看双方的通信协议是怎样的，一切以通讯协议的特点出发吧。

28 楼 danielzhan 2009-02-12  

我做过的一个项目正好相反,是Java的服务端和C++的客户端通讯.
对于Java的Server,大家有什么建议.