Refactor middleware-system

Author: simonwep

src/express/Express.java

@@ -3,17 +3,16 @@
 import com.sun.net.httpserver.HttpServer;
 import express.events.Action;
 import express.events.HttpRequest;
-import express.expressfilter.ExpressFilter;
 import express.expressfilter.ExpressFilterChain;
+import express.expressfilter.ExpressFilterImpl;
+import express.expressfilter.ExpressFilterTask;
+import express.expressfilter.ExpressFilterWorker;
 import express.http.Request;
 import express.http.Response;
-import express.middleware.ExpressWorker;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
 import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
 
 /**
  * @author Simon Reinisch
@@ -23,49 +22,52 @@
  */
 public class Express {
 
-  private final List<ExpressWorker> WORKERS = Collections.synchronizedList(new ArrayList<>());
+  private final ArrayList<ExpressFilterWorker> WORKER = new ArrayList<>();
+  private final ExpressFilterChain MIDDLEWARE_CHAIN = new ExpressFilterChain();
   private final ExpressFilterChain FILTER_CHAIN = new ExpressFilterChain();
 
   private HttpServer httpServer;
 
   /**
    * Add an middleware which will be firea BEFORE EACH request-type listener will be fired.
    *
-   * @param request An listener which will be fired on every equestmethod- and  path.
+   * @param middleware An middleware which will be fired on every equestmethod- and  path.
    */
-  public void use(HttpRequest request) {
-    addFilter(true, "*", "*", request);
+  public void use(HttpRequest middleware) {
+    addMiddleware("*", "*", middleware);
   }
 
   /**
    * Add an middleware which will be firea BEFORE EACH request-type listener will be fired.
    *
-   * @param context The context where the middleware should listen, see README for information about placeholder.
-   * @param request An listener which will be fired if the context matches the requestpath.
+   * @param context    The context where the middleware should listen, see README for information about placeholder.
+   * @param middleware An middleware which will be fired if the context matches the requestpath.
    */
-  public void use(String context, HttpRequest request) {
-    addFilter(true, "*", context, request);
+  public void use(String context, HttpRequest middleware) {
+    addMiddleware("*", context, middleware);
   }
 
   /**
    * Add an middleware which will be firea BEFORE EACH request-type listener will be fired.
    *
    * @param context       The context where the middleware should listen, see README for information about placeholder.
    * @param requestMethod And type of request-method eg. GET, POST etc.
-   * @param request       An listener which will be fired if the context matches the requestmethod- and  path.
+   * @param middleware    An middleware which will be fired if the context matches the requestmethod- and  path.
    */
-  public void use(String context, String requestMethod, HttpRequest request) {
-    addFilter(true, requestMethod.toUpperCase(), context, request);
+  public void use(String context, String requestMethod, HttpRequest middleware) {
+    addMiddleware(requestMethod.toUpperCase(), context, middleware);
+  }
+
+  private void addMiddleware(String requestMethod, String context, HttpRequest middleware) {
+    if (middleware instanceof ExpressFilterTask) {
+      WORKER.add(new ExpressFilterWorker((ExpressFilterTask) middleware));
+    }
+
+    MIDDLEWARE_CHAIN.add(new ExpressFilterImpl(requestMethod, context, middleware));
   }
 
-  /**
-   * Add an listener for request types.
-   *
-   * @param context The context, see README for information about placeholder.
-   * @param request An listener.
-   */
   public void all(String context, HttpRequest request) {
-    addFilter(false, "*", context, request);
+    FILTER_CHAIN.add(new ExpressFilterImpl("*", context, request));
   }
 
   /**
@@ -75,7 +77,7 @@ public void all(String context, HttpRequest request) {
    * @param request An listener which will be fired if the context matches the requestpath.
    */
   public void get(String context, HttpRequest request) {
-    addFilter(false, "GET", context, request);
+    FILTER_CHAIN.add(new ExpressFilterImpl("GET", context, request));
   }
 
   /**
@@ -85,7 +87,7 @@ public void get(String context, HttpRequest request) {
    * @param request An listener which will be fired if the context matches the requestpath.
    */
   public void post(String context, HttpRequest request) {
-    addFilter(false, "POST", context, request);
+    FILTER_CHAIN.add(new ExpressFilterImpl("POST", context, request));
   }
 
   /**
@@ -95,7 +97,7 @@ public void post(String context, HttpRequest request) {
    * @param request An listener which will be fired if the context matches the requestpath.
    */
   public void put(String context, HttpRequest request) {
-    addFilter(false, "PUT", context, request);
+    FILTER_CHAIN.add(new ExpressFilterImpl("PUT", context, request));
   }
 
   /**
@@ -105,7 +107,7 @@ public void put(String context, HttpRequest request) {
    * @param request An listener which will be fired if the context matches the requestpath.
    */
   public void delete(String context, HttpRequest request) {
-    addFilter(false, "DELETE", context, request);
+    FILTER_CHAIN.add(new ExpressFilterImpl("DELETE", context, request));
   }
 
   /**
@@ -115,31 +117,7 @@ public void delete(String context, HttpRequest request) {
    * @param request An listener which will be fired if the context matches the requestpath.
    */
   public void patch(String context, HttpRequest request) {
-    addFilter(false, "PATCH", context, request);
-  }
-
-  /**
-   * Internal method to add an filter
-   *
-   * @param middleware    If the filter is an middleware
-   * @param requestMethod The request-method
-   * @param context       The url-path
-   * @param request       An listener which will be fired if the given context is matching
-   */
-  private void addFilter(boolean middleware, String requestMethod, String context, HttpRequest request) {
-    ExpressFilter handler = new ExpressFilter(requestMethod, context, request);
-
-    if (request instanceof ExpressWorker){
-      ((ExpressWorker) request).start();
-      WORKERS.add((ExpressWorker) request);
-    }
-
-
-    // Middleware needs an seperated list because it will ALWAYS fired before each request handler
-    if (middleware)
-      FILTER_CHAIN.addMiddleware(handler);
-    else
-      FILTER_CHAIN.addFilter(handler);
+    FILTER_CHAIN.add(new ExpressFilterImpl("PATCH", context, request));
   }
 
   /**
@@ -186,12 +164,20 @@ public void listen(Action onStart) throws IOException {
   public void listen(Action onStart, int port) throws IOException {
     new Thread(() -> {
       try {
+        // Fire worker threads
+        WORKER.forEach(ExpressFilterWorker::start);
+
+
+        // Create http server
         httpServer = HttpServer.create(new InetSocketAddress("localhost", port), 0);
         httpServer.setExecutor(null);
 
         httpServer.createContext("/", httpExchange -> {
           Request request = new Request(httpExchange);
           Response response = new Response(httpExchange);
+
+          // First fire all middlewares, then the normal request filter
+          MIDDLEWARE_CHAIN.filter(request, response);
           FILTER_CHAIN.filter(request, response);
         });
 

src/express/expressfilter/AbstractExpressFilter.java

@@ -1,70 +1,11 @@
 package express.expressfilter;
 
-import express.events.HttpRequest;
-import express.http.Request;
-import express.http.Response;
-
-import java.util.HashMap;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-/**
- * @author Simon Reinisch
- * @implNote Core modul of express, don't change anything.
- * <p>
- * Filter to handle request handling & parsing.
- */
-public class ExpressFilter extends AbstractExpressFilter {
-
-  private final HttpRequest REQUEST;
-  private final String REQUEST_METHOD;
-
-  private final String CONTEXT;
-  private final String[] CONTEXT_PARAMS;
-  private final String CONTEXT_REGEX;
-  private final Pattern CONTEXT_PATTERN;
-
-  public ExpressFilter(String requestMethod, String context, HttpRequest httpRequest) {
-    this.REQUEST_METHOD = requestMethod;
-    this.REQUEST = httpRequest;
-
-    this.CONTEXT = context;
-    this.CONTEXT_PARAMS = context.split("(/)(:|[^:]+|)(:|)");
-    this.CONTEXT_REGEX = "\\Q" + context.replaceAll(":([^/]+)", "\\\\E([^/]+)\\\\Q") + "\\E";
-    this.CONTEXT_PATTERN = Pattern.compile(CONTEXT_REGEX);
-  }
-
-  @Override
-  public void doFilter(Request req, Response res, ExpressFilterChain chain) {
-    String requestMethod = req.getMethod();
-    String requestPath = req.getURI().getRawPath();
-
-    if (!requestMethod.equals(REQUEST_METHOD) || (REQUEST_METHOD.equals("*") && CONTEXT.equals("*"))) {
-      REQUEST.handle(req, res);
-      return;
-    }
-
-    if (!requestPath.matches(CONTEXT_REGEX) && !CONTEXT.equals("*")) {
-      return;
-    }
-
-    // Parse params, see README
-    HashMap<String, String> params = new HashMap<>();
-    Matcher matcher = CONTEXT_PATTERN.matcher(requestPath);
-
-    // Match all params
-    if (matcher.find()) {
-
-      for (int i = 1; i <= matcher.groupCount() && i < CONTEXT_PARAMS.length; i++) {
-        String g = matcher.group(i);
-        params.put(CONTEXT_PARAMS[i], g);
-      }
-
-    } else {
-      return;
-    }
-
-    req.setParams(params);
-    REQUEST.handle(req, res);
-  }
+public interface ExpressFilter {
+
+  /**
+   * Identifier for the middleware
+   *
+   * @return
+   */
+  String getName();
 }

src/express/expressfilter/ExpressFilter.java

@@ -1,5 +1,6 @@
 package express.expressfilter;
 
+import express.events.HttpRequest;
 import express.http.Request;
 import express.http.Response;
 
@@ -8,25 +9,20 @@
 import java.util.List;
 import java.util.ListIterator;
 
-public class ExpressFilterChain {
+public class ExpressFilterChain <T extends HttpRequest> {
 
-  private List<ExpressFilter> expressFilterList = Collections.synchronizedList(new ArrayList<ExpressFilter>());
+  private List<T> expressFilters = Collections.synchronizedList(new ArrayList<>());
 
-  public void addFilter(ExpressFilter expressFilter) {
-    expressFilterList.add(expressFilter);
-  }
-
-  public void addMiddleware(ExpressFilter expressFilter) {
-    expressFilterList.add(0, expressFilter);
+  public void add(T expressFilter) {
+    expressFilters.add(expressFilter);
   }
 
   public void filter(Request req, Response res) {
-    ListIterator<ExpressFilter> iter = expressFilterList.listIterator();
+    ListIterator<T> iter = expressFilters.listIterator();
 
     while (!res.isClosed() && iter.hasNext()) {
       if (iter.hasNext()) {
-        AbstractExpressFilter expressFilter = iter.next();
-        expressFilter.doFilter(req, res, this);
+        iter.next().handle(req, res);
       }
     }
   }

src/express/expressfilter/ExpressFilterChain.java

@@ -0,0 +1,70 @@
+package express.expressfilter;
+
+import express.events.HttpRequest;
+import express.http.Request;
+import express.http.Response;
+
+import java.util.HashMap;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * @author Simon Reinisch
+ * @implNote Core modul of express, don't change anything.
+ * <p>
+ * Filter to handle request handling & parsing.
+ */
+public class ExpressFilterImpl implements HttpRequest {
+
+  private final HttpRequest REQUEST;
+  private final String REQUEST_METHOD;
+
+  private final String CONTEXT;
+  private final String[] CONTEXT_PARAMS;
+  private final String CONTEXT_REGEX;
+  private final Pattern CONTEXT_PATTERN;
+
+  public ExpressFilterImpl(String requestMethod, String context, HttpRequest httpRequest) {
+    this.REQUEST_METHOD = requestMethod;
+    this.REQUEST = httpRequest;
+
+    this.CONTEXT = context;
+    this.CONTEXT_PARAMS = context.split("(/)(:|[^:]+|)(:|)");
+    this.CONTEXT_REGEX = "\\Q" + context.replaceAll(":([^/]+)", "\\\\E([^/]+)\\\\Q") + "\\E";
+    this.CONTEXT_PATTERN = Pattern.compile(CONTEXT_REGEX);
+  }
+
+  @Override
+  public void handle(Request req, Response res) {
+    String requestMethod = req.getMethod();
+    String requestPath = req.getURI().getRawPath();
+
+    if (!requestMethod.equals(REQUEST_METHOD) || (REQUEST_METHOD.equals("*") && CONTEXT.equals("*"))) {
+      REQUEST.handle(req, res);
+      return;
+    }
+
+    if (!requestPath.matches(CONTEXT_REGEX) && !CONTEXT.equals("*")) {
+      return;
+    }
+
+    // Parse params, see README
+    HashMap<String, String> params = new HashMap<>();
+    Matcher matcher = CONTEXT_PATTERN.matcher(requestPath);
+
+    // Match all params
+    if (matcher.find()) {
+
+      for (int i = 1; i <= matcher.groupCount() && i < CONTEXT_PARAMS.length; i++) {
+        String g = matcher.group(i);
+        params.put(CONTEXT_PARAMS[i], g);
+      }
+
+    } else {
+      return;
+    }
+
+    req.setParams(params);
+    REQUEST.handle(req, res);
+  }
+}

src/express/expressfilter/ExpressFilterImpl.java

@@ -0,0 +1,13 @@
+package express.expressfilter;
+
+
+public interface ExpressFilterTask {
+
+  long getDelay();
+
+  void onUpdate();
+
+  void onStart();
+
+  void onStop();
+}