使用Thrift传输二进制数据遇到的问题

最近使用Thrift传输图片数据，一开始使用string保存图片数据，创建的service如下：

enum RetCode {
  F_Success = 0,
  F_NotFound,
  F_Failed,
  F_LastStatus
}


struct Response {
  1:RetCode ret_code,
  2:string err_msg
}


service FileStorage {
Response WriteFile(1:string file_name, 2:string schema, 3:string write_buffer, 4:i32 length)
}

这里需要介绍以下几个问题： 
1. 第一个问题：为什么可以通过string传输二进制数据？如果二进制数据中有’\0’字节的话，string不会被截断吗？

        1）先看Thrift生成的接口：

class FileStorageIf {
 public:
  virtual ~FileStorageIf() {}
  virtual void WriteFile(Response& _return, const std::string& file_name, const std::string& schema, const std::string& write_buffer, const int32_t length) = 0;
};

    2） Thrift客户端是将数据写到socket的：
    客户端通过FileStorage_WriteFile_args::write将各个参数传给TBufferedTransport；
    最后调用下面的函数将数据写到socket：

oprot_->getTransport()->flush();

void FileStorageClient::send_WriteFile(const std::string& file_name, const std::string& schema, const std::string& write_buffer, const int32_t length)
{
  int32_t cseqid = 0;
  oprot_->writeMessageBegin("WriteFile", ::apache::thrift::protocol::T_CALL, cseqid);

  FileStorage_WriteFile_pargs args;
  args.file_name = &file_name;
  args.schema = &schema;
  args.write_buffer = &write_buffer;
  args.length = &length;
  args.write(oprot_);

  oprot_->writeMessageEnd();
  oprot_->getTransport()->writeEnd();
  oprot_->getTransport()->flush();
}

uint32_t FileStorage_WriteFile_args::write(::apache::thrift::protocol::TProtocol* oprot) const {
  uint32_t xfer = 0;
  ……
  xfer += oprot->writeFieldBegin("write_buffer", ::apache::thrift::protocol::T_STRING, 3);
  xfer += oprot->writeString(this->write_buffer);
  xfer += oprot->writeFieldEnd();
  ……
  return xfer;
}

    下面看writeString方法的实现：
        首先通过str.size()得到string的长度，先将长度写入TBufferedTransport的buffer；
        然后将str.data()写入buffer；

template <class Transport_>
uint32_t TBinaryProtocolT<Transport_>::writeString(const std::string& str) {
  uint32_t size = str.size();
  uint32_t result = writeI32((int32_t)size);
  if (size > 0) {
    this->trans_->write((uint8_t*)str.data(), size);
  }
  return result + size;
}

    3） str.size()和str.data()可以得到这个二进制字符串的长度和完整数据吗？

问题：如果二进制数据中有’\0’字节的话，string不会被截断吗？

答案是string不会截断字符串，而char*会截断字符串。下面是测试程序：

#include <stdio.h>
#include <string>
#include <iostream>

using namespace std;


int main(int __argc, char* __argv[]) {
  char char_buf[] = {'a', 'b', 'c', 'd', '\0', 'e'};
  string str1 = char_buf;
  string str2;
  str2.assign(char_buf);
  string str3;
  str3.assign(char_buf, sizeof(char_buf));
  cout << "str1: " << str1.size() << endl;
  cout << "str2: " << str2.size() << endl;
  cout << "str3: " << str3.size() << endl;
  return 0;
}

     运行结果如下：

guojun8@guojun8-desktop:~/test/string$ g++ -o test main.c

guojun8@guojun8-desktop:~/test/string$ ./test

str1: 4

str2: 4

str3: 6

string类型中存放有数据的长度和数据（数据时buffer而不是字符串），当通过下面的方法设置数据时，会根据传递的长度复制数据并设置长度；

              string& assign (const char* s, size_t n); 

    2. 当客户端使用java调掉并传入String时，会出现数据格式错误的问题。

我昨天遇到这个问题，用java调用这个接口并写入图片数据时，在服务端收到数据并检查是总是报数据不合法，不是图片数据，但是用Python和PHP写入数据都没有这个问题。我一起没有学过java，但为了弄清这个问题还是看了一下，下面分析一下这个问题：

1) Thrift文件生成的Java客户端代码：

    使用Thrift生成的Java接口代码如下：
	

	

		
		
public class FileStorage {

  public interface Iface {

    public Response WriteFile(String file_name, String schema, String write_buffer, int length) throws org.apache.thrift.TException;

  }

											

    2) 客户端的代码：  

InputStream in = new FileInputStream("C:/temp/photo4l.jpg");
data = new byte[in.available()];
in.read(data);
in.close();
String str = new String(data);
Response result = client.WriteFile(file_name, schema, str, in.available());

    客户端的代码实现是从文件中读取图片数据并将数据转为String，并传输到服务端。但是服务端收到数据解析永远是bad_image_format.

3）问题分析

下面看String的构造函数说明：

 public String(byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the platform's default charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array. 

The behavior of this constructor when the given bytes are not valid in the default charset is unspecified. The  class should be used when more control over the decoding process is required.

String的构造函数用当前的默认字符编码解码字节数组，当字节数组不合法时没有处理。而图片数据的字节数组不可能满足任何一种字符集的解码操作，所以这里生成的String未定义，全是乱码。   

 另外Java中TBinaryProtocol::writeString的实现：
											

											

												
												
public void writeString(String str) throws TException {
    try {
      byte[] dat = str.getBytes("UTF-8");
      writeI32(dat.length);
      trans_.write(dat, 0, dat.length);
    } catch (UnsupportedEncodingException uex) {
      throw new TException("JVM DOES NOT SUPPORT UTF-8");
    }
  }

																							

     str.getBytes("UTF-8");将String编码成UTF-8格式的byte数组，并写到buffer中，如果String的数据是乱码，编码生成的data也是乱码，所以传到服务端的数据也是乱码。

 4) 问题解决

    使用Python，PHP和C++调用这个接口时都不会出现这个问题，因为string类型默认不会对数据做编解码，保存的是原始的字节数组格式。

Thrift中提供了binary类型用于解决这个问题，将thrift文件中的write_buffer改成binary类型，如下：

service FileStorage {
Response WriteFile(1:string file_name, 2:string schema, 3:binary write_buffer, 4:i32 length)
}

生成的Java接口中write_buffer是ByteBuffer：

public class FileStorage {

  public interface Iface {

    public Response WriteFile(String file_name, String schema, ByteBuffer write_buffer, int length) throws org.apache.thrift.TException;

  }