fix duplicate code in exampple module. (#12733)

Motivation: I found some duplicated code when reading the netty code. Modification: all the changes in the netty-example module. Result: fix duplicate code in netty-example module.
netty · Sep 7, 2022 · fe8c26d · fe8c26d
1 parent 77e06b4
commit fe8c26d
Show file tree

Hide file tree

Showing 18 changed files with 96 additions and 143 deletions.
diff --git a/.gitignore b/.gitignore
@@ -54,3 +54,4 @@ mainframer
 
 # exclude file created by the flatten plugin
 .flattened-pom.xml
+.java-version
diff --git a/example/src/main/java/io/netty5/example/discard/DiscardClient.java b/example/src/main/java/io/netty5/example/discard/DiscardClient.java
@@ -24,29 +24,21 @@
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.SocketChannel;
 import io.netty5.channel.socket.nio.NioSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.InsecureTrustManagerFactory;
 
 /**
  * Keeps sending random data to the specified address.
  */
 public final class DiscardClient {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final String HOST = System.getProperty("host", "127.0.0.1");
     static final int PORT = Integer.parseInt(System.getProperty("port", "8009"));
     static final int SIZE = Integer.parseInt(System.getProperty("size", "256"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            sslCtx = SslContextBuilder.forClient()
-                .trustManager(InsecureTrustManagerFactory.INSTANCE).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup group = new MultithreadEventLoopGroup(NioHandler.newFactory());
         try {

diff --git a/example/src/main/java/io/netty5/example/discard/DiscardServer.java b/example/src/main/java/io/netty5/example/discard/DiscardServer.java
@@ -24,29 +24,21 @@
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.SocketChannel;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * Discards any incoming data.
  */
 public final class DiscardServer {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final int PORT = Integer.parseInt(System.getProperty("port", "8009"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/echo/EchoClient.java b/example/src/main/java/io/netty5/example/echo/EchoClient.java
@@ -25,9 +25,8 @@
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.SocketChannel;
 import io.netty5.channel.socket.nio.NioSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.InsecureTrustManagerFactory;
 
 /**
  * Sends one message when a connection is open and echoes back any received
@@ -37,20 +36,13 @@
  */
 public final class EchoClient {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final String HOST = System.getProperty("host", "127.0.0.1");
     static final int PORT = Integer.parseInt(System.getProperty("port", "8007"));
     static final int SIZE = Integer.parseInt(System.getProperty("size", "256"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.git
-        final SslContext sslCtx;
-        if (SSL) {
-            sslCtx = SslContextBuilder.forClient()
-                .trustManager(InsecureTrustManagerFactory.INSTANCE).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         // Configure the client.
         EventLoopGroup group = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/echo/EchoServer.java b/example/src/main/java/io/netty5/example/echo/EchoServer.java
@@ -25,29 +25,21 @@
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.SocketChannel;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * Echoes back any received data from a client.
  */
 public final class EchoServer {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final int PORT = Integer.parseInt(System.getProperty("port", "8007"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         // Configure the server.
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/factorial/FactorialClient.java b/example/src/main/java/io/netty5/example/factorial/FactorialClient.java
@@ -21,30 +21,22 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.InsecureTrustManagerFactory;
 
 /**
  * Sends a sequence of integers to a {@link FactorialServer} to calculate
  * the factorial of the specified integer.
  */
 public final class FactorialClient {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final String HOST = System.getProperty("host", "127.0.0.1");
     static final int PORT = Integer.parseInt(System.getProperty("port", "8322"));
     static final int COUNT = Integer.parseInt(System.getProperty("count", "1000"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            sslCtx = SslContextBuilder.forClient()
-                .trustManager(InsecureTrustManagerFactory.INSTANCE).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup group = new MultithreadEventLoopGroup(NioHandler.newFactory());
         try {

diff --git a/example/src/main/java/io/netty5/example/factorial/FactorialServer.java b/example/src/main/java/io/netty5/example/factorial/FactorialServer.java
@@ -20,30 +20,22 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * Receives a sequence of integers from a {@link FactorialClient} to calculate
  * the factorial of the specified integer.
  */
 public final class FactorialServer {
 
-    static final boolean SSL = System.getProperty("ssl") != null;
     static final int PORT = Integer.parseInt(System.getProperty("port", "8322"));
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/file/FileServer.java b/example/src/main/java/io/netty5/example/file/FileServer.java
@@ -25,14 +25,13 @@
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.SocketChannel;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.codec.LineBasedFrameDecoder;
 import io.netty5.handler.codec.string.StringDecoder;
 import io.netty5.handler.codec.string.StringEncoder;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 import io.netty5.handler.stream.ChunkedWriteHandler;
 
 import java.nio.charset.StandardCharsets;
@@ -48,13 +47,7 @@ public final class FileServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         // Configure the server.
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/cors/HttpCorsServer.java b/example/src/main/java/io/netty5/example/http/cors/HttpCorsServer.java
@@ -20,11 +20,10 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * This example server aims to demonstrate
@@ -79,13 +78,7 @@ public final class HttpCorsServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/file/HttpStaticFileServer.java b/example/src/main/java/io/netty5/example/http/file/HttpStaticFileServer.java
@@ -21,12 +21,10 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.SslProvider;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 public final class HttpStaticFileServer {
 
@@ -35,14 +33,7 @@ public final class HttpStaticFileServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey())
-                .sslProvider(SslProvider.JDK).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/helloworld/HttpHelloWorldServer.java b/example/src/main/java/io/netty5/example/http/helloworld/HttpHelloWorldServer.java
@@ -22,11 +22,10 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * An HTTP server that sends back the content of the received HTTP request
@@ -39,13 +38,7 @@ public final class HttpHelloWorldServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         // Configure the server.
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/snoop/HttpSnoopServer.java b/example/src/main/java/io/netty5/example/http/snoop/HttpSnoopServer.java
@@ -21,11 +21,10 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * An HTTP server that sends back the content of the received HTTP request
@@ -38,13 +37,7 @@ public final class HttpSnoopServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         // Configure the server.
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/websocketx/benchmarkserver/WebSocketServer.java b/example/src/main/java/io/netty5/example/http/websocketx/benchmarkserver/WebSocketServer.java
@@ -21,9 +21,8 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * A Benchmark application for websocket which is served at:
@@ -40,13 +39,7 @@ public final class WebSocketServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());

diff --git a/example/src/main/java/io/netty5/example/http/websocketx/server/WebSocketServer.java b/example/src/main/java/io/netty5/example/http/websocketx/server/WebSocketServer.java
@@ -21,11 +21,10 @@
 import io.netty5.channel.MultithreadEventLoopGroup;
 import io.netty5.channel.nio.NioHandler;
 import io.netty5.channel.socket.nio.NioServerSocketChannel;
+import io.netty5.example.util.ServerUtil;
 import io.netty5.handler.logging.LogLevel;
 import io.netty5.handler.logging.LoggingHandler;
 import io.netty5.handler.ssl.SslContext;
-import io.netty5.handler.ssl.SslContextBuilder;
-import io.netty5.handler.ssl.util.SelfSignedCertificate;
 
 /**
  * An HTTP server which serves Web Socket requests at:
@@ -53,13 +52,7 @@ public final class WebSocketServer {
 
     public static void main(String[] args) throws Exception {
         // Configure SSL.
-        final SslContext sslCtx;
-        if (SSL) {
-            SelfSignedCertificate ssc = new SelfSignedCertificate();
-            sslCtx = SslContextBuilder.forServer(ssc.certificate(), ssc.privateKey()).build();
-        } else {
-            sslCtx = null;
-        }
+        final SslContext sslCtx = ServerUtil.buildSslContext();
 
         EventLoopGroup bossGroup = new MultithreadEventLoopGroup(1, NioHandler.newFactory());
         EventLoopGroup workerGroup = new MultithreadEventLoopGroup(NioHandler.newFactory());