fix(LocalPortGenerater): update class documentation and plan for future name correction

This commit is contained in:
yulin 2025-11-23 19:26:36 +08:00
parent 7258a5b946
commit edb4401e47

View File

@ -4,14 +4,34 @@ import java.io.Serializable;
import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicInteger;
/** /**
* 本地端口生成器<br> * 本地端口生成器LocalPortGenerator
* 用于生成本地可用未被占用的端口号<br> * <p>
* 注意多线程甚至单线程访问时可能会返回同一端口例如获取了端口但是没有使用 * 当前类名中Generater为拼写错误正确应为 Generator为保持兼容性暂未更改
* 该问题将在后续大版本中以重命名方式修复并保留旧类名的弃用@Deprecated兼容层
* <p>
* *
* 用于从指定起点开始递增探测一个当前可用的本地端口探测通过短暂绑定
* {@link java.net.ServerSocket}以及可选 UDP DatagramSocket完成但不会真正占用端口
* <p>注意</p>
* <ul>
* <li>该方法执行的是端口探测分配返回端口不保证实际使用时仍然可用</li>
* <li>存在 TOCTOU检测到使用之间竞态多线程下可能返回同一端口</li>
* <li>UDP 探测可能导致误判TCP 可用但 UDP 被占用</li>
* <li>不适合作为生产级端口分配策略推荐使用 {@code new ServerSocket(0)}</li>
* </ul>
*
* <p>未来版本计划</p>
* <ul>
* <li>修复类名拼写问题Generater更名为 Generator</li>
* <li>提供真正可靠的端口获取实现绑定即占用避免竞态</li>
* <li>优化探测策略减少不必要的 UDP 检测</li>
* <li>提供更安全的随机端口生成 API</li>
* </ul>
* @author looly * @author looly
* @since 4.0.3 * @since 4.0.3
*
*/ */
public class LocalPortGenerater implements Serializable{ public class LocalPortGenerater implements Serializable{
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;