feat:Add generic parameter passing functionality to the HTTP protocol of trpc-java

lilylilili · lilylilili · commit 8a37f93d95a8 · 2025-06-16T10:29:02.000+08:00
diff --git a/trpc-core/src/main/java/com/tencent/trpc/core/utils/JsonUtils.java b/trpc-core/src/main/java/com/tencent/trpc/core/utils/JsonUtils.java
@@ -1,7 +1,7 @@
 /*
  * Tencent is pleased to support the open source community by making tRPC available.
  *
- * Copyright (C) 2023 THL A29 Limited, a Tencent company. 
+ * Copyright (C) 2023 THL A29 Limited, a Tencent company.
  * All rights reserved.
  *
  * If you have downloaded a copy of the tRPC source code from Tencent,
@@ -23,6 +23,7 @@
 import com.tencent.trpc.core.logger.LoggerFactory;
 import java.io.IOException;
 import java.io.InputStream;
+import java.lang.reflect.Type;
 
 /**
  * JSON utility.
@@ -71,6 +72,26 @@ public static <T> T fromInputStream(InputStream is, Class<T> clz) {
         }
     }
 
+    /**
+     * json to Type
+     *
+     * @param is JSON input stream
+     * @param type the class of the Type to deserialize
+     * @param <T> the type of the deserialized object
+     * @return the deserialized object
+     */
+    public static <T> T fromInputStream(InputStream is, Type type) {
+        try {
+            return objectMapper
+                    .readValue(is, objectMapper.getTypeFactory().constructType(type));
+        } catch (Exception e) {
+            logger.error("object mapper readValue error:", e);
+            throw TRpcException.newException(ErrorCode.JSON_DESERIALIZATION_ERR, 0,
+                    "object mapper readValue to Type error, jsonStream:%s, type:%s",
+                    is, type.getTypeName());
+        }
+    }
+
     /**
      * JSON to Object.
      *
@@ -126,6 +147,26 @@ public static <T> T fromJson(String json, TypeReference<T> typeReference) {
         }
     }
 
+    /**
+     * json to Type
+     *
+     * @param json JSON string
+     * @param type the type reference of the object to deserialize
+     * @param <T> the type of the deserialized object
+     * @return the deserialized object
+     */
+    public static <T> T fromJson(String json, Type type) {
+        try {
+            return objectMapper
+                    .readValue(json, objectMapper.getTypeFactory().constructType(type));
+        } catch (Exception e) {
+            logger.error("object mapper readValue error:", e);
+            throw TRpcException.newException(ErrorCode.JSON_DESERIALIZATION_ERR, 0,
+                    "object mapper readValue to Type error, json:%s, type:%s", json,
+                    type.getTypeName());
+        }
+    }
+
     /**
      * Byte arrays to Object.
      *
diff --git a/trpc-demo/trpc-spring-demo/pom.xml b/trpc-demo/trpc-spring-demo/pom.xml
@@ -9,6 +9,7 @@
     <modules>
         <module>trpc-spring-server-demo</module>
         <module>trpc-spring-client-demo</module>
+        <module>trpc-spring-demo-api</module>
     </modules>
     <packaging>pom</packaging>
 
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/pom.xml b/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/pom.xml
@@ -16,6 +16,11 @@
             <groupId>com.tencent.trpc</groupId>
             <artifactId>trpc-proto-http</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.tencent.trpc</groupId>
+            <artifactId>trpc-spring-demo-api</artifactId>
+            <version>${parent.version}</version>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/java/com/tencent/trpc/spring/demo/ClientApplication.java b/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/java/com/tencent/trpc/spring/demo/ClientApplication.java
@@ -1,7 +1,7 @@
 /*
  * Tencent is pleased to support the open source community by making tRPC available.
  *
- * Copyright (C) 2023 THL A29 Limited, a Tencent company. 
+ * Copyright (C) 2023 THL A29 Limited, a Tencent company.
  * All rights reserved.
  *
  * If you have downloaded a copy of the tRPC source code from Tencent,
@@ -12,6 +12,8 @@
 package com.tencent.trpc.spring.demo;
 
 import com.google.protobuf.Message;
+import com.tencent.trpc.GreeterService3API;
+import com.tencent.trpc.GreeterService3API.RequestParameterizedBean;
 import com.tencent.trpc.core.rpc.RpcClientContext;
 import com.tencent.trpc.core.rpc.RpcContext;
 import com.tencent.trpc.demo.proto.GreeterService2AsyncAPI;
@@ -39,20 +41,26 @@ public static void main(String[] args) throws Exception {
             GreeterService2AsyncAPI service2 = context.getBean(ProxyService.SERVICE_NAME2,
                     GreeterService2AsyncAPI.class);
 
+            GreeterService3API service3 = context.getBean(ProxyService.SERVICE_NAME3,
+                    GreeterService3API.class);
+
             RpcContext ctx = new RpcClientContext();
             HelloRequestProtocol.HelloRequest request = HelloRequestProtocol.HelloRequest.newBuilder()
                     .setMessage("tRPC-Java")
                     .build();
+            RequestParameterizedBean<String> parameterizedBean = RequestParameterizedBean.of("message",
+                    "hello parameterizedBean");
 
             int times = 5;
 
             for (int i = 0; i < times; i++) {
                 System.out.println("service1>>>>" + syncGetMessage(service1.sayHello(ctx, request)));
                 System.out.println("service2>>>>" + syncGetMessage(service2.sayHi(ctx, request)));
-                System.out.println("demo service1>>>>" +
-                        syncGetMessage(demoService.getGreeterService().sayHello(ctx, request)));
-                System.out.println("demo service2>>>>" +
-                        syncGetMessage(demoService.getGreeterService2().sayHi(ctx, request)));
+                System.out.println("service3>>>>" + service3.sayHelloParameterized(ctx, parameterizedBean));
+                System.out.println("demo service1>>>>"
+                        + syncGetMessage(demoService.getGreeterService().sayHello(ctx, request)));
+                System.out.println("demo service2>>>>"
+                        + syncGetMessage(demoService.getGreeterService2().sayHi(ctx, request)));
                 TimeUnit.SECONDS.sleep(1);
             }
 
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/java/com/tencent/trpc/spring/demo/server/ProxyService.java b/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/java/com/tencent/trpc/spring/demo/server/ProxyService.java
@@ -1,7 +1,7 @@
 /*
  * Tencent is pleased to support the open source community by making tRPC available.
  *
- * Copyright (C) 2023 THL A29 Limited, a Tencent company. 
+ * Copyright (C) 2023 THL A29 Limited, a Tencent company.
  * All rights reserved.
  *
  * If you have downloaded a copy of the tRPC source code from Tencent,
@@ -11,6 +11,7 @@
 
 package com.tencent.trpc.spring.demo.server;
 
+import com.tencent.trpc.GreeterService3API;
 import com.tencent.trpc.demo.proto.GreeterService2AsyncAPI;
 import com.tencent.trpc.demo.proto.GreeterServiceAsyncAPI;
 import com.tencent.trpc.spring.annotation.TRpcClient;
@@ -21,13 +22,17 @@ public class ProxyService {
 
     public static final String SERVICE_NAME1 = "trpc.TestApp.TestServer.Greeter1";
     public static final String SERVICE_NAME2 = "trpc.TestApp.TestServer.Greeter2";
+    public static final String SERVICE_NAME3 = "trpc.TestApp.TestServer.Greeter3";
 
     @TRpcClient(id = SERVICE_NAME1)
     private GreeterServiceAsyncAPI greeterService;
 
     @TRpcClient(id = SERVICE_NAME2)
     private GreeterService2AsyncAPI greeterService2;
 
+    @TRpcClient(id = SERVICE_NAME3)
+    private GreeterService3API greeterService3;
+
     public GreeterServiceAsyncAPI getGreeterService() {
         return greeterService;
     }
@@ -36,4 +41,8 @@ public GreeterService2AsyncAPI getGreeterService2() {
         return greeterService2;
     }
 
+    public GreeterService3API getGreeterService3() {
+        return greeterService3;
+    }
+
 }
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/resources/application.yml b/trpc-demo/trpc-spring-demo/trpc-spring-client-demo/src/main/resources/application.yml
@@ -14,3 +14,8 @@ trpc:
         interface: com.tencent.trpc.demo.proto.GreeterService2AsyncAPI  # Service interface
         protocol: http  # Protocol type, default is trpc
         basePath: /rest # The base path of the client service url address
+      - name: trpc.TestApp.TestServer.Greeter3  # Service name
+        naming_url: ip://127.0.0.1:12322  # Router address
+        interface: com.tencent.trpc.GreeterService3API  # Service interface
+        protocol: http  # Protocol type, default is trpc
+        basePath: /rest # The base path of the client service url address
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-demo-api/pom.xml b/trpc-demo/trpc-spring-demo/trpc-spring-demo-api/pom.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="http://maven.apache.org/POM/4.0.0"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.tencent.trpc</groupId>
+        <artifactId>trpc-spring-demo</artifactId>
+        <version>1.4.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>trpc-spring-demo-api</artifactId>
+    <packaging>jar</packaging>
+    <name>${project.artifactId}</name>
+    <properties>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+</project>
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-demo-api/src/main/java/com/tencent/trpc/GreeterService3API.java b/trpc-demo/trpc-spring-demo/trpc-spring-demo-api/src/main/java/com/tencent/trpc/GreeterService3API.java
@@ -0,0 +1,42 @@
+package com.tencent.trpc;
+
+import com.tencent.trpc.core.rpc.RpcContext;
+import com.tencent.trpc.core.rpc.anno.TRpcMethod;
+import com.tencent.trpc.core.rpc.anno.TRpcService;
+import java.util.Map;
+
+@TRpcService(name = "trpc.TestApp.TestServer.GreeterService3")
+public interface GreeterService3API {
+
+    @TRpcMethod(name = "sayHelloParameterized")
+    <T> Map sayHelloParameterized(RpcContext context, RequestParameterizedBean<T> request);
+
+    class RequestParameterizedBean<T> {
+
+        String message;
+        T data;
+
+        public static <T> RequestParameterizedBean<T> of(String message, T data) {
+            RequestParameterizedBean<T> bean = new RequestParameterizedBean<>();
+            bean.setMessage(message);
+            bean.setData(data);
+            return bean;
+        }
+
+        public String getMessage() {
+            return message;
+        }
+
+        public void setMessage(String message) {
+            this.message = message;
+        }
+
+        public T getData() {
+            return data;
+        }
+
+        public void setData(T data) {
+            this.data = data;
+        }
+    }
+}
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/pom.xml b/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/pom.xml
@@ -16,6 +16,11 @@
             <groupId>com.tencent.trpc</groupId>
             <artifactId>trpc-springmvc</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.tencent.trpc</groupId>
+            <artifactId>trpc-spring-demo-api</artifactId>
+            <version>${parent.version}</version>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/src/main/java/com/tencent/trpc/spring/demo/server/impl/GreeterServiceImpl3.java b/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/src/main/java/com/tencent/trpc/spring/demo/server/impl/GreeterServiceImpl3.java
@@ -0,0 +1,22 @@
+package com.tencent.trpc.spring.demo.server.impl;
+
+import com.tencent.trpc.GreeterService3API;
+import com.tencent.trpc.core.logger.Logger;
+import com.tencent.trpc.core.logger.LoggerFactory;
+import com.tencent.trpc.core.rpc.RpcContext;
+import java.util.Collections;
+import java.util.Map;
+import org.springframework.stereotype.Service;
+
+@Service
+public class GreeterServiceImpl3 implements GreeterService3API {
+
+    private static final Logger logger = LoggerFactory.getLogger(GreeterServiceImpl3.class);
+
+    @Override
+    public <T> Map sayHelloParameterized(RpcContext context, RequestParameterizedBean<T> request) {
+        logger.info("got hello json request, request is '{}'", request);
+
+        return Collections.singletonMap("message", "Hi:" + request.getData());
+    }
+}
diff --git a/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/src/main/resources/application.yml b/trpc-demo/trpc-spring-demo/trpc-spring-server-demo/src/main/resources/application.yml
@@ -16,8 +16,9 @@ trpc:
       - name: trpc.TestApp.TestServer.Greeter2  # Service name
         impls: # Service implement classes
           - com.tencent.trpc.spring.demo.server.impl.GreeterServiceImpl2
+          - com.tencent.trpc.spring.demo.server.impl.GreeterServiceImpl3
         ip: 127.0.0.1     # Listen ip
         port: 12322       # Listen port
         protocol: rest    # Means using trpc-springmvc mode, service exported as spring mvc controller
         basePath: /rest   # The url address is the base_path plus the service name annotated with @TRpcService, and the
-                          # '.' in the service name are all replaced with '/'. Default is '/'.
+        # '.' in the service name are all replaced with '/'. Default is '/'.
diff --git a/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/AbstractConsumerInvoker.java b/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/AbstractConsumerInvoker.java
@@ -201,9 +201,10 @@ protected String encodeToJson(Request request) {
         if (paramsTypes.length <= 1) {
             return null;
         }
-        Class<?> reqType = (Class<?>) paramsTypes[1];
-
-        if (Message.class.isAssignableFrom(reqType)) {
+        Type reqType = paramsTypes[1];
+        // The protobuf Message type uses ProtoJsonConverter for JSON data conversion,
+        // the other types use JsonUtils, supporting request parameters with generic type parameters
+        if (reqType instanceof Class<?> && Message.class.isAssignableFrom((Class<?>) reqType)) {
             Map<String, Object> jsonData = ProtoJsonConverter.messageToMap((Message) param);
             return JsonUtils.toJson(jsonData);
         } else {
diff --git a/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/common/HttpCodec.java b/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/common/HttpCodec.java
@@ -17,16 +17,18 @@
 import com.tencent.trpc.core.serialization.spi.Serialization;
 import com.tencent.trpc.core.serialization.support.JSONSerialization;
 import com.tencent.trpc.core.serialization.support.PBSerialization;
+import com.tencent.trpc.core.utils.JsonUtils;
 import com.tencent.trpc.core.utils.ProtoJsonConverter;
 import com.tencent.trpc.proto.http.util.StreamUtils;
+import jakarta.servlet.ServletOutputStream;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.lang.reflect.Method;
+import java.lang.reflect.Type;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.Map;
-import jakarta.servlet.ServletOutputStream;
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
 import org.apache.commons.beanutils.BeanUtils;
 import org.apache.http.HttpHeaders;
 
@@ -181,6 +183,33 @@ public Object convertToJavaBean(HttpServletRequest request, Class<?> msgType) th
         return bean;
     }
 
+    /**
+     * Convert HTTP request body to Parameterized Types POJO
+     *
+     * @param request HttpServletRequest
+     * @param type the type of decoded param
+     * @return decoded param
+     * @throws Exception if param parsing failed
+     */
+    public Object convertToParameterizedBean(HttpServletRequest request, Type type) throws Exception {
+        Map<String, Object> params = new HashMap<>();
+        if (HttpConstants.HTTP_METHOD_GET.equalsIgnoreCase(request.getMethod())) {
+            Enumeration<String> parameterNames = request.getParameterNames();
+            while (parameterNames.hasMoreElements()) {
+                String param = parameterNames.nextElement();
+                params.put(param, request.getParameter(param));
+            }
+            return JsonUtils.fromJson(JsonUtils.toJson(params), type);
+        }
+        String contentType = request.getContentType().toLowerCase();
+        if (contentType.startsWith(HttpConstants.CONTENT_TYPE_JSON)) {
+            return JsonUtils.fromInputStream(request.getInputStream(), type);
+        } else {
+            // unsupported content-type
+            throw new IllegalArgumentException("unsupported content-type " + contentType);
+        }
+    }
+
     /**
      * Serialize the return result. Currently, all results are converted to JSON.
      *
diff --git a/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/server/AbstractHttpExecutor.java b/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/server/AbstractHttpExecutor.java
diff --git a/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/HttpRpcClientTest.java b/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/HttpRpcClientTest.java
diff --git a/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/HttpRpcServerTest.java b/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/HttpRpcServerTest.java
diff --git a/trpc-proto/trpc-proto-http/src/test/java/tests/service/GreeterParameterizedService.java b/trpc-proto/trpc-proto-http/src/test/java/tests/service/GreeterParameterizedService.java
diff --git a/trpc-proto/trpc-proto-http/src/test/java/tests/service/impl1/GreeterParameterizedServiceImpl.java b/trpc-proto/trpc-proto-http/src/test/java/tests/service/impl1/GreeterParameterizedServiceImpl.java
