2 Star 1 Fork 4

后端研发Marion / marion-micro

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

marion-micro

我的社交资料

微信公众号 微信群(备注:加群)

【Marion-Micro】

微服务模版框架

项目架构图

一、目标

1. 作为传统单体服务改造成微服务架构的模板项目

2. 参考目前主流的模板项目开发

3. 技术栈全面可插拔式引入网关、RPC、服务注册发现、链路追踪、ELK、监控告警、定时任务等

4. 多模块开发,领域驱动设计、设计模式

二、技术选型

1. 开发语言:JAVA / JDK11

2. 数据库:MySQL | Redis | ElasticSearch

3. 开发框架:SpringBoot

4. 开发工具:Gradle/Maven私服

5. 项目部署:Docker/Jinkens/K8s

6. 开源组件:SpringCloud Gateway | OpenFeign | Nacos | Apollo | Sentinel | Sleuth + Zipkin | ELK | XXL-Job | Kafka

7. 性能压测:Jemter | 全链路压测

三、项目结构

技术栈

    1. maven
    1. gitee

1. 目录设计

  • 父模块定义

      1. 子模块定义
      1. 公用依赖和版本控制
        1. springboot版本
        • 2.2.2.RELEASE
        1. lombok版本
        • 1.8.22
        1. mysql驱动版本
        • 8.0.21
        1. JPA版本或者Mybatis-Plus
        • JPA-2.2.2.RELEASE
        1. redis版本
        • 2.2.2.RELEASE
        1. spring-cloud版本
        • Hoxton.SR1
        1. nacos注册中心版本
        • 2.2.1.RELEASE
        1. nacos配置中心版本
        • 2.2.1.RELEASE
      1. 微服务端口定义
        1. gatway:10000
        1. amin: 10010
        1. app: 10020
        1. web: 10030
    1. 公用模块-common
      1. 目的
      • 管理每一个微服务公用的依赖、工具类、错误类、常量、验证错误,方便定位错误项目以及减少工具类的复制粘贴,微服务之间的RPC接口
      1. 依赖
        1. 父子模块依赖如何定义
        1. 父模块定义统一版本,子模块不需要声明版本
        1. 子模块定义
        1. 定义微服务公用的依赖
      1. 子目录
        1. RPC接口
        1. 工具类
        1. 错误类
        1. RPC接口类
      1. 优缺点
        1. 优点:统一管理
        1. 缺点:修改需要更新版本
    1. 核心模块-core
      1. 目的
        1. 参考Spring-Core设计思路,IO操作、反射操作
        1. 只有部分微服务项目依赖
      1. 子目录
      • 核心工具类

          1. 分布式ID
          1. 加解密算法
          1. Jwt令牌
      1. 优缺点
        1. 优点:代码复用
        1. 缺点:新增需要发包,其他包可能不需要
    1. 网关模块-gateway
      1. 目的
        1. 鉴权、限流、负载均衡、统一入口、服务注册发现
        1. 技术选型-SpringCloud Gateway
      1. 问题
        1. 启动依赖报错问题,解决不兼容问题
      1. 依赖说明

         <spring-cloud.version>Hoxton.SR1</spring-cloud.version>
         <spring-boot.version>2.2.2.RELEASE</spring-boot.version>
      1. 集成nacos注册中心与配置中心
        1. 注册中心
          1. 添加依赖
          1. 在 application.properties 中配置 Nacos server 的地址
          • server.port=8070
          • spring.application.name=service-provider
          • spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
          1. 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能
        1. 配置中心
      1. 测试路由转发
        1. 转发报错:java.lang.NoClassDefFoundError: reactor/util/retry/Retry
        • Hoxton.SR1和2.2.2
      1. 定义路由转发规则
        1. /admin -> marion-micro-admin
    1. 后台管理-admin
      1. 目的
        1. 前后端分离的后台管理项目Vue开发
      1. 依赖说明
org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-web mysql mysql-connector-java org.springframework.boot spring-boot-starter-data-jpa com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery com.alibaba.cloud spring-cloud-starter-alibaba-nacos-config org.springframework.boot spring-boot-starter-test test
- 3. 定义数据库连接和接口
- 4. 引入common模块和core模块,取消多余模块
    1. App接口-app
      1. 目的
        1. 提供给APP端接口
        1. 该模块可以拆分成多个微服务模块替换-api
      1. 依赖说明
    1. Web接口-web
      1. 目的
        1. 提供给Web端接口
      1. 依赖说明
    1. 公用模块
      1. 短信模块-sms
      1. 搜索模块-search
      1. 公用三方服务-third-party

2. 项目新建

    1. 新建springboot多模块项目,定义父子模块

3. 依赖管理

四、代码设计

1. 全局异常定义与捕获,定义公共错误返回

    1. @RestControllerAdvice
      1. SpringBoot全局异常,返回JSON数据
    1. @ExceptionHandler
    1. 定义错误类ResponseException
    1. 自定义异常extends RuntimeException
    1. 定义400错误返回,200正常返回
    1. Junit5单元测试和MockMvc测试接口
      1. SpringBoot 测试及 MockMvc的使用

2. 整合swagger接口文档

  • 【CSDN】java集成Swagger的详细步骤

  • 总结错误 No mapping for GET /swagger-ui.html

  • 什么是swagger,一篇带你入门

3. 配置线程池,异步线程池

  • 【CSDN】springboot配置多个线程池

  • SpringBoot 线程池 配置使用

    1. @EnableAsync
    1. 创建ThreadPoolTaskExecutor
    1. 线程池调优

4. 数据主从配置,Durid数据库连接池配置与监控

  • 【github】Druid Spring Boot Starter

  • maven配置阿里云镜像的两种方式

  • druid监控配置

5. 数据库操作工具类,查询分页类公共库封装

6. 整理Kafka消息中间件

  • 【CSDN】Springboot整合kafka

    1. kafka启动命令
    • zookeeper-server-start -daemon /opt/homebrew/etc/kafka/zookeeper.properties & kafka-server-start /opt/homebrew/etc/kafka/server.properties
    1. kafka控制台创建topic
    • kafka 命令行命令大全

      1. 查看topic
      • kafka-topics --bootstrap-server :9092 topic --list
      1. 创建topic
      • kafka-topics --bootstrap-server :9092 --create --replication-factor 1 --partitions 1 --topic demo
      1. 删除topic

7. 集成sentinel

    1. 参考文档
    • sentinel
    1. 操作流程
      1. 启动sentinel命令:
      • nohup java -server -Xms64m -Xmx256m -Dserver.port=8849 -Dcsp.sentinel.dashboard.server=localhost:8849 -Dproject.name=sentinel-dashboard -jar /opt/www/spring-cloud-alibaba/sentinel-dashboard/sentinel-dashboard-1.8.0.jar &
      1. 引入pom
      1. yml配置
      1. 控制台对接口限流测试
      1. 限流规则持久化

8. 集成Prometheus+Grafana实现监控告警

9. 集成xxl-job

五、业务设计

1. 微服务模块拆分、领域驱动设计DDD

2. 数据库ER建模,代码生成器

六、数据中台

七、项目部署

1. 测试多模块打包

    1. 子模块不能加
    1. clean and package
    1. 运行测试

2. docker部署

3. 代码发布

    1. 发布到私服
  • 2.发布到Gitee

4. Jinkens部署

5. K8S部署

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.

简介

1. 作为传统单体服务改造成微服务架构的模板项目 2. 参考目前主流的模板项目开发 3. 技术栈全面可插拔式引入网关、RPC、服务注册发现、链路追踪、ELK、监控告警、定时任务等 4. 多模块开发,领域驱动设计、设计模式 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/zeus-maker/marion-micro.git
git@gitee.com:zeus-maker/marion-micro.git
zeus-maker
marion-micro
marion-micro
master

搜索帮助

14c37bed 8189591 565d56ea 8189591