Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
# BuzhouKit
##### An idempotent component
##### 一个简单的幂等组件库
##### A Lightweight Idempotent Component
##### 轻量级幂等组件库

> ##### *西北海之外，大荒之隅，有山而不合，名曰不周负子，有两黄兽守之。有水曰寒署之水。水西有湿山，水东有幕山。*
> ##### <div align="right"><em>—— 《山海经》海经·大荒西经</em></div>
## 项目概述

**BuzhouKit** 是一款专为确保幂等性设计的组件库。此库适用于需要保证操作重复性和一致性的应用场景，为开发者提供一个可靠、稳定的基础设施。
### 配置/如何使用
### 1，代码配置
##### 方法一（将代码配置到本地maven仓库）
1，将代码克隆/下载到本地
2，在BuZhouKit\BuZhouKit-Idempotent>目录下运行`mvn clean install`
##### 方法二（推荐，将代码作为你的项目的一个模块来使用）
1，将代码克隆/下载到本地
2，将代码copy到项目某模块中
### 2，组件使用
简而言之就是在需要实现幂等的方法上添加幂等注解@Idempotent，再配置所需的参数。
下面主要讲解核心参数的含义与使用：
1，

### 参数类型选择
1,缓存类型选择：1，基于caffeine组件的本地缓存；2，基于redis的分布式缓存