Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
shimingxy committed Aug 30, 2024
1 parent 5678831 commit d3430a9
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 42 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,25 @@

![pathRoleMatcher](docs/_images/PathRoleMatcher.svg)

##### Compare
##### Framework Sample Support

- [x] Sureness integration **Spring Boot** sample(configuration file scheme) [sample-bootstrap](sample-bootstrap)
- [x] Sureness integration **Spring Boot** sample(database scheme) [sample-tom](sample-tom)
- [x] Sureness integration **Quarkus** sample [sample-quarkus](samples/quarkus-sureness)
- [x] Sureness integration **Javalin** sample [sample-javalin](samples/javalin-sureness)
- [x] Sureness integration **Ktor** sample [sample-ktor](samples/ktor-sureness)
- [x] Sureness integration **Spring Webflux** sample [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] Sureness integration **Micronaut** sample [sample-micronaut](samples/micronaut-sureness)
- [x] Sureness integration **Jfinal** sample [sample-jfinal](samples/jfinal-sureness)
- [x] Sureness integration **Solon** sample [sample-solon](samples/solon-sureness)
- [x] Sureness integration **Spring Gateway** sample [sample-spring-gateway](samples/spring-gateway-sureness)
- [x] Sureness integration **Zuul** sample [sample-zuul](samples/zuul-sureness)
- [x] Sureness integration Session sample [sureness-session](samples/sureness-session)
- [x] Sureness integration Redis Session cache sample [sureness-redis-session](samples/sureness-redis-session)
- [x] More samples todo

## security framework Compare
##### Sureness VS Shiro VS Spring Security

| ~ | Sureness | Shiro | Spring Security |
| --- | --- | --- | --- |
Expand All @@ -61,26 +79,7 @@

**Benchmark test shows Sureness to lose 0.026ms performance compared to frameless application, Shiro lose 0.088ms, Spring Security lose 0.116ms.**
**In contrast, Sureness basically does not consume performance, and the performance (TPS loss) is 3 times that of Shiro and 4 times that of Spring Security.**
**The performance gap will be further widened as the api matching chain increases.**

Detail see [Benchmark Test](https://github.com/tomsun28/sureness-shiro-spring-security-benchmark)

##### Framework Sample Support

- [x] Sureness integration **Spring Boot** sample(configuration file scheme) [sample-bootstrap](sample-bootstrap)
- [x] Sureness integration **Spring Boot** sample(database scheme) [sample-tom](sample-tom)
- [x] Sureness integration **Quarkus** sample [sample-quarkus](samples/quarkus-sureness)
- [x] Sureness integration **Javalin** sample [sample-javalin](samples/javalin-sureness)
- [x] Sureness integration **Ktor** sample [sample-ktor](samples/ktor-sureness)
- [x] Sureness integration **Spring Webflux** sample [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] Sureness integration **Micronaut** sample [sample-micronaut](samples/micronaut-sureness)
- [x] Sureness integration **Jfinal** sample [sample-jfinal](samples/jfinal-sureness)
- [x] Sureness integration **Solon** sample [sample-solon](samples/solon-sureness)
- [x] Sureness integration **Spring Gateway** sample [sample-spring-gateway](samples/spring-gateway-sureness)
- [x] Sureness integration **Zuul** sample [sample-zuul](samples/zuul-sureness)
- [x] Sureness integration Session sample [sureness-session](samples/sureness-session)
- [x] Sureness integration Redis Session cache sample [sureness-redis-session](samples/sureness-redis-session)
- [x] More samples todo
**The performance gap will be further widened as the api matching chain increases.**Detail see [Benchmark Test](https://github.com/tomsun28/sureness-shiro-spring-security-benchmark)

## Quick Start

Expand Down
42 changes: 21 additions & 21 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,25 @@

![pathRoleMatcher](docs/_images/PathRoleMatcher.svg)

##### 鉴权框架对比
##### 框架支持样例

- [x] Sureness集成**Spring Boot**样例(配置文件方案) [sample-bootstrap](sample-bootstrap)
- [x] Sureness集成**Spring Boot**样例(数据库方案) [sample-tom](sample-tom)
- [x] Sureness集成**Quarkus**样例 [sample-quarkus](samples/quarkus-sureness)
- [x] Sureness集成**Javalin**样例 [sample-javalin](samples/javalin-sureness)
- [x] Sureness集成**Ktor**样例 [sample-ktor](samples/ktor-sureness)
- [x] Sureness集成**Spring Webflux**样例 [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] Sureness集成**Micronaut**样例 [sample-micronaut](samples/micronaut-sureness)
- [x] Sureness集成**Jfinal**样例 [sample-jfinal](samples/jfinal-sureness)
- [x] Sureness集成**Solon**样例 [sample-solon](samples/solon-sureness)
- [x] Sureness集成**Spring Gateway**样例 [sample-spring-gateway](samples/spring-gateway-sureness)
- [x] Sureness集成**Zuul**样例 [sample-zuul](samples/zuul-sureness)
- [x] Sureness使用Session样例 [sureness-session](samples/sureness-session)
- [x] Sureness分布式缓存Session样例 [sureness-redis-session](samples/sureness-redis-session)
- [x] More samples todo

## 鉴权框架对比
##### Sureness VS Shiro VS Spring Security

| ~ | Sureness | Shiro | Spring Security |
| --- | --- | --- | --- |
Expand All @@ -61,26 +79,8 @@

**基准测试显示Sureness对比无权限框架应用损耗0.026ms性能,Shiro损耗0.088ms,Spring Security损耗0.116ms,
相比之下Sureness性能(参考TPS损耗)是Shiro的3倍,Spring Security的4倍**
**性能差距会随着api匹配链的增加而进一步拉大**
详见[基准测试](https://github.com/tomsun28/sureness-shiro-spring-security)

##### 框架支持样例

- [x] Sureness集成**Spring Boot**样例(配置文件方案) [sample-bootstrap](sample-bootstrap)
- [x] Sureness集成**Spring Boot**样例(数据库方案) [sample-tom](sample-tom)
- [x] Sureness集成**Quarkus**样例 [sample-quarkus](samples/quarkus-sureness)
- [x] Sureness集成**Javalin**样例 [sample-javalin](samples/javalin-sureness)
- [x] Sureness集成**Ktor**样例 [sample-ktor](samples/ktor-sureness)
- [x] Sureness集成**Spring Webflux**样例 [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] Sureness集成**Micronaut**样例 [sample-micronaut](samples/micronaut-sureness)
- [x] Sureness集成**Jfinal**样例 [sample-jfinal](samples/jfinal-sureness)
- [x] Sureness集成**Solon**样例 [sample-solon](samples/solon-sureness)
- [x] Sureness集成**Spring Gateway**样例 [sample-spring-gateway](samples/spring-gateway-sureness)
- [x] Sureness集成**Zuul**样例 [sample-zuul](samples/zuul-sureness)
- [x] Sureness使用Session样例 [sureness-session](samples/sureness-session)
- [x] Sureness分布式缓存Session样例 [sureness-redis-session](samples/sureness-redis-session)
- [x] More samples todo

**性能差距会随着api匹配链的增加而进一步拉大** , 详见[基准测试](https://github.com/tomsun28/sureness-shiro-spring-security)


## 快速开始

Expand Down

0 comments on commit d3430a9

Please sign in to comment.