标签（空格分隔）： 紫牛小筑 MongoDB
- 用户相关信息，包括用户信息和角色。
user {
"id" : String //主键ID，自动生成
"loginName" : String(32) //登录用户名
"showName" : String(32) //显示的用户名称
"passwd" : String(64) //登录密码
"stage" : byte(1) //状态
"roles" : List<String> //角色列表
"sex" : byte(1) //性别
"age" : int //年龄
"rank" : String(16) //职级(段位)
"cellNum" : String(16) //通讯号码
"jc" : int //节操
"email" : String(64) //电子邮箱
"avatar" : Res {
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
}
"gmtCreate" : Date //创建时间
"gmtModify" : Date //修改时间
}
- 配置信息，可以做配置，也可以做规则配置
config {
"code" : String(64) //配置编码，主键
"name" : String(64) //配置名称
"type" : byte(1) //类型，默认为0
"stage" : byte(1) //有效状态：0为使用中，1为已弃用，2为保留。
"descrip" : String(32) //配置值说明
"byteVar" : byte(2) //1~2位数值型数据
"intVar" : int //1~9位数值型数据
"longVar" : long(18) //10~18位数值型数据
"strVar" : String(64) //短字符串型数据
"str1024Var" : String(1024) //长字符串型数据
"gmtModify" : Date //修改时间
}
- 节操流水，记录节操流通信息
jcRec {
"id" : String //主键ID，自动生成
"outer" : String(32) //节操流出方的loginName
"amount" : int //数量
"iner" : String(32) //节操流入方的loginName
"type" : byte(1) //类型，系统发放为0，系统奖励为1，系统返还为2，用户打赏为5，其他用户消耗为6
"descrip" : String(32) //说明
}
- 课程相关信息，包括课程资源信息。
course {
"id" : String //主键ID
"title" : String(32) //主题
"descrip" : String(128) //课程介绍
"lecturer" : String(32) //讲师的loginName
"lecturerName" : String(32) //讲师的showName
"audience" : String(32) //受众描述
"gmtLecture" : Date //开讲时间
"addr" : String(128) //讲课地点
"stage" : byte(1) //课程阶段：0为发布，1为审核，2为保留，3为报名，4为闭课，5为开课，6为结课，7为公开。
"ruleCode" : String(64) //规则编码
"signups" : List<Signup> [ //报名列表
{
"loginName" : String(32) //登录用户名
"showName" : String(32) //显示的用户名称
"rewardCnt" : int //赞赏次数，大于0的最长不超过4位的纯数字
"gmtSignup" : Date //报名时间
}
]
"cover" : Res { //封面图片
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
}
"ppt" : DownableRes { //演示文档
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
"fsize" : int //文件大小，单位为B字节
"downCnt" : int //下载次数
}
"speech" : DownableRes { //课程文稿
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
"fsize" : int //文件大小，单位为B字节
"downCnt" : int //下载次数
}
"audio" : PlayableRes { //演讲音频
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
"fsize" : int //文件大小，单位为B字节
"playCnt" : int //播放次数
"downCnt" : int //下载次数
}
"video" : PlayableRes { //演讲视频
"bucket" : String(32) //储存空间
"fileKey" : String(64) //文件key
"url" : String(128) //外连URL
"fsize" : int //文件大小，单位为B字节
"playCnt" : int //播放次数
"downCnt" : int //下载次数
}
"gmtModify" : Date //修改时间
}
- 课程评论相关信息，包括评论课程的用户、评论、被赞父评论ID等信息。
courseCmt {
"id" : String //主键ID，自动生成
"courseId" : String //课程ID
"loginName" : String(32) //登录用户名
"showName" : String(32) //显示的用户名称
"cmtPid" : String //回复的评论的ID
"likes" : List<String> [ //点赞的用户
"loginName" : String(32) //登录用户名
]
"content" : String(256) //评论内容
"gmtModify" : Date //修改时间
}
- common：公共层，一些共用工具类、静态常量类、枚举类等
- data：数据层，数据存取接口、实体对象等
- service：服务层，对数据功能进行封装的接口，承担外部接口与数据层的桥梁，实现复杂业务逻辑的处理
- control：控制层，提供Http接口，承担请求的权限和安全的控制，参数的校验和简单业务逻辑的控制
- webapp：Web层，启动入口、配置等，前端页面、脚本、样式和资源等
- 使用Gradle管理依赖，依赖的包要加在就近引用的子模块，各模块避免重复引入
- 配置文件统一放在/resources/config目录下，要求精简，并且风格统一，不保留无用的配置
- 框架配置类统一放在webapp子模块的config包下
- 实体对象类都要加Document注解，子类与父类共用同一集合的，子类需要使用collection指定集合名
- 持久层接口统一从MongoRepository接口继承，其中自定义的方法请遵循Mongodb约定命名
- 服务层也要做必要的校验和异常处理，以及格式化日志输出
- 控制层接口建议继承BaseController类，返回数据请调用BaseController类中封装的方法
- Http接口非特殊不返回页面，统一返回JSON格式的数据，并按下一条规范进行封装
- 返回数据封装字段：success、code、msg、data，返回失败时，无数据data可以省略
- 对于MongoDB集合数据，主键ID为ObjectId类型时，请使用BaseController中setKey或setKeys方法，对返回的数据进行封装，以ModelMap类型返回，设置对象主键为key，对象为value
- 日志输出建议使用log，统一使用slf4j的标准包
- Html页面统一放在/resources/static目录下，并且按功能或模块分子目录
- Js和Css等统一放在/resources/public目录下，并且按功能或模块分子目录
- 对静态资源的引用统一使用项目根路径
- 统一使用Ajax请求后端接口
- 一些通用和方法和token管理相关的方法都在/js/commons.js中进行了封装，建议引用
- 已经集成了Jwt和SpringSecurity实现了登录和权限的控制，并对前端管理token也进行了js封装。
- 在controller中可以对整个类或者指定方法进行权限的控制，配置方法如下：
@RestController
@PreAuthorize("hasRole('ADMIN')")
public class CourseReviewController extends BaseController {
}@RestController
@RequestMapping("/course")
public class CourseController extends BaseController {
@PostMapping("/signup")
@PreAuthorize("hasRole('USER')")
public ModelMap signup(String id) {
}
}- 所有的人都要设置文件头，格式如下：
/**
* Copyright © 2017年 ziniuxiaozhu. All rights reserved.
* @author 临江仙 [email protected]
* @Date ${DATE} ${TIME}
*
*/
- 每个类和每个方法都要写上注释，注释请参考优秀的spring源码
- 安装阿里代码规约插件和findbug插件，提交时务必对自己代码进行扫描
