WebSocket on Triple (#14390)

* WebSocket on Triple * Resolve conflict * Fix issues Fix issues * Merge latest code * Change package * Merge latest code * Merge latest code * Use Filter instead of GenericFilter
apache · Nov 13, 2024 · 59663c8 · 59663c8
1 parent 343a1ab
commit 59663c8
Show file tree

Hide file tree

Showing 48 changed files with 1,898 additions and 14 deletions.
diff --git a/.artifacts b/.artifacts
@@ -75,6 +75,7 @@ dubbo-remoting
 dubbo-remoting-api
 dubbo-remoting-http12
 dubbo-remoting-http3
+dubbo-remoting-websocket
 dubbo-remoting-netty
 dubbo-remoting-netty4
 dubbo-remoting-zookeeper-curator5
@@ -116,3 +117,4 @@ dubbo-plugin-loom
 dubbo-rest-jaxrs
 dubbo-rest-spring
 dubbo-triple-servlet
+dubbo-triple-websocket
diff --git a/dubbo-common/src/main/java/org/apache/dubbo/config/nested/TripleConfig.java b/dubbo-common/src/main/java/org/apache/dubbo/config/nested/TripleConfig.java
@@ -152,6 +152,9 @@ public class TripleConfig implements Serializable {
     @Nested
     private ServletConfig servlet;
 
+    @Nested
+    private WebSocketConfig websocket;
+
     public Boolean getVerbose() {
         return verbose;
     }
@@ -370,4 +373,12 @@ public ServletConfig getServlet() {
     public void setServlet(ServletConfig servlet) {
         this.servlet = servlet;
     }
+
+    public WebSocketConfig getWebsocket() {
+        return websocket;
+    }
+
+    public void setWebsocket(WebSocketConfig websocket) {
+        this.websocket = websocket;
+    }
 }
diff --git a/dubbo-common/src/main/java/org/apache/dubbo/config/nested/WebSocketConfig.java b/dubbo-common/src/main/java/org/apache/dubbo/config/nested/WebSocketConfig.java
@@ -0,0 +1,66 @@
+/*
+ * 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 org.apache.dubbo.config.nested;
+
+import java.io.Serializable;
+
+public class WebSocketConfig implements Serializable {
+
+    private static final long serialVersionUID = -2504271061733141988L;
+
+    /**
+     * Whether to enable websocket support, requests are transport through the websocket container
+     * <p>The default value is false.
+     */
+    private Boolean enabled;
+
+    /**
+     * The URL patterns that the websocket filter will be registered for.
+     * <p>The default value is '/*'.
+     */
+    private String[] filterUrlPatterns;
+
+    /**
+     * The order of the websocket filter.
+     * <p>The default value is -1000000.
+     */
+    private Integer filterOrder;
+
+    public Boolean getEnabled() {
+        return enabled;
+    }
+
+    public void setEnabled(Boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    public String[] getFilterUrlPatterns() {
+        return filterUrlPatterns;
+    }
+
+    public void setFilterUrlPatterns(String[] filterUrlPatterns) {
+        this.filterUrlPatterns = filterUrlPatterns;
+    }
+
+    public Integer getFilterOrder() {
+        return filterOrder;
+    }
+
+    public void setFilterOrder(Integer filterOrder) {
+        this.filterOrder = filterOrder;
+    }
+}
diff --git a/dubbo-dependencies-bom/pom.xml b/dubbo-dependencies-bom/pom.xml
@@ -108,6 +108,7 @@
     <protobuf-java_version>3.25.5</protobuf-java_version>
     <javax_annotation-api_version>1.3.2</javax_annotation-api_version>
     <servlet_version>3.1.0</servlet_version>
+    <jakarta_websocket_version>2.2.0</jakarta_websocket_version>
     <jakarta_servlet_version>6.1.0</jakarta_servlet_version>
     <jetty_version>9.4.56.v20240826</jetty_version>
     <validation_new_version>3.1.0</validation_new_version>
@@ -462,6 +463,18 @@
         <version>${jakarta_servlet_version}</version>
         <scope>provided</scope>
       </dependency>
+      <dependency>
+        <groupId>jakarta.websocket</groupId>
+        <artifactId>jakarta.websocket-api</artifactId>
+        <version>${jakarta_websocket_version}</version>
+        <scope>provided</scope>
+      </dependency>
+      <dependency>
+        <groupId>jakarta.websocket</groupId>
+        <artifactId>jakarta.websocket-client-api</artifactId>
+        <version>${jakarta_websocket_version}</version>
+        <scope>provided</scope>
+      </dependency>
       <dependency>
         <groupId>com.squareup.okhttp3</groupId>
         <artifactId>okhttp</artifactId>

diff --git a/dubbo-distribution/dubbo-all-shaded/pom.xml b/dubbo-distribution/dubbo-all-shaded/pom.xml
@@ -283,6 +283,13 @@
       <scope>compile</scope>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>org.apache.dubbo</groupId>
+      <artifactId>dubbo-triple-websocket</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
 
     <!-- registry -->
     <dependency>
@@ -343,6 +350,13 @@
       <scope>compile</scope>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>org.apache.dubbo</groupId>
+      <artifactId>dubbo-remoting-websocket</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>org.apache.dubbo</groupId>
       <artifactId>dubbo-remoting-netty</artifactId>
@@ -500,6 +514,7 @@
                   <include>org.apache.dubbo:dubbo-remoting-api</include>
                   <include>org.apache.dubbo:dubbo-remoting-http12</include>
                   <include>org.apache.dubbo:dubbo-remoting-http3</include>
+                  <include>org.apache.dubbo:dubbo-remoting-websocket</include>
                   <include>org.apache.dubbo:dubbo-remoting-netty4</include>
                   <include>org.apache.dubbo:dubbo-remoting-netty</include>
                   <include>org.apache.dubbo:dubbo-remoting-zookeeper-curator5</include>
@@ -510,6 +525,7 @@
                   <include>org.apache.dubbo:dubbo-rest-jaxrs</include>
                   <include>org.apache.dubbo:dubbo-rest-spring</include>
                   <include>org.apache.dubbo:dubbo-triple-servlet</include>
+                  <include>org.apache.dubbo:dubbo-triple-websocket</include>
                   <include>org.apache.dubbo:dubbo-serialization-api</include>
                   <include>org.apache.dubbo:dubbo-serialization-hessian2</include>
                   <include>org.apache.dubbo:dubbo-serialization-fastjson2</include>
@@ -745,6 +761,9 @@
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.http3.Http3ServerTransportListenerFactory</resource>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                  <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.websocket.WebSocketServerTransportListenerFactory</resource>
+                </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.telnet.TelnetHandler</resource>
                 </transformer>

diff --git a/dubbo-distribution/dubbo-all/pom.xml b/dubbo-distribution/dubbo-all/pom.xml
@@ -283,6 +283,13 @@
       <scope>compile</scope>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>org.apache.dubbo</groupId>
+      <artifactId>dubbo-triple-websocket</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
 
     <!-- registry -->
     <dependency>
@@ -343,6 +350,13 @@
       <scope>compile</scope>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>org.apache.dubbo</groupId>
+      <artifactId>dubbo-remoting-websocket</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>org.apache.dubbo</groupId>
       <artifactId>dubbo-remoting-netty</artifactId>
@@ -499,6 +513,7 @@
                   <include>org.apache.dubbo:dubbo-remoting-api</include>
                   <include>org.apache.dubbo:dubbo-remoting-http12</include>
                   <include>org.apache.dubbo:dubbo-remoting-http3</include>
+                  <include>org.apache.dubbo:dubbo-remoting-websocket</include>
                   <include>org.apache.dubbo:dubbo-remoting-netty4</include>
                   <include>org.apache.dubbo:dubbo-remoting-netty</include>
                   <include>org.apache.dubbo:dubbo-remoting-zookeeper-curator5</include>
@@ -509,6 +524,7 @@
                   <include>org.apache.dubbo:dubbo-rest-jaxrs</include>
                   <include>org.apache.dubbo:dubbo-rest-spring</include>
                   <include>org.apache.dubbo:dubbo-triple-servlet</include>
+                  <include>org.apache.dubbo:dubbo-triple-websocket</include>
                   <include>org.apache.dubbo:dubbo-serialization-api</include>
                   <include>org.apache.dubbo:dubbo-serialization-hessian2</include>
                   <include>org.apache.dubbo:dubbo-serialization-fastjson2</include>
@@ -743,6 +759,9 @@
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.http3.Http3ServerTransportListenerFactory</resource>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                  <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.websocket.WebSocketServerTransportListenerFactory</resource>
+                </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.telnet.TelnetHandler</resource>
                 </transformer>

diff --git a/dubbo-distribution/dubbo-bom/pom.xml b/dubbo-distribution/dubbo-bom/pom.xml
@@ -339,6 +339,11 @@
         <artifactId>dubbo-triple-servlet</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.dubbo</groupId>
+        <artifactId>dubbo-triple-websocket</artifactId>
+        <version>${project.version}</version>
+      </dependency>
 
       <!-- registry -->
       <dependency>
@@ -395,6 +400,11 @@
         <artifactId>dubbo-remoting-http3</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.dubbo</groupId>
+        <artifactId>dubbo-remoting-websocket</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.apache.dubbo</groupId>
         <artifactId>dubbo-remoting-netty</artifactId>

diff --git a/dubbo-distribution/dubbo-core-spi/pom.xml b/dubbo-distribution/dubbo-core-spi/pom.xml
@@ -363,6 +363,9 @@
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.http3.Http3ServerTransportListenerFactory</resource>
                 </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                  <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.websocket.WebSocketServerTransportListenerFactory</resource>
+                </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                   <resource>META-INF/dubbo/internal/org.apache.dubbo.remoting.telnet.TelnetHandler</resource>
                 </transformer>

diff --git a/...-triple-servlet/src/main/java/org/apache/dubbo/rpc/protocol/tri/servlet/TripleFilter.java b/...-triple-servlet/src/main/java/org/apache/dubbo/rpc/protocol/tri/servlet/TripleFilter.java
@@ -59,6 +59,8 @@
 import java.util.Arrays;
 import java.util.Set;
 
+import static org.apache.dubbo.rpc.protocol.tri.TripleConstants.UPGRADE_HEADER_KEY;
+
 public class TripleFilter implements Filter {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(TripleFilter.class);
@@ -86,7 +88,7 @@ public void doFilter(ServletRequest servletRequest, ServletResponse servletRespo
                 return;
             }
         } else {
-            if (mappingRegistry.exists(request.getRequestURI(), request.getMethod())) {
+            if (!isUpgradeRequest(request) && mappingRegistry.exists(request.getRequestURI(), request.getMethod())) {
                 handleHttp1(request, response);
                 return;
             }
@@ -188,6 +190,10 @@ private static int resolveTimeout(HttpServletRequest request, boolean isGrpc) {
         return 0;
     }
 
+    private boolean isUpgradeRequest(HttpServletRequest request) {
+        return request.getHeader(UPGRADE_HEADER_KEY) != null;
+    }
+
     private static final class TripleAsyncListener implements AsyncListener {
 
         private final ServletStreamChannel streamChannel;