1 Star 3 Fork 0

Ralph / ralph-cloud

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

Ralph-Cloud微服务

技术架构

作者画图的技能暂未点亮,暂时先以文本描述

用到的技术栈如下:SpringCloudAlibaba、SpringBoot、Nacos、SpringCloudGateway、Feign、MybatisPlus、Redis

整体结构

ralph-cloud

​ |——logs // 项目运行日志

​ |——ralph-admin // 系统模块

​ |——ralph-business-article // 业务模块

​ |——ralph-common // 通用模块

​ |——ralph-common-codegen // mybatisplus自动生成代码模块

​ |——ralph-common-core // 通用模块,如工具类、通用实体类、常量类、通用配置等

​ |——ralph-common-docs // 文档模块,目前集成了swagger文档

​ |——ralph-common-feign // feign模块

​ |——ralph-common-security // 安全模块

​ |——ralph-gateway // 网关模块

​ |——ralph-nacos // 服务注册与发现,配置模块

​ |——ralph-oauth // 授权模块

​ |——script // 脚本文件、日志文件、jar包

模块介绍

ralph-admin

系统模块,该模块包含了字典功能、参数管理功能、菜单功能、用户功能、角色功能、token管理功能、文件管理功能(MinIO)等

TODO:部门功能

ralph-business-article

自定义业务模块,业务功能:可以定时调用csdn博客接口,增加博客访问量(作用不大)

ralph-common

ralph-common-codegen

基于mybatilplus自动生成代码,使用的是新版的自动生成代码;

可以根据模板生成Controller、Entity等,Controller中还会自动生成增删改查接口代码,可以配置是否需要Swagger注解、是否需要Security的权限注解、是否需要增加日志注解等;还会生成增删改查相关菜单的sql,在数据库执行即可新增相关菜单

集成Screw,实现了数据库文档生成

TODO:交互式生成代码

ralph-common-core

通用类包含内容如下:

  • Redistemplate的配置,Mybatisplus的配置、线程池配置
  • 各种常量类
  • 通用实体类
  • 全局异常类
  • 各种工具类
  • banner文件统一管理 在ralph-common-core模块的resources文件夹下有banners文件夹,该文件夹中维护了各模块的banner文件
  • 日志文件统一管理 将日志管理文件logback-spring.xml放在ralph-common-core模块的resources文件夹下,所有依赖于core的模块都会按照该日志文件生成日志
  • 自定义注解
    • @ActionLog加了该注解的接口会记录操作时间,操作人,操作者ip,请求方式,请求参数等
    • @IgnoreUrl加了该注解的接口不会受到Security的权限卡控,可以直接访问接口
    • @PreventRepeatInvoke加了该注解的接口可以限制一段时间内不允许重复访问

ralph-common-docs

文档模块,目前集成了swagger,使用了knife4j进行了加强

swagger访问路径:http://ip:port/swagger-ui/index.html

knife4j访问路径:http://ip:port/doc.html

鉴权方式:token统一鉴权,在登录后,将获取到的token设置在swagger右上角的Authorized即可,需注意加Bearer 前缀

ralph-common-feign

服务间通信,将服务的feign配置在该模块下,支持fallback

ralph-common-security

安全模块

自定义了密码校验,目前支持MD5,可扩展其他校验方式

JWT校验,接口权限控制

ralph-common-rule

规则引擎模块

根据数据库配置的规则引擎进行校验,如果校验不通过则抛出异常

如果需要新增规则,需要在com.ralph.common.rule.engin.impl下新增实现类,类名规则:Rule+规则编码

使用时注入RuleCheckService即可

ralph-gateway

网关模块,实现基于数据库的动态路由功能,无需在配置文件中进行配置路由

ralph-nacos

使用nacos进行服务的注册与发现,配置管理

ralph-oauth

授权模块,登录、登出等

目前支持用户名密码登录,图形验证码登录

集成JustAuth实现各种第三方登录

script

sql

部署项目所需要数据库sql

bin

该文件夹下有直接启动nacos的命令,可以直接通过该文件启动nacos

jar

打包生成的jar包与依赖

待开发模块

工作流模块

部署项目前期准备

1、需要在hosts文件中增加如下映射:

  • 127.0.0.1 ralph-mysql
  • 127.0.0.1 ralph-nacos
  • 127.0.0.1 ralph-redis

或者直接将配置文件中的映射修改为ip也可以

2、创建数据库

2.1 nacos数据库

在数据库中执行/sql文件夹下ralph-nacos.sql文件即可,如果想修改数据库名称,可以修改ralph-nacos/conf/application.properties文件末尾的db.url.0配置

2.2 系统模块数据库

执行/sql文件夹下的ralph_cloud.sql文件可以生成系统模块所需的数据库表,其中还有业务模块的数据库表,不需要的可以删除

3、打包相关

打包时可以将依赖和本体分开打包,将jar包放至ralph-cloud/jar/{projectName}/文件夹下,相关依赖在ralph-cloud/jar/{projectName}/libs文件夹下

在运行时只需要执行nohup java -Dfile.encoding=utf-8 -Duser.timezone=GMT+8 -Dloader.path=libs/ -jar xxx.jar 即可

这样在修改完项目时如果没有新增依赖,那么只需要更新jar包即可,如果有新增依赖,只需要将新依赖添加至libs包即可

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

SpringCloud后台管理系统,纯后端,仅供学习交流 展开 收起
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/ralphchen/ralph-cloud.git
git@gitee.com:ralphchen/ralph-cloud.git
ralphchen
ralph-cloud
ralph-cloud
master

搜索帮助