feat: 按照JavaDoc规范调整代码

Author: meethigher

src/main/java/top/meethigher/proxy/http/ReverseHttpProxy.java

@@ -254,6 +254,10 @@ protected static String generateName() {
     /**
      * 更新路由内数据。
      * 该内容以路由为单位。
+     *
+     * @param route 路由对象
+     * @param key   元数据键
+     * @param value 元数据值
      */
     protected void setRouteMetadata(Route route, String key, Object value) {
         route.putMetadata(key, value == null ? "" : value);
@@ -268,6 +272,10 @@ protected Object getRouteMetadata(Route route, String key) {
     /**
      * 更新请求上下文内数据。
      * 该内容以请求为单位。对于请求来说，是线程安全的。
+     *
+     * @param ctx   路由上下文
+     * @param key   数据键
+     * @param value 数据值
      */
     protected void setContextData(RoutingContext ctx, String key, Object value) {
         ctx.put(key, value == null ? "" : value);
@@ -348,7 +356,12 @@ public ReverseHttpProxy addRoute(ProxyRoute proxyRoute, Integer order) {
     }
 
     /**
-     * order越小，优先级越高
+     * 添加路由
+     *
+     * @param proxyRoute 路由信息
+     * @param order      order越小，优先级越高
+     * @param printLog   true表示打印日志
+     * @return 实例本身
      */
     public ReverseHttpProxy addRoute(
             ProxyRoute proxyRoute,
@@ -406,6 +419,9 @@ public List<Route> getRoutes() {
     /**
      * 将标头转为小写后，判断是否是逐跳标头
      * 时间复杂度为 O(1)
+     *
+     * @param headerName 标头名称
+     * @return 是否是逐跳标头
      */
     protected boolean isHopByHopHeader(String headerName) {
         return headerName != null && HOP_BY_HOP_HEADERS_SET.contains(headerName.toLowerCase());
@@ -414,6 +430,10 @@ protected boolean isHopByHopHeader(String headerName) {
 
     /**
      * 复制请求头。复制的过程中忽略逐跳标头
+     *
+     * @param ctx      路由上下文
+     * @param realReq  真实请求
+     * @param proxyReq 代理请求
      */
     protected void copyRequestHeaders(RoutingContext ctx, HttpServerRequest realReq, HttpClientRequest proxyReq) {
         proxyReq.headers().clear();
@@ -451,6 +471,11 @@ protected void copyRequestHeaders(RoutingContext ctx, HttpServerRequest realReq,
 
     /**
      * 复制响应头。复制的过程中忽略逐跳标头
+     *
+     * @param ctx       路由上下文
+     * @param realReq   真实请求
+     * @param realResp  真实响应
+     * @param proxyResp 代理响应
      */
     protected void copyResponseHeaders(RoutingContext ctx, HttpServerRequest realReq, HttpServerResponse realResp, HttpClientResponse proxyResp) {
         realResp.headers().clear();
@@ -510,6 +535,11 @@ else if ("Location".equalsIgnoreCase(headerName)) {
 
     /**
      * 重写Location
+     *
+     * @param ctx      路由上下文
+     * @param url      原始URL
+     * @param location 重定向位置
+     * @return 重写后的Location
      */
     protected String rewriteLocation(RoutingContext ctx, String url, String location) {
         // 若重定向的地址，在反向代理的范围内，则进行重写
@@ -525,6 +555,12 @@ protected String rewriteLocation(RoutingContext ctx, String url, String location
 
     /**
      * 发起请求Handler
+     *
+     * @param ctx        路由上下文
+     * @param serverReq  服务端请求
+     * @param serverResp 服务端响应
+     * @param proxyUrl   代理URL
+     * @return 异步处理Handler
      */
     protected Handler<AsyncResult<HttpClientResponse>> sendRequestHandler(RoutingContext ctx, HttpServerRequest serverReq, HttpServerResponse serverResp, String proxyUrl) {
         return ar -> {
@@ -560,6 +596,12 @@ protected Handler<AsyncResult<HttpClientResponse>> sendRequestHandler(RoutingCon
 
     /**
      * 建立连接Handler
+     *
+     * @param ctx        路由上下文
+     * @param serverReq  服务端请求
+     * @param serverResp 服务端响应
+     * @param proxyUrl   代理URL
+     * @return 异步处理Handler
      */
     protected Handler<AsyncResult<HttpClientRequest>> connectHandler(RoutingContext ctx, HttpServerRequest serverReq, HttpServerResponse serverResp, String proxyUrl) {
         return ar -> {
@@ -611,6 +653,9 @@ protected void badGateway(RoutingContext ctx, HttpServerResponse serverResp) {
 
     /**
      * 路由处理Handler
+     *
+     * @param httpClient HTTP客户端
+     * @return 路由处理Handler
      */
     protected Handler<RoutingContext> routingContextHandler(HttpClient httpClient) {
         return ctx -> {
@@ -685,6 +730,11 @@ protected Handler<RoutingContext> routingContextHandler(HttpClient httpClient) {
     /**
      * 获取代理后的完整proxyUrl，不区分代理目标路径是否以/结尾。
      * 处理逻辑为删除掉匹配的路径，并将剩下的内容追加到代理目标路径后面。
+     *
+     * @param ctx        路由上下文
+     * @param serverReq  服务端请求
+     * @param serverResp 服务端响应
+     * @return 代理后的完整URL
      */
     protected String getProxyUrl(RoutingContext ctx, HttpServerRequest serverReq, HttpServerResponse serverResp) {
         String targetUrl = getContextData(ctx, P_TARGET_URL).toString();

src/main/java/top/meethigher/proxy/http/UrlParser.java

@@ -7,6 +7,10 @@ public class UrlParser {
 
     /**
      * 在压测时，性能比String.replace略优
+     * @param text 需要替换的文本
+     * @param search 要搜索的字符串
+     * @param replacement 替换的字符串
+     * @return 替换后的文本
      */
     public static String fastReplace(String text, String search, String replacement) {
         if (text == null || search == null || replacement == null || search.isEmpty()) {
@@ -25,6 +29,9 @@ public static String fastReplace(String text, String search, String replacement)
 
     /**
      * 拼接两个uri。不要求uri以"/"结尾
+     * @param uri1 第一个URI字符串
+     * @param uri2 第二个URI字符串
+     * @return 拼接后的URI字符串
      */
     public static String joinURI(String uri1, String uri2) {
         if (uri1.endsWith("/") && uri2.startsWith("/")) {

src/main/java/top/meethigher/proxy/tcp/tunnel/ReverseTcpProxyTunnelServer.java

@@ -206,7 +206,7 @@ public DataProxyServer(Vertx vertx, String name,
          * <p>
          * 通过标识码判定是用户连接还是数据连接，通过唯一编号判定用户连接和数据连接的对应关系
          *
-         * @param socket 连接
+         * @param socket 建立的网络连接Socket，需要通过前缀字节判断其类型（用户连接或数据连接）
          */
         protected void handleConnect(NetSocket socket) {
             socket.pause();
@@ -240,8 +240,8 @@ protected void handleConnect(NetSocket socket) {
         /**
          * 数据连接的处理逻辑
          *
-         * @param socket  连接
-         * @param buf     数据
+         * @param socket  数据连接的Socket
+         * @param buf     接收到的数据缓冲区，包含4字节标识码和4字节会话ID
          * @param timerId 延时判定数据连接的定时器id，-1表示不存在定时器
          */
         protected void handleDataConnection(NetSocket socket, Buffer buf, long timerId) {
@@ -264,8 +264,8 @@ protected void handleDataConnection(NetSocket socket, Buffer buf, long timerId)
         /**
          * 用户连接的处理逻辑
          *
-         * @param socket  连接
-         * @param buf     数据
+         * @param socket  用户连接的Socket
+         * @param buf     接收到的数据缓冲区，可能为null表示没有接收到数据
          * @param timerId 延时判定数据连接的定时器id，-1表示不存在定时器
          */
         protected void handleUserConnection(NetSocket socket, Buffer buf, long timerId) {

src/main/java/top/meethigher/proxy/tcp/tunnel/Tunnel.java

@@ -45,13 +45,18 @@ protected Tunnel(Vertx vertx) {
 
     /**
      * 监听socket连接成功触发的动作
+     *
+     * @param tunnelHandler 连接成功后处理逻辑
      */
     public void onConnected(TunnelHandler tunnelHandler) {
         tunnelHandlers.put(null, tunnelHandler);
     }
 
     /**
      * 监听 {@code TunnelMessageType} 事件
+     *
+     * @param type          消息类型
+     * @param tunnelHandler 处理逻辑
      */
     public void on(TunnelMessageType type, TunnelHandler tunnelHandler) {
         tunnelHandlers.put(type, tunnelHandler);

src/main/java/top/meethigher/proxy/tcp/tunnel/codec/TunnelMessageCodec.java

@@ -15,6 +15,13 @@
 public class TunnelMessageCodec {
 
 
+    /**
+     * 将消息类型和消息体编码为Buffer
+     * 
+     * @param type 消息类型，2字节
+     * @param body 消息体字节数组
+     * @return 编码后的Buffer，格式为：4字节消息长度 + 2字节消息类型 + 变长消息体
+     */
     public static Buffer encode(short type, byte[] body) {
         int totalLength = 4 + 2 + body.length;
         Buffer buffer = Buffer.buffer();
@@ -24,13 +31,22 @@ public static Buffer encode(short type, byte[] body) {
         return buffer;
     }
 
+    /**
+     * 将Buffer解码为DecodedMessage对象
+     * 
+     * @param buffer 待解码的Buffer，格式为：4字节消息长度 + 2字节消息类型 + 变长消息体
+     * @return 解码后的DecodedMessage对象，包含总长度、消息类型和消息体
+     */
     public static DecodedMessage decode(Buffer buffer) {
         int totalLength = buffer.getInt(0);
         short type = buffer.getShort(4);
         byte[] body = buffer.getBytes(6, buffer.length());
         return new DecodedMessage(totalLength, type, body);
     }
 
+    /**
+     * 解码后的消息对象，包含总长度、消息类型和消息体
+     */
     public static class DecodedMessage {
         public final int totalLength;
         public final short type;

src/main/java/top/meethigher/proxy/tcp/tunnel/handler/AbstractTunnelHandler.java

@@ -34,6 +34,12 @@ public void handle(Vertx vertx, NetSocket netSocket, Buffer buffer) {
 
     /**
      * 执行逻辑，并返回执行结果。true表示成功
+     * 
+     * @param vertx 用于执行异步操作的Vertx实例
+     * @param netSocket 网络连接Socket
+     * @param type 消息类型
+     * @param bodyBytes 消息体字节数组
+     * @return 处理结果，true表示成功，false表示失败
      */
     protected abstract boolean doHandle(Vertx vertx, NetSocket netSocket, TunnelMessageType type, byte[] bodyBytes);
 }

src/main/java/top/meethigher/proxy/tcp/tunnel/utils/IdGenerator.java

@@ -15,6 +15,8 @@ public class IdGenerator {
     /**
      * 获取一个 4 字节的唯一编号
      * 超过 Integer.MAX_VALUE 后从 1 重新开始（跳过负数）
+     *
+     * @return 编号
      */
     public static int nextId() {
         int id = counter.getAndIncrement();