Skip to content

在IDE中打开项目

下载源码

通过git clone命令将项目克隆到本地:

bash
git clone git@github.com:lishangbu/avalon.git

配置发工具

项目采用的是JDK25开发而成,在低于JDK25的环境下可能会出现一些莫名其妙的问题,建议使用JDK25以上版本。虽然我感觉我没有使用多少新特性。但项目大量使用了多行文本块以及record/Markdown 文档注释等新特性,因此,版本绝对不能低于JDK23。

JDK有多种方式,包括sdkman、homebrew、vfox、asdf等,笔者采用的是asdf,具体安装方式请参考各自官网。

个人推荐可以使用Intellij IDEA的新 具体可以通过File-> Project Structure->Project->Project SDK-Download JDK一键配置。

为了开发体验,建议使用以下插件:

插件备注
Lombok高版本IntelliJ IDEA内置此插件
Spotless Applier使用spotless格式化代码,通过Settings > Tools > Actions on Save > Run spotless 来启用

之后就可以使用IDE打开对应项目了,

生成运行必须的资源

从安全与仓库体积控制角度考虑,RSA 密钥与 IP 数据库不会始终放在仓库中。运行项目之前,建议先在项目根目录执行以下 Gradle 任务:

bash
./gradlew generateRsaKeys downloadIpData

如果需要强制刷新 IP 数据,可以增加下载 Token 与刷新参数:

bash
./gradlew downloadIpData -PipDbDownloadToken=your-token -PrefreshIpDb=true

IP 数据的具体配置方式见 IP2Location

初始化数据库

项目本身采用的是postgres数据库,用户只需要完成数据库的创建与配置。如果采用前文的docker-compose文件,那就什么都不需要改直接启动就行。项目的建表与数据初始化在开发环境下会在项目启动时自动通过JPA完成。 暂时没做其他数据库的支持。

启动

执行avalon-application模块avalon-standalone-server下的AvalonStandaloneServerApplication的main方法,IDE会启动一个可运行的Spring Boot项目了。

要想启动管理后台,则执行avalon-application模块下的avalon-admin-server的AvalonAdminApplication的main方法,IDE会启动一个可运行的Spring Boot管理后台项目了。

Released under the AGPL v3 License.