# opensite

**Repository Path**: papwuj/opensite

## Basic Information

- **Project Name**: opensite
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-01
- **Last Updated**: 2026-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenSite

基于 Gradle 的多层多模块 Java 项目结构。

## 项目结构

```
opensite/
├── frameworks/                 # 基础框架（精简合并）
│   ├── opensite-framework-commons   # 公共 API：CRUD/分页/导出导入/权限/字典/流程/定时/多租户/链路/限流熔断等接口与常量
│   ├── opensite-framework-web      # Web 层：BaseController、链路追踪/多租户/网关鉴权 Filter、限流熔断实现
│   ├── opensite-framework-logs      # 日志与审计：OpenSiteLogger、Slf4jAuditLogService
│   └── opensite-framework-support  # 业务支撑实现：数据字典、定时任务、流程引擎（Activiti）
├── modules/                    # 多模块父级
│   ├── opensite-module-admin   # 管理员模块
│   ├── opensite-module-cms     # CMS 模块
│   ├── opensite-module-setup   # 安装模块
│   └── opensite-module-system  # 系统模块
├── platforms/                  # 平台
│   ├── opensite-dependencies  # 依赖管理（所有引用版本集中在此）
│   └── opensite-parent        # 统一父模块占位
└── servers/                    # 服务
    ├── cloud-servers/          # 微服务
    │   ├── opensite-server-cloud   # 微服务 Web 项目（Eureka Client）
    │   └── opensite-server-registry # 微服务注册中心（Eureka Server）
    └── single-servers/         # 单服务
        └── opensite-server-web     # 单服务 Web 项目（Spring Boot + Thymeleaf）
```

## 依赖关系

- **opensite-dependencies**：Java Platform，统一管理 Spring Boot 4.0.2、Spring Cloud 2025.1.0 及 Vaadin/Spring AI/Modulith 等 BOM 版本，其它子项目通过 `implementation platform(project(':opensite-dependencies'))` 使用。
- **frameworks**：仅依赖 platform。commons 为纯 API；web 提供控制器基类与 Filter/限流熔断；logs 提供日志与审计实现；support 提供字典/定时/流程实现。
- **modules**：依赖 framework-commons、framework-logs。
- **opensite-server-web**：依赖 framework-commons、framework-logs、module-admin、module-system；单机 Web 应用。
- **opensite-server-cloud**：依赖 framework-commons、framework-logs、module-system；微服务应用，注册到 Eureka。
- **opensite-server-registry**：Eureka Server，无业务模块依赖。

## 环境要求

- JDK 21+
- Gradle 9.3+（或使用项目自带 Wrapper）
- 依赖版本由 start.spring.io 生成配置对齐：Spring Boot 4.0.2、Spring Cloud 2025.1.0

若目录下没有 `gradle/wrapper/gradle-wrapper.jar`，请先安装 [Gradle](https://gradle.org/install/)，在项目根目录执行：

```bash
gradle wrapper --gradle-version 9.3
```

## 常用命令

```bash
# 编译所有子项目
./gradlew build
# Windows:
.\gradlew.bat build

# 仅编译某层
./gradlew :opensite-framework-commons:build
./gradlew :opensite-module-system:build

# 运行单服务 Web
./gradlew :opensite-server-web:bootRun

# 运行微服务注册中心（需先启动）
./gradlew :opensite-server-registry:bootRun

# 运行微服务 Web（需先启动 registry）
./gradlew :opensite-server-cloud:bootRun

# 运行所有测试
./gradlew test

# 清理
./gradlew clean
```

## 示例说明

- **opensite-framework-commons**：`Greeting`、`GreetingService` 示例及单元测试。
- **opensite-framework-logs**：`OpenSiteLogger` 统一获取 SLF4J Logger。
- **opensite-server-web**：首页 `GET /`（Thymeleaf）、REST `GET /api/greet?name=xxx`。
- **opensite-server-cloud**：`GET /actuator/health`，并注册到 Eureka。
- **opensite-server-registry**：Eureka 控制台默认端口 8761。

启动单服务后访问：http://localhost:8080/ 与 http://localhost:8080/api/greet?name=World 。