2 Star 9 Fork 2

慕容小草 / acp-admin-cloud

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

acp-admin-cloud

v6.2.1 版本更新日志
  • 使用Application Construction Platform 应用构建平台作为脚手架
  • 基于 Spring Cloud 的微服务版本,基于 Spring Boot 的单机版请查看这里
  • 该项目是前后端分离架构中的“后端部分”。前端工程

相关组件版本

技术栈

  • camunda
  • joda-time
  • netty
  • hibernate
  • jackson
  • poi
  • freemarker
  • flying-saucer-pdf-itext5
  • knife4j
  • junit5
  • spring-boot
    • spring-boot-starter-webflux
    • spring-boot-starter-undertow
    • spring-boot-starter-actuator
    • spring-boot-starter-validation
    • spring-boot-starter-aop
    • spring-boot-starter-websocket
    • spring-boot-starter-security
    • spring-boot-starter-data-jpa
    • spring-boot-starter-data-redis
    • spring-boot-starter-data-redis-reactive
    • spring-boot-starter-oauth2-resource-server
    • spring-boot-starter-oauth2-authorization-server
  • spring-boot-admin-server
  • spring-cloud-alibaba
    • spring-cloud-starter-alibaba-nacos-discovery
    • spring-cloud-starter-alibaba-nacos-config
    • spring-cloud-starter-alibaba-sentinel
    • sentinel-datasource-nacos
  • spring-cloud
    • spring-cloud-starter-loadbalancer
    • spring-cloud-starter-gateway
    • spring-cloud-starter-stream-kafka
    • spring-cloud-stream-binder-kafka-streams
    • spring-cloud-starter-bus-kafka
    • spring-cloud-starter-openfeign
  • feign-hc5
  • micrometer-tracing-bridge-otel
  • opentelemetry-exporter-zipkin

总体架构

Architecture diagram

说明

  • 各服务在 Nacos 上进行注册,gateway 和其他各个服务通过 Nacos 发现和查找目标服务进行访问
  • 各服务将互相调用的断路信息通过 admin server 进行监控
  • 【依赖中间件 redis】 gateway server 根据制定的策略路由到指定服务;路由定义从 Redis 获取,缓存至本地;基于动态路由配置可根据实际情况扩展实现灰度发布
  • 【依赖中间件 redis、kafka】 route server 修改路由信息后更新至 Redis ,通过 Kafka 通知 gateway server 动态更新路由
  • 【依赖中间件 kafka】 oauth server 修改应用配置和参数配置后通过 Kafka 推送 Bus 总线事件,广播通知所有 oauth server 更新缓存
  • 【依赖中间件 kafka】 各深度定制开发的服务通过 kafka 发送日志消息,log serverKafka 中消费消息并进行日志的统一记录
  • 【依赖中间件 kafka、logstash、elasticsearch】 log server 不仅将日志信息记录在本地,还发送给 elasticsearch 进行汇总
  • 【依赖中间件 redis】 包路径中包含 Redis 时,oauth servertoken 信息持久化到 Redis 进行统一认证管理,否则仅持久化到内存
  • 【依赖中间件 zookeeper】 分布式锁,实现 io.gitee.zhangbinhub.acp.cloud.lock.DistributedLock 接口,并注册为Spring Bean ,包路径中包含 curator-recipes 时,默认配置一个基于 zookeeper 的分布式锁实现
  • 需要进行防重请求的 controller 方法上增加注解 io.gitee.zhangbinhub.acp.cloud.annotation.AcpCloudDuplicateSubmission ,默认30秒过期
  • 前后端交互 HttpStatus Code 说明
HttpStatus 描述
200 请求成功
201 资源创建成功
400 业务错误
401 token(登录)失效
403 权限不足
404 找不到资源
500 系统异常

一、环境要求

  • java 17+
  • gradle 7.5+
  • kotlin 1.6+

二、gradle 脚本配置及使用

(一)配置文件

1.gradle/application.gradle

应用模块公共配置

2.gradle/commonTask.gradle

公共自定义任务配置,适用于所有项目模块

3.gradle/dependencies.gradle

定义外部依赖版本号

4.gradle/globalTask.gradle

全局自定义任务配置,适用于顶层项目

5.gradle/moduleVersion.gradle

各子模块版本号

6.gradle/publish.gradle

发布任务配置,适用于所有项目模块

7.settings.gradle

定义项目/模块结构

8.project.properties

gradle全局参数:

  • gradleVersion:gradle版本号
  • group:对应打包时的最外层groupid,最终的groupid还会加上模块路径,例如groupid.acp.core
  • version:版本号
  • encoding:编译字符集
  • mavenCentralUrl:maven中央仓库地址
  • javaVersion:jdk版本号
5.build.gradle

公共构建脚本

(二)自定义任务

  • 全局自定义任务
    • publishAll 发布所有构建至maven中央仓库
    • publishToMavenLocalAll 发布所有构建至maven本地仓库
    • buildImageAll 所有模块打包镜像(Dockerfile模式)
    • bootBuildImageAll 所有模块打包镜像(Spring模式)
  • 公共自定义任务
    • clearPj 清理所有输出文件
    • release 编译、打包并输出
      • 如需编译打包对应环境,命令中使用参数active,例如
        gradlew project:release -Pactive=test
    • buildImage 通过Dockerfile打包镜像
    • pushImage 通过Dockerfile打包镜像并上传

(三)发布至maven仓库

1、发布至本地仓库
  • 执行 publishToMavenLocal 任务
    • publishToMavenLocalAll
2、发布至私服
  • 项目根路径下创建 gradle.properties 并添加如下参数(参数值根据实际情况修改)
mavenUploadUrlRelease=https://maven.com/repositories/releases/
mavenUploadUrlSnapshot=https://maven.com/repositories/snapshot/
mavenUserName=username
mavenPassword=password
  • 执行 publish 任务
    • publishAll
3、发布至中央仓库
  • 项目根路径下创建 gradle.properties 并添加如下参数(参数值根据实际情况修改)
mavenUploadUrlRelease=https://maven.com/repositories/releases/
mavenUploadUrlSnapshot=https://maven.com/repositories/snapshot/
mavenUserName=username
mavenPassword=password
signing.keyId=shortId
signing.password=keyPassword
signing.secretKeyRingFile=keyFile
  • 执行 publish 任务
    • publishAll

(四)升级命令

gradlew wrapper --gradle-distribution-url=https://mirrors.cloud.tencent.com/gradle/gradle-8.6-all.zip

三、工程说明

  • 工程全局默认使用 UTF-8 字符集
  • 工程结构
acp-admin-cloud         -------工程根目录,root模块
├─ common               -------公共模块
├─ deploy               -------部署脚本
├─ doc                  -------文档
├─ gradle               -------gradle脚本
└─ modules              -------子模块路径

四、启停 SpringBoot 应用

命令 描述
./server.sh 查看可用参数
./server.sh status 查看系统运行状态
./server.sh start 启动应用
./server.sh stop 停止应用
./server.sh restart 重启应用

五、基础中间件环境搭建(docker)

  • 启动服务

命令模式依次进入deploy/docker/middleware deploy/docker/elk目录,执行启动命令

docker-compose up -d
  • 停止服务
docker-compose stop
  • 停止并删除容器实例
docker-compose down

六、系统初始化

(一)数据库

  • 服务首次启动时,必要资源数据会自动进行初始化

七、服务列表

(一)acp-admin-cloud-constant

全局静态常量定义 定义服务间内部访问restful路径 定义角色编码 定义功能权限编码 定义路由相关常量 定义token相关常量

(二)acp-admin-cloud-dependencies

  • 普通服务依赖模块
  • 分布式锁实现
  • 全局流水号生成实现
  • 自动配置相关组件
  • 依赖acp-admin-cloud-constant

(三)acp-admin-cloud-dependencies-resource-server

  • 纳入统一认证的服务依赖模块
  • 依赖acp-admin-cloud-dependencies

(四)admin-server

  • 基于SpringBootAdmin的可视化监控,监控服务状态
  • 依赖acp-spring-cloud-starter
  • 其他依赖,请查看build.gradle

(五)gateway-server

  • 网关服务
  • 依赖acp-spring-cloud-starter
  • 其他依赖,请查看build.gradle
  • 动态路由信息保存在 redis

(六)deploy-server

  • 部署服务
  • 依赖acp-spring-cloud-starter-resource-server
  • 其他依赖,请查看build.gradle

(七)log-server

  • 统一日志服务
  • 依赖acp-spring-cloud-starter-resource-server
  • 其他依赖,请查看build.gradle
  • 通过 kafka 收集其余服务的日志信息,统一进行记录
  • 通过 kafka 收集网关消息,记录路由日志
  • 根据配置中心参数,压缩备份日志文件
  • 根据配置中心参数,记录操作日志和登录日志
  • 每日将路由日志、操作日志、登录日志迁移至历史库
  • 根据 oauth 服务中运行参数配置的策略,压缩备份日志文件
  • 提供备份的日志文件查询、下载接口,只有超级管理员有权限访问

(八)oauth-server

  • 统一认证服务
  • 依赖acp-spring-cloud-starter-resource-server
  • 其他依赖,请查看build.gradle
  • 提供全套权限体系服务,包含客户端应用管理、用户管理、机构管理、角色管理、权限管理、token管理、运行参数管理等

(九)route-server

  • 路由服务
  • 依赖acp-spring-cloud-starter-resource-server
  • 其他依赖,请查看build.gradle
  • 提供动态路由策略配置及刷新

(十)workflow-server

  • 工作流引擎服务
  • 依赖acp-spring-cloud-starter-resource-server
  • 其他依赖,请查看build.gradle
  • 提供工作流相关接口服务

(十一)其他自定义服务

  • 不需要统一认证,依赖acp-spring-cloud-starter
  • 需要统一认证,依赖acp-spring-cloud-starter-resource-server

八、Sentinel 动态数据源配置

九、公共配置信息

十、环境变量及启动参数

变量名 描述 默认值 说明
JAVA_TOOL_OPTIONS JVM启动参数 该环境变量在容器部署时使用
acp_profile_active 激活的配置环境 dev 服务器部署时建议java启动命令加入参数 -Dacp_profile_active 或 --acp_profile_active;容器部署时指定环境变量即可
acp_server_port 服务启动端口 0(随机端口) 服务器部署时建议java启动命令加入参数 -Dacp_server_port 或 --acp_server_port;容器部署时指定环境变量即可。服务不需要外部直接访问时,建议保持默认值。注:admin-server默认值:9099,gateway-server默认值:8771
acp_log_path 日志路径 logs/${spring.application.name} 服务器部署时建议java启动命令加入参数 -Dacp_log_path 或 --acp_log_path;容器部署时指定环境变量即可
acp_nacos_addr nacos地址 127.0.0.1:8848 nacos服务地址,ip:port
acp_nacos_username nacos用户名 nacos nacos用户名,默认nacos,可自行在nacos管理端添加用户
acp_nacos_password nacos密码 nacos nacos用户密码,默认nacos,可自行在nacos管理端添加用户
acp_nacos_namespace nacos命名空间 acp-cloud-admin nacos命名空间,默认nacos,可自行在nacos管理端配置

十一、打包OCI镜像

  • 单个模块
    • 打包:buildImage
    • 打包并上传:pushImage
  • 批量
    • 打包:buildImageAll
    • 打包并上传:pushImageAll

十二、容器部署

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.

简介

使用 Kotlin 语言编写,基于 Spring Cloud 的微服务架构。该项目是前后端分离中的"后端部分" 展开 收起
Kotlin 等 4 种语言
Apache-2.0
取消

发行版 (22)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Kotlin
1
https://gitee.com/zhangbinhub/acp-admin-cloud.git
git@gitee.com:zhangbinhub/acp-admin-cloud.git
zhangbinhub
acp-admin-cloud
acp-admin-cloud
master

搜索帮助