1 Star 0 Fork 6

tannoy / yfcloud-repo

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

yfcloud-repo

YF组件库

1、Quickstart

1.1、业务场景

  • 自己学习技术可以适当地造一些轮子来练手
  • 业务催得急,研发任务重,还要保障交付质量
  • 使用统一公共组件可以极大提高工作效率和产出质量

1.2、使用建议

  • 作为springboot starter使用
  • 作为第三方jar使用
  • 拷贝java类使用
  • 【规划】结合范例项目来进一步讲解组件的高效使用

2、TODO

2.1、正在推进建设中(在1.5.x版本可以开始逐步试用功能,在1.6.0版本正式发布)

  1. 主数据yfcloud-base-mdm,包括基础,人员,组织,门店
  2. 标准权限模块,参考主数据模块的方式,改造console的实现
  3. 基础服务yfcloud-base-service,包括lbs,mcs的能力
  4. 鉴权sdk和统一异常处理,统一返回包装信息,RPC调用收到包装类后,client负责解析并且抛CustomException异常
  5. 状态机yfcloud-base-statemachine(cola-component-statemachine),移除yfcloud-base-starter-fsm
  6. 基于yfcloud-workflow项目的实践经验,升级spring生态版本和jdk版本
  7. 基于Cola组件(dto,exception,catchlog等)在微服务引擎实现base-starter的必须功能,替换验证ok了再移除yfcloud-base-starter
  8. 正本清源,开始develop分支开发+主分支打tag,推进工具类规整

2.2、待定(考虑清楚后再定)

  1. 在yfcloud-client工程加一个web app模块依赖client模块来跑起来并且提供API接口,轻量级应用不受数据库等环境限制
  2. 流控模块组件,可以将以前的存入数据库和从数据库取作为默认实现方便业务方使用(支持业务自定义实现),再就是替换插入式注解方案(com.sun.tools,jdk11已经去掉了这个包)

3、Repo List

3.1、base

编号 名称 功能 说明
1 yfcloud-base-parent 基础pom 新建项目继承该parent作为pom基础
2 yfcloud-base-api 基础API 常用基础对象
3 yfcloud-base-utils 基础工具类 常用工具类
4 yfcloud-base-starter 框架基础 Base 是核心模块,提供最基础的框架能力
5 yfcloud-base-security 标准权限 提供应用接入鉴权的能力,以及请求上下文管理
6 yfcloud-base-encryption 加密SDK 支持数据AES加密解密
7 yfcloud-base-mdm 标准主数据 基础、人员、组织、门店等
8 yfcloud-base-service 标准基础服务 【建设中】LBS,消息、流程

3.2、micro-service

编号 名称 功能 说明
1 yfcloud-micro-service-starter-server 微服务服务端starter 新建项目建议依赖该starter作为服务端项目基础,
以及批量读和写多源数据库
2 yfcloud-micro-service-starter-client 微服务客户端starter 当前仅依赖了一些组件包

3.3、controller

编号 名称 功能 说明
1 yfcloud-controller-starter-excel-loader 导入导出组件 负责excel导入&导出的公共逻辑, 简化业务研发工作量
2 yfcloud-controller-starter-rocketmq 消息队列组件 提供消息队列操作的最佳实践,包括push和pull
3 yfcloud-controller-starter-postman 请求配置组件 提供请求配置功能,简化第三方调用的开发工作
4 yfcloud-controller-starter-statemachine 状态机组件 计划使用基于cola-component-statemachine的
yfcloud-controller-starter-statemachine
来代替yfcloud-base-starter-fsm
5 yfcloud-controller-starter-traffic 流量控制组件 入口流量和出口流量管控

3.4、toolkit

编号 名称 功能 说明
1 yfcloud-toolkit-starter-redis redis分布式缓存 支持轻量级直接操作redis,支持注解方式操作
2 yfcloud-toolkit-starter-elasticsearch ES搜索 ES搜索的常用操作的最佳实践
3 yfcloud-toolkit-starter-oss 文件服务starter 支持快速使用文件服务

3.5、apm

编号 名称 功能 说明
1 yfcloud-apm-logx 日志能力组件 当前仅支持阿里云SLS
2 yfcloud-apm-trace 全链路日志组件(老) 非springboot项目可以使用该组件
3 yfcloud-apm-starter-endpoint 全链路日志组件(新) springboot项目可以使用该组件

4、Releases

1.5.0:2023年08月25日开始

  • 多数据源和权重随机访问
  • 强事务管理和写事务走主库
  • 分布式主键id生成:支持多节点
  • 消息队列组件:Pull、Push
  • 业务鉴权SDK组件:2B2C2S,JWT
  • 数据加密解密SDK组件:AES对称加密

1.4.0:2023年06月30日开始

  • 代码生成(Mybatis-plus-generator)
  • 多功能查询(LambdaQueryWrapper)
  • 强事务管理(Spring事务注解解析器)
  • Mybatis-Plus组件:乐观锁、逻辑删除、分页
  • 通用请求配置组件:消息中心项目落地

1.3.0:2023年05月05日开始

  • 兼容Openx接口的多字段模式
  • 日志接入组件:Springboot无感接入、华为云日志
  • 通用导入导出组件:商品多个项目落地

1.2.0:2023年02月23日开始

  • 通用导入导出组件

1.1.0:2022年10月08日开始

  • 日志接入组件:Spring无感接入,阿里云日志
  • 链路接入组件:Skywalking全链路

1.0.0:2022年09月07日开始

  • 适配现状定制开发支持落地
  • Elasticsearch分布式搜索组件
  • Redis分布式缓存组件
  • 消息队列Stream组件
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.

简介

组件库 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/tannoy/yfcloud-repo.git
git@gitee.com:tannoy/yfcloud-repo.git
tannoy
yfcloud-repo
yfcloud-repo
1.5.0

搜索帮助