一、前置条件准备

1. 安装Java Development Kit (JDK)

   • 下载并安装Java JDK 8或更高版本。
   • 配置环境变量，确保JAVA_HOME和PATH正确指向JDK安装目录。

2. 安装Apache Maven

   • 下载Maven 3.8.1或更高版本。
   • 解压并配置Maven环境变量，确保M2_HOME和PATH正确指向Maven安装目录。

3. 设置Maven仓库路径

   • 在Maven的配置文件（通常位于~/.maven/settings.xml）中添加以下内容：

     <settings>
       <localRepository>
         <id>local-maven-repository</id>
         <rootFolder>${user.home}/.maven/repository</rootFolder>
       </localRepository>
       ...
     </settings>

   • 这样可以确保SingBox和其他依赖能够被下载和缓存。

创建SingBox项目

1. 使用Maven创建新项目

   • 打开终端，在指定的项目目录中执行以下命令：

     mvn io.singbox:singbox-parent:pom:1..

   • 这将下载并创建一个SingBox项目,包含相关的模块和依赖。

2. 添加SingBox依赖

   • 打开项目的pom.xml文件，确保<dependencies>部分包含以下内容：

     <dependency>
       <groupId>io.singbox</groupId>
       <artifactId>singbox</artifactId>
       <version>1..</version>
     </dependency>

   • 确保版本与你的项目需求相匹配,根据文档或项目需求调整版本号。

配置数据库

1. 选择数据库类型

   SingBox支持多种数据库，例如H2、HSQLDB、MySQL等,你可以根据项目需求选择合适的数据库类型。

2. 创建数据库

   • 如果选择H2，创建一个记事本式数据库文件：

     mkdir -p target/db
     touch target/db/singbox.db

   • 如果选择HSQLDB或MySQL,按照数据库类型创建相应的数据库。

3. 配置数据库连接

   • 在项目的application.properties文件中添加以下内容：

     spring.datasource.url=jdbc:h2:file:target/db/singbox.db
     spring.datasource.username=sa
     spring.datasource.password=
     spring.datasource.driverClassName=org.h2.Driver

   • 根据数据库类型调整spring.datasource.url和其他参数。

应用配置

1. 配置基本属性

   • 在application.properties中添加：

     app.name=singbox-example
     app.version=1..
     app.description=SingBox Example Application

2. 配置数据库连接池

   • 添加HikariCP配置：

     spring.datasource池名=DataSource Pool
     spring.datasource池连接数=10
     spring.datasource池最大连接数=20
     spring.datasource池.idle连接数=5
     spring.datasource池超时=300

3. 启用调试日志

   • 如果需要调试，可以在application.properties中添加：

     logging.level.root=debug
     logging.level.org.springframework=debug
     logging.level.io.singbox=debug

打包和运行

1. 打包项目

   • 在项目根目录执行：

     mvn clean install

2. 运行应用

   • 执行：

     mvn spring-boot:run

   • 应用将在http://localhost:808启动。

访问应用

1. 访问主页

   • 打开浏览器，访问http://localhost:808。

2. 登录入口

   • 根据项目需求，登录入口可能在http://localhost:808/login或类似的路径。

注意事项

1. 检查数据库连接

   确保数据库连接配置正确,尤其是用户名和密码。

2. 处理依赖冲突

   如果遇到依赖冲突,可以尝试更新到最新版本或调整版本号。

3. JDK版本

   确保使用Java 8或更高版本,否则可能会出现兼容性问题。

4. 调整JVM内存

   • 如果应用启动后出现内存问题，可以在application.properties中调整JVM设置：

     java_OPTS=-Xms64m -Xmx64m

常见问题

1. 启动失败

   • 检查依赖下载是否成功，尝试清理Maven缓存：

     mvn clean install -DskipTest

2. 数据库连接错误

   确认数据库是否存在,用户权限是否正确。

3. 内存问题

   调整JVM内存设置,或者增加物理内存。

扩展参考

• official documentation: SingBox Documentation
• example projects: SingBox Examples

通过以上步骤,你可以成功安装并运行一个基于SingBox框架的项目。