Skip to content

Latest commit

 

History

History
64 lines (51 loc) · 3.21 KB

README.md

File metadata and controls

64 lines (51 loc) · 3.21 KB

MaaBackendCenter

使用 Kotlin 编写的 MAA 作业服务器后端

开发技术栈

  • kotlin 2.1 (Java 21)
  • SpringBoot 3
    • spring-security
    • springdoc-openapi
  • MongoDB
  • Redis

本地开发指南

  1. 使用你喜欢的 IDE 导入此项目，复制 /src/main/resources/application-template.yml 到同目录下，命名为 application-dev.yml，修改数据库配置以符合你自己配置的环境。
  2. 下载安装 JDK 21 或者以上版本的 jdk，可以考虑从 zuluJDK 或者 libreicaJDK 下载安装。 Jetbrains Idea 可以使用自带的 JDK 管理器进行下载。
  3. 你需要一个有redis和mongoDB的环境，如果你是windows用户，可以从 https://github.com/redis-windows/redis-windows/releases 中下载使用。 您也可以直接使用 ./dev-docker/docker-compose.yml 来启动 docker 服务。
  4. 运行 ./gradlew bootRun, windows 环境为 ./gradlew.bat bootRun
  5. 首次运行建议修改配置文件中的 maa-copilot.task-cron.ark-level 配置，这样可以将明日方舟中的关卡数据同步到你本地的 mongodb 中，为了防止反复调用造成调试的麻烦，建议首次运行同步成功后再将配置修改回去

项目结构

  • config # 存放 spring 配置
  • common # 共享的逻辑
  • controller # 交互层
    • request # 入参类型
    • response # 响应类型
  • repository # 数据仓库层，用于和数据库交互
    • entity # 与数据库字段对应的类型
  • service # 业务处理层，复杂或者公用逻辑放在这里
    • model # 应用内传输用类型放这里

编译与部署

  1. 安装 JDK 21，可以考虑从 zuluJDK 或者 libreicaJDK 下载
  2. clone 此项目 git clone https://github.com/MaaAssistantArknights/MaaBackendCenter.git
  3. 进入此项目目录 cd MaaBackendCenter
  4. 编译项目 ./gradlew bootJar，windows 环境下请使用 gradlew.bat bootJar
  5. 获得编译后的 jar 文件 cp ./build/libs/MaaBackendCenter-1.0-SNAPSHOT.jar .
  6. 复制一份配置文件 cp ./build/resources/main/application-template.yml ./application-prod.yml
  7. 修改配置文件 application-prod.yml
  8. 运行项目 java -jar MaaBackendCenter-1.0-SNAPSHOT.jar --spring.profiles.active=prod

native 编译（暂时废弃，如果希望协助维护，请查看native分支）

  1. 安装 GraalVM Java21，并配置好环境变量，部分功能需要正确配置 JAVA_HOME 变量为 GraalVM 安装目录才能正常使用
  2. 如果您处于 Windows 环境下，需要安装 Visual Studio 并且安装 C++ 组件，Linux 环境下则需要安装 gcc 工具链，Mac 下需要安装 xcode 工具链，详情查看 native-image#prerequisites
  3. 在该项目目录下，执行 ./gradlew nativeRun 或者 .\gradlew.bat nativeRun 编译并运行该项目
  4. 如果您希望产生 docker image，请执行 ./gradlew bootBuildImage

Join us!

QQ Group: 724540644