作业管理系统服务端

V2版本（V2分支）目前正在编写中

点我查看主分支完成版本

主分支使用Spring Boot编写，请点击查看

前后端分离项目，前端：shw_client

架构

微服务架构。使用Spring Cloud开发部署。

项目采用微服务开发，采用JWT技术作为身份验证手段，前后端分离。目前前后端交互使用JSON方式，GraphQL和protobuf通信方式正在开发中。

技术栈：

前端：Vue.JS

后端：Spring Cloud

数据库：MongoDB

中间件：RabbitMQ

服务（模块）简要功能说明：

1. shw-gateway

   网关服务。使用zuul框架实现的微服务网关，该网关拦截未经认证的请求并将请求转发到shw-security服务。

2. shw-eureka

   微服务发现与注册服务。

3. shw-security

   安全服务。使用CAS实现SSO进行统一登陆，发放token。token使用JWT技术实现。

4. shw-group

   群组服务。教师所创建的群组CRUD的业务逻辑实现。

5. shw-studentgroup

   学生群组服务。管理学生加入的群组。

6. shw-upload

   上传服务。学生上传作业文件，教师下载文件的业务逻辑服务。

7. shw-work

   作业服务。管理教师创建的作业，作业数据的CRUD。

8. shw-notice

   通知服务。管理教师发布的通知。

9. shw-file

   文件服务。文件的持久化服务。

10. shw-common

    公共模块。包括一些异常，工具类等等

11. shw-hystrix-dashboard

    hystrix监控信息服务

消息队列系统:

为什么使用消息队列？

1. 异步

   教师与学生的一些操作在异步的环境下进行，增加了系统承载QPS。

2. 解耦

   服务与服务之间耦合度降低。

3. 削峰

   减轻高峰时间数据库压力。

数据库：

登陆流程：

验证用户信息流程：

部署

开启rabbitmq

docker run -d --hostname localhost --name myrabbit -p 15672:15672 -p 5672:5672 -p 4369:4369 -p 5671:5671 -p 15671:15671 -p 25672:25672 rabbitmq:3.7.14-management

开启ziplin

docker run -d -e RABBIT_ADDRESSES=dockervm -p 9411:9411 openzipkin/zipkin

API文档

HTML版本

Markdown版本

表字段实体属性

群组属性(group)

学生群组属性(student_group)

作业属性(work)

上传属性(upload)

通知属性(notice)

接口

统一响应格式:

Content-Type: application/json

状态吗:

400 请求参数错误

401 需要登陆

403 权限不足

404 资源不存在

405 不支持该请求方法

500 服务器出错

503 服务不可用

Json格式规范:

{
   "code": -1,
   "msg": "该活动不存在",
   "data":"响应数据"
}

公共

获取登陆用户信息

请求方法 GET

请求路径 /user

响应状态 200(请求成功)

群组

获取学生的所有群组

请求方法 GET

请求路径 /student/groups

响应状态 200(请求成功)

{
    "code": 200,
    "msg": "请求成功",
    "data":[{
        "id":"a3f65ga621v3za6",
        "name":"群组A",
        ...
    }, {   } ]
}

###学生添加群组

请求方法 POST

请求路径 /student/group

响应状态 201(创建成功)

学生退出群组

请求方法 DELETE

请求路径 /student/group/{id}

响应状态 204(退出成功) 404(ID不存在)

获取教师的所有群组

请求方法 GET

请求路径 /teacher/groups

响应状态 200(请求成功)

教师创建群组

请求方法 PUT

请求参数 name

响应状态 201(创建成功)

教师解散群组

请求方法 DELETE

请求路径 /teacher/group/{id}

响应状态 204(解散成功) 404(ID不存在)

教师修改群信息

请求方法 PATCH

请求路径 /teacher/group/{id}

响应状态 204(修改成功) 404(ID不存在)

管理员查询所有群信息

请求方法 GET

请求路径 /admin/groups

响应状态 200(查询成功)

管理员根据群名称模糊搜索

请求方法 GET

请求路径 /admin/search/groups/{name}

响应状态 200(查询成功)

邀请(待定)

学生拉取邀请消息

请求方法 GET

请求路径 /student/notices

响应状态 200(l拉取成功)

学生处理邀请消息

请求方法 PATCH

请求路径 /student/notice/{id}

响应状态 204(处理成功) 404(ID不存在)

备注 消息处理后直接删除

作业

教师新建作业

请求方法 PUT

请求路径 /teacher/work

响应状态 201(新建成功)

教师查询所有作业

请求方法 GET

请求路径 /teacher/works/{group_id}

响应状态 200(查询成功) 404(ID不存在)

教师修改作业状态

请求方法 PATCH

请求路径 /teacher/work/{id}

响应状态 204(修改成功) 404(ID不存在)

教师删除作业

请求方法 DELETE

请求路径 /teacher/work/{id}

响应状态 204(删除成功) 404(ID不存在)

学生上传作业

请求方法 POST

请求路径 /student/work/{id}

响应状态 201(上传成功)

下载某学生作业

请求方法 GET

请求路径 /student/download/{student_id}/{work_id}

响应状态 200(请求成功) 404(ID不存在)

学生查询未交作业

请求方法 GET

请求路径 /student/works/un_done

响应状态 200(请求成功)

学生查询已交作业

请求方法 GET

请求路径 /student/works/done

响应状态 200(请求成功)

学生删除作业

请求方法 DELETE

请求路径 /student/work/{word_id}

上传

学生查询上传信息

请求方法 GET

请求路径 /student/upload/{work_id}

响应状态 200(请求成功)