使用C++11模板SFINAE特性重写序列化与反序列化
序列化与反序列化在编程中是最常见不过了，项目中原来写的序列化与反序列化是使用的普通类成员函数来写的，每一个数据类型都写了一个operator«以及operator»函数，整个代码相当长，而且冗余度高。 假如我们一个Stream类如下：
1class Stream
2{
3public:
4 // 序列化
5 virtual void Serialize(void* data, size_t size)
6 {
7 // 实现略
8 }
9 // 反序列化
10 virtual void Deserialize(void* data, size_t size)
11 {
12 // 实现略
13 }
14};
如果我们重载«符号来进行序列化，重载»符号来进行反序列化，使用普通类成员函数的写法，以int类型为例就是：
1class Stream
2{
3public:
4 // 序列化
5 virtual void Serialize(void* data, size_t size)
6 {
7 // 实现略
8 }
9 // 反序列化
10 virtual void Deserialize(void* data, size_t size)
11 {
12 // 实现略
13 }
14 Stream& operator<<(const int v)
15 {
16 Serialize((void*)&v, sizeof(v));
17 return *this;
18 }
19 Stream& operator>>(int& v)
20 {
21 Deserialize(&v, sizeof(v));
22 return *this;
23 }
24};
C++中有bool,char, unsigned char,short, unsigned short,int,unsigned int,long long,unsigned long long等等许多标准类型，还有枚举类型以及自定义类型。如果每一个类型都写一个函数去重载，代码量还是非常大的，而且函数除了参数类型不一样外，其它都一样，相当冗余。这种情况非常适合使用C++的模板，特别是C++11之后，可以直接使用标准库的模板函数来进行类型匹配。
在C++11之前，可能需要自己来写一系列的模板判断哪些类型是标准类型，根据是否是标准类型让编译器来判断匹配哪个函数；C++11就可以直接使用std::is_XXX系列函数来进行判断了。
在写出实现前，我们需要了解一下什么是SFINAE： SFINAE是Substitution Failure Is Not An Error的缩写，直译为中文是：替换失败不是错误， cppreference中的定义为：
在函数模板的重载决议中：为模板形参替换推导类型失败时，从重载集抛弃特化，而非导致编译错误。
我的理解就是编译器在匹配重载函数时，通过类型的推导可能匹配到类型不一致的重载函数而导致匹配失败，但是只要最后能正确匹配到一个重载函数，编译器就不会报错。使用过Erlang语言的读者会对函数匹配有比较深刻的理解。
这里有一个非常关键的模板函数std::enable_if，它会让编译器根据条件来判断该重载函数是否是所需要的函数。std::enable_if 可以使用在以下三个方面：
作为函数参数：
1template<typename T>
2struct Check1
3{
4 template<typename U = T>
5 U read(typename std::enable_if<
6 std::is_same<U, int>::value >::type* = 0) { return 42; }
7
8 template<typename U = T>
9 U read(typename std::enable_if<
10 std::is_same<U, double>::value >::type* = 0) { return 3.14; }
11};
作为模板参数：
1template<typename T>
2struct Check2
3{
4 template<typename U = T, typename std::enable_if<
5 std::is_same<U, int>::value, int>::type = 0>
6 U read() { return 42; }
7
8 template<typename U = T, typename std::enable_if<
9 std::is_same<U, double>::value, int>::type = 0>
10 U read() { return 3.14; }
11};
作为返回类型：
1template<typename T>
2struct Check3
3{
4 template<typename U = T>
5 typename std::enable_if<std::is_same<U, int>::value, U>::type read() {
6 return 42;
7 }
8
9 template<typename U = T>
10 typename std::enable_if<std::is_same<U, double>::value, U>::type read() {
11 return 3.14;
12 }
13};
了解了SFINAE（替换失败不是错误）就可以使用C++11来重写前面的冗余代码了。
在C++11中对枚举进行了扩展，以前的枚举定义是:
1enum XXX
2{
3 AA,
4 BB
5};
现在添加了enum class XXX，
1enum class XXX
2{
3 AA,
4 BB
5};
两者的区别就是前者可以直接在代码中引用AA，BB，编译器把它们当作整数来对待；后者不能直接在代码中引用AA，BB，要引用必须添加XXX::限定符，即XXX::AA，XXX::BB，编译器不再把它们当作整数来对待，所以不能与整数进行比较，要与整数比较必须进行强转。
所以如果要序列化enum class枚举，编译器不再匹配为整数，而是需要单独处理。所以如果不想在使用的时候不断写强转代码，普通类成员函数是无法满足各种枚举类型的序列化与反序列化的，只能使用模板函数来处理：
1template<typename T>
2Stream& operator<<(typename std::enable_if<std::is_enum<T>::value, Stream>::type &stream, const T& v)
3{
4 return stream << static_cast<typename std::underlying_type<T>::type>(v);
5}
这个模板使用std::is_enum模板函数来检测模板参数T是否是枚举类型，配合std::enable_if模板函数让编译器匹配枚举类型。实现代码中再使用std::underlying_type模板函数将T转换成标准的类型，默认是int类型，如果枚举从其它标准类型派生则为基类类型，比如：
1enum class XXX : char
就是char类型。
处理了枚举类型，就需要处理前面提到的标准类型，C++11提供了std::is_integral模板函数来判断是否是除浮点类型外的基本类型，而浮点类型使用std::is_floating_point模板函数来判断浮点类型，同时提供了std::is_arithmetic模板函数来判断前面两个函数包含的所有类型。所以我们使用下面的模板函数来处理这些类型：
1template<typename T>
2Stream& operator<<(typename std::enable_if<std::is_arithmetic<T>::value, Stream>::type &stream, const T& v)
3{
4 stream.Serialize((void*)&v, sizeof(T));
5 return stream;
6}
7
8template<typename T>
9Stream& operator>>(typename std::enable_if<std::is_arithmetic<T>::value, Stream>::type &stream, T& v)
10{
11 stream.Deserialize((void*)&v, sizeof(T));
12 return stream;
13}
这里序列化有一点问题就是如果有强转，如果模板匹配没写对，可能会导致编译通不过，比如
1uint8 n;
2stream << (uint16)n;
这是因为在强制转换时从左值变为右值了，所以需要一个右值引用的函数：
1template<typename T>
2Stream& operator<<(typename std::enable_if<std::is_arithmetic<T>::value, Stream>::type &stream, const T&& v)
3{
4 stream.Serialize((void*)&v, sizeof(T));
5 return stream;
6}
编译器在正常情况下会自动进行转换，比如自动添加const进行匹配，右值可以匹配到左值引用。后面的代码清单就是利用了编译器的这些自动转换。
这样几个函数就把使用普通成员类函数所能表达的所有标准类型以及枚举类型的情况处理完了，是不是非常简洁？
然后就是自己定义的类型的处理了，这里需要作一个规定，就是自己定义的类型如果要序列化与反序列化，必须要有：
1// 序列化
2void Serialize(Stream &stream) const
3{
4 // 实现略
5}
6// 反序列化
7void Deserialize(Stream &stream) const
8{
9 // 实现略
10}
这两个类成员函数的实现，这样就可以使用下面的模板函数来处理自定义类了：
1template<typename T>
2Stream& operator<<(typename std::enable_if<std::is_member_function_pointer<decltype(&T::Serialize)>::value, Stream>::type &stream, const T& v)
3{
4 v.Serialize(stream);
5 return stream;
6}
7
8template<typename T>
9Stream& operator>>(typename std::enable_if<std::is_member_function_pointer<decltype(&T::Deserialize)>::value, Stream>::type &stream, T& v)
10{
11 v.Deserialize(stream);
12 return stream;
13}
这里使用了std::is_member_function_pointer模板函数来判断类型T是否有Serialize函数以及Deserialize函数，如果有则匹配，没有则不匹配。
如果自定义类型没有Serialize与Deserialize的函数实现，比如STL的容器类型，可以继续使用普通的类成员函数，也可以提出来，这些不再使用模板函数来处理，而是需要单独实现重载。
下面列出经过优化后的代码清单：
1#include <iostream>
2
3typedef unsigned int uint;
4
5class Stream
6{
7public:
8 // 序列化
9 virtual void Serialize(void* data, size_t size)
10 {
11 // 实现略
12 }
13 // 反序列化
14 virtual void Deserialize(void* data, size_t size)
15 {
16 // 实现略
17 }
18};
19
20// 序列化
21// 该函数可以匹配char*, const char*, std::string以及const std::string
22static Stream& operator<<(Stream &stream, const std::string& v)
23{
24 uint len = (uint)v.length();
25 stream.Serialize(&len, sizeof(uint));
26 stream.Serialize((void*)v.c_str(), len);
27 return stream;
28}
29
30// 该函数可以匹配算术类型以及枚举类型
31template<typename T>
32Stream& operator<<(typename std::enable_if<std::is_arithmetic<T>::value || std::is_enum<T>::value, Stream>::type &stream, const T& v)
33{
34 stream.Serialize((void*)&v, sizeof(T));
35 return stream;
36}
37
38// 该函数匹配所有自定义类中有void Serialize(Stream &stream) const函数实现的类型
39template<typename T>
40Stream& operator<<(typename std::enable_if<std::is_member_function_pointer<decltype(&T::Serialize)>::value, Stream>::type &stream, const T& v)
41{
42 v.Serialize(stream);
43 return stream;
44}
45
46// 反序列化
47// 该函数可以匹配算术类型以及枚举类型
48template<typename T>
49Stream& operator>>(typename std::enable_if<std::is_arithmetic<T>::value || std::is_enum<T>::value, Stream>::type &stream, T& v)
50{
51 stream.Deserialize(&v, sizeof(T));
52 return stream;
53}
54
55// 该函数匹配所有自定义类中有void Deserialize(Stream &stream) const函数实现的类型
56template<typename T>
57Stream& operator>>(typename std::enable_if<std::is_member_function_pointer<decltype(&T::Deserialize)>::value, Stream>::type &stream, T& v)
58{
59 v.Deserialize(stream);
60 return stream;
61}
62// 该函数只能匹配std::string
63static Stream& operator>>(Stream &stream, std::string& v)
64{
65 uint len = 0;
66 stream.Deserialize(&len, sizeof(uint));
67 v.resize(len);
68 stream.Deserialize(&v[0], len);
69 return stream;
70}
以上是使用的类外重载操作符来实现的，如果是使用类的成员函数应该怎么写呢？下面列出代码清单：
1#include <iostream>
2
3typedef unsigned int uint;
4
5class Stream
6{
7public:
8 // 序列化
9 virtual void Serialize(void* data, size_t size)
10 {
11 // 实现略
12 }
13 // 反序列化
14 virtual void Deserialize(void* data, size_t size)
15 {
16 // 实现略
17 }
18 // 序列化
19 Stream& operator<<(const std::string& v)
20 {
21 uint len = (uint)v.length();
22 Serialize(&len, sizeof(uint));
23 Serialize((void*)v.c_str(), len);
24 return *this;
25 }
26
27 template<typename T, std::enable_if_t<std::is_arithmetic<T>::value || std::is_enum<T>::value> * = nullptr>
28 Stream& operator<<(const T& v)
29 {
30 Serialize((void*)&v, sizeof(T));
31 return *this;
32 }
33
34 template<typename T, std::enable_if_t<std::is_member_function_pointer<decltype(&T::Serialize)>::value> * = nullptr>
35 Stream& operator<<(const T& v)
36 {
37 v.Serialize(*this);
38 return *this;
39 }
40
41 // 反序列化
42 Stream& operator>>(std::string& v)
43 {
44 uint len = 0;
45 Deserialize(&len, sizeof(uint));
46 v.resize(len);
47 Deserialize(&v[0], len);
48 return *this;
49 }
50
51 template<typename T, std::enable_if_t<std::is_arithmetic<T>::value || std::is_enum<T>::value> * = nullptr>
52 Stream& operator>>(T& v)
53 {
54 Deserialize(&v, sizeof(T));
55 return *this;
56 }
57
58 template<typename T, std::enable_if_t<std::is_member_function_pointer<decltype(&T::Deserialize)>::value> * = nullptr>
59 Stream& operator>>(T& v)
60 {
61 v.Deserialize(*this);
62 return *this;
63 }
64};
是不是感觉特别简洁，代码量非常小。这里的类成员函数是使用函数签名的方式来实现的，模板参数中enable_if_t成立则等效于：
1template <typename T, void * = nullptr>
在书写时需要注意的是*与=之间必须有一个空格，不然会出现编译错误。 以上代码在VS2015、GCC 4.9.3、Clang 9.0编译器编译通过。
参考： https://zh.cppreference.com/w/cpp/language/sfinae https://stackoverflow.com/questions/14600201/why-should-i-avoid-stdenable-if-in-function-signatures
- 原文作者：Witton
- 原文链接：https://wittonbell.github.io/posts/2020/2020-11-10-使用C++11模板SFINAE特性重写序列化与反序列化/
- 版权声明：本作品采用知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议. 进行许可，非商业转载请注明出处（作者，原文链接），商业转载请联系作者获得授权。