【微服务大作业留档】CloudNote分布式在线笔记大纲

CloudNote - 分布式在线笔记系统 完整项目大纲项目摘要CloudNote 是一个基于 Spring Cloud 微服务架构的分布式在线笔记系统包含用户、笔记、分享、日志和网关五个核心服务。系统采用 Nacos 作为注册与配置中心Gateway 实现统一路由与 JWT 鉴权通过 FeignHystrix 实现服务间调用与熔断降级利用 RabbitMQ 异步处理操作日志。项目涵盖完整的 CRUD 功能、分页搜索、短链接分享、回收站机制并提供了详细的数据库设计、接口清单、测试计划及技术难点解决方案满足课程项目评分要求。项目定位一个功能完整、技术栈全面的分布式在线笔记系统覆盖Spring Cloud微服务核心组件。一、项目架构全景1.1 微服务架构图基础设施层数据层异步层业务服务层网关层客户端FeignHystrixFeignHystrixFeignHystrix发送日志消息发送日志消息注册注册注册注册注册浏览器 / Postman / JMeterGateway :8080路由JWT鉴权user-service :8081用户管理note-service :8082笔记管理share-service :8083分享协作RabbitMQ消息队列log-service :8084日志消费Redis缓存MySQL主数据库Nacos注册中心配置中心1.2 服务清单序号服务名端口职责数据库1gateway8080路由转发、JWT校验无2user-service8081用户注册/登录/信息查询user_db3note-service8082笔记CRUD、搜索、回收站note_db4share-service8083分享链接生成/访问/权限share_db5log-service8084消费MQ、记录操作日志log_db6common-公共模块DTO、工具类-二、功能模块详解2.1 功能总览模块功能点优先级涉及技术用户模块注册核心BCrypt加密登录核心JWT生成获取用户信息核心Token解析笔记模块创建笔记核心-编辑笔记核心-删除笔记软删除核心状态标记笔记列表分页核心MyBatis Plus分页笔记详情核心-搜索笔记核心LIKE模糊查询回收站恢复进阶状态变更分享模块生成分享链接核心短码生成访问分享链接核心权限校验2.2 核心接口清单满足Postman 20请求编号接口方法说明Feign调用1/api/user/registerPOST用户注册无2/api/user/loginPOST登录返回JWT无3/api/note/createPOST创建笔记无4/api/note/listGET笔记列表✅ 调用user-service5/api/note/detail/{id}GET笔记详情✅ 调用user-service6/api/note/delete/{id}DELETE软删除无7/api/note/searchGET搜索笔记✅ 调用user-service8/api/share/create/{noteId}POST生成分享链接✅ 调用note-service9/api/share/access/{code}GET访问分享✅ 调用note-service10/api/log/queryGET查询日志无共10个接口每个2-3次请求即可超过20次2.3 Hystrix熔断点设计// 熔断点1note-service → user-serviceFeignClient(nameuser-service,fallbackUserFallback.class)publicinterfaceUserClient{GetMapping(/user/info/{userId})UserDTOgetUserInfo(PathVariableLonguserId);}// 降级返回默认用户信息publicclassUserFallbackimplementsUserClient{publicUserDTOgetUserInfo(LonguserId){returnnewUserDTO(userId,用户已离线,***example.com);}}// 熔断点2share-service → note-serviceFeignClient(namenote-service,fallbackNoteFallback.class)publicinterfaceNoteClient{GetMapping(/note/detail/{noteId})NoteDTOgetNoteDetail(PathVariableLongnoteId);}// 降级返回提示信息publicclassNoteFallbackimplementsNoteClient{publicNoteDTOgetNoteDetail(LongnoteId){NoteDTOdtonewNoteDTO();dto.setTitle(笔记加载中...);dto.setContent(笔记服务繁忙请稍后重试);returndto;}}三、数据库设计3.1 ER图┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │ user │ │ note │ │ share │ ├─────────────┤ ├─────────────┤ ├─────────────┤ │ id(PK) │←─── │ user_id(FK) │ │ id(PK) │ │ username │ │ id(PK) │←─── │ note_id(FK) │ │ password │ │ title │ │ code(唯一) │ │ email │ │ content │ │ permission │ │ create_time │ │ status │ │ visit_count │ └─────────────┘ │ create_time │ │ create_time │ │ update_time │ └─────────────┘ └─────────────┘ │ ↓ ┌─────────────┐ │ log │ ├─────────────┤ │ id(PK) │ │ user_id │ │ action │ │ target_id │ │ detail │ │ create_time │ └─────────────┘3.2 建表SQLuser_db 数据库CREATETABLEuser(idbigintPRIMARYKEYAUTO_INCREMENT,usernamevarchar(50)NOTNULLCOMMENT用户名,passwordvarchar(255)NOTNULLCOMMENTBCrypt加密密码,emailvarchar(100)COMMENT邮箱,create_timedatetimeDEFAULTCURRENT_TIMESTAMP,update_timedatetimeDEFAULTCURRENT_TIMESTAMPONUPDATECURRENT_TIMESTAMP,UNIQUEKEYuk_username(username));note_db 数据库CREATETABLEnote(idbigintPRIMARYKEYAUTO_INCREMENT,user_idbigintNOTNULLCOMMENT所属用户ID,titlevarchar(200)NOTNULLCOMMENT笔记标题,contenttextCOMMENT笔记内容,statustinyintDEFAULT1COMMENT1-正常 0-回收站,create_timedatetimeDEFAULTCURRENT_TIMESTAMP,update_timedatetimeDEFAULTCURRENT_TIMESTAMPONUPDATECURRENT_TIMESTAMP,KEYidx_user_id(user_id),KEYidx_status(status));share_db 数据库CREATETABLEshare(idbigintPRIMARYKEYAUTO_INCREMENT,note_idbigintNOTNULLCOMMENT笔记ID,user_idbigintNOTNULLCOMMENT分享人ID,codevarchar(20)NOTNULLCOMMENT分享码,permissiontinyintDEFAULT1COMMENT1-只读 2-可编辑,visit_countintDEFAULT0COMMENT访问次数,statustinyintDEFAULT1COMMENT1-有效 0-失效,expire_timedatetimeCOMMENT过期时间,create_timedatetimeDEFAULTCURRENT_TIMESTAMP,UNIQUEKEYuk_code(code),KEYidx_note_id(note_id));CREATETABLEshare_visit(idbigintPRIMARYKEYAUTO_INCREMENT,share_idbigintNOTNULL,visitor_ipvarchar(50),user_agentvarchar(255),visit_timedatetimeDEFAULTCURRENT_TIMESTAMP);log_db 数据库CREATETABLEoperation_log(idbigintPRIMARYKEYAUTO_INCREMENT,user_idbigintNOTNULLCOMMENT操作用户ID,actionvarchar(50)NOTNULLCOMMENT操作类型,target_idbigintCOMMENT目标ID,detailvarchar(500)COMMENT操作详情,create_timedatetimeDEFAULTCURRENT_TIMESTAMP,KEYidx_user_id(user_id),KEYidx_create_time(create_time));四、评分项逐一满足表评分项分值本项目实现方式自评功能完整性205个服务、14个功能点、10接口✅ 充足微服务划分20合理拆分用户/笔记/分享/日志/网关✅ 合理服务治理-Nacos注册中心、心跳感知✅配置中心-Nacos动态配置笔记字数限制等✅网关-Gateway路由JWT全局过滤器✅熔断降级-3处Hystrix降级点✅消息队列-RabbitMQ异步日志✅ 加分Postman测试2510个接口、20请求、含截图✅压测-JMeter 50→150→500并发✅熔断测试-手动停服务验证降级✅热更新测试-Nacos配置动态生效✅代码质量15阿里规范、注释、分层✅文档报告10需求架构测试部署✅答辩演示10PPT演示视频问题准备✅五、技术难点与解决方案难点解决方案复杂度短分享码生成雪花算法 Base62编码⭐⭐⭐分布式日志记录RabbitMQ异步 消息确认⭐⭐⭐⭐笔记回收站定时清理Scheduled Redis分布式锁⭐⭐⭐多服务数据一致性最终一致性 日志补偿⭐⭐⭐JWT无状态认证Token Redis黑名单⭐⭐⭐Hystrix熔断配置合理设置阈值参数⭐⭐六、测试计划6.1 功能测试Postman测试批次接口数量请求次数重点验证第1批3个用户6次注册/登录/Token第2批4个笔记8次CRUD分页搜索第3批2个分享6次生成/访问第4批1个日志4次异步写入验证6.2 压测计划JMeter场景并发数持续时间目标指标负载测试50→1505分钟P95 1s压力测试3005分钟错误率 1%极限测试5003分钟触发熔断Hystrix测试100持续-验证降级生效6.3 异常场景测试场景操作预期结果服务熔断停止user-service笔记列表显示用户离线MQ故障停止RabbitMQ主业务不受影响消息持久化网关鉴权不带Token访问返回401配置热更新修改笔记字数限制不重启生效