Cat Online Judge
作者:猫十二懿
项目介绍
本项目是基于 Spring Boot + Spring Cloud Alibaba 微服务 + Docker + RabbitMQ + Vue 3 的 编程算法题目在线评测系统
(简称OJ)。
在线访问:http://oj.kongshier.top/
源项目来自编程导航(https://yupi.icu)
Cat OJ(Cat Online Judge)系统是一个在线算法评测系统,用户可以选择题目、编写代码并提交代码进行评测,而且是高效、稳定的 OJ
在线判题评测系统,它能够根据用户提交的代码、出题人预先设置的题目输入和输出用例,进行编译代码、运行代码、判断代码运行结果是否正确。
项目功能
题目模块
- 创建题目(管理员)
- 删除题目(管理员)
- 修改题目(管理员)
- 搜索题目(用户/管理员)
- 题目管理(管理员)
- 在线做题(用户/管理)
- 提交题目代码(用户/管理)
- 消息队列:防止判题服务执行时间过长,并使用死信队列处理判题失败的题目,避免消息积压。
用户模块
- 注册
- 登录,在微服务中使用JWT Token实现登录,在网关层面获取token登录消息,实现用户鉴权
- 用户管理(管理员)
- 用户上传头像功能,使用阿里云对象存储OSS存储图片
- 用户限流。本项目使用到令牌桶限流算法,使用Redisson实现简单且高效分布式限流,限制用户每秒只能调用一次提交一次题目,防止用户恶意占用系统资源
判题模块
- 提交判题:结果是否正确与错误
- 错误处理:内存益出、安全性、超时
- 代码沙箱:执行代码,返回执行信息
- 开放接口:提供一个独立的新服务
代码沙箱
- 只负责接受代码和输入,运行代码,返回编译运行的结果,不用管用户提交的程序是否正确(不负责判题)
OJ系统调研
- https://github.com/HimitZH/HOJ (适合学习)
- https://github.com/QingdaoU/OnlineJudge (python,不好学,很成熟)
- https://github.com/hzxie/voj (在Github上的Start⭐⭐没那么多,没那么成熟,但相对好学)
- https://github.com/fleaking/uoj (php实现的)
- https://github.com/zhblue/hustoj (成熟,但是php实现)
- https://github.com/hydro-dev/Hydro (功能强大,Node.js实现)
项目核心亮点 ⭐
- 权限校验:用户权限校验
- 代码沙箱(安全沙箱)
- 用户代码藏毒:写个木马文件、修改系统权限
- 沙箱:隔离的、安全的环境,用户的代码不会影响到沙箱之外的系统的运行
- 资源分配:限制用户程序的占用资源
- 判题规则
- 任务调度(消息队列执行判题)
- 服务器资源有限,用户要排队,按照顺序去依次执行判题
快速启动 ♂️
- 下载/拉取本项目到本地(shieroj-backend-single、shieroj-code-sandbox、shieroj-frontend)
- 通过 IDEA 代码编辑器进行打开项目,等待依赖的下载
- 修改配置文件
application.yaml
的信息,比如数据库、Redis、RabbitMQ等
- 修改信息完成后,通过
ShierApplication
程序进行运行项目
项目结构图
![Cat Online Judge 判题系统_第2张图片](http://img.e-com-net.com/image/info8/a9fab34b0e124ce0bbb8b6afc1370570.jpg)
项目核心业务流程
判题服务:获取题目信息、预计的输入输出结果,返回给主业务后端:用户的答案是否正确
代码沙箱:只负责运行代码,给出程序运行的结果,不用管用户提交的程序是否正确。 因此 判题服务 和 代码沙箱 实现了解耦
![Cat Online Judge 判题系统_第3张图片](http://img.e-com-net.com/image/info8/4827eef4e77f4b45876918464000f9f5.jpg)
核心流程时序图
![Cat Online Judge 判题系统_第4张图片](http://img.e-com-net.com/image/info8/c317b392c7db4ea0ade80d4a33a6ee8a.jpg)
微服务项目
服务模块划分
- shieroj-backend-common:系统通用模块,比如用户角色权限校验,异常处理,统一返回值,常量,工具类等
- shieroj-backend-file-service:系统文件模块,比如用户头像上传等
- shieroj-backend-gateway:系统网关模块:实现了给前端返回统一接口路由,聚合文档(Knife4j),全局跨域配置,权限校验(JWT Token)等
- shieroj-backend-judge-service:系统判题模块:调用远程代码沙箱接口,实现工厂模式、策略模式、代理模式,验证代码沙箱执行结果是否正确与错误,使用消息队列实现异步处理消息
- shieroj-backend-model:系统实体模块,比如用户实体类、题目实体类,VO、枚举等
- shieroj-backend-question-service:系统题目模块:题目的增删改查、题目提交限流、使用消息队列异步处理消息
- shieroj-backend-service-client:系统内部调用模块,给内部系统提供调用接口
- shieroj-backend-user-service:系统用户模块,管理员对用户的增删改查,用户自己信息查询,修改,头像上传。
项目技术栈和特点 ❤️
后端
- Spring Boot:简化Spring开发框架
- Spring MVC:
- Spring Boot 调试工具和项目处理器
- Spring AOP 切面编程
- Spring 事务注解
- Spring Cloud Alibaba
- Spring Gateway
- MyBatis + MyBatis Plus 数据访问(开启分页)
- MyBatis-Plus 数据库访问结构
- Redis:分布式存储用户信息
- Redisson:限流控制
- JWT Token:用户鉴权
- RabbitMQ:消息队列
- Docker 代码沙箱,实现隔离环境运行Java程序
- Java安全管理器:保护 JVM、Java 安全的机制,实现对资源的操作限制
- Nacos:服务注册管理中心
- OpenFeign:微服务模块之间调用
前端
- Vue 3
- Vue Router: 路由管理
- Vue-Cli 脚手架
- Axios: HTTP客户端
- Bytemd: Markdown 编辑器
- Monaco Editor: 代码编辑器
- highlight.js: 语法高亮
- Moment.js: 日期处理库
- Arco Design Vue: UI组件库
- TypeScript: 静态类型系统
数据存储
通用特性
- Spring Session Redis 分布式登录
- 全局请求响应拦截器(记录日志)
- 全局异常处理器
- 自定义错误码
- 封装通用响应类
- Swagger + Knife4j 接口文档
- 自定义权限注解 + 全局校验
- 全局跨域处理
- 长整数丢失精度解决
- 多环境配置
- IDEA插件 MyBatisX : 根据数据库表自动生成
- Hutool工具库 、Apache Common Utils、Gson 解析库、Lombok 注解
单元测试
设计模式
远程开发
- VMware Workstation虚拟机
- Ubuntu Linux 18
- Docker环境
- 使用JetBrains Client连接
单体项目目录结构
├─sql // 项目的SQL文件:创建数据库和数据表
├─src
├─main
├─java
│ └─com
│ └─shieroj
│ ├─annotation // 权限控制
│ ├─aop //AOP切面
│ ├─common // 通用类
│ ├─config // 项目配置
│ ├─constant // 项目常量
│ ├─controller // 前端请求
│ ├─exception // 项目异常
│ ├─judge // 判题服务
│ │ ├─codesandbox // 代码沙箱
│ │ │ ├─impl
│ │ │ └─model
│ │ └─strategy
│ ├─manager // 管理
│ ├─mapper // 数据访问(操作数据库)
│ ├─model // 项目实体
│ │ ├─dto
│ │ │ ├─file
│ │ │ ├─question
│ │ │ ├─questionsumbit
│ │ │ └─user
│ │ ├─entity
│ │ ├─enums
│ │ └─vo
│ ├─mq // 消息队列
│ ├─service // 项目服务
│ │ └─impl
│ └─utils // 项目工具
└─resources // 项目资源配置
└─mapper
OJ项目展示
项目首页
![Cat Online Judge 判题系统_第5张图片](http://img.e-com-net.com/image/info8/4f99ed2321e547b69ba1a31675f8b780.jpg)
用户登录注册
![Cat Online Judge 判题系统_第6张图片](http://img.e-com-net.com/image/info8/c8777bb8b8614ea4871dc52d47637f00.jpg)
![Cat Online Judge 判题系统_第7张图片](http://img.e-com-net.com/image/info8/6cf9574fd04e4c689ebfd8261f9bad28.jpg)
管理员创建题目
![Cat Online Judge 判题系统_第8张图片](http://img.e-com-net.com/image/info8/8d0435712224484796c794dab9423211.jpg)
![Cat Online Judge 判题系统_第9张图片](http://img.e-com-net.com/image/info8/3ead5ca9998f45d3b816d6789e470cce.jpg)
题目管理
![Cat Online Judge 判题系统_第10张图片](http://img.e-com-net.com/image/info8/780d349ed995485da341ea7679f762d9.jpg)
修改题目信息
![Cat Online Judge 判题系统_第11张图片](http://img.e-com-net.com/image/info8/eb9b1c8613ed4dc7906ad72cd89658a6.jpg)
用户管理(管理员)
![Cat Online Judge 判题系统_第12张图片](http://img.e-com-net.com/image/info8/68582899b95048d8b53d3996ab34ef42.jpg)
管理员修改用户信息
![Cat Online Judge 判题系统_第13张图片](http://img.e-com-net.com/image/info8/eb17f7400c334e2da0b9b6328c785534.jpg)
个人信息
![Cat Online Judge 判题系统_第14张图片](http://img.e-com-net.com/image/info8/28fe1c996db4468fa93efca9f1e950b9.jpg)
点击头像即可重新上传用户头像
![Cat Online Judge 判题系统_第15张图片](http://img.e-com-net.com/image/info8/11dbb981b4cd4f72a837b3747cbaed21.jpg)
提交题目展示
![Cat Online Judge 判题系统_第16张图片](http://img.e-com-net.com/image/info8/3cdc929684be4258bafde265860ba8a5.jpg)
后续项目扩展
❤️❤️❤️需要项目请评论区留言。