From 469abf647fbcd1b1e3128c53861bdc9b26bb1585 Mon Sep 17 00:00:00 2001 From: godotg Date: Sun, 4 Dec 2022 11:27:36 +0800 Subject: [PATCH] doc[event]: update code comments --- .../java/com/zfoo/event/EventContext.java | 2 -- .../java/com/zfoo/event/manager/EventBus.java | 33 ++++++++++--------- .../zfoo/event/model/anno/EventReceiver.java | 2 +- .../main/java/com/zfoo/util/SafeRunnable.java | 4 +-- 4 files changed, 21 insertions(+), 20 deletions(-) diff --git a/event/src/main/java/com/zfoo/event/EventContext.java b/event/src/main/java/com/zfoo/event/EventContext.java index 5e4c6c9c..5105a472 100644 --- a/event/src/main/java/com/zfoo/event/EventContext.java +++ b/event/src/main/java/com/zfoo/event/EventContext.java @@ -31,8 +31,6 @@ import java.util.concurrent.ExecutorService; /** * @author godotg * @version 3.0 - *

- * 在EventRegisterProcessor 中完成扫描 */ public class EventContext implements ApplicationListener, Ordered { diff --git a/event/src/main/java/com/zfoo/event/manager/EventBus.java b/event/src/main/java/com/zfoo/event/manager/EventBus.java index f52d2160..6f597777 100644 --- a/event/src/main/java/com/zfoo/event/manager/EventBus.java +++ b/event/src/main/java/com/zfoo/event/manager/EventBus.java @@ -30,7 +30,10 @@ import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; -import java.util.concurrent.*; +import java.util.concurrent.Executor; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicInteger; /** @@ -42,7 +45,8 @@ public abstract class EventBus { private static final Logger logger = LoggerFactory.getLogger(EventBus.class); /** - * 线程池的大小. event的线程池比较大 + * EN: The size of the thread pool. Event's thread pool is often used to do time-consuming operations, so set it a little bigger + * CN: 线程池的大小. event的线程池经常用来做一些耗时的操作，所以要设置大一点 */ public static final int EXECUTORS_SIZE = Runtime.getRuntime().availableProcessors() * 2; @@ -50,11 +54,11 @@ public abstract class EventBus { private static final CopyOnWriteHashMapLongObject threadMap = new CopyOnWriteHashMapLongObject<>(EXECUTORS_SIZE); /** - * 同步事件映射 + * Synchronous event mapping, synchronize observers */ private static final Map, List> receiverMapSync = new HashMap<>(); /** - * 异步事件映射 + * Asynchronous event mapping, asynchronous observer */ private static final Map, List> receiverMapAsync = new HashMap<>(); @@ -91,7 +95,7 @@ public abstract class EventBus { } /** - * 处理事件 + * Publish the event */ public static void submit(IEvent event) { syncSubmit(event); @@ -99,7 +103,8 @@ public abstract class EventBus { } /** - * 同步抛出一个事件，会在当前线程中运行(只有同步观察者会处理事件) + * EN: Synchronously publish an event that runs in the current thread (only receiverMapSync process the event) + * CN: 同步抛出一个事件，会在当前线程中运行(只有同步观察者会处理事件) */ public static void syncSubmit(IEvent event) { var list = receiverMapSync.get(event.getClass()); @@ -111,7 +116,8 @@ public abstract class EventBus { /** - * 异步抛出一个事件，事件不在同一个线程中处理(只有异步观察者会处理事件) + * EN: Asynchronously publish an event, and the event is not processed in the current thread (only receiverMapAsync process the event) + * CN: 异步抛出一个事件，事件不在同一个线程中处理(只有异步观察者会处理事件) */ public static void asyncSubmit(IEvent event) { var list = receiverMapAsync.get(event.getClass()); @@ -127,32 +133,29 @@ public abstract class EventBus { } /** - * 用指定线程执行 + * Use the event thread specified by the hashcode to execute the task */ public static void execute(int hashcode, Runnable runnable) { executors[Math.abs(hashcode % EXECUTORS_SIZE)].execute(SafeRunnable.valueOf(runnable)); } /** - * 执行方法调用 - * - * @param event 事件 - * @param receiverList 所有的观察者 + * The observer executes the method call */ private static void doSubmit(IEvent event, List receiverList) { for (var receiver : receiverList) { try { receiver.invoke(event); } catch (Exception e) { - logger.error("eventBus未知exception异常", e); + logger.error("eventBus unknown exception", e); } catch (Throwable t) { - logger.error("eventBus未知error异常", t); + logger.error("eventBus unknown error", t); } } } /** - * 注册事件及其对应同异步观察者 + * Register the event and its counterpart observer */ public static void registerEventReceiver(Class eventType, IEventReceiver receiver, boolean asyncFlag) { if (asyncFlag) { diff --git a/event/src/main/java/com/zfoo/event/model/anno/EventReceiver.java b/event/src/main/java/com/zfoo/event/model/anno/EventReceiver.java index b707a5b1..04372cb4 100644 --- a/event/src/main/java/com/zfoo/event/model/anno/EventReceiver.java +++ b/event/src/main/java/com/zfoo/event/model/anno/EventReceiver.java @@ -16,7 +16,7 @@ package com.zfoo.event.model.anno; import java.lang.annotation.*; /** - * 接收事件的注解 + * Receive annotations for events (observers). * * @author godotg * @version 3.0 diff --git a/util/src/main/java/com/zfoo/util/SafeRunnable.java b/util/src/main/java/com/zfoo/util/SafeRunnable.java index 8dd28929..ff90ce94 100644 --- a/util/src/main/java/com/zfoo/util/SafeRunnable.java +++ b/util/src/main/java/com/zfoo/util/SafeRunnable.java @@ -27,9 +27,9 @@ public class SafeRunnable implements Runnable { try { runnable.run(); } catch (Exception e) { - logger.error("未知exception异常", e); + logger.error("unknown exception", e); } catch (Throwable t) { - logger.error("未知throwable异常", t); + logger.error("unknown error", t); } }