feat: support encode & decode custom map type (#122)

Author: gxcsoccer

lib/v1/encoder.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var utility = require('utility');
 var ByteBuffer = require('byte');
 var debug = require('debug')('hessian:v1:encoder');
 var utils = require('../utils');
@@ -15,10 +16,19 @@ function Encoder(options) {
     size: options.size
   });
   this.objects = [];
+  this.mapTypes = utility.assign({
+    'java.util.HashMap': true,
+    'java.util.Map': true,
+    'com.alibaba.fastjson.JSONObject': true,
+  }, options.mapTypes);
 }
 
 var proto = Encoder.prototype;
 
+proto.isMap = function (type) {
+  return utility.has(this.mapTypes, type) && this.mapTypes[type];
+};
+
 proto._assertType = function (method, expectType, val, desc) {
   var valType = typeof val;
   if (!is[expectType](val)) {
@@ -245,15 +255,15 @@ proto._checkRef = function (obj) {
  * @param {Object} obj simple obj
  * @return {this}
  */
-proto._writeHashMap = function (obj) {
+proto._writeHashMap = function (obj, type) {
   debug('_writeHashMap() %j, fields: %j', obj);
 
   // Real code in java impl:
   // http://grepcode.com/file/repo1.maven.org/maven2/com.caucho/hessian/3.1.3/com/caucho/hessian/io/Hessian2Output.java#Hessian2Output.writeMapBegin%28java.lang.String%29
   // M(0x4d) type(writeType) (<key> <value>) z(0x7a)
   this.byteBuffer.put(0x4d);
   // hashmap's type is null
-  this.writeType('');
+  this.writeType(type);
 
   if (supportES6Map && obj instanceof Map) {
     obj.forEach(function (value, key) {
@@ -322,8 +332,8 @@ proto.writeObject = function (obj) {
     realObj = obj.$;
   }
 
-  if (!className) {
-    return this._writeHashMap(realObj);
+  if (!className || this.isMap(className)) {
+    return this._writeHashMap(realObj, className);
   }
 
   debug('writeObject with complex object, className: %s', className);

lib/v2/encoder.js

@@ -578,10 +578,15 @@ proto._writeObject = function (obj) {
  * @param {Object} obj simple obj
  * @return {this}
  */
-proto._writeHashMap = function (obj) {
+proto._writeHashMap = function (obj, type) {
   debug('_writeHashMap() %j, fields: %j', obj);
 
-  this.byteBuffer.put(0x48); // H
+  if (type) {
+    this.byteBuffer.put(0x4d);
+    this.writeType(type);
+  } else {
+    this.byteBuffer.put(0x48); // H
+  }
 
   if (supportES6Map && obj instanceof Map) {
     obj.forEach(function (value, key) {

test/map.test.js

@@ -219,6 +219,65 @@ describe('map.test.js', function() {
     assert(result.$map.get(123456) === 123);
   });
 
+  it('should encode & decode custom map type', function() {
+     var buf = new Buffer('5674001E636F6D2E616C69626162612E666173746A736F6E2E4A534F4E41727261796C000000034D74001F636F6D2E616C69626162612E666173746A736F6E2E4A534F4E4F626A65637453000D44415445204F46204249525448530013323031362F31322F31322031323A31323A313253000946554C4C204E414D45530005446F652030530003414745490000000A7A4D74001F636F6D2E616C69626162612E666173746A736F6E2E4A534F4E4F626A65637453000D44415445204F46204249525448530013323031362F31322F31322031323A31323A313253000946554C4C204E414D45530005446F652031530003414745490000000A7A4D74001F636F6D2E616C69626162612E666173746A736F6E2E4A534F4E4F626A6563745300037878785300037979797A7A', 'hex');
+     var obj = hessian.decode(buf, '1.0', true);
+     assert.deepEqual(obj, {
+       $class: 'com.alibaba.fastjson.JSONArray',
+       $: [
+        {
+         $class: 'com.alibaba.fastjson.JSONObject',
+         $: {
+          'DATE OF BIRTH': {
+            $class: 'java.lang.String',
+            $: '2016/12/12 12:12:12',
+          },
+          'FULL NAME': {
+            $class: 'java.lang.String',
+            $: 'Doe 0',
+          },
+          AGE: {
+            $: 10,
+            $class: 'int',
+          }
+         }
+        },
+        {
+         $class: 'com.alibaba.fastjson.JSONObject',
+         $: {
+          'DATE OF BIRTH': {
+            $class: 'java.lang.String',
+            $: '2016/12/12 12:12:12',
+          },
+          'FULL NAME': {
+            $class: 'java.lang.String',
+            $: 'Doe 1',
+          },
+          AGE: {
+            $: 10,
+            $class: 'int',
+          }
+         }
+        },
+        {
+         $class: 'com.alibaba.fastjson.JSONObject',
+         $: {
+          xxx: {
+            $class: 'java.lang.String',
+            $: 'yyy',
+          }
+         }
+        }
+       ]
+      });
+
+     var buf2 = hessian.encode(obj, '1.0', {
+      'com.alibaba.fastjson.JSONObject': true,
+     });
+     var obj2 = hessian.decode(buf2, '1.0', true);
+     assert.deepEqual(obj, obj2);
+  });
+
   describe('v2.0', function() {
     // map = new HashMap();
     // map.put(new Integer(1), "fee");
@@ -469,6 +528,42 @@ describe('map.test.js', function() {
       var plainObject = JSON.parse(JSON.stringify(res.data));
       assert.deepEqual(plainObject, { '[object Object]': 166239 });
     });
+
+    it('should encode & decode custom map type', function() {
+       var buf = new Buffer('731E636F6D2E616C69626162612E666173746A736F6E2E4A534F4E41727261794D1F636F6D2E616C69626162612E666173746A736F6E2E4A534F4E4F626A6563740D44415445204F4620424952544813323031362F31322F31322031323A31323A31320946554C4C204E414D4505446F652030034147459A5A4D910D44415445204F4620424952544813323031362F31322F31322031323A31323A31320946554C4C204E414D4505446F652031034147459A5A4D9103787878037979795A', 'hex');
+       var obj = hessian.decode(buf, '2.0', true);
+       assert.deepEqual(obj, {
+         $class: 'com.alibaba.fastjson.JSONArray',
+         $: [
+          {
+           $class: 'com.alibaba.fastjson.JSONObject',
+           $: {
+            'DATE OF BIRTH': '2016/12/12 12:12:12',
+            'FULL NAME': 'Doe 0',
+            AGE: 10
+           }
+          },
+          {
+           $class: 'com.alibaba.fastjson.JSONObject',
+           $: {
+            'DATE OF BIRTH': '2016/12/12 12:12:12',
+            'FULL NAME': 'Doe 1',
+            AGE: 10
+           }
+          },
+          {
+           $class: 'com.alibaba.fastjson.JSONObject',
+           $: {
+            xxx: 'yyy'
+           }
+          }
+         ]
+        });
+
+       var buf2 = hessian.encode(obj, '2.0');
+       var obj2 = hessian.decode(buf2, '2.0', true);
+       assert.deepEqual(obj, obj2);
+    });
   });
 
 });