日常开发配置说明
数据库:remote
redis:remote
es:local (elasticsearch-7.17.9:启动elasticsearch.bat
),确认http://localhost:9200/是否启动成功
kinbana:local(kibana-7.17.9,bin目录下启动kinbana.bat
),确认http://localhost:5601/是否启动成功(kinbana启动依赖于es,启动失败需确认关联依赖)
N合一参考:https://www.yesapi.cn/
wego:N合一整合:https://github.com/lhccong/we-go
参考GIthub:https://github.com/lhccong
待处理细节:
多表操作注意细节:数据库事务处理
例如用户注册(当扩展信息插入失败,数据并没有回滚,导致后续重新插入提示账号重复,但实际账号信息是插入失败的)
计划安排:
- [ ] 聚合搜索模块(前端页面交互)
- [ ] API接口调用模块(分布式架构构建,模拟API接口调用)、前端页面交互
- [ ] 用户注册信息(绑定资源内容,接口调用等,积分制概念)
- [ ] AI模块引入(AI模块响应交互)
- [ ] 交互(前后端交互提示信息需处理,设定业务提示)
- [ ] 智能分析模块:异步优化和MQ优化版本调用同一个接口,后端统一接收处理
- [ ] 登录模块(邮箱登录)
网站友链申请(todo):友情链接表
核心功能构建说明
Shiro框架引入(替换原有session机制)
ES构建
todo列表
[ ] 引入内容管理模块:记录系统、用户操作日志、系统监控等相关内容
[ ] 数据检索查询优化(避免大文本内容直接传输,考虑网络性能和数据体量)
[ ] 接口调整:聚合接口(将接口信息状态修改的操作统一成聚合接口,限定参数:id、stauts、执行操作即可,统一由后端校验),区分前后台操作用户权限
Git提交规范
Git提交规范是一种重要的团队协作和代码管理实践,有助于提高代码管理的可读性和可维护性。一个典型的Git提交消息包含以下几个部分:12
- 提交类型(Commit Type):用于描述提交的内容,常见的类型包括[feat](https://www.baidu.com/s?wd=feat&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=7768yDmjw2VC6yFqHccs0lLaW0aW1qR5sD1HCz1%2FLDg6t4D6snUMZ4ikfs8&sa=re_dqa_zy&icon=1)(新增功能)、[fix](https://www.baidu.com/s?wd=fix&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=c78aUAFITyQKOOPMYhP2eEe5m5XBhsTPeKmimbbDjn%2FD4Da3DXOnMux%2B90I&sa=re_dqa_zy&icon=1)(修复bug)、[docs](https://www.baidu.com/s?wd=docs&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=c78aUAFITyQKOOPMYhP2eEe5m5XBhsTPeKmimbbDjn%2FD4Da3DXOnMux%2B90I&sa=re_dqa_zy&icon=1)(文档修改)、[style](https://www.baidu.com/s?wd=style&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=c78aUAFITyQKOOPMYhP2eEe5m5XBhsTPeKmimbbDjn%2FD4Da3DXOnMux%2B90I&sa=re_dqa_zy&icon=1)(代码样式调整,不影响代码逻辑)、[refactor](https://www.baidu.com/s?wd=refactor&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=ca9ehP1Uqw14ZMrNplc95CwjSkdVFKbWiUS1Wl%2FtpPuxwAexloLEM%2Bw4KNY&sa=re_dqa_zy&icon=1)(代码重构)、[perf](https://www.baidu.com/s?wd=perf&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=ca9ehP1Uqw14ZMrNplc95CwjSkdVFKbWiUS1Wl%2FtpPuxwAexloLEM%2Bw4KNY&sa=re_dqa_zy&icon=1)(性能优化)、[test](https://www.baidu.com/s?wd=test&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=ca9ehP1Uqw14ZMrNplc95CwjSkdVFKbWiUS1Wl%2FtpPuxwAexloLEM%2Bw4KNY&sa=re_dqa_zy&icon=1)(增加或修改测试代码)、[chore](https://www.baidu.com/s?wd=chore&usm=1&ie=utf-8&rsv_pq=8ab4cf4e01503f02&oq=git 提交规范&rsv_t=ca9ehP1Uqw14ZMrNplc95CwjSkdVFKbWiUS1Wl%2FtpPuxwAexloLEM%2Bw4KNY&sa=re_dqa_zy&icon=1)(构建过程或辅助工具的变动)等。
- 提交范围(Scope):标明本次提交涉及的模块、组件、文件等具体范围。
- 提交主题(Subject):简明扼要地描述本次提交的内容,避免使用过长或不清晰的描述。
- 提交正文(Body):可选项,提供更详细的信息,如问题原因、解决方案等。
- 提交注释(Footer):可选项,用于关联问题跟踪系统中的问题ID或其他相关信息。
20240510
20240509
backend:引入通知/公告管理
- 后台接入通知/公告管理
- 前端接入自定义SDK实现消息通知机制
backend:构建检索数据源(爬取boss-jd信息)
20240502
backend 引入用户签到功能&积分机制:
新增用户签到功能:签到表user_sign设计、用户签到信息管理、用户签到校验(联动赠送积分)
新增用户积分机制(签到成功之后获赠积分),其他场景业务待嵌入
20240501
- [x] search:聚合搜索文章同步接口调整
- [x] frontend:前端优化调整
20240430
[x] 接口信息管理页面改造:原参考用户管理实现基本的CRUD操作,现调整为搜索联动可控制不同的tab页,便于管理员操作。
考虑拆分用户和管理员的接口信息管理页面实现(优化前台用户体验)
[x] ⚡取消原有session机制管理用户,交由Shiro框架统一管理用户登陆信息
后端接口调整:
- 用户登陆:userController/userLogin=》accountController/login
- 用户注销:userController/userLogout=》accountController/logout
- 获取登陆用户信息:userController/getLoginUser=》accountController/getCurrentLoginUser
- 接口排查:使用shiro接管了用户登陆状态管理,则项目中原有的一些内容已经不再适用,类似获取登陆用户信息、request(从session中获取内容等)都失效需要进行重构,此外鉴权(@AuthCheck也由shiro进行接管)
PS:😤😤😤给后续代码排查留个坑
前端调整:
- 对应前端登陆引用调整:注意fetchUserInfo、登陆方法等相关进行替换,校验登陆流程(项目中用到登陆、注销、获取用户登陆信息相关的接口都要进行排查,否则报错),如果出现登陆之后用户信息没更新则需要排查接口交互响应参数
20240429
[x] BI 智能分析模块构建(常规模式和异步任务模式)
[x] interface_info数据表status字段:用户提交的接口经由管理员审核后进行发布,新增审核概念(草稿、发布、审核、上线、下线等)
- 状态机:草稿=》待审核=》审核通过=》上线(如果审核不通过可重新发布回到待审核)=》下线(审核通过或者已经下线的接口可以重新上线)
20240428
【⭕1】🤡解决react代码编写问题导致webstorm内存突然飙升、CPU占满问题(后续需系统性学习框架内容)
【⭕2】调整数据检索模块页面接口响应交互
【⭕3】数据表引入:
- user_extend(用户关联扩展信息,如果业务场景较大可以按照业务场景关联表内容拆分多表存储(user_develop_mode、user_vip、user_score)),例如:
- 绑定用户关联的开发者模式信息develop_mode(用户可以以开发者的身份去灵活使用网站的资源,调用接口等)
- 绑定用户会员等级信息(会员等级:默认是普通、VIP、SVIP)
- 绑定用户积分(user_score):设定用户积分,可以使用积分下载网站资源内容,进行限流(例如API接口调用、智能BI图表渲染等)
调整内容:用户注册、用户新增接口,补充用户扩展信息填充并初始化
【4】接口信息管理模块初始化(原有内容嵌入)、接口数据统计:todo 模拟接口调用(微服务改造)
【5】BI智能分析接入(原有内容嵌入):todo 待对接
20240427
【⭕1】项目框架构建:单体应用脚手架构建(itc-platform-backend、itc-platform-frontend)
【⭕2】项目模块构建:前后端联调
- 基础模块:用户管理、文章管理、数据管理、模板管理
【⭕3】聚合搜索模块开发后端接口构思(文章、图片、数据检索)