从零搭建x-ui开发环境：编译调试全攻略

你还在为x-ui环境配置繁琐而烦恼？本文将带你一步到位完成本地编译与调试，无需复杂操作，新手也能轻松上手。读完本文你将获得：

• 开发环境搭建的完整步骤
• 项目编译与运行的实用技巧
• 常见问题的解决方案
• 调试工具的使用方法

环境准备

开发x-ui前需要安装以下工具：

• Git：用于获取源码
• Go（1.16+）：项目使用Go语言开发，版本信息见go.mod
• 文本编辑器：如VS Code、GoLand等

安装完成后，可通过以下命令验证：

git --version
go version

源码获取

首先克隆项目源码到本地：

git clone https://gitcode.com/gh_mirrors/xu/x-ui.git
cd x-ui

克隆完成后，你将看到类似以下的项目结构：

x-ui/
├── Dockerfile
├── LICENSE
├── README.md
├── config/
├── database/
├── go.mod
├── go.sum
├── install.sh
├── logger/
├── main.go
├── media/
├── util/
├── v2ui/
├── web/
├── x-ui.service
├── x-ui.sh
└── xray/

依赖安装

项目依赖管理使用Go Modules，安装依赖只需执行：

go mod download

该命令会根据go.mod文件下载所需依赖包，主要包括：

• gin-gonic/gin：Web框架
• gorm.io/gorm：ORM框架
• xtls/xray-core：核心代理功能

编译步骤

编译x-ui非常简单，执行以下命令即可：

go build -o x-ui main.go

编译成功后，当前目录会生成可执行文件x-ui。如果需要交叉编译其他平台版本，可以使用：

# 编译Linux AMD64版本
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o x-ui-linux-amd64 main.go

运行与调试

运行项目

执行以下命令启动x-ui服务：

./x-ui

首次运行会提示设置管理员账户和密码，按照提示操作即可。启动成功后，访问http://localhost:54321即可打开管理界面。

调试方法

使用Go内置的调试工具可以方便地进行调试：

dlv debug main.go

在VS Code中调试时，可以创建.vscode/launch.json文件，配置如下：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "program": "${workspaceFolder}/main.go",
            "args": []
        }
    ]
}

界面预览

启动成功后，访问管理界面可以看到如下界面：

登录后进入主控制台：

在配置页面可以添加各种代理协议：

常见问题解决

问题	解决方案
编译报错"undefined: xray..."	执行go mod tidy更新依赖
端口被占用	修改配置文件config/config.go中的默认端口
启动后无法访问	检查防火墙设置，确保端口已开放
依赖下载缓慢	设置GOPROXY：go env -w GOPROXY=https://goproxy.cn,direct

总结

通过本文的步骤，你已经成功搭建了x-ui的开发环境，包括源码获取、依赖安装、编译运行和调试等环节。如果在实践过程中遇到其他问题，可以查阅项目文档README.md或提交issue反馈。

希望本文对你有所帮助，欢迎点赞收藏，关注后续更多x-ui使用技巧和开发指南！