ITADN
team-dodn/spring-boot-java-template
team-dodn/spring-boot-java-template · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

SpringBoot Java 模板

Twitter Youtube CI License

这不是最佳结构。在项目早期,当生产力至关重要时,这是一个很好的基础结构。

请记住,随着软件的成长,你的结构也必须随之成长。

模块

核心

该模块的每个子模块负责一个领域服务。

这必须使模块化结构随着服务的成长而成长。

core:core-api

它是项目中唯一可执行的模块。其结构包含领域,以最大化初始开发生产力。

它还负责提供 API 并为服务设置框架。

core:core-enum

该模块包含 core-api 所使用的枚举,并且必须交付给外部模块。


客户端

本模块的子模块负责与外部系统集成。

clients:clients-example

本模块展示了与 Spring-Cloud-Open-Feign 进行 HTTP 通信的示例。


存储

本模块的子模块负责与各种存储进行集成。

storage:db-core

本模块展示了使用 Spring-Data-JPA 连接 MySql 的示例。


支持

该模块的子模块负责提供额外的支持。

support:logging

该模块支持服务日志记录,并添加了用于分布式追踪支持的依赖项。

它还包含用于支持 Sentry 的依赖项。

support:monitoring

该模块支持服务监控。


测试

本模块的子模块负责简化测试代码的编写。

tests:api-docs

本模块用于便捷地编写 spring-rest-docs。


依赖管理

所有依赖的版本管理均通过 gradle.properties 文件完成。

如果要添加新的依赖,请将版本放入 gradle.properties 并在 build.gradle 中加载。


运行时配置

local

此配置旨在设置一个即使网络断开也能进行开发的环境。

local-dev

此配置旨在设置允许我从本地机器连接到 DEV 环境的配置。

dev

此配置用于部署 Development 环境。

staging

此配置用于部署 Staging 环境。

live

此配置用于部署 Live 环境。


测试任务与标签

test

这是一组我们希望在 CI 上运行的测试任务。

如果您想更改设置,请修改 build.gradle 文件。

unitTest

这是一组通常没有依赖项、运行速度快且测试单一功能的测试。

contextTest

这是一个使用 SpringContext 运行并包含集成测试的任务。

restDocsTest

这是一个基于 spring-rest-docs 创建 asciidoc 的任务。

developTest

这是一个不应在 CI 中运行的测试任务。

如果您不擅长编写测试,这是一个很好的标签。


推荐设置

IntelliJ IDEA

此设置可更轻松地直接运行 test code

// Gradle Build and run with IntelliJ IDEA
Build, Execution, Deployment > Build Tools > Gradle > Run tests using > IntelliJ IDEA	

如果您希望将 lint 设置应用于 IDEA 的格式,请参阅以下指南。

Spring Java Format IntelliJ IDEA


支持方

JetBrains Logo (Main) logo.