From e5175733c2044f2b52e88bcf9afb98d00f5e4fb1 Mon Sep 17 00:00:00 2001 From: heavyrain2012 Date: Wed, 17 Nov 2021 16:43:27 +0800 Subject: [PATCH] udpate readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9d8918f..9bd69a4 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ java -jar app-XXXXX.jar 本服务最早只提供获取token功能，后来逐渐增加了群公告/Shiro等功能，需要引入数据库。为了提高用户体验的便利性，引入了数据库[H2](http://www.h2database.com)，让用户可以无需安装任何软件就可以直接运行（JRE还是需要的），另外shiro的session也存储在h2数据库中。提高了便利性的同时导致一方面性能有瓶颈，另外一方面也不能水平扩展和高可用。因此需要使用本工程上线必须修改2个地方。 1. 切换到MySQL，切换方法请参考 ```application.properties``` 文件中的描述。 2. 使用RedisSessionDao，详情请参考 https://www.baidu.com/s?wd=shiro+redis&tn=84053098_3_dg&ie=utf-8 +3. 从0.53版本开始，应用服务改为无状态服务，可以集群部署。验证码和PC会话等信息都存放到数据库中，如果压力较大，可以二开引入redis缓存。 #### 版本兼容 + 0.40版本引入了shiro功能，在升级本服务之前，需要确保客户端已经引入了本工程0.40版本发布时或之后的移动客户端。并且在升级之后，客户端需要退出重新登录一次以便保存session(退出登录时调用disconnect，需要使用false值，这样重新登录才能保留历史聊天记录，一定要在新版本中改成这样)。如果是旧版本或者没有重新登录，群公告和扫码登录功能将不可用。为了系统的安全性，建议升级。 @@ -59,6 +60,8 @@ java -jar app-XXXXX.jar + 0.51版本添加了token认证。可以同时支持token和cookies认证，客户端也做了对应修改，优先使用token。注意做好兼容。 ++ 从0.53版本开始，所以数据都存储在数据库中，因此应用服务为无状态服务，可以部署多台应用服务做高可用和水平扩展。需要注意数据都是存储在数据库中，如果用户量较大或者业务量比较大，可以自己二开应用服务，添加redis缓存。 + #### 注意事项 服务中对同一个IP的请求会有限频，默认是一个ip一小时可以请求200次，可以根据您的实际情况调整（搜索rateLimiter字符串就能找到）。如果使用了nginx做反向代理需要注意把用户真实ip传递过去（使用X-Real-IP或X-Forwarded-For)，避免获取不到真实ip从而影响正常使用。