34 Star 436 Fork 220

享同 / xtoon-cloud-ddd

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

xtoon-cloud

基于领域驱动设计(DDD)并支持SaaS平台的微服务开发框架.

ApiAdmin ApiAdmin ApiAdmin

单体应用版:https://gitee.com/xtoon/xtoon-boot

帮忙右上角点下 ⭐Star ,感谢您的支持。

为何开源

项目初期或MVP阶段就上微服务,服务拆分的很细,这会增加开发成本和风险。
个人认为可以选择合适的框架先开发基于DDD的单体应用,后期根据领域的不同弹性需求再快速的、低成本的过渡为微服务版。
这也是我们开源基于DDD的xtoon框架的初衷,目前单体应用版和微服务版都已发布正式版,如想更深入的学习和交流欢迎加入微信群!

为何选择xtoon-cloud

  • 解决编写过程式和事务代码,造成后期维护逻辑混乱、维护成本高的痛点;
  • 边界规范易维持,核心业务逻辑内聚在领域内,低耦合,高内聚,易于长期维护;
  • 网上基本讲的都是DDD的理论很少有讲怎么落地,xtoon-cloud提供了完整落地方案和企业级微服务架构;
  • 可以快速开发,框架提供了系统管理和组织架构等核心模块;
  • 支持多租户的SaaS平台;

DDD落地公众号

学习DDD概念和落地经验分享,欢迎关注

技术交流

欢迎入扫码加入微信群或扫码加我好友拉你进大群 ,来和DDD实践者们一起探讨DDD落地方案吧。

如果你解决了某些bug,或者新增了一些功能,欢迎 贡献代码,感激不尽~

技术选型

  • 基础框架:Spring Cloud Alibaba
  • 网关:Spring Cloud Gateway
  • 鉴权认证:Spring Cloud Security+JWT
  • 服务监控:spring-boot-admin
  • 流量控制:Sentinel
  • 注册配置中心:Nacos
  • RPC:dubbo
  • mybatis-plus

主要模块

  1. 登录注册:账号、手机号验证登录,租户注册;
  2. 用户管理:用户新增,分配角色,禁用等;
  3. 角色管理:角色新增,查看,维护菜单等;
  4. 菜单管理:树形菜单管理,可配置菜单和按钮权限等;
  5. 租户管理:租户列表,禁用等;
  6. 日志管理:记录操作日志记录和查询;

项目结构

xtoon-could
├──doc                           文档
│    ├─db                        sql
│    └─yaml                      配置文件

├─xtoon-common                   公共模块
│    ├─xtoon-common-core         核心公共模块
│    ├─xtoon-common-log          日志公共模块
│    ├─xtoon-common-mybatis      mybatis公共模块
│    ├─xtoon-common-redis        redis公共模块
│    ├─xtoon-common-swagger      swagger公共模块
│    ├─xtoon-common-tenant       多租户公共模块 
│    └─xtoon-common-web          web公共模块 

├─xtoon-ops                      运维服务
│    ├─xtoon-auth-server         认证服务
│    ├─xtoon-gateway-server      网关  
│    ├─xtoon-monitor-server      健康监控服务 
│    ├─xtoon-register-server     注册配置中心
│    └─xtoon-sentinel-server     流量控制

├─xtoon-service                  业务服务
│    └─xtoon-sys                 系统管理领域
│         ├─xtoon-sys-interface  系统管理接口
│         └─xtoon-sys-server     系统管理服务

部署

前期准备

  • 拉取前后端项目代码;
  • 安装必要的环境:jdk1.8+,mysql5.7+,redis,nodejs等;
  • mysql新建两个库,导入doc下面的sql文件;
  • 修改成本地环境配置:mysql,redis;
  • 启动前后端项目,访问地址;#

本地启动顺序

  • xtoon-register-server(注册配置中心)
  • xtoon-sys-server(用户服务)
  • xtoon-auth-server(认证服务)
  • xtoon-gateway-server(网关服务)
  • xtoon-monitor-server(监控服务)
  • xtoon-sentinel-server(流量控制服务)
  • xtoon-could-element(前端项目)

测试/生产发布

支持jenkins pipeline + docker + harbor + k8s部署,项目开源配置文件:Dockerfile,Jenkinsfile,k8s-deployment.tpl,具体可加群讨论(QQ:13095000)

核心理念

六边形理论

Alistair Cockburn提出了六边形架构,又被称为端口和适配器架构。观察上图我们发现,对于核心的应用程序和领域模型来说,其他的底层依赖或实现都可以抽象为输入和输出两类。组织关系变为了一个二维的内外关系,而不是上下结构。每个io与应用程序之前均有适配器完成隔离工作,每个最外围的边都是一个端口。基于六边形架构设计的系统是DDD追求的最终形态。

数据驱动和领域驱动对比

领域驱动设计与之前的系统设计开发过程有很大的不同: 1. 就在于系统的参与角色,产品、开发、测试等,需要形成一套通用语言; 2. 在于方案设计不再把db设计放在一个核心问题去解决,更加专注于业务模型本身,进行领域、业务聚合的设计,领域层的聚合及实体才是整个系统的核心内容; 3. 真正的面向对象编程,由过程式的事务脚本方式,转变为真正的面向对象。

分层架构

  • 用户界面层(或表示层)
    负责向用户显示信息和解释用户指令。这里指的用户可以是另一个计算机系统, 不一定是使用用户界面的人
  • 应用层
    定义软件要完成的任务,并且指挥表达领域概念的对象来解决问题。这一层所负 责的工作对业务来说意义重大,也是与其他系统的应用层进行交互的必要渠道 应用层要尽量简单,不包含业务规则或者知识,而只为下一层中的领域对象协调 任务,分配工作,使它们互相协作。它没有反映业务情况的状态,但是却可以具有另外一种状态,为用户或程序显示某个任务的进度
  • 领域层(或模型层)
    负责表达业务概念,业务状态信息以及业务规则。尽管保存业务状态的技术细节 是由基础设施层实现的,但是反映业务情况的状态是由本层控制并且使用的。领域层是业务软件的核心
  • 基础设施层
    为上面各层提供通用的技术能力:为应用层传递消息,为领域层提供持久化机制, 为用户界面层绘制屏幕组件,等等。基础设施层还能够通过架构框架来支持4个层次间的交互模式

相关文档

维护者

版权声明

Apache-2.0 license

本软件基于 Apache-2.0 协议进行分发和使用,更多信息参见 协议文件

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于DDD(领域驱动设计)并支持SaaS平台的微服务框架 展开 收起
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/xtoon/xtoon-cloud.git
git@gitee.com:xtoon/xtoon-cloud.git
xtoon
xtoon-cloud
xtoon-cloud-ddd
develop

搜索帮助