1 Star 0 Fork 32

Allen / yc-framework

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

YC FrameWork

一、理念

致力于打造一款优秀的分布式微服务解决方案。

二、特性

  • 让开发分布式微服务应用更简单;
  • 让部署分布式微服务应用更简单;
  • 集成众多行业领域优秀的解决方案;
  • 微服务更易实现高可用、高性能、高并发。

三、架构思想

  • 模块化;
  • 简单化;
  • 自动化;
  • 易扩展;
  • 轻量级;
  • 自由且包容。

四、技术架构

技术架构图

五、技术选型

  • JDK版本:1.8;
  • 项目依赖管理:Maven3.6.2;
  • 版本控制工具:Git;
  • 分布式框架:SpringCloud+SpringCloud Alibaba;
  • 微服务基础框架:SpringBoot;
  • 接口鉴权框架:Sa-Token;
  • 缓存:Redis;
  • 关系型数据库:MySQL;
  • 接口文档自动生成框架:Knife4j;
  • 持久层框架:MyBatis-Plus;
  • 第三方工具类框架:Hutool;
  • 数据库连接池:Druid;
  • 多数据源框架:dynamic-datasource-spring-boot-starter;
  • 限流熔断:Sentinel;
  • 分库分表中间件:ShardingJdbc、MyCat;
  • 爬虫框架:JSOUP/WebMagic;
  • 日志框架:Lombok;
  • Excel处理:Apache Poi、EasyPoi;
  • 分布式定时任务:Quartz、Xxl-Job、Elastic-Job、ShedLock;
  • 服务链路追踪:SpringCloud Sleuth+Zipkin;
  • Word模板引擎:Poi-tl;
  • 消息队列:Kafka、ActiveMQ、RabbitMQ、RocketMQ;
  • 大数据存储与计算处理:Hadoop;
  • 分布式搜索引擎:Elastic Search;
  • 文档数据库:MongoDB;
  • SOA:Apache CXF;
  • 服务注册与配置中心:Nacos、Eureka、Dubbo;
  • 支付:IJPay;
  • 微信生态支持:WxJava;
  • 多种通信支持:gRPC、HTTP、WebSocket等;
  • 分布式处理引擎:Apache Flink;
  • 文件存储:私有云或公有云均支持;
  • 单元测试框架:Junit;
  • 分布式事务:Seata、Tx-LCN;
  • 规则引擎:Drools、LiteFlow;
  • 通信框架:Netty、Smart Socket。

六、系统模块

├── yc-gateway         // 网关服务 [8080]
├── yc-auth            // 认证服务 [8081]
├── yc-api             // 接口服务
├── yc-common          // 通用模块
│       └── yc-common-core                    // 核心模块
│       └── yc-common-knife4j                 // 接口文档自动生成模块
│       └── yc-common-redis                   // Redis模块
│       └── yc-common-security                // 安全模块
│       └── yc-common-elasticsearch           // ElasticSearch模块
│       └── yc-common-mongodb                 // MongoDB模块
│       └── yc-common-rabbitmq                // RabbitMQ模块
│       └── yc-common-activemq                // ActiveMQ模块
│       └── yc-common-kafka                    // Kafka模块
│       └── yc-common-rocketmq                 // RocketMQ日志模块
│       └── yc-common-wx                       // 微信生态模块
│       └── yc-common-crawler                  // 爬虫模块
│       └── yc-common-seata                    // 分布式事务Seata模块
│       └── yc-common-txlcn                    // 分布式事务Tx-LCN模块
│       └── yc-common-quartz                   // 分布式定时任务Quartz模块
│       └── yc-common-xxljob                   // 分布式定时任务xxl-job模块
│       └── yc-common-logstash                 // 分布式日志管理(ELK)模块
│       └── yc-common-pay                      // 第三方支付模块
│       └── yc-common-hadoop                   // 大数据Hadoop模块
│       └── yc-common-flink                    // 分布式计算引擎模块
│       └── yc-common-netty                    // Netty模块
│       └── yc-common-openfeign                // 分布式微服务通信模块
│       └── yc-common-mp                       // MyBatis-Plus模块
│       └── yc-common-linktrack                // 分布式链路追踪模块
│       └── yc-common-cs                       // 对象云存储模块
│       └── yc-common-monitor                  // 微服务监控模块
│       └── yc-common-test                     // 单元测试模块
│       └── yc-common-nacos                    // nacos模块
│       └── yc-common-eureka                   // eureka模块
│       └── yc-common-cxf                      //  webservice模块
│       └── yc-common-sentinel                 //  sentinel模块
│       └── yc-common-shardingjdbc             //  shardingjdbc模块
│       └── yc-common-dubbo                    //  dubbo模块
│       └── yc-common-grpc                     //  grpc模块
│       └── yc-common-liteflow                 //  liteflow模块
│       └── yc-common-shedlock                 //  shedlock模块
│       └── yc-common-easypoi                 //  easypoi模块
│       └── yc-common-smart-socket             //  smart-socket模块
│       └── yc-common-dynamic-tp                 //  dynamic-tp 模块
│       └── yc-common-easyes                 //  easyes模块
│       └── yc-common-easypdf                 //  easypdf模块
│       └── yc-common-gobrs-async              //  gobrs-async模块
│       └── yc-common-image-combiner          //  image-combiner模块
│       └── yc-common-influxdb                //  influxdb模块
│       └── yc-common-neo4j                   //  neo4j模块
│       └── yc-common-sqlserver                //  sqlserver模块
│       └── yc-common-dmjdbc                //  dmjdbc模块
│       └── yc-common-clickhouse               //  clickhouse模块
│       └── yc-common-couchbase               //  couchbase模块


├── yc-modules           // 微服务模块
│       └── yc-admin                              // 统一用户微服务 [9000]
│       └── yc-cms                                // 内容管理微服务 [9001]
│       └── yc-crawler                            // 爬虫微服务 [9002]
│       └── yc-file                               // 文件微服务 [9003]
│       └── yc-job                                // 定时任务服务 [9004]
│       └── yc-plugins                            // 插件微服务 [9005]
│       └── yc-wechat                             // 微信生态微服务 [9006]
│       └── yc-monitor-server                     // 监控微服务 [9100]
│       └── yc-code-generator                     // 代码生成器工具
│       └── yc-xjar                               // jar包加密微服务[9007]

├──pom.xml  
       
├── yc-ui         // YC-Framework后台管理系统      

七、功能

当前版本所具有的功能如下:

  • 用户登录/注册、登录状态、用户信息、退出;
  • 微服务接口鉴权模块化;
  • 数据爬虫(博客园、思否、CSDN等网站数据);
  • 用户管理;
  • CMS基础功能(文章管理、分类管理、标签管理等;
  • 文件管理;
  • 接口文档模块化;
  • Sentinel限流熔断;
  • 分布式Token;
  • 默认集成博客园、聚合等第三方API;
  • Redis模块化;
  • ElasticSearch模块化;
  • 消息队列RabbitMQ模块化;
  • MongoDB模块化;
  • 消息队列ActiveMQ模块化;
  • 微服务日志模块化(支持MySQL、MongoDB等数据存储仓库);
  • 接口文档网关统一化;
  • 微信生态(支持微信公众号、微信支付、微信开放平台、微信小程序、企业号/企业微信等)模块化;
  • Admin Server微服务监控模块化;
  • 分布式事务Seata模块化;
  • 分布式事务Tx-LCN模块化;
  • 消息队列Kafka模块化;
  • 消息队列RocketMQ模块化;
  • 分布式定时任务Xxl-Job模块化;
  • 微信生态方案模块化;
  • 分布式定时任务Elastic-Job模块化;
  • Quartz定时任务模块化;
  • 爬虫模块化;
  • 分布式链路追踪模块化;
  • Hadoop模块化;
  • 分布式日志管理(ELK)模块化;
  • Apache Flink模块化;
  • Netty模块化;
  • OpenFeign模块化;
  • 第三方支付模块化;
  • 单元测试模块化;
  • MyBatis-Plus模块化;
  • 对象云存储模块化;
  • Nacos模块化;
  • Eureka模块化;
  • Apache CXF模块化;
  • Sentinel模块化;
  • Shardingjdbc模块化;
  • Dubbo模块化;
  • gRPC模块化;
  • Shedlock模块化;
  • Drools模块化
  • LiteFlow模块化;
  • EasyPoi模块化;
  • Smart-Socket模块化;
  • 代码生成器;
  • Jar包加密;
  • 支持Dromara生态;
  • 支持国产分布式数据库;
  • 支持开源主流分布式数据库;
  • 例子覆盖60%(yc-example)。

本次版本V1.0.10更新

  • 1.精简与完善Example
  • 2.鉴权体系精确到接口级别
  • 3.文档全面更新
  • 4.增加JWT插件
  • 5.修复若干bug
  • 6.增加国密算法(SM2 SM3 SM4)
  • 7.升级:
    • (1)LiteFlow升级2.9.3
    • (2)Sa-Token升级1.32.0
    • (3)Wx-Java升级4.4.0
    • (4)Smart-Socket升级1.6.0
    • (5)ShedLock升级4.42.0
    • (6)T-Log升级1.5.0
    • (7)IJPay升级2.9.4
    • (8)Image Combiner升级2.3.7
    • (9)Gobrs Async升级1.2.3-RELEASE
    • (10)ElasticJob升级3.0.2
    • (11)Easy-Poi升级4.4.0
    • (12)Dynamic-Tp升级1.0.9
    • (13)Easy-ES升级1.0.3
    • (14)Dubbo升级3.1.2
    • (15)WebMagic升级0.7.6

八、环境

1.开发环境

  • IDE:IntelliJ IDEA 2018.2+版本以上均支持;
  • DB:MySQL5.7.x或MySQL8.x版本均支持;
  • JDK:1.8;
  • Maven: 3.x版本均支持;
  • Nacos:1.3.x版本均支持;
  • Redis: 5.x版本均支持;
  • MongoDB:4.x版本均支持;
  • ElasticSearch:7.x版本均支持;
  • RabbitMQ:3.x版本均支持;
  • ActiveMQ:5.x版本均支持;
  • Kafka:2.x版本均支持;
  • RocketMQ:4.x版本均支持;
  • Seata:1.3.x版本均支持;
  • Tx-LCN:5.x版本均支持;
  • Xxl-Job:2.x版本均支持;
  • Zipkin:2.x版本均支持;
  • Elastic-Job:3.x版本支持;
  • Hadoop:3.3.1版本支持。
  • ELK:7.4.0版本支持。

2.服务器部署环境

  • DB:MySQL5.7.x或MySQL8.x版本均支持;
  • JRE:JRE1.8;
  • Nacos:1.3.x版本均支持;
  • Redix:5.x版本均支持;
  • MongoDB:4.x版本均支持;
  • ElasticSearch:7.x版本均支持;
  • RabbitMQ:3.x版本均支持;
  • ActiveMQ:5.x版本均支持;
  • Kafka:2.x版本均支持;
  • RocketMQ:4.x版本均支持;
  • Seata:1.3.x版本均支持;
  • Tx-LCN:5.x版本均支持;
  • Xxl-Job:2.x版本均支持;
  • Zipkin:2.x版本均支持;
  • Elastic-Job:3.x版本支持;
  • Hadoop:3.3.1版本支持;
  • ELK:7.4.0版本支持;
  • 操作系统:Windows Server和Ubuntu、CenOS等均支持。

九、项目启动

项目启动顺序分别为:

  • yc-gateway;
  • yc-auth;
  • yc-admin;
  • yc-cms;
  • yc-crawler;
  • yc-file;
  • yc-job;
  • yc-plugins;
  • yc-wechat。

其中涉及数据爬虫相关,必须确保yc-crawler、yc-plugins、yc-job等运行起来才行。

注意: 通过爬虫获取的数据只能用于个人学习研究,不能用于任何的商业用途,违反者,后果自负。

十、官方文档

文档地址: http://framework.youcongtech.com/

开源作者博客: https://youcongtech.com/

开源作者博客关于YC-Framework相关: https://youcongtech.com/tags/YC-Framework/

欢迎关注官方微信公众号:

微信公众号

YC-Framework技术交流群,请添加如下(添加请备注技术交流):

微信公众号

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 (c) 2021<a href="http://www.ycframework.net">YC-Framework</a> All rights reserved. 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.

简介

致力于打造一款优秀的分布式微服务解决方案 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/sxhjlzl/yc-framework.git
git@gitee.com:sxhjlzl/yc-framework.git
sxhjlzl
yc-framework
yc-framework
main

搜索帮助