Java开发文档要注意设计规范，数据类型，速来学习

前言：关于【约起来】在线实习项目

约起来是基于大学生群体的类陌生人活动应用。

1、项目本身就是大学生自身的项目，面试的时候不用花很多时间去解释，去过多的掩饰来源。

2、项目本身的亮度足以达到大厂实习的项目水准。

比如说本项目的活动发起流程、陌生人安全性校验、活动时的选举投票机制，快速发现活动中存在问题。而且因为商用，功能点的深度都比较深。

3、真实的小程序上线

表现为手机网站应用，可嵌入微信端、小程序或APP中

本期发布的是在线实习“约起来“项目，第一期Java活动发布模块文档评审。

产品逻辑给了大家很多信息，整体来说各位同学开发文档写的不错，但是要注意设计规范，数据类型等。

作品一：FLAWLESS同学（8分）

一、活动信息表

二、活动发布模块接口设计

【导师点评】

本作品完成度较高，数据表对图片以及其他字段的类型和长度设计合理，但是列名设置不够规范，可读性稍低，接口文档不符合插入的逻辑。

作品二：星辰同学（8分）

一、数据库设计

二、接口设计

【导师点评】

本作品再接口设计上，考虑到前端对时间和链表格式的兼容性，但是数据库设计部分缺少部分商用字段。

这个作品整体的设计是比周最佳要好一点，但是因为数据库设计部分没有跟从我们的字段说明，略微减了一点分。

作品三：。。。同学（9分周最佳）

数据表：

【导师点评】

本作品数据库设计中能够考虑到数据类型以及图片等特殊条件下的处理，但是商用规范的部分字段有缺失。

这位同学的作品基本上覆盖了活动发布模块的模型数据，同时对活动类型的枚举和存储进行了一定的设计，特别是上传多个图片之后，怎么对一对多的情况变成一对一的数据库设计。

活动发布模块官方Java文档讲解

下面我们一起来看一下官方版文档，官方版在第一期里面给了很多表。我们着重来看几个，完整版文档大家可以自行下载。

• 数据表

ID是主键，自增，int类型一定要注意长度，一般来说11位，它最大长度就这了。CatagoryID分类，写成枚举，设计的值已经给出来了。HighLight亮点是varchar类型。content为test类型，不知道具体多长，一般长度如果再长的话，Test也不够。status比较特殊，认为0是删除，但这次有很多时候0作为无效态，要加个审核状态作为它的一个控制。所以0作为未审查，我们可以加个-1，-1是删除，这样就不用单独加个删除。images有一个技巧，如果图片比较多，而且不是特别重要，没有很多其他的属性，只有他自己的名称属性的时候，可以用逗号分格，这样的话就不用单独弄一张表，查取就会非常省性能。CityID城市也是枚举值，因为这次我们是做有限城市，所以不分什么省市。

• 分类

有两个分类。一个是活动的分类，一个是城市的分类。

注意，这两个分类，因为前端要发布的时候要用，一定是传约定好的这个数字，要注意接口传递。包括数据库的记录，能放数值就放数值不要放数字，因为数字一是很容易出问题，二是它的统计上不如数字方便来做。

• 接口设计

这次都在数据库实体类的范围内，所以我们直接把这个实体类作为一个参数。但是一定要注意，实体类做参数的时候，有些是传不过来的，比如说时间，前后端的时间格式上是不太好传的，这个时候一定要做一个处理。

基于此文档，可以进行下一步的开发。

本期点评和官方版讲解就到这里啦，看完之后有没有感到收获满满，想动手实操一下呢？如果对本期官方评审有任何疑问，或想具体了解在线实习「约起来」项目，欢迎关注“校招VIP”。

本期评审视频观看地址：https://m.naoffer.com/intern/review/312

更多报名项：线上实习-[约起来] 找人组团玩起来