https://github.com/weweibuy/weweibuy-framework

https://github.com/weweibuy/weweibuy-framework

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/weweibuy/weweibuy-framework
• Owner: weweibuy
• Created: 2024-06-16T11:28:42.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-18T14:20:23.000Z (over 1 year ago)
• Last Synced: 2024-08-05T17:36:43.667Z (over 1 year ago)
• Language: Java
• Size: 14.2 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-hacking-lists - weweibuy/weweibuy-framework - 基于Springboot 封装的基础组件, 包括: Http请求响应日志,日志脱敏,APM, 加解密,签名(AES,BCrypt,RSA,JWT),数据库脱敏,报文脱敏,下滑线风格URL传参,统一异常处理,feign mock,feign日志,feign报文风格转换,跨应用异常上抛,自动补偿组件,幂等组件,RocketMq客户端 (Java)

README

          

 

weweibuy-framework 

--------

### weweibuy-framework 提供一些基于SpringBoot 2X 封装的基础组件, 包括日志,脱敏,http调用,幂等,补偿,MQ,加解密,Excel,CSV等功能,涵盖了日常开发中基础框架所应对的大部分场景;

### 1. 核心 common-core

  核心模型,异常,常用工具等

  

### 2. codec common-codec

  整理常用的加解密,签名工具(AES,BCrypt,RSA,JWT)等,并将其封装为可以直接使用的工具  

### 3. 日志 common-log

  完全无侵入的实现: 输出Http请求响应日志,日志脱敏,日志APM等功能的组件  

  适用场景:  

  - 对于Http请求我们需要输出请求/响应数据,特定请求可以屏蔽日志(如响应Base64图片)

  - 对请求响应日志部分字段进行脱敏

  - 日志链路追踪APM功能(并且在多线程下也能正常使用)

  - 日志策略分环境, 非开发环境不输出控制台日志

- [common-log](./common/common-log/README.md)：common-log 介绍

### 4. 数据库 common-db

  基于Mybatis无侵入的实现,数据库敏感字段的脱敏/加解密与多数源功能  

  适用场景:   

   - 数据库中存储敏感信息时对其脱敏 

   - 密码进行不可逆加密

   - 身份证进行可逆加密   

   - 通过简单配置实现多数据源功能

*  [common-db](./common/common-db/README.md)：common-db 介绍

### 5. mvc扩展 common-mvc

  封装了报文脱敏,下滑线风格URL传参,统一异常处理  

  适用场景: 

   - 下滑线风格的url请求参数,将其绑定到小驼峰的Java对象属性上  

      eg: localhost/oauth/token?client_id=demoClientId 将client_id映射成clientId

   - Http响应报文部分字段脱敏(如:手机号)

   - 统一异常处理,上抛Feign调用异常

*  [common-mvc](./common/common-mvc/README.md) ：介绍common-mvc

### 6. feign调用 common-feign

  该组件是在SpringCloudFeign提供的功能扩展点上进行扩展,所有的设计思想继承了SpringCloudFeign. 在此基础上  

  实现了调用mock,无侵入日志输出,报文风格转换,跨应用异常上抛,调用APM等功能  

  适用场景:

   - 希望输出feign请求,响应日志  

   - 对接不同的系统,其接口报文风格为下划线风格,希望无侵入的互相映射

   - 对接方接口还没好,我们可以无侵入的Mock接口数据,先跑通自己这边逻辑

   - APM,异常信息跨应用上抛

*  [common-feign](./common/common-feign/README.md)：介绍common-feign。

### 7. common-util 通用工具

#### 7.1 common-util-csv CSV工具

  面向对象,基于注解,简单高效的CSV导入导出工具

*  [common-util](./common/common-util/README.md) ：介绍common-util  

### 8. 补偿机制 compensate

  基于注解的适用于异步场景的失败自动补偿组件  

   适用场景: 

   - 如A服务调用B服务,B服务在做完主业务流程后,在B服务内部需要异步执行B-1任务,若B-1任务失败希望有机制可以重试  

   - 重试机制可以灵活配置 

*  [compensate](./compensate/README.md) ：介绍compensate

### 9. 幂等

  基于注解的,对代码几乎无侵入的幂等组件,开箱即用,简单易用,同时支持数据库与Redis做幂等的场景  

*  [idempotent](./idempotent/README.md) ：介绍idempotent

### 10. rocketMQ 客户端 

  基于注解形式的RocketMq客户端封装组件,开箱即用,简单易用,符合正常开发习惯,可以极大简化消息发送/接收,支持:   

  - 同步发送  

  - 异步发送  

  - one-way发送   

  - 顺序发送   

  - 顺序消费  

  - 批量发送  

  - 批量消费  

  - 并发消费(广播/集群)  

  - TAG过滤   

  - 内置发送/消费日志,并且可以可自行扩展或添加功能     

*  [rocketMQ](./rocketmq/README.md) ：介绍rocketMQ客户端