Kungfu 项目使用文档

1. 项目目录结构及介绍

kungfu/
├── bin/
│   ├── kungfu-server
│   └── kungfu-client
├── config/
│   ├── config.yaml
│   └── logging.yaml
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── server/
│   │   ├── main.go
│   │   └── handlers/
│   └── client/
│       ├── main.go
│       └── ui/
├── tests/
│   ├── server_test.go
│   └── client_test.go
├── .gitignore
├── LICENSE
└── README.md

目录结构说明

• bin/: 存放编译后的可执行文件，包括 kungfu-server 和 kungfu-client。
• config/: 存放项目的配置文件，如 config.yaml 和 logging.yaml。
• docs/: 存放项目的文档文件，包括 README.md 和 CONTRIBUTING.md。
• src/: 存放项目的源代码，分为 server/ 和 client/ 两个子目录。
  • server/: 服务器端代码，包含主文件 main.go 和处理逻辑的 handlers/ 目录。
  • client/: 客户端代码，包含主文件 main.go 和用户界面相关的 ui/ 目录。
• tests/: 存放项目的测试代码，包括 server_test.go 和 client_test.go。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目的主 README 文件。

2. 项目启动文件介绍

服务器端启动文件

文件路径: src/server/main.go

package main

import (
    "kungfu/config"
    "kungfu/server/handlers"
    "log"
    "net/http"
)

func main() {
    // 加载配置文件
    config.LoadConfig()

    // 设置路由
    http.HandleFunc("/", handlers.HomeHandler)
    http.HandleFunc("/api", handlers.ApiHandler)

    // 启动服务器
    log.Println("Server started on port 8080")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

客户端启动文件

文件路径: src/client/main.go

package main

import (
    "kungfu/client/ui"
    "log"
)

func main() {
    // 初始化用户界面
    ui.InitUI()

    // 启动客户端
    log.Println("Client started")
    ui.Run()
}

3. 项目配置文件介绍

配置文件路径

文件路径: config/config.yaml

server:
  port: 8080
  host: "localhost"

client:
  api_url: "http://localhost:8080/api"

logging:
  level: "info"
  file: "logs/kungfu.log"

配置文件说明

• server: 服务器配置
  • port: 服务器监听的端口号。
  • host: 服务器的主机地址。
• client: 客户端配置
  • api_url: 客户端请求的 API 地址。
• logging: 日志配置
  • level: 日志级别，如 info, debug, error 等。
  • file: 日志文件路径。

通过以上配置文件，可以灵活调整服务器和客户端的行为，以及日志的输出方式。