前言

????????此次我参加这次集训，并写了这次的后端作业，感觉收益良多。这也是我第一次发表博文，博文书写的方式我也参照了网上(协会会长)的一些书写格式，但一定有些许不好的地方，望谅解。

? ? ? ? 我个人来说，我不太喜欢写文档，所以做完这个项目的时候，我是把最后的一天的时间来写文档的。

? ? ? ? 对于刚刚接触spring项目的我来说，期间也是踩了不少的坑，查阅了相当多的资料。

一、项目需求

1.背景介绍

在以往的协会招新和实验室招新的过程中，我们发现一个问题，那就是宣传不足，尽管我们有自己的公众号和WordPress制作的官网，但是效果不尽如人意。

很多时候，我们无法将我们协会和实验室的优点宣传出去，我们开展的活动往往无人问津。在以往的接触中，很多同学对我们协会、我们实验室的了解仅仅停留在名字上，甚至有些即将毕业的学长学姐都没有听过我们协会和实验室的名字。

这使我们不得不反思宣传的不足，于是我们有了自己开发协会/实验室官网的想法，一个是为了更好的展示我们协会和实验室的风采，一个也是为了我们协会/实验室开展活动之便。

2.需求简介

1.前后台（必做）

前台主要做展示交互

后台可以对完整进行管理设置

注：以下功能并未注明哪些事前台，哪些是后台，这个需要大家根据自己的经验合理分配

2.权限管理（必做）

网站权限设计中，分为普通用户，实验室成员，系统管理员三个角色。

普通用户：可以进入网站前台进行浏览，包括浏览成员博文，成员简介，实验室发展历史等，也可以发表评论，参与留言

实验室成员：除了以上权限外，实验室成员可以参与实验室内部的讨论，查看实验室内部的资源，登录后台发布博文等等

系统管理员：除了以上权限外，系统管理员可以对网站进行管理，如发布公告，管理用户等等

3.评论设计（必做）

可以展示多级评论（至少两级）

评论需要展示评论内容，评论时间，评论用户

用户可以对评论进行回复

注：评论功能可以参考各个网站/app的设计，要求和他们差不多

4.用户注册（必做）

用户注册时填写相关个人信息即可注册（刚注册时是普通用户）

同时需要绑定登录账号，比如邮箱、手机号等作为找回密码的依据（这里推荐邮箱注册，因为比较简单）

注意要进行验证操作（发送验证码，如果是邮箱就发邮件，手机号就发短信）

5.多方式登录（选做）

登录可以账号密码（这个必须有）

如果有能力的也可以另外再去弄微信、qq第三方登录方式登录

6.成员信息管理（必做）

后台可以对用户进行管理，比如授权

7.博文模块（必做）

可以展示实验室实验室同学最近写的优秀博文

点击博文详情可以进行查看

博文可以进行点赞，收藏，评论等互动操作

用户可以编写博文并发布，如果未编写完成也可以保存在草稿箱内

用户可以对自己的博文进行管理（修改，删除，设置不可见等）

8.公告模块（必做）

网站首页应该有公告显示

管理员可以在后台发布公告

公告应该可以有公告内容，发布人，发布时间等

9.消息通知功能（必做）

需要有消息通知界面，用户博文被点赞、评论，评论被回复等情况需要收到相应的消息通知（有能力的同学可以再发一封邮件告知用户）

10.个人信息模块（必做）

个人风采展示

比如个人介绍，曾任职的职位，技术方向，写的博文等等

注：这个需要自己去设计拓展合理的功能

个人信息修改

用户可以修改自己的账号信息

11.活动模块（选做）

可以查看最近的实验室/协会活动。

点开可以看到活动详情，点击报名填写相关信息后即为报名成功。

可以在活动下方评论

12.学习小组功能（选做）

注：该功能对应到我们实验室的学习小组，比如Java后端学习，前端开发学习小组等等，所以同学们可以发挥自己的想象去设计完成学习小组的功能

实验室成员可以创建学习小组（可以设置加入权限，比如实验室成员才可以加入，或者所有人都可以加入）

学习小组需要有名称，简介等信息

学习小组功能里有话题讨论功能，所有人都可以参加讨论

自己的写的博文可以关联到学习小组，这样关联的学习小组页面就会有相应的博文展示

用户可以加入相应的学习小组

13.集训功能(选做)

集训报名

信息收集

作业发布与提交

发布作业者评分

14.拓展模块/功能（选做）

根据自己对未来可能出现的需求进行补充，需求合理可额外加分

比如用户有职位称号，比如游客，实验室成员，宣传部部长，实验室负责人等等

二、我的设计思路

1.我的技术栈

后端：Spring+SringMVC+Mybaits+Springboot+tomcat+Maven+Mysql

测试：Postman

注：我采用了SSM+Springboot的架构

2.项目架构示意图

我觉得这样子示意图比较官方，我给出个人见解

Database：顾名思义就是存放数据的地方，其实它与数据层是有个连接池，我并未画出

数据层：书写一些sql语句和执行一些sql语句的dao接口

业务层：简单理解就是执行你业务逻辑的地方，就是如何使用数据层的dao接口并返回数据或者不返回

控制层：接受页面传递过来的数据或者不传递，然后根据情况来使用业务层业务逻辑的方法，返回值或者跳转页面。

3.系统架构图

注：我这里参考我们集训会长的图，和他的一些书写方式，很不错可以看看

详细：(17条消息) 【项目实战】仓库信息管理系统（layui+SSM+SpringBoot）_追梦-CSDN博客?

4.响应格式

我规定了返回格式也就是请求响应的格式，Result类规定响应格式的内容，如下：

package com.syk.labweb.returntype;

import lombok.Data;

/**
 * 定义一个通用的返回类型
 * @author syk
 */
@Data
public class Result {

    //成功标志
    private boolean success;

    //返回处理消息
    private String message;

    //返回状态码
    private int code;

    //返回具体数据（如用户账户信息）
    /** 这里result返回Object类型 可以将Data包里的数据传过来 */
    private Object result;

    public Result(){}

    public Result(boolean success,String message,int code){
        this.success=success;
        this.message=message;
        this.code=code;

    }

    public Result(boolean success,String message,int code,Object result){
        this.success=success;
        this.message=message;
        this.code=code;
        this.result=result;
    }

}

?Data类里的是我用来返回响应的数据，也可以返回给前端的数据，这里我只包装3个数据类，其余的其他响应数据我直接使用entity包里的实体类。（偷懒）