五子棋在线对战

1. 五子棋基础介绍

五子棋起源于中国，规则简单但变化无穷。

2. 在线对战平台概述

基于 C/S (Client-Server) 架构的命令行实时网络对战系统。

3.1 系统架构图

系统采用标准的 Client-Server 架构：

• Server (服务端): 负责处理连接请求、维护房间列表、管理游戏状态、执行游戏逻辑（规则判定）。
• Client (客户端): 负责接收用户输入、发送指令、解析服务器响应、渲染游戏画面。

3.3 开发环境要求

• 操作系统: Windows / macOS / Linux
• JDK 版本: Java 8 或更高
• IDE: IntelliJ IDEA / VS Code

3.2 技术选型说明

4.1 服务器端功能

• 连接管理:

  监听端口 8888，使用线程池分配 ClientHandler。

• 用户管理:

  处理昵称注册，处理断线重连/异常退出。

• 房间管理:

  初始化固定数量房间，提供 ls rooms 查询，处理 enter/leave。

• 游戏逻辑:

  落子验证（越界/重复/轮次），胜负算法（4方向扫描），状态广播。

4.2 客户端功能

• 网络连接:

  独立线程持续接收消息。

• 用户界面 (CLI):

  命令输入: ls, enter, start, put, quit, help。

• 棋盘渲染:

  解析 ANSI 颜色代码。

  使用清屏控制码 \033[H\033[2J 实现“伪动态”刷新。

  显示黑子(●)、白子(○)、空位(┼)。

5. 项目交付要求

• 5.1 代码规范: PascalCase/camelCase, 合理分包 (client/server/common), 关键逻辑注释。
• 5.2 文档要求:
  • 需求文档 (即本文)。
  • 设计文档 (UML类图, 时序图)。
  • 用户手册 (启动说明, 操作指令)。
• 5.3 测试用例: JUnit 单元测试 (胜负逻辑) + 集成测试。
• 5.4 演示视频: 3-5分钟，展示完整流程 (启动->连接->对战->胜负->重开)。
• 5.5 截止日期: 2025年X月X日

6. 评分标准 (基础分: 80%)

说明：基础功能满分为80分，剩余20分通过扩展功能获得

Task 1: 颜色字典 AnsiColor

创建 com.wuzi.common.AnsiColor。

• 1.1 定义常量:

  public static final String RESET = "\u001B[0m";
  
  // 字体颜色 (Foreground)
  public static final String RED = "\u001B[31m";
  public static final String GREEN = "\u001B[32m";
  public static final String YELLOW = "\u001B[33m";
  public static final String BLUE = "\u001B[34m";
  public static final String MAGENTA = "\u001B[35m";
  public static final String CYAN = "\u001B[36m";
  public static final String WHITE = "\u001B[37m";
  
  // 背景颜色 (Background)
  public static final String BG_RED = "\u001B[41m"; // 高亮背景

• 1.2 辅助方法:

  防止颜色泄漏，打印完自动重置。

  public static String color(String text, String colorCode) {
      return colorCode + text + RESET;
  }

Task 2: 日志管家 ServerLogger

创建 com.wuzi.server.ServerLogger。

• 2.1 时间格式化:

  使用 DateTimeFormatter ("yyyy-MM-dd HH:mm:ss")。

• 2.2 辅助方法 getTimestamp():

  返回如 [2023-10-01 12:00:00] 的字符串。

  建议给时间戳加上颜色（如白色或灰色）以区分日志内容。

• 2.3 分级打印:
  • info(msg): 时间 + [INFO] (青色) + msg
  • success(msg): 时间 + [SUCCESS] (绿色) + msg
  • error(msg): 时间 + [ERROR] (红色) + msg (建议用 System.err)

验证与测试 (TestHomework1)

public class TestHomework1 {
    public static void main(String[] args) {
        System.out.println("--- 1. 测试颜色工具 ---");
        // 红色字
        System.out.println(AnsiColor.color("Error Text", AnsiColor.RED));
        // 红色背景 (模拟棋盘高亮)
        System.out.println(AnsiColor.color(" Last Move ", AnsiColor.BG_RED));

        System.out.println("\n--- 2. 测试日志格式 ---");
        // 观察输出是否带有 [当前时间]
        ServerLogger.info("服务器正在初始化...");
        ServerLogger.warn("CPU 温度过高 (模拟警告)");
        ServerLogger.error("数据库连接失败！");
        ServerLogger.success("系统启动完成。");
    }
}

Task 1 & 2: 棋盘定义与落子

类：com.wuzi.server.GameBoard

• 1.1 成员变量:
  • BOARD_SIZE = 15
  • private int[][] board
  • lastMoveX, lastMoveY (用于高亮，也用于未来可能的AI扩展)。
• 1.2 makeMove (防御性编程):
  1. 检查 x, y 是否越界？(<0 或>=15) -> return false
  2. 检查该位置是否有子？(!=0) -> return false
  3. 一切正常 -> 修改数组, 更新 lastMove。

Task 3: 核心算法 checkWin (重中之重)

五子棋获胜规则: 在横、竖、斜任意方向上连续5个相同颜色的棋子即获胜。

算法优化: 只需检查新落子点周围的4个方向，无需扫描全盘。

Task 4: toString 可视化

• 必须使用 Part 1 的 AnsiColor。
• 两层循环遍历数组：
  • 空(0): 打印 ┼ (黄色/青色)
  • 黑(1): 打印 ● (青色)
  • 白(2): 打印 ○ (白色)

验证与评分

// TestHomework2.java
board.reset();
// 边界获胜测试: 在最底下一行连下5个黑子
for(int i=0; i<5; i++) {
     board.makeMove(14, i, "black");
     if (board.checkWin(14, i)) {
         System.out.println("第 " + (i+1) + " 子落下后获胜！");
     }
}
// 越界测试
boolean res = board.makeMove(-1, 0, "black"); // false

Task 1: Player 类

简单的实体类 (POJO)。

• 属性：name, socket (暂null), color ("black"/"white"), currentRoom。
• 接口：sendMessage(String msg) (暂时用 System.out 模拟)。

Task 2: GameRoom 类 (核心)

• 2.1 初始化:
  • roomId
  • new GameBoard()
  • playerCount (建议使用 AtomicInteger 以确保线程安全，或在同步块中操作)。
• 2.2 addPlayer(Player p):
  • 人满(>2)返回 false。
  • 第一个是 p1，第二个是 p2。
  • 更新 p.currentRoom。
• 2.3 startGame(): 重置棋盘，随机分配颜色，isGameStarted=true。

Task 2: GameRoom (续) - makeMove

验证与测试 (TestHomework3)

不需要网络，左右互搏。

GameRoom room = new GameRoom(888);
Player alice = new Player("Alice", ...);
Player bob = new Player("Bob", ...);

room.addPlayer(alice);
room.addPlayer(bob);
// 假设触发 startGame...
System.out.println("当前执子: " + room.getCurrentTurnColor());

boolean p1Move = room.makeMove(7, 7, "black"); // 黑棋落子
System.out.println("黑棋落子: " + p1Move); // true

boolean p1Again = room.makeMove(7, 8, "black"); // 黑棋企图连下
System.out.println("黑棋连下: " + p1Again); // 应该 false

boolean p2Move = room.makeMove(7, 8, "white"); // 白棋落子
System.out.println("白棋落子: " + p2Move); // true

Task 1: RoomManager 定义

类：com.wuzi.server.RoomManager

• 1.1 成员变量:

  private final Map rooms;
  private final AtomicInteger idGenerator;

• 1.2 构造方法:
  • rooms = new ConcurrentHashMap<>();
  • idGenerator = new AtomicInteger(1);
  • 可选: 预先创建 10 个房间，避免第一批玩家等待。

Task 2: 核心业务方法

• 创建房间:

  public GameRoom createRoom() {
      int id = idGenerator.getAndIncrement(); // 安全获取ID
      GameRoom room = new GameRoom(id);
      rooms.put(id, room);
      ServerLogger.info("房间 " + id + " 已创建");
      return room;
  }

• 销毁房间: removeRoom(int id) -> rooms.remove(id) + 日志。
• 查找与列表:
  • getRoom(int id): 简单代理 Map 的 get。
  • getAllRooms(): 直接返回 Map (或只读视图)。

验证与测试 (TestHomework4)

RoomManager manager = new RoomManager();

System.out.println("--- 1. 创建测试 ---");
GameRoom r1 = manager.createRoom();
GameRoom r2 = manager.createRoom();
System.out.println("R1 ID: " + r1.getRoomId()); // 1
System.out.println("R2 ID: " + r2.getRoomId()); // 2

System.out.println("--- 2. 查找测试 ---");
GameRoom found = manager.getRoom(1); 
System.out.println("查找 ID=1: " + (found == r1)); // true
GameRoom notFound = manager.getRoom(999); // null

System.out.println("--- 3. 销毁测试 ---");
manager.removeRoom(1);
System.out.println("剩余: " + manager.getAllRooms().size()); // 1

Task 1: 服务员 ClientHandler

实现 Runnable 接口。

• 1.1 构造: 接收 Socket 和 RoomManager。
• 1.2 run() 方法:
  1. 获取输入流(BufferedReader)和输出流(PrintWriter)。
  2. 读取第一行作为名字，创建 Player。
  3. while(true) 循环读取指令。
  4. 解析指令 (split(" "))，调用 GameRoom 逻辑。
  5. 关键: 结果通过 out.println 发回客户端。

Task 2: 总机 GameServer

程序的入口。

public static void main(String[] args) {
    ServerSocket server = new ServerSocket(8888);
    ExecutorService pool = Executors.newCachedThreadPool();
    RoomManager manager = new RoomManager();
    
    ServerLogger.info("监听端口 8888...");
    
    while(true) {
        // 阻塞直到有人连接
        Socket client = server.accept();
        // 把客人交给服务员
        pool.execute(new ClientHandler(client, manager));
    }
}

Task 3: 玩家终端 GameClient

双线程架构: 为什么？你不知道对手何时落子，不能傻等。

• 主线程: 读取键盘 (Scanner) -> 发送给服务器。
• 接收线程: 后台循环读取服务器消息 -> 打印到屏幕。

评分标准

• 并发能力 (40%): 服务器必须能同时处理 Alice 和 Bob，不能因 Alice 没说话就卡住 Bob。
• 协议解析 (30%): 正确处理 ls, enter, put。错误命令(put abc)有提示且不崩溃。
• 用户体验 (30%): 棋盘刷新及时。断开连接能正确清理资源(踢出房间)。