From ff3ce7daa5fd5cd81a9b86e39ad917048a922e92 Mon Sep 17 00:00:00 2001 From: click33 <2393584716@qq.com> Date: Mon, 29 Dec 2025 01:44:28 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=9B=BE=E7=89=87=E5=9C=B0=E5=9D=80?= =?UTF-8?q?=E6=9B=B4=E6=8D=A2=E4=B8=BA=E6=9C=AC=E5=9C=B0=E6=96=87=E4=BB=B6?= =?UTF-8?q?=20(=E9=99=84=E5=BD=95=E7=AF=87)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- sa-token-doc/fun/auth-flow.md | 6 ++--- sa-token-doc/fun/curr-domain.md | 6 ++--- sa-token-doc/fun/git-pr.md | 24 ++++++++++---------- sa-token-doc/fun/sa-token-context--backup.md | 2 +- sa-token-doc/fun/sa-token-context.md | 2 +- sa-token-doc/fun/session-model.md | 2 +- sa-token-doc/more/join-group.md | 6 ++--- sa-token-doc/more/sa-token-donate.md | 3 ++- 8 files changed, 25 insertions(+), 26 deletions(-) diff --git a/sa-token-doc/fun/auth-flow.md b/sa-token-doc/fun/auth-flow.md index ae0f1b14..de22eaa1 100644 --- a/sa-token-doc/fun/auth-flow.md +++ b/sa-token-doc/fun/auth-flow.md @@ -4,12 +4,12 @@ ### Sa-Token 功能结构图： -![sa-token-rz](https://oss.dev33.cn/sa-token/art/sa-token-js4--2.png 's-w') +sa-token-rz ### Sa-Token 认证流程图： -![sa-token-rz](https://oss.dev33.cn/sa-token/art/sa-token-rz2.png 's-w') +sa-token-rz -PS：鼠标右键选择 **`[在新窗口打开图片]`** 即可高清模式查看图片。(本流程图使用 [ProcessOn](https://www.processon.com) 绘制完成) +PS：鼠标右键选择 **`[在新窗口打开图片]`** 即可高清模式查看图片。 diff --git a/sa-token-doc/fun/curr-domain.md b/sa-token-doc/fun/curr-domain.md index 33c6a8c9..534aa0e9 100644 --- a/sa-token-doc/fun/curr-domain.md +++ b/sa-token-doc/fun/curr-domain.md @@ -16,11 +16,11 @@ public String test() { 从浏览器访问此接口，我们可以看到： -![test-curr-domain.png](https://oss.dev33.cn/sa-token/doc/test-curr-domain.png 's-w-sh') +test-curr-domain.png 此 API 在本地开发时一般可以正常工作，然而如果我们在部署时使用 Nginx 做了一层反向代理后，其最终结果可能会和我们预想的有一点偏差： -![test-curr-domain-fxdl.png](https://oss.dev33.cn/sa-token/doc/test-curr-domain-fxdl.png 's-w-sh') +test-curr-domain-fxdl.png 不仅是 Nginx，所有包含路由转发的地方都有可能导致上述丢失 uri 的现象，解决方案也很简单，既然程序无法自动识别，我们改成手动获取即可，Sa-Token 提供两个方案： @@ -29,7 +29,7 @@ public String test() { ##### 1、首先在 Nginx 代理转发的地方增加参数 -![nginx-add-header.png](https://oss.dev33.cn/sa-token/doc/nginx-add-header.png 's-w-sh') +nginx-add-header.png 重点是这一句：`proxy_set_header Public-Network-URL http://$http_host$request_uri;` diff --git a/sa-token-doc/fun/git-pr.md b/sa-token-doc/fun/git-pr.md index 363e5ca8..0fbc8441 100644 --- a/sa-token-doc/fun/git-pr.md +++ b/sa-token-doc/fun/git-pr.md @@ -3,12 +3,12 @@ 2. 滑动右侧页面滑块, 查看页面内容最下方, 评论区上方 3. 找到这一行文字 -![在线编辑提示](https://oss.dev33.cn/sa-token/doc/git-pr/online_1.png) +在线编辑提示 4. 点击Gitee或GitHub按钮中的任意一个, 国内用户推荐使用 [Gitee](https://gitee.com) (请先注册登录后再往下浏览) 5. 此时会进入当前页面源码预览页面,找到下方按钮组 -![按钮组](https://oss.dev33.cn/sa-token/doc/git-pr/online_2.png) +按钮组 6. 点击编辑按钮 7. 此时进入待修改页面的源码页面, 按照markdown格式编辑为需要的结果(Ctrl+P可查看最终效果,再次按下可恢复源码界面) @@ -36,16 +36,16 @@ git config --list 1. 点击[Gitee](https://gitee.com/dromara/sa-token)或[Github](https://github.com/dromara/sa-token)进入Sa-Token项目主页, 以下以Gitee为例,Github类似(请先注册登录后再往下浏览) 2. 找到页面右上角的按钮组, 点击Forked按钮 -![按钮组](https://oss.dev33.cn/sa-token/doc/git-pr/code_1.png) +按钮组 3. 选择个人仓库并点击确认 4. 此时在你的个人仓库中会多了一个Sa-Token项目 -5. 在新的Sa-Token项目中, 点击 ![克隆/下载](https://oss.dev33.cn/sa-token/doc/git-pr/code_2.png) 按钮, 点击弹出框里面的复制按钮 +5. 在新的Sa-Token项目中, 点击 克隆/下载 按钮, 点击弹出框里面的复制按钮 6. 在本地某空文件夹下右键选择: git bash here -![git bash](https://oss.dev33.cn/sa-token/doc/git-pr/code_4.png) +git bash -![git bash 打开后的图](https://oss.dev33.cn/sa-token/doc/git-pr/code_3.png) +git bash 打开后的图 14. 在里面输入如下命令, 按换行后自动下载整个项目 @@ -61,18 +61,18 @@ git clone 这里替换为复制后的链接 ### 方式一 1. 在idea中打开项目进入Commit选项 -![本地暂存](https://oss.dev33.cn/sa-token/doc/git-pr/code_5.png) +本地暂存 2. 勾选需要本地暂存的文件 3. 在同一页面的下方输入提示信息 -![提示信息](https://oss.dev33.cn/sa-token/doc/git-pr/code_6.png) +提示信息 4. 点击Commit按钮暂存到本地, 点击Commit and Push按钮暂存之后提交到远程 ### 方式二 1. 除了点击Commit and Push按钮外,还有一个地方可以提交git -![git按钮](https://oss.dev33.cn/sa-token/doc/git-pr/code_7.png) +git按钮 2. 位置在idea右上方的工具栏里面 3. 指向左下箭头为拉取项目,可以随时更新 @@ -82,11 +82,11 @@ git clone 这里替换为复制后的链接 1. 提交后进入Gitee个人仓库中克隆的Sa-Token项目 2. 找到下图的Pull Request按钮 -![工具栏](https://oss.dev33.cn/sa-token/doc/git-pr/code_8.png) +工具栏 3. 点击提交, 进入如下页面 -![提交信息填写页面](https://oss.dev33.cn/sa-token/doc/git-pr/code_9.png 's-width') +提交信息填写页面 4. 在这里,你可以选择要提交的分支,一般都是dev开发分支.可以填写合并信息,其他测试审查之类的可以不填写, 最后点击创建即可完成一次提交. @@ -94,7 +94,7 @@ git clone 这里替换为复制后的链接 1. 有时候主项目更新了,之前克隆的项目代码陈旧,如何处理? 2. 在个人仓库的Sa-Token项目主页面中, 找到下图的圆圈 -![更新按钮](https://oss.dev33.cn/sa-token/doc/git-pr/code_10.png) +更新按钮 3. 点击右侧圆圈按钮后Gitee会自动同步主项目, 这样就不用像我之前一样,删除项目又重新fork了. diff --git a/sa-token-doc/fun/sa-token-context--backup.md b/sa-token-doc/fun/sa-token-context--backup.md index 32d3b58b..952238cd 100644 --- a/sa-token-doc/fun/sa-token-context--backup.md +++ b/sa-token-doc/fun/sa-token-context--backup.md @@ -14,7 +14,7 @@ 解决这个问题的关键就在于 `SaTokenContext` 接口，此接口的作用是屏蔽掉不同 Web 框架之间的差异，提供统一的调用API： -![sa-token-context](https://oss.dev33.cn/sa-token/doc/sa-token-context.svg 's-w') +sa-token-context SaTokenContext只是一个接口，没有工作能力，这也就意味着 SaTokenContext 接口的实现是必须的。 diff --git a/sa-token-doc/fun/sa-token-context.md b/sa-token-doc/fun/sa-token-context.md index 6fcd9c39..26a2faa7 100644 --- a/sa-token-doc/fun/sa-token-context.md +++ b/sa-token-doc/fun/sa-token-context.md @@ -60,7 +60,7 @@ public static void setContext(HttpServletRequest request, HttpServletResponse re Sa-Token 为了一套代码对接所有的 Web 框架，就在原生请求对象的基础上又封装了一层 `SaTokenContext` 相关接口，用于屏蔽掉不同 Web 框架之间的差异，提供统一的调用API： -![sa-token-context](https://oss.dev33.cn/sa-token/doc/plugin/sa-token-context-2.svg) +sa-token-context 因此，要对接不同的 Web 框架，就要针对不同的 Web 框架封装不同版本的 `SaRequest`、`SaResponse`、`SaStorage` 包装类对象。 diff --git a/sa-token-doc/fun/session-model.md b/sa-token-doc/fun/session-model.md index a10f4062..3608bbba 100644 --- a/sa-token-doc/fun/session-model.md +++ b/sa-token-doc/fun/session-model.md @@ -99,7 +99,7 @@ session.updateTimeout(1000); // 参数说明和全局有效期保持一致 **假设三个客户端登录同一账号，且配置了不共享token，那么此时的Session模型是：** -![session-model](https://oss.dev33.cn/sa-token/doc/session-model3.png 's-w') +session-model 简而言之： - `Account-Session` 以账号 id 为主，只要 token 指向的账号 id 一致，那么对应的Session对象就一致 diff --git a/sa-token-doc/more/join-group.md b/sa-token-doc/more/join-group.md index 1c02eed7..cbb5de0a 100644 --- a/sa-token-doc/more/join-group.md +++ b/sa-token-doc/more/join-group.md @@ -6,8 +6,6 @@ ### 1、加入QQ交流群 - - @@ -16,9 +14,9 @@ QQ交流群：823181187 [点击加入](https://qm.qq.com/q/EBIJVZBVGE) ### 2、加入微信交流群： - + -![微信群](https://oss.dev33.cn/sa-token/qr/i-wx-qr2.png ':size=175') +微信群 （扫码添加微信，备注：sa，邀您加入群聊） diff --git a/sa-token-doc/more/sa-token-donate.md b/sa-token-doc/more/sa-token-donate.md index 13a5cbb6..f082f61c 100644 --- a/sa-token-doc/more/sa-token-donate.md +++ b/sa-token-doc/more/sa-token-donate.md @@ -10,7 +10,8 @@ Sa-Token 采用 Apache-2.0 开源协议，**承诺框架本身与官网文档永 您可以在项目 [Gitee](https://gitee.com/dromara/sa-token) 主页进行捐赠 -![gitee-zanzhu2.png](https://oss.dev33.cn/sa-token/doc/gitee-zanzhu2.png) + +gitee-zanzhu2.png