Skip to content

README.md

Latest commit

 

History

History
146 lines (102 loc) · 8.65 KB

README.md

File metadata and controls

146 lines (102 loc) · 8.65 KB
Raw

License Maven Central Build Status codecov

springboot-framework | Springboot领域驱动开发

当你无意间推开这一扇门，将会感叹原来生活可以如此的美好。

本框架基于springboot为提供领域驱动设计与事件风暴开发落地，提供的范式开源框架。

Project Version | 项目版本说明

自 17.3.0 起，项目采用 CI-Friendly 版本管理方式（与 flow-engine 相同）：pom 中的版本声明为 ${revision}，开发期锁定为 SNAPSHOT 版本（当前为 17.3.0-SNAPSHOT），正式发布时通过 -Drevision=x.y.z 指定正式版本号，无需修改 pom。

版本号含义：第一位为 JDK 版本，第二位为 Spring Boot 大版本，第三位为补丁版本。例如 17.3.0 表示基于 JDK 17、Spring Boot 3.x 的第 0 个补丁版本。

（历史版本线：v.2.x 对应 Spring Boot 2.x / JDK 8；v.3.x 对应 Spring Boot 3.x / JDK 17。）

Since 17.3.0, the project uses a CI-Friendly versioning scheme (same approach as flow-engine): the pom declares its version as ${revision}, which is pinned to a SNAPSHOT during development (currently 17.3.0-SNAPSHOT); the release version is supplied via -Drevision=x.y.z at release time, with no pom changes needed.

Version number convention: first segment = JDK version, second segment = Spring Boot major version, third segment = patch version. For example, 17.3.0 targets JDK 17 and Spring Boot 3.x, patch 0.

(Legacy lines: v.2.x for Spring Boot 2.x on JDK 8; v.3.x for Spring Boot 3.x on JDK 17.)

Frontend Framework Version | 前端框架版本说明

Package Description Version
@codingapi/ui-framework UI-Framework npm
@codingapi/form-pc Form-PC npm
@codingapi/form-mobile Form-Mobile npm

前端代码位于 frontend 目录，采用 pnpm workspace 管理：包含 apps/pc（原 admin-ui）与 apps/mobile（原 mobile-ui）两个应用，公共代码抽取在 packages/shared（@springboot-framework/shared）。

The frontend code lives in the frontend directory, managed as a pnpm workspace: it contains two apps apps/pc (formerly admin-ui) and apps/mobile (formerly mobile-ui), with shared code extracted into packages/shared (@springboot-framework/shared).

cd frontend
pnpm install
pnpm dev:pc        # PC 端开发模式（代理后端） / PC dev mode (proxies backend)
pnpm dev:mobile    # 移动端开发模式（代理后端） / Mobile dev mode (proxies backend)
pnpm build:pc      # PC 端生产构建 / PC production build
pnpm build:mobile  # 移动端生产构建 / Mobile production build

更多指令见 frontend/README.md。

See frontend/README.md for more scripts.

Project Modules Description | 项目模块介绍

  • springboot-starter | Springboot领域驱动框架
  • springboot-starter-script | 脚本引擎框架
  • springboot-starter-data-fast | 快速数据呈现框架
  • springboot-starter-data-authorization | 数据权限框架
  • springboot-starter-security | security权限框架支持基于JWT的无状态权限认证与Redis的有状态权限认证
  • example | 示例DDD项目
  • frontend | 前端 monorepo（pnpm workspace），包含 apps/pc（原 admin-ui）管理后台UI脚手架、apps/mobile（原 mobile-ui）移动端UI脚手架与 packages/shared 公共代码

Flow Engine Migration | 流程引擎迁移说明

工作流引擎（springboot-starter-flow）已从本框架移除，重构为独立仓库维护，新地址：https://github.com/codingapi/flow-engine。需要使用流程引擎的项目请改用独立仓库。

The workflow engine (springboot-starter-flow) has been removed from this framework and refactored into an independently maintained repository: https://github.com/codingapi/flow-engine. Projects that need the workflow engine should migrate to the standalone repository.

SpringBoot DDD Architecture | SpringBoot DDD 框架图

maven install

以下示例使用正式发布版本（如 17.3.0，最新发布版见上方 Maven Central 徽章）；如需体验开发快照版本，请使用 17.3.0-SNAPSHOT。

The examples below use an official release version (e.g. 17.3.0; see the Maven Central badge above for the latest release). Use 17.3.0-SNAPSHOT for the development snapshot.

    <!-- Springboot领域驱动框架 -->
    <dependency>
        <groupId>com.codingapi.springboot</groupId>
        <artifactId>springboot-starter</artifactId>
        <version>17.3.0</version>
    </dependency>
    
    <!-- 脚本引擎框架 -->
    <dependency>
        <groupId>com.codingapi.springboot</groupId>
        <artifactId>springboot-starter-script</artifactId>
        <version>17.3.0</version>
    </dependency>
    
     <!-- 快速数据呈现框架 -->
     <dependency>
        <groupId>com.codingapi.springboot</groupId>
        <artifactId>springboot-starter-data-fast</artifactId>
        <version>17.3.0</version>
    </dependency>
    
     <!-- 数据权限框架 -->
     <dependency>
        <groupId>com.codingapi.springboot</groupId>
        <artifactId>springboot-starter-data-authorization</artifactId>
        <version>17.3.0</version>
    </dependency>

     <!-- security&jwt权限框架 -->
     <dependency>
        <groupId>com.codingapi.springboot</groupId>
        <artifactId>springboot-starter-security</artifactId>
        <version>17.3.0</version>
     </dependency>

CONTRIBUTING

Welcome to springboot-framework ! This document is a guideline about how to contribute to springboot-framework. If you find something incorrect or missing, please leave comments / suggestions.

CONTRIBUTING

Documentation

https://github.com/codingapi/springboot-framework/wiki

Example

见 example

Reference Documentation

For further reference, please consider the following sections: