Edison Microservice 项目教程

Edison Microservice 项目教程

edison-microservice Collection of independent libraries on top of Spring Boot to provide a faster setup of jvm microservices 项目地址: https://gitcode.com/gh_mirrors/ed/edison-microservice

1. 项目的目录结构及介绍

Edison Microservice 项目的目录结构如下：

edison-microservice/
├── bin/
├── edison-core/
├── edison-jobs/
├── edison-mongo/
├── edison-testsupport/
├── edison-togglz/
├── edison-validation/
├── examples/
├── gradle/
├── .gitignore
├── .sdkmanrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── MAINTAINERS
├── OSSMETADATA
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── release.sh
└── settings.gradle

目录结构介绍

• bin/: 存放项目的二进制文件或脚本。
• edison-core/: Edison 微服务的主库，包含核心功能。
• edison-jobs/: 提供简单的任务处理库，用于运行异步后台任务。
• edison-mongo/: 提供 MongoDB 的自动配置和 MongoJobRepository 的实现。
• edison-testsupport/: 提供测试支持，包括功能切换和实用工具。
• edison-togglz/: 提供基于 Togglz 的功能切换支持。
• edison-validation/: 提供 Spring 中的验证模块，具有特定的响应格式。
• examples/: 包含一些示例项目，帮助用户快速上手。
• gradle/: 存放 Gradle 构建工具的相关文件。
• .gitignore: Git 忽略文件配置。
• .sdkmanrc: SDKMAN 配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• MAINTAINERS: 维护者列表。
• OSSMETADATA: 开源元数据文件。
• README.md: 项目介绍和使用说明。
• build.gradle: Gradle 构建脚本。
• gradle.properties: Gradle 属性配置文件。
• gradlew: Gradle 包装器脚本。
• gradlew.bat: Windows 下的 Gradle 包装器脚本。
• release.sh: 发布脚本。
• settings.gradle: Gradle 设置文件。

2. 项目的启动文件介绍

Edison Microservice 项目的启动文件主要是 build.gradle 和 gradlew 文件。

build.gradle

build.gradle 是 Gradle 构建脚本，定义了项目的依赖、任务和插件。以下是一些关键配置：

plugins {
    id 'org.springframework.boot' version '3.3.x'
    id 'io.spring.dependency-management' version '1.1.x'
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
    implementation 'org.togglz:togglz-spring-boot-starter:2.x.x'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

test {
    useJUnitPlatform()
}

gradlew

gradlew 是 Gradle 包装器脚本，用于在不同环境中一致地运行 Gradle 构建。用户可以通过以下命令启动项目：

./gradlew bootRun

3. 项目的配置文件介绍

Edison Microservice 项目的配置文件主要包括 application.yml 和 settings.gradle。

application.yml

application.yml 是 Spring Boot 的配置文件，定义了应用程序的各种配置，如数据库连接、端口等。以下是一个示例配置：

spring:
  application:
    name: edison-microservice
  data:
    mongodb:
      uri: mongodb://localhost:27017/edison

server:
  port: 8080

management:
  endpoints:
    web:
      base-path: /internal

settings.gradle

settings.gradle 是 Gradle 的设置文件，定义了项目的模块和仓库配置。以下是一个示例配置：

rootProject.name = 'edison-microservice'

include 'edison-core', 'edison-jobs', 'edison-mongo', 'edison-testsupport', 'edison-togglz', 'edison-validation', 'examples'

通过以上配置，用户可以轻松启动和管理 Edison Microservice 项目。

edison-microservice Collection of independent libraries on top of Spring Boot to provide a faster setup of jvm microservices 项目地址: https://gitcode.com/gh_mirrors/ed/edison-microservice