# XD-student-management

**Repository Path**: we-learn/xd-student-management

## Basic Information

- **Project Name**: XD-student-management
- **Description**: 一个前后端分离的学生管理系统
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-08-26
- **Last Updated**: 2024-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](.static/logo.png)

# XD-student-management

#### 项目背景

一个简单的前后端分离的学生管理系统。前端为Vue 2 、Ant Design Pro ，后端为Spring Boot。

#### 环境依赖

Node.js , JDK1.8 , MySql 11

#### 安装

待完善

#### 使用

待完善

#### 目录结构

```            
├── .static                  # 非代码中引用的静态资源，如项目Logo、截图、数据库备份文件等
├── service                  # 后端项目目录
├── web                      # 前端项目目录
├── LICENSE
├── .gitignore
└── README.md
```


#### Git commit 规范

Git commit 消息尽量按照约定式提交规，进行规范的提交。

结构如下：

```            
<type>(<scope>): <short summary>
// 空一行
[body]
// 空一行
[footer]
```

**header 部分**

第一行是 header 部分，必须使用类型字段前缀，它由一个名词组成，只能是下面几种之一：
* feat: 新功能
* fix: 修复bug
* docs：只改动了文档
* style：修改代码格式（例如去掉空格、改变缩进、增删分号，不影响代码逻辑）
* refactor：重构代码（理论上不影响现有功能）
* perf：提升性能的改动
* test：增加修改测试用例
* chore：改变构建流程、或者增加依赖库、工具等
* revert：回滚到上一个版本
* ci：持续集成
* build：构建版本

其后接一个可选的作用域字段，作用域必须是一个描述某部分代码的名词，并用圆括号包围，例如： fix(parser)。每个项目的作用域都不一样，在基于 lerna 的 monorepo 仓库中，通常用 package 名称作为 scope。
然后紧接着一个冒号（英文半角）和空格。
最后是简短描述，建议不要超过 50 个字符。
总结如下：

```
<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ 描述：指的是对代码变更的简短总结
  │       │
  │       └─⫸ 作用域: animations|bazel|benchpress|common|compiler|...
  │
  └─⫸ 提交类型：build|ci|docs|feat|fix|perf|refactor|test...
```

**body 部分 (该部分可省略)**

Body 部分是对本次 commit 的详细描述，可以分成多行，提交者自由发挥。

**footer 部分 (该部分可省略)**
footer 部分一般用于记录不兼容的改动，以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。最后还可以添加关闭的 issue。

```
BREAKING CHANGE: <breaking change summary>
// 空一行
<breaking change description + migration instructions>
// 空一行
// 空一行
Fixes #<issue number>
```

#### 后端接口规范
1. API风格：
   前后端通过HTTP协议进行通讯，接口设计参照RPC协议面向方法调用。

2. 接口返回的数据结构：
返回的数据应包含在 HTTP 响应体中, 为 JSON Object. 该 Object 有且仅有 3 个字段 ```data, ret, msg```  如：
```Json
{
  "data": {
    "userInfo": {
      "id": 1,
      "name" : "张三"
    }
  },
  "msg": "SUCCESS",
  "ret": 200
}
```
```data```为响应的主体，必须是一个对象，该对象可以包含任意属性。```ret```为后端返回的状态码，只有200时，才为请求成功。```msg```为请求处理消息，只有msg为SUCCESS,才算请求（处理）成功。如果msg为其他消息，前端应该将该消息呈现给用户