1 Star 0 Fork 11

dou dou / martin

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

Martin

spring cloud企业级微服务,开箱即用

带你领略spring boot、spring cloud 之美


体验地址

https://martin.java2e.com/

技术架构图

在这里插入图片描述

技术栈

  • spring boot
  • spring cloud
  • mybatis plus
  • oauth2.0
  • nacos
  • sentinel
  • skywalking
  • redis
  • minio
  • elk
  • spring boot admin
  • swagger
  • docker
  • docker compose

背景

为什么有了那么多优秀的spring cloud开源项目了,我还要再自己做一个呢?

问君哪得清如许,为有源头活水来。

正如这句名言所讲,水清是因为有源头活水,用到架构设计、写代码上,也是一个道理,要想写出好的代码,就必须到源头学习。spirng boot官方英文文档就是 spring boot 最好的学习源头,而翻译它官方的文档,就是最好的实践。我阅读了spirng boot官方英文文档,翻译了spring boot 官网多篇技术文章,在做了上述两件事之后,我开始调研国内外开源的 spring boot 项目,对比了gitee、github上五个比较优秀的开源项目,从这几个开源项目里也学到了很多优秀的思想与技术,比如mybatis-plus、ouath2.0、jwt、项目结构划分等等。

看过的开源项目地址如下:

1. iBase4J       https://gitee.com/iBase4J/iBase4J
2. guns         https://gitee.com/stylefeng/guns 
3. pig          https://gitee.com/log4j/pig
4. paascloud-master https://github.com/paascloud/paascloud-master
5. piggyMetrics    https://github.com/sqshq/PiggyMetrics

解决哪些问题

项目结构规划不合理

项目结构规划对整个开发周期来说,有着决定性的作用,一个好的结构设计,对后期开发和维护项目有着很友好辅助作用,项目划分的越细,做的越大,体现的越明显。下面看看我看的这几个开源项目的一个划分思路:

  • iBase4J 在这里插入图片描述

  • guns
    在这里插入图片描述

  • pig 在这里插入图片描述

  • paascloud-master 在这里插入图片描述

  • piggyMetrics 在这里插入图片描述

总结:

这几个项目的架构设计划分上,各有千秋,我无权说哪个好,哪个差,有的更偏向按业务划分,有的更偏向按技术划分,我个人结合这几个项目,加自己多年的开发经验,为 Martin做了如下结构设计:

----> Martin

    ----> Martin-biz(各种资源、业务模块)
        ----> Martin-biz-auth     (定义整个项目认证模块)
        ----> Martin-biz-resource (示例资源模块)
        ----> Martin-biz-sso       (示例单点登录模块)
        ----> Martin-biz-swagger   (示例接口文档模块)
        ----> Martin-biz-system    (定义整个项目核心业务、系统功能)
       

    ----> Martin-cloud(各种 spring cloud 模块)
        ----> Martin-cloud-gateway  (网关)
        ----> Martin-cloud-nacos    (注册、配置中心)

    ----> Martin-common(各种公共组件模块)
        ----> Martin-common-api     (暴露整个项目各个模块开放的api)
        ----> Martin-common-bean    (暴露整个项目核心系统的bean)
        ----> Martin-common-bom     (约定整个项目jar版本)
        ----> Martin-common-core    (定义整个项目核心ar)
        ----> Martin-common-data    (约定整个项目缓存、mybatis-plus)
        ----> Martin-common-feign   (约定整个项目远程通信方式)
        ----> Martin-common-log     (定义整个项目日志输出)
        ----> Martin-common-security(控制整个项目安全策略)
        ----> Martin-common-sentinel(约定整个项目流控组件为sentinel)
        ----> Martin-common-swagger (配置整个项目接口文档)

    ----> Martin-extension(各种拓展模块)
        ----> Martin-extension-generator     (代码生成)
        ----> Martin-common-monitor          (系统监控)
        ----> Martin-common-skywalking       (skywalking消息推送)

下面看看 eureka 管理端展示图吧!所有服务从上至下有序排列,一目了然! 在这里插入图片描述

jar包引用不合理

有的项目中jar引入过多,导致最终打出的jar包有点大。Martin中尽量只引入必须的包,比如想使用 spring boot 的一些基础功能,只引入spring-boot-starter,后面用到什么引入什么,做到最小化引入。

spring boot 使用不简洁、规范

得益于对 spring boot 官方教程的翻译工作,对 srpig boot 的基础实用有了一定了解, spring boot 最核心的功能是“自动装配”,有的开源项目中并未发挥该优势,还在基于 spring mvc 做技术架构设计。Martin中但凡是第三方功能,都不需要Enalbe*去开启相应功能,比如swagger、oauth-resource等等,均为自动配置,Martin 默认为martin-biz模块下的所有模块开启这些功能,可通过修改配置文件一键关闭。所有新增的biz模块,只需要像搭建最简单的 spring boot 项目那样,写一个启动类,然后开心的写业务模块。

项目端口规划

----> Martin

    ----> Martin-biz:94**(各种资源、业务模块)
        ----> Martin-biz-auth:9400     (定义整个项目认证模块)
        ----> Martin-biz-resource:9401 (示例资源模块)
        ----> Martin-biz-sso:9402      (示例单点登录模块)
        ----> Martin-biz-swagger:9403   (示例接口文档模块)
        ----> Martin-biz-system:9404    (定义整个项目核心业务、系统功能)
       

    ----> Martin-cloud(各种 spring cloud 模块)
        ----> Martin-cloud-gateway:9527  (网关)
        ----> Martin-cloud-nacos:8848    (注册、配置中心)


    ----> Martin-extension:96**(各种拓展模块)
        ----> Martin-extension-generator:9601     (代码生成)
        ----> Martin-common-monitor:9602          (系统监控)
        ----> Martin-common-skywalking:9603       (skywalking消息推送)
        ----> skywalking-ui:9604       (skywalking消息推送)

开关特性

spring boot最核心的特性是自动装配,这个特性在spring boot 本身,以及很多开源项目上得到了广泛使用,大部分非spring boot的第三方代码,都是用enable***来开启功能。诸君想过这么做的后果是什么吗?硬编码,对,会导致在代码里硬编码,要开启或者关闭某些功能,就只能改代码。

Martin Cloud对这一现象做了改进、优化,将一切用到的特性,封装成可配置开关,只需修改nacos配置即可实时生效!

在这里插入图片描述

feign链路加密

为了暴露出来的feign接口更加安全,Martin Cloud对所有Feign调用配置了秘钥,可在配置文件动态修改。 在这里插入图片描述

管理端支持全字段搜索、排序

管理端每个功能都支持全字段搜索、排序。

  • 排序 在这里插入图片描述
  • 搜索 在这里插入图片描述

演示图片

  • 用户管理 在这里插入图片描述
  • 角色管理 在这里插入图片描述
  • 部门管理 在这里插入图片描述
  • 菜单管理 在这里插入图片描述
  • 操作日志管理 在这里插入图片描述
  • 服务监控 在这里插入图片描述 在这里插入图片描述 在这里插入图片描述

在这里插入图片描述

  • redis监控 在这里插入图片描述
  • 链路追踪 在这里插入图片描述

微信二维码

如需详细部署、使用资料,请点star后,截图给下面微信联系人。 在这里插入图片描述

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 2019 martin 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.

简介

spring cloud企业级一站式微服务解决方案,开箱即用 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/hugosz/martin.git
git@gitee.com:hugosz/martin.git
hugosz
martin
martin
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891