Merge pull request #15 from zenuo/feature_lints

zenuo · web-flow · commit c0c0c2bd79f4 · 2020-07-26T15:35:57.000+08:00
Feature lints
diff --git a/gogo-server/pom.xml b/gogo-server/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>zenuo</groupId>
     <artifactId>gogo</artifactId>
-    <version>1.7.4</version>
+    <version>1.7.5</version>
 
     <packaging>jar</packaging>
 
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/Handler.java b/gogo-server/src/main/java/zenuo/gogo/core/Handler.java
@@ -14,6 +14,7 @@
 import zenuo.gogo.core.processor.IIndexProcessor;
 import zenuo.gogo.core.processor.ILintProcessor;
 import zenuo.gogo.core.processor.ISearchProcessor;
+import zenuo.gogo.core.processor.IStaticProcessor;
 
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
@@ -47,6 +48,11 @@ public final class Handler extends SimpleChannelInboundHandler<FullHttpRequest>
      */
     private final ILintProcessor lintProcessor = ServiceLoader.load(ILintProcessor.class).iterator().next();
 
+    /**
+     * 静态文件处理器
+     */
+    private final IStaticProcessor staticProcessor = ServiceLoader.load(IStaticProcessor.class).iterator().next();
+
     /**
      * 处理工作者线程池
      */
@@ -73,7 +79,7 @@ protected void channelRead0(ChannelHandlerContext ctx, FullHttpRequest request)
             indexProcessor.response(ctx,
                     request,
                     ResponseType.API,
-                    "{\"error\": \"too many requests, please try again later.\"}",
+                    "{\"error\": \"too many requests, please try again later.\"}".getBytes(StandardCharsets.UTF_8),
                     HttpResponseStatus.TOO_MANY_REQUESTS);
         } else {
             // 此处线程是事件循环worker，由processWorkers完成逻辑、搜索请求解析，再由processWorkers触发worker线程响应客户端
@@ -88,7 +94,7 @@ private void doChannelRead0(ChannelHandlerContext ctx, FullHttpRequest request)
             indexProcessor.response(ctx,
                     request,
                     ResponseType.API,
-                    "{\"error\", \"the http method should be GET only\"}",
+                    "{\"error\", \"the http method should be GET only\"}".getBytes(StandardCharsets.UTF_8),
                     HttpResponseStatus.BAD_REQUEST);
         } else {
             final QueryStringDecoder decoder = new QueryStringDecoder(request.uri());
@@ -112,11 +118,15 @@ private void doChannelRead0(ChannelHandlerContext ctx, FullHttpRequest request)
                     lintProcessor.process(ctx, request, decoder, null);
                     break;
                 default:
-                    indexProcessor.response(ctx,
-                            request,
-                            ResponseType.API,
-                            "{\"error\": \"BAD_GATEWAY\"}",
-                            HttpResponseStatus.BAD_GATEWAY);
+                    if (decoder.path().startsWith("/static")) {
+                        staticProcessor.process(ctx, request, decoder, null);
+                    } else {
+                        indexProcessor.response(ctx,
+                                request,
+                                ResponseType.API,
+                                "{\"error\": \"BAD_GATEWAY\"}".getBytes(StandardCharsets.UTF_8),
+                                HttpResponseStatus.BAD_GATEWAY);
+                    }
             }
         }
     }
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/config/ApplicationConfig.java b/gogo-server/src/main/java/zenuo/gogo/core/config/ApplicationConfig.java
@@ -33,10 +33,6 @@ public class ApplicationConfig {
         INSTANCE.gogoConfig.postConstruct();
     }
 
-    public static void main(String[] args) {
-        System.out.println(INSTANCE);
-    }
-
     public static HttpClientConfig httpClientConfig() {
         return INSTANCE.httpClientConfig;
     }
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/IProcessor.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/IProcessor.java
@@ -10,8 +10,6 @@
 import io.netty.handler.codec.http.QueryStringDecoder;
 import zenuo.gogo.core.ResponseType;
 
-import java.nio.charset.StandardCharsets;
-
 interface IProcessor {
 
     /**
@@ -37,14 +35,14 @@ default void response(
             final ChannelHandlerContext ctx,
             final FullHttpRequest request,
             final ResponseType responseType,
-            final String body,
+            final byte[] body,
             final HttpResponseStatus status
     ) {
         //响应对象
         final DefaultFullHttpResponse response = new DefaultFullHttpResponse(
                 request.protocolVersion(),
                 status,
-                body == null ? Unpooled.buffer() : Unpooled.copiedBuffer(body.getBytes(StandardCharsets.UTF_8)));
+                body == null ? Unpooled.buffer() : Unpooled.copiedBuffer(body));
         //设置头信息
         response.headers().add(HttpHeaderNames.SERVER, "gogo");
         response.headers().add(HttpHeaderNames.CACHE_CONTROL, "private, max-age=120");
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/IStaticProcessor.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/IStaticProcessor.java
@@ -0,0 +1,10 @@
+package zenuo.gogo.core.processor;
+
+/**
+ * note
+ *
+ * @author zenuo
+ * @version 2020-07-26
+ */
+public interface IStaticProcessor extends IProcessor {
+}
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/IndexProcessorImpl.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/IndexProcessorImpl.java
@@ -9,10 +9,13 @@
 import zenuo.gogo.web.IIndexPageBuilder;
 import zenuo.gogo.web.IPageBuilder;
 
+import java.nio.charset.StandardCharsets;
 import java.util.ServiceLoader;
 
 public final class IndexProcessorImpl implements IIndexProcessor {
 
+    private static final byte[] RESPONSE_BODY_WELCOME = "{\"info\":\"Hello, welcome to Gogo API, https://github.com/zenuo/gogo\"}".getBytes(StandardCharsets.UTF_8);
+
     /**
      * 页面构建器
      */
@@ -24,7 +27,7 @@ public void process(ChannelHandlerContext ctx, FullHttpRequest request, QueryStr
             response(ctx,
                     request,
                     ResponseType.API,
-                    "{\"info\":\"Hello, welcome to Gogo API, https://github.com/zenuo/gogo\"}",
+                    RESPONSE_BODY_WELCOME,
                     HttpResponseStatus.OK);
         } else {
             response(ctx,
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/LintProcessorImpl.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/LintProcessorImpl.java
@@ -25,21 +25,23 @@
 @Slf4j
 public final class LintProcessorImpl implements ILintProcessor {
 
+    final byte[] RESPONSE_BODY_KEYWORD_EMPTY = "{\"error\": \"the keyword should not be empty\"}".getBytes(StandardCharsets.UTF_8);
+
     @Override
     public void process(ChannelHandlerContext ctx, FullHttpRequest request, QueryStringDecoder decoder, ResponseType responseType) {
         final List<String> keys = decoder.parameters().get("q");
         if (keys == null || "".equals(keys.get(0))) {
             response(ctx,
                     request,
                     ResponseType.API,
-                    "{\"error\": \"the keyword should not be empty\"}",
+                    RESPONSE_BODY_KEYWORD_EMPTY,
                     HttpResponseStatus.BAD_REQUEST);
         } else {
             final LintResponse response = response(keys.get(0));
             response(ctx,
                     request,
                     ResponseType.API,
-                    JsonUtils.toJson(response),
+                    JsonUtils.toJsonBytes(response),
                     response.getStatus());
         }
     }
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/SearchProcessorImpl.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/SearchProcessorImpl.java
@@ -15,6 +15,7 @@
 import zenuo.gogo.web.IPageBuilder;
 import zenuo.gogo.web.IResultPageBuilder;
 
+import java.nio.charset.StandardCharsets;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Optional;
@@ -34,14 +35,17 @@ public final class SearchProcessorImpl implements ISearchProcessor {
             .sorted(Comparator.comparingInt(ISearchResultProvider::priority))
             .collect(Collectors.toList());
 
+    private static final byte[] RESPONSE_BODY_KEYWORD_EMPTY = "{\"error\": \"the keyword should not be empty\"}".getBytes(StandardCharsets.UTF_8);
+
     @Override
     public void process(ChannelHandlerContext ctx, FullHttpRequest request, QueryStringDecoder decoder, ResponseType responseType) {
         final List<String> keys = decoder.parameters().get("q");
         if (keys == null || "".equals(keys.get(0))) {
+
             response(ctx,
                     request,
                     ResponseType.API,
-                    "{\"error\": \"the keyword should not be empty\"}",
+                    RESPONSE_BODY_KEYWORD_EMPTY,
                     HttpResponseStatus.BAD_REQUEST);
         } else {
             final List<String> pages = decoder.parameters().get("p");
@@ -85,15 +89,15 @@ public void process(ChannelHandlerContext ctx, FullHttpRequest request, QueryStr
                 response(ctx,
                         request,
                         responseType,
-                        responseType == ResponseType.API ? "{\"error\": \"" + searchException.getMessage() + "\"}"
+                        responseType == ResponseType.API ? ("{\"error\": \"" + searchException.getMessage() + "\"}").getBytes(StandardCharsets.UTF_8)
                                 : resultPageBuilder.build(SearchResponse.builder().key(key).error(searchException.getMessage()).build()),
                         HttpResponseStatus.OK);
 
             } else {
                 response(ctx,
                         request,
                         responseType,
-                        responseType == ResponseType.API ? JsonUtils.toJson(response) : resultPageBuilder.build(response),
+                        responseType == ResponseType.API ? JsonUtils.toJsonBytes(response) : resultPageBuilder.build(response),
                         response.getStatus() == null ? HttpResponseStatus.OK : response.getStatus());
             }
         }
diff --git a/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/StaticProcessorImpl.java b/gogo-server/src/main/java/zenuo/gogo/core/processor/impl/StaticProcessorImpl.java
@@ -0,0 +1,54 @@
+package zenuo.gogo.core.processor.impl;
+
+import io.netty.buffer.Unpooled;
+import io.netty.channel.ChannelFutureListener;
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.handler.codec.http.DefaultFullHttpResponse;
+import io.netty.handler.codec.http.FullHttpRequest;
+import io.netty.handler.codec.http.HttpHeaderNames;
+import io.netty.handler.codec.http.HttpHeaderValues;
+import io.netty.handler.codec.http.HttpResponseStatus;
+import io.netty.handler.codec.http.QueryStringDecoder;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.IOUtils;
+import zenuo.gogo.core.ResponseType;
+import zenuo.gogo.core.processor.IStaticProcessor;
+
+import java.io.InputStream;
+
+/**
+ * note
+ *
+ * @author zenuo
+ * @version 2020-07-26
+ */
+@Slf4j
+public final class StaticProcessorImpl implements IStaticProcessor {
+    @Override
+    public void process(ChannelHandlerContext ctx, FullHttpRequest request, QueryStringDecoder decoder, ResponseType responseType) {
+        final String path = "web" + decoder.path();
+        final byte[] bytes;
+        try (final InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(path)) {
+            bytes = IOUtils.toByteArray(inputStream);
+        } catch (Exception e) {
+            log.error("process static '{}' error", path, e);
+            throw new RuntimeException(e);
+        }
+        //响应对象
+        final DefaultFullHttpResponse response = new DefaultFullHttpResponse(
+                request.protocolVersion(),
+                HttpResponseStatus.OK,
+                Unpooled.copiedBuffer(bytes));
+        //设置头信息
+        response.headers().add(HttpHeaderNames.SERVER, "gogo");
+        response.headers().add(HttpHeaderNames.CACHE_CONTROL, "private, max-age=120");
+        if (path.endsWith(".js")) {
+            response.headers().add(HttpHeaderNames.CONTENT_TYPE, "text/javascript");
+        } else {
+            response.headers().add(HttpHeaderNames.CONTENT_TYPE, HttpHeaderValues.FILE);
+        }
+        //响应后关闭通道
+        ctx.writeAndFlush(response)
+                .addListener(ChannelFutureListener.CLOSE);
+    }
+}
diff --git a/gogo-server/src/main/java/zenuo/gogo/util/JsonUtils.java b/gogo-server/src/main/java/zenuo/gogo/util/JsonUtils.java
@@ -29,6 +29,15 @@ public static String toJson(final Object object) {
         }
     }
 
+    public static byte[] toJsonBytes(final Object object) {
+        try {
+            return Constants.MAPPER.writeValueAsBytes(object);
+        } catch (Exception e) {
+            log.error("toJson", e);
+            throw new IllegalStateException(e);
+        }
+    }
+
     public static <T> T fromJson(String json, Class<? extends T> clazz) {
         try {
             return Constants.MAPPER.readValue(json, clazz);
diff --git a/gogo-server/src/main/java/zenuo/gogo/web/IPageBuilder.java b/gogo-server/src/main/java/zenuo/gogo/web/IPageBuilder.java
@@ -15,5 +15,5 @@ public interface IPageBuilder {
      * @param response 响应
      * @return 网页的HTML字符串
      */
-    String build(final IResponse response);
+    byte[] build(final IResponse response);
 }
diff --git a/gogo-server/src/main/java/zenuo/gogo/web/IndexPageBuilder.java b/gogo-server/src/main/java/zenuo/gogo/web/IndexPageBuilder.java
@@ -1,70 +1,36 @@
 package zenuo.gogo.web;
 
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.IOUtils;
 import zenuo.gogo.core.config.ApplicationConfig;
 import zenuo.gogo.core.config.GogoConfig;
 import zenuo.gogo.model.IResponse;
 
-import java.time.LocalTime;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Objects;
 
 /**
  * 主页构建器
  *
  * @author zenuo
  * 2018-07-08 20:50:25
  */
+@Slf4j
 public final class IndexPageBuilder implements IIndexPageBuilder {
 
     private final GogoConfig gogoConfig = ApplicationConfig.gogoConfig();
 
-    /**
-     * 样式表之前的HTML字符串
-     */
-    private static final String HTML_BEFORE_STYLE
-            = "<!DOCTYPE html>" +
-            "<html lang=\"en\">" +
-            "<head>" +
-            "<meta charset=\"utf-8\"/>" +
-            "<title>勾勾</title>" +
-            "<style>";
+    private final byte[] htmlBytes;
 
-    /**
-     * 样式表之后的HTML字符串
-     */
-    private String htmlAfterStyle;
-
-    /**
-     * 夜间模式的样式表
-     */
-    private static final String HTML_NIGHT_MODE_STYLE = "body{text-align:center;background-color:#000;color:#B6C5D4}" +
-            "h1{font-size:50px;font-family:\"Times New Roman\",Times,serif}" +
-            "footer{font-size:15px;font-family:Roboto,arial,sans-serif}" +
-            ".main{margin:0 auto;width:50%;padding-bottom:50px}";
-
-    /**
-     * 日间模式的样式表
-     */
-    private static final String HTML_DAY_MODE_STYLE = "body{text-align:center;background-color:#F8F4E7;color:#552800}" +
-            "h1{font-size:50px;font-family:\"Times New Roman\",Times,serif}" +
-            "footer{font-size:15px;font-family:Roboto,arial,sans-serif}" +
-            ".main{margin:0 auto;width:50%;padding-bottom:50px}";
-
-    public IndexPageBuilder() {
-        htmlAfterStyle = "</style>" +
-                "</head>" +
-                "<body>" +
-                "<a href=\"https://github.com/zenuo/gogo\"><img style=\"position: absolute; top: 0; right: 0; border: 0;\" width=\"149\" height=\"149\" src=\"https://github.blog/wp-content/uploads/2008/12/forkme_right_orange_ff7600.png?resize=149%2C149\" class=\"attachment-full size-full\" alt=\"Fork me on GitHub\" data-recalc-dims=\"1\"></a>" +
-                "<div class=\"main\">" +
-                "<h1>勾勾</h1>" +
-                "<form action=\"/search\" method=\"GET\" onsubmit=\"return q.value!=''\">" +
-                "<input name=\"q\" autocomplete=\"off\" autofocus=\"autofocus\" type=\"text\">" +
-                "<button value=\"Search\" type=\"submit\">Go</button>" +
-                "</form>" +
-                "</div>" +
-                "<footer>"
-                + gogoConfig.getSlogan()
-                + "</footer>" +
-                "</body>" +
-                "</html>";
+    {
+        try (final InputStream resourceAsStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("web/index.html")) {
+            final String indexHtml = IOUtils.toString(Objects.requireNonNull(resourceAsStream), StandardCharsets.UTF_8);
+            htmlBytes = indexHtml.replace("__SLOGAN__", gogoConfig.getSlogan()).getBytes(StandardCharsets.UTF_8);
+        } catch (Exception e) {
+            log.error("build index error", e);
+            throw new RuntimeException(e);
+        }
     }
 
     /**
@@ -73,22 +39,8 @@ public IndexPageBuilder() {
      * @return 主页的字符串
      */
     @Override
-    public String build(IResponse response) {
-        //字符串构建器，初始化内容为样式表之前的HTML
-        final StringBuilder sb = new StringBuilder(HTML_BEFORE_STYLE);
-        //当前时间
-        final LocalTime now = LocalTime.now();
-        if (now.isBefore(gogoConfig.getDayModeStartTime()) ||
-                now.isAfter(gogoConfig.getDayModeEndTime())) {
-            //若是夜间模式，拼接夜间模式样式表
-            sb.append(HTML_NIGHT_MODE_STYLE);
-        } else {
-            //若是日间模式，拼接日间模式样式表
-            sb.append(HTML_DAY_MODE_STYLE);
-        }
-        //拼接样式表之后的HTML
-        sb.append(htmlAfterStyle);
+    public byte[] build(IResponse response) {
         //返回字符串
-        return sb.toString();
+        return htmlBytes;
     }
 }
diff --git a/gogo-server/src/main/java/zenuo/gogo/web/ResultPageBuilder.java b/gogo-server/src/main/java/zenuo/gogo/web/ResultPageBuilder.java
diff --git a/gogo-server/src/main/resources/META-INF/services/zenuo.gogo.core.processor.IStaticProcessor b/gogo-server/src/main/resources/META-INF/services/zenuo.gogo.core.processor.IStaticProcessor
diff --git a/gogo-server/src/main/resources/web/index.html b/gogo-server/src/main/resources/web/index.html
diff --git a/gogo-server/src/main/resources/web/static/script.js b/gogo-server/src/main/resources/web/static/script.js

Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,6 @@ public class ApplicationConfig {`
`33`	`33`	`INSTANCE.gogoConfig.postConstruct();`
`34`	`34`	`}`
`35`	`35`
`36`		`- public static void main(String[] args) {`
`37`		`- System.out.println(INSTANCE);`
`38`		`- }`
`39`		`-`
`40`	`36`	`public static HttpClientConfig httpClientConfig() {`
`41`	`37`	`return INSTANCE.httpClientConfig;`
`42`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ public interface IPageBuilder {`
`15`	`15`	`* @param response 响应`
`16`	`16`	`* @return 网页的HTML字符串`
`17`	`17`	`*/`
`18`		`- String build(final IResponse response);`
	`18`	`+ byte[] build(final IResponse response);`
`19`	`19`	`}`