Custom serializer register

core/api/src/main/java/com/alipay/sofa/rpc/common/RpcOptions.java

@@ -562,4 +562,10 @@ public class RpcOptions {
      */
     public static final String RPC_UNIQUEID_PATTERN_CHECK               = "sofa.rpc.uniqueId.pattern.check";
 
+    /**
+     * bolt serializer register extension
+     * @since 5.10.0
+     */
+    public static final String BOLT_SERIALIZER_REGISTER_EXTENSION       = "sofa.rpc.bolt.serializer.register.extension";
+
 }

core/common/src/main/resources/com/alipay/sofa/rpc/common/rpc-config-default.json

@@ -304,5 +304,7 @@ PS:大家也看到了，本JSON文档是支持注释的，而标准JSON是不支
   //是否禁止开启lookout采集信息
   "connection.validate.sleep": false,
   //是否关闭uniqueId 特殊字符的校验
-  "sofa.rpc.uniqueId.pattern.check": true
-}
+  "sofa.rpc.uniqueId.pattern.check": true,
+  // bolt serializer 的注册器
+  "sofa.rpc.bolt.serializer.register.extension": "sofaRpcSerializationRegister"
+}

remoting/remoting-bolt/src/main/java/com/alipay/sofa/rpc/codec/bolt/AbstractSerializationRegister.java

@@ -0,0 +1,31 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.alipay.sofa.rpc.codec.bolt;
+
+import com.alipay.sofa.rpc.ext.Extensible;
+
+/**
+ *
+ * @author junyuan
+ * @version AbstractSerializationRegister.java, v 0.1 2022年12月23日 15:01 junyuan Exp $
+ */
+@Extensible
+public abstract class AbstractSerializationRegister {
+
+    public abstract void doRegisterCustomSerializer();
+
+}

remoting/remoting-bolt/src/main/java/com/alipay/sofa/rpc/codec/bolt/SofaRpcSerializationRegister.java

@@ -19,6 +19,7 @@
 import com.alipay.remoting.CustomSerializerManager;
 import com.alipay.sofa.rpc.core.request.SofaRequest;
 import com.alipay.sofa.rpc.core.response.SofaResponse;
+import com.alipay.sofa.rpc.ext.Extension;
 
 import java.util.concurrent.atomic.AtomicBoolean;
 
@@ -27,13 +28,15 @@
  *
  * @author <a href="mailto:zhanggeng.zg@antfin.com">GengZhang</a>
  */
-public class SofaRpcSerializationRegister {
+@Extension(value = "sofaRpcSerializationRegister")
+public class SofaRpcSerializationRegister extends AbstractSerializationRegister {
 
-    private static final SofaRpcSerialization RPC_SERIALIZATION = new SofaRpcSerialization();
+    private final SofaRpcSerialization sofaRpcSerialization = new SofaRpcSerialization();
 
-    private static volatile AtomicBoolean     registered        = new AtomicBoolean(false);
+    private volatile AtomicBoolean     registered           = new AtomicBoolean(false);
 
-    public static void registerCustomSerializer() {
+    @Override
+    public void doRegisterCustomSerializer() {
         if (registered.compareAndSet(false, true)) {
             innerRegisterCustomSerializer();
         }
@@ -42,15 +45,15 @@ public static void registerCustomSerializer() {
     /**
      * we can override or rewrite the method
      */
-    protected static void innerRegisterCustomSerializer() {
+    protected void innerRegisterCustomSerializer() {
         // 注册序列化器到bolt
         if (CustomSerializerManager.getCustomSerializer(SofaRequest.class.getName()) == null) {
             CustomSerializerManager.registerCustomSerializer(SofaRequest.class.getName(),
-                RPC_SERIALIZATION);
+                sofaRpcSerialization);
         }
         if (CustomSerializerManager.getCustomSerializer(SofaResponse.class.getName()) == null) {
             CustomSerializerManager.registerCustomSerializer(SofaResponse.class.getName(),
-                RPC_SERIALIZATION);
+                sofaRpcSerialization);
         }
     }
 }

remoting/remoting-bolt/src/main/java/com/alipay/sofa/rpc/server/bolt/BoltServerProcessor.java

@@ -21,9 +21,11 @@
 import com.alipay.remoting.InvokeContext;
 import com.alipay.remoting.rpc.protocol.AsyncUserProcessor;
 import com.alipay.remoting.rpc.protocol.UserProcessor;
-import com.alipay.sofa.rpc.codec.bolt.SofaRpcSerializationRegister;
+import com.alipay.sofa.rpc.codec.bolt.AbstractSerializationRegister;
 import com.alipay.sofa.rpc.common.RemotingConstants;
+import com.alipay.sofa.rpc.common.RpcConfigs;
 import com.alipay.sofa.rpc.common.RpcConstants;
+import com.alipay.sofa.rpc.common.RpcOptions;
 import com.alipay.sofa.rpc.common.SystemInfo;
 import com.alipay.sofa.rpc.common.cache.ReflectCache;
 import com.alipay.sofa.rpc.common.utils.CommonUtils;
@@ -40,6 +42,7 @@
 import com.alipay.sofa.rpc.event.ServerEndHandleEvent;
 import com.alipay.sofa.rpc.event.ServerReceiveEvent;
 import com.alipay.sofa.rpc.event.ServerSendEvent;
+import com.alipay.sofa.rpc.ext.ExtensionLoaderFactory;
 import com.alipay.sofa.rpc.invoke.Invoker;
 import com.alipay.sofa.rpc.log.LogCodes;
 import com.alipay.sofa.rpc.log.Logger;
@@ -69,7 +72,9 @@ public class BoltServerProcessor extends AsyncUserProcessor<SofaRequest> {
      * 提前注册序列化器
      */
     static {
-        SofaRpcSerializationRegister.registerCustomSerializer();
+        String extensionAlias = RpcConfigs.getStringValue(RpcOptions.BOLT_SERIALIZER_REGISTER_EXTENSION);
+        ExtensionLoaderFactory.getExtensionLoader(AbstractSerializationRegister.class)
+            .getExtension(extensionAlias).doRegisterCustomSerializer();
     }
 
     /**

remoting/remoting-bolt/src/main/java/com/alipay/sofa/rpc/transport/bolt/BoltClientTransport.java

@@ -30,7 +30,7 @@
 import com.alipay.remoting.rpc.exception.InvokeServerException;
 import com.alipay.remoting.rpc.exception.InvokeTimeoutException;
 import com.alipay.sofa.rpc.client.ProviderInfo;
-import com.alipay.sofa.rpc.codec.bolt.SofaRpcSerializationRegister;
+import com.alipay.sofa.rpc.codec.bolt.AbstractSerializationRegister;
 import com.alipay.sofa.rpc.common.RemotingConstants;
 import com.alipay.sofa.rpc.common.RpcConfigs;
 import com.alipay.sofa.rpc.common.RpcConstants;
@@ -50,6 +50,7 @@
 import com.alipay.sofa.rpc.event.ClientSyncReceiveEvent;
 import com.alipay.sofa.rpc.event.EventBus;
 import com.alipay.sofa.rpc.ext.Extension;
+import com.alipay.sofa.rpc.ext.ExtensionLoaderFactory;
 import com.alipay.sofa.rpc.log.LogCodes;
 import com.alipay.sofa.rpc.log.Logger;
 import com.alipay.sofa.rpc.log.LoggerFactory;
@@ -96,7 +97,10 @@ public class BoltClientTransport extends ClientTransport {
 
     static {
         RPC_CLIENT.init();
-        SofaRpcSerializationRegister.registerCustomSerializer();
+
+        String extensionAlias = RpcConfigs.getStringValue(RpcOptions.BOLT_SERIALIZER_REGISTER_EXTENSION);
+        ExtensionLoaderFactory.getExtensionLoader(AbstractSerializationRegister.class)
+            .getExtension(extensionAlias).doRegisterCustomSerializer();
     }
 
     /**

remoting/remoting-bolt/src/main/resources/META-INF/services/sofa-rpc/com.alipay.sofa.rpc.codec.bolt.AbstractSerializationRegister

@@ -0,0 +1 @@
+sofaRpcSerializationRegister=com.alipay.sofa.rpc.codec.bolt.SofaRpcSerializationRegister

remoting/remoting-bolt/src/test/java/com/alipay/sofa/rpc/codec/bolt/BoltSerializationInitTest.java

@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.alipay.sofa.rpc.codec.bolt;
+
+import com.alipay.remoting.CustomSerializerManager;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import com.alipay.sofa.rpc.ext.ExtensionLoaderFactory;
+import com.alipay.sofa.rpc.test.TestSofaRpcSerializationRegister;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ *
+ * @author junyuan
+ * @version BoltSerializationInitTest.java, v 0.1 2022年12月23日 16:26 junyuan Exp $
+ */
+public class BoltSerializationInitTest {
+
+    @Test
+    public void testSerializerRegisterOverride() {
+        AbstractSerializationRegister abstractSerializationRegister = ExtensionLoaderFactory.getExtensionLoader(
+            AbstractSerializationRegister.class).getExtension("sofaRpcSerializationRegister");
+        abstractSerializationRegister.doRegisterCustomSerializer();
+
+        Assert.assertNull("testRegister未能覆盖原版register",
+            CustomSerializerManager.getCustomSerializer(SofaResponse.class.getName()));
+
+        Assert.assertNotNull("testRegister未能覆盖原版register", CustomSerializerManager.getCustomSerializer(
+            TestSofaRpcSerializationRegister.class.getName()));
+    }
+
+    @After
+    public void clearClassSerializerMap() {
+        CustomSerializerManager.clear();
+    }
+
+}

remoting/remoting-bolt/src/test/java/com/alipay/sofa/rpc/test/TestSofaRpcSerializationRegister.java

@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.alipay.sofa.rpc.test;
+
+import com.alipay.remoting.CustomSerializerManager;
+import com.alipay.sofa.rpc.codec.bolt.AbstractSerializationRegister;
+import com.alipay.sofa.rpc.codec.bolt.SofaRpcSerialization;
+import com.alipay.sofa.rpc.codec.bolt.SofaRpcSerializationRegister;
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.ext.Extension;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * Register custom serializer to bolt.
+ *
+ * @author <a href="mailto:zhanggeng.zg@antfin.com">GengZhang</a>
+ */
+@Extension(value = "sofaRpcSerializationRegister", override = true, order = 20)
+public class TestSofaRpcSerializationRegister extends SofaRpcSerializationRegister {
+
+    private final SofaRpcSerialization rpcSerialization = new SofaRpcSerialization();
+
+    /**
+     * we can override or rewrite the method
+     */
+    @Override
+    protected void innerRegisterCustomSerializer() {
+        // 注册序列化器到bolt
+        if (CustomSerializerManager.getCustomSerializer(SofaRequest.class.getName()) == null) {
+            CustomSerializerManager.registerCustomSerializer(SofaRequest.class.getName(),
+                rpcSerialization);
+        }
+
+        if (CustomSerializerManager.getCustomSerializer(TestSofaRpcSerializationRegister.class.getName()) == null) {
+            CustomSerializerManager.registerCustomSerializer(TestSofaRpcSerializationRegister.class.getName(),
+                rpcSerialization);
+        }
+    }
+}

remoting/remoting-bolt/src/test/resources/META-INF/services/com.alipay.sofa.rpc.codec.bolt.AbstractSerializationRegister

@@ -0,0 +1 @@
+sofaRpcSerializationRegister=com.alipay.sofa.rpc.test.TestSofaRpcSerializationRegister