Skip to content

A stackoverflow web application practise which is the project of course CS209A Spring in SUSTech.

Notifications You must be signed in to change notification settings

XiaoLeGG/stackoverflow-web-application

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CS209A-Spring Java 2


Stackoverflow Web Application

Project Report


  • 伦天乐(学号:12113019)贡献比:50%
  • 罗嘉诚(学号:12112910)贡献比:50%

项目简介与部署

项目简介

Stack Overflow网站是一个非常受欢迎的 IT 技术在线问答社区,专注于编程和软件开发领域。它允许开发人员在网站上提出技术问题,并接收来自全球开发者社区的答案和解决方案。

image-20230522150131283

本网络应用项目对Stack Overflow网站进行相关数据抽样统计,并进行数据可视化。项目主要采用 Spring BootMybatis Plus 作为后端框架,Vue 3.0 作为前端框架,使用PostgreSQL 数据库作为数据存储媒介。

用户可通过网络应用,查看相应的可视化数据图,直观地了解相应日期之间的Stack Overflow网站数据统计;用户也可以通过项目提供的 REST 服务,通过相应 API 获取处理后的数据。

GitHub开源链接:https://github.com/XiaoLeGG/stackoverflow-web-application

image-20230523163720719

项目本地部署

  1. 使用下列命令克隆项目仓库到本地:git clone https://github.com/XiaoLeGG/stackoverflow-web-application.git

  2. 如需爬取数据,请进入src/main/java/cn/edu/sustech/crawler 包中,运行 CrawlerMain.java,此操作需要配置需要存储爬取数据的数据库,即在代码中修改:主机(SQL_HOST)、端口(SQL_PORT)、数据库名称(SQL_DATABASE)、数据库用户名(SQL_USER)、数据库用户密码(SQL_PASSWORD)。

      private static final String SQL_HOST = "localhost";
      private static final String SQL_USER = "username";
      private static final String SQL_PASSWORD = "password";
      private static final String SQL_DATABASE = "database";
      private static final int SQL_PORT = 5432;
  3. 启用项目后端,请进入 src/main/java/cn/edu/sustech 包中,运行 StackofWebApplication.java,此操作需要首先配置src/resources 中的application.properties

    spring.devtools.restart.enabled=true
    spring.devtools.restart.additional-paths=src/main/java
    spring.datasource.url=jdbc:postgresql://localhost:5432/database
    spring.datasource.username=username
    spring.datasource.password=password
    spring.datasource.driver-class-name=org.postgresql.Driver
    mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

    image-20230522154251605

  4. 启用项目前端,请进入frontend 目录,在终端中执行 npm install 构建,再使用npm run dev 命令获取项目URL 链接。

  5. 确保项目前端、后端都正常运行后,可使用浏览器访问对应的项目URL 链接(即http://127.0.0.1:5173),访问网络应用。

image-20230522154538128

image-20230522154610226

项目架构

总体架构

本项目主要使用 Apache Maven 进行项目管理和自动构建,分为前端和后端两部分。前端框架采用 Vue 3.0,后端框架采用 SpringBoot 和 Mybatis-Plus,使用 Java 爬取数据到 PostgreSQL 数据库。

image-20230522192918486

上图的代码结构中,前端相关的代码部分保存在 frontend目录下,后端相关的代码部分保存在 src 目录下,其他文件是 Apache Maven 进行项目管理和自动构建时产生的文件。

前端架构

前端相关代码保存在 frontend 目录下,其树形结构图如下:

    frontend
    ├─public
    └─src
        ├─assets
        │  └─bg
        └─components
            ├─charts
            ├─data-containers
            └─parameters

前端主要使用了Vue 3.0ViteElement-UIVue-echarts包来设计前端,axiosdayjssass等依赖包用于获取和处理数据以及处理样式。同时,我们采用npm来处理依赖和包管理。

frontend包下,index.html为网页的主体html,vite.config.js配置Vue相关参数,如服务器代理,package.json包含了本次项目相关配置信息。

src包下主要是Vue构建的基本内容,其中App.vue是主体组件,main.js负责创建和导入包括css样式文件在内的全局的一些控件。

assets包下包含了一些css样式文件和icon等用到的图像文件。

components包下主要是Vue的其它子组件,其中包含了整体网页的顶部选项卡(HeaderComponent.vue),项目介绍组件(IntroductionComponent.vue)和数据内容展示组件(ContentComponent.vue),还有一个StatisticsContainer.vue作为数据展示容器模板。

charts包下主要为实现各类图表的基本组件,是根据本项目定制后设计的组件,方便后续使用。

data-containers主要包含了各类需要查询的数据图表容器组件。

parameters为各类数据查询需要的参数的输入组件。

另外,前端的数据采集主要使用的是后端的REST Api,前后端可以说是完全分离的。

后端架构

后端相关代码保存在 src 目录下,其树形结构图如下:

    src
    ├─main
    │  ├─java
    │  │  └─cn
    │  │      └─edu
    │  │          └─sustech
    │  │              ├─controller
    │  │              ├─crawler
    │  │              ├─entity
    │  │              ├─mapper
    │  │              │  └─api
    │  │              └─service
    │  └─resources
    └─test
        └─java
            └─cn
                └─edu
                    └─sustech

后端主要使用了SpringMybatis-Plus来提供Web服务。

controller 包中存储形如 XXXController.java 若干与相应实体(问题、答案、评论、用户等)的控制方法,既能提供相关的 REST 服务,即通过相应 API 提供处理后的数据;又能为前端可视化提供所需要的数据。

crawler 包中存储有 CrawlerMain.java 是主方法,运行后将刷新数据库中的数据,使用到同一包下的工具类DatabaseService.java(提供数据库的服务)、DataCollector.java(提供爬虫的服务)、StandfordCoreNLPService.java(提供 NLP分词服务)。

entity 包中是数据表中各表的实体,在 Mybatis-Plus 框架中使用到。

mapper 包中是数据表中各表的映射,在 Mybatis-Plus 框架中使用到。

service 包中是使用 Mybatis 在各表中进行数据查询的服务类。

数据库架构

本项目采用 PostgreSQL 数据库存储数据。PostgreSQL是一个功能强大的关系型数据库管理系统(RDBMS),它的设计目标是提供可靠性、可扩展性和数据完整性。

  • 可靠性:PostgreSQL是一个可靠的数据库系统,具有良好的数据完整性和持久性。它支持事务处理,可以确保在数据库操作过程中的错误或故障时数据的一致性和可靠性。
  • 可扩展性:PostgreSQL具有良好的可扩展性,可以处理大量数据和高并发访问。它支持水平扩展和垂直扩展,可以通过添加更多的服务器节点或增加硬件资源来提高数据库的性能和容量。
  • 强大的功能:PostgreSQL提供了广泛的功能和灵活的查询语言,支持复杂的查询操作和高级特性,如联接、子查询、触发器、视图等。它还支持多种数据类型,包括文本、数字、日期/时间、地理空间数据等。

ER 图

image-20230522202040421

可视化图

diagram

爬虫

实现方式

使用官方 StackOverflow REST API 文档,通过相应接口随机爬取若干问题、这些问题对应的所有回答、评论。

爬虫在 src/main/java/cn/edu/sustech/crawler 包中得到实现,需要使用如下三个服务:DatabaseService.java(提供数据库的服务)、DataCollector.java(提供爬虫的服务)、StandfordCoreNLPService.java(提供 NLP分词服务)。

数据库服务

DatabaseService 提供如下重要方法:

  1. connect()/close() 连接/关闭数据库
  2. createTable() 数据表创建
  3. disableForeignKeyCheck()/enableForeignKeyCheck() 关闭打开外键约束
  4. insertQuestion()/insertTag()/... 向某数据表中插入数据
  5. insertQuestionRecord()/insertAnswerRecord()/insertCommentRecord() 将问题/答案/评论的 JSON 格式的数据插入数据库

爬虫服务

由两个参数控制爬取的数据量:pageSize 和 pageStep。前者表示每次分页查询的数据条数(最多是 pageSize 条,最多 $100$,通过也设为 $100$),后者表示按照 activity 排序后,每隔 pageStep 页获取一页数据,插入到数据库中。

DataCollector 提供如下重要方法:

  1. refresh() 爬取最新数据,并插入到数据库中。
  2. collectData() 数据爬取。
  3. getCommentsFromAnswer(String ids) 获取每个回答的评论,idsanswer_id的字符串,以分号分隔。
  4. getCommentsFromQuestion(String ids) 获取每个问题的评论,idsquestion_id的字符串,以分号分隔。
  5. getAnswers(String ids) 获取每个问题的回答,ids question_id的字符串,以分号分隔。

NLP分词服务

Stanford NLP是由斯坦福大学开发的强大工具包,专注于自然语言处理领域。它提供了丰富的功能,其中包括英文分词。英文分词是将英文文本切分成独立的词语或标记的过程。Stanford NLP中的英文分词模块采用了现代的机器学习和统计技术,以及大规模的语料库和语言资源。它能够准确地切分出英文文本中的单词、短语和标点符号。

基于此,在爬取数据写入数据库时,我们使用 Stanford NLP 工具包对所有QuestionAnswerCommentbody 中的内容进行 NLP 分词,获得句子中出现的 Jave API 纳入统计。

StanfordCoreNLPService类的 getAllJavaAPI() 方法就是对于输入的字符串,返回一个 Jave API 的词频 Map

public class StanfordCoreNLPService {
  private final Properties props;
  private final StanfordCoreNLP pipeline;
  public StanfordCoreNLPService() {
    props = new Properties();
    props.setProperty("annotators", "tokenize,ssplit,pos,lemma,ner");
    props.setProperty("ner.useSUTime", "false");
    pipeline = new StanfordCoreNLP(props);
  }

  public Map<String, Integer> getAllJavaAPI(String htmlText) {
    Map<String, Integer> javaAPIs = new HashMap<>();
    Annotation annotation = new Annotation(htmlText);
    pipeline.annotate(annotation);
    List<CoreMap> sentences = annotation.get(CoreAnnotations.SentencesAnnotation.class);
    for (CoreMap sentence : sentences) {
      List<CoreLabel> tokens = sentence.get(CoreAnnotations.TokensAnnotation.class);
      for (CoreLabel token : tokens) {
        String word = token.get(CoreAnnotations.TextAnnotation.class);
        if (word.startsWith("java.")) {
          if (javaAPIs.containsKey(word)) {
            javaAPIs.put(word, javaAPIs.get(word) + 1);
          } else {
            javaAPIs.put(word, 1);
          }
        }
      }
    }
    return javaAPIs;
  }
}

数据情况

截止2023年05月22日晚23:10:09,最后一次以 pageSize = 100 和 pageStep = 100 进行数据爬取(即完成StackOverflow中 1% 问答数据的收集)。

image-20230523013758090

共计收集 19,000 个 Thread 的数据。包括:

  • 19,000 个问题

    image-20230523013910605
  • 30,592 个答案

    image-20230523013942310
  • 80,372条评论

    image-20230523014044015
  • 42,407个用户

    image-20230523014109815
  • 1,769 个不同的 Java API

    image-20230523014136823
  • 5,516 种不同的问题标签

image-20230523014155721

数据分析结果

我们选取 2000年01月01日到2023年5月23日的数据进行分析。

答案的个数

没有答案的问题的百分比

根据下图可以得出,没有答案的问题百分比约为 14.27%。

image-20230523020355619

问题答案个数的平均值

根据下图可以得出,问题答案个数的平均值约为 1.61个。

image-20230523020724729

问题答案个数的最大值

根据下图可以得出,问题答案个数的最大值为 31个。

image-20230523020806520

问题答案个数的分布

根据下图可以得出,问题答案个数总体趋势是集中在 1 个答案,随着问题答案数目的增加,拥有相应个数答案的问题数量波动下降。

image-20230523020905169

image-20230523021113908

被接受的答案

有被接受答案问题的百分比

根据下图可以得出,有接受答案的问题的百分比约为 49.26%。

image-20230523021226280

问题从提出到解决的时间间隔分布

根据下图可以得出,问题从提出到解决的时间间隔分布的累积分布图如下。

image-20230523021347780

含有非接受答案的赞同数高于被接受答案的问题的百分比

根据下图可以得出,含有非接受答案的赞同数高于被接受答案的问题(拥有更好答案的问题)的百分比约为 9.07% 。

image-20230523021751368

标签

单标签经常出现、得到最多的点赞、得到最多的浏览量

由于我们数据收集时默认筛选 java,所以我们此时默认不显示 java标签。可以发现单标签经常出现、得到最多的点赞、得到最多的浏览量都是android 标签。

image-20230523021945668

标签组经常出现、得到最多的点赞、得到最多的浏览量

由于在StackOverflow中,标签组最多能设置 $5$ 个标签,由于我们数据收集时默认筛选 java,所以此处可选择标签组标签个数范围为 $1$$4$,此处以标签组标签个数为 3 举例,发现最经常出现的标签组合是android, firebase, google-cloud-firestore、点赞数最高的标签组合是 annotations, autowired, spring、拥有最多浏览量的标签组是bit, integer, x

image-20230523022232591

用户

参与 Thread 讨论的用户数量的分布

根据下图可以得出,参与Thread 讨论的用户数量的总体趋势是集中在 1 到 10 位用户讨论,随着参与讨论用户数目的增加,拥有相应参与讨论用户数目的问题数量波动下降。

image-20230523023056131

image-20230523023250696

对于问题提出 Answer 的用户数量的分布

根据下图可以得出,参与 Answer 的用户数量的总体趋势是集中在 1 到 5 位用户讨论,随着参与讨论用户数目的增加,拥有相应参与用户数目的问题数量波动下降。

image-20230523023341787

针对问题和对应答案参与 Comment 讨论的用户数量的分布

根据下图可以得出,参与 Comment的用户数量的总体趋势是集中在 1 到 7 位用户讨论,随着参与讨论用户数目的增加,拥有相应参与用户数目的问题数量波动下降。

image-20230523023531189

活跃用户

用户的活跃度定义为其提问数、回答数、评论数之和,我们统计了活跃度前10名的用户,以柱形图方式呈现。其中匿名(用五角星标出)表示用户以某种方式(注销、匿名参与)没有account_id可供识别账户的用户的活跃度。

image-20230523023751511

最频繁讨论的 Java API

采用 Stanford NLP 分词统计所有收集到的 body 长文本内容,提取其中出现的 Java API 种类以及出现的次数进行统计,得到最频繁讨论的 Java API 的前10名。

image-20230523024117285

RESTful API 接口文档

为了满足开发者使用本项目提供的 RESTful API,下面是本项目提供相关接口。

请求参数

字段 类型 描述
from 日期型 查询数据起始时间(采用yyyy-MM-ddTHH:mm:ss格式)
end 日期型 查询数据结束时间(采用yyyy-MM-ddTHH:mm:ss格式)
size 整数型 查询标签组中标签的个数

Number of Answers

没有答案问题的百分比

GET /api/question/no-answer/percentage

请求参数:from(必填)、end(必填)。

响应参数:浮点数,没有答案问题的百分比。

示例http://localhost:8080/api/question/no-answer/percentage?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523155940377

问题回答数量的平均值

GET /api/question/answer/average

请求参数:from(必填)、end(必填)。

响应参数:浮点数,问题回答数量的平均值。

示例http://localhost:8080/api/question/answer/average?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523155958024

问题答案数量的最大值

GET /api/question/answer/max

请求参数:from(必填)、end(必填)。

响应参数:整数,问题答案数量的最大值。

示例http://localhost:8080/api/question/answer/max?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523160035746

问题回答数量分布

GET /api/question/answer/distribution

请求参数:from(必填)、end(必填)。

响应参数:二元组集合,表示的是每一个特定回答数量的问题数量。如[1, 371]表示的是回答数只有1个问题数有371个。

示例http://localhost:8080/api/question/answer/distribution?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523160244172

Accepted Answers

有被接受答案的问题(占问题总数)的百分比

GET /api/question/with-accepted-answer/percentage

请求参数:from(必填)、end(必填)。

响应参数:浮点数,有被接受答案的问题(占问题总数)的百分比。

示例http://localhost:8080/api/question/with-accepted-answer/percentage?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523160504481

问题从提出到解决的时间间隔分布

GET /api/question/with-accepted-answer/resolution-distribution

请求参数:from(必填)、end(必填)。

响应参数:二元组集合,表示的是每一个解决时间间隔的问题数量,时间间隔单位为毫秒。如[1289000, 1]表示的是花了1289000毫秒才得到解决的问题数有一个。

示例http://localhost:8080/api/question/with-accepted-answer/resolution-distribution?from=2021-12-28T00:00:00&end=2023-02-01T00:00:00。

image-20230523160713501

含有非接受答案的点赞数高于被接受答案问题的百分比

GET /api/question/with-accepted-answer/better-answer/percentage

请求参数:from(必填)、end(必填)。

响应参数:浮点数,没有答案问题的百分比。

示例http://localhost:8080/api/question/with-accepted-answer/better-answer/percentage?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523160844766

单 tag 出现的次数

GET /api/tag/single-tag/count

请求参数:from(必填)、end(必填)。

响应参数:Json格式数据,tag是tag的名称,count是这个tag的出现次数。

示例http://localhost:8080/api/tag/single-tag/count?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523212307813

单 tag 的点赞数

GET /api/tag/single-tag/upvote

请求参数:from(必填)、end(必填)。

响应参数:Json格式数据,tag是tag的名称,count是这个tag的点赞数。

示例http://localhost:8080/api/tag/single-tag/upvote?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523212516363

单 tag 的浏览量

GET /api/tag/single-tag/view

请求参数:from(必填)、end(必填)。

响应参数:Json格式数据,tag是tag的名称,count是这个tag的浏览量。

示例http://localhost:8080/api/tag/single-tag/view?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523212616984

Tags

一定规模的tag组出现的次数

GET /api/tag/group-tag/count

请求参数:from(必填)、end(必填)、size(必填)。

响应参数:Json格式数据,tags是tag组的所有tag字典序排序后通过逗号分割拼起来的字符串,count是这个tag组的出现次数。

示例http://localhost:8080/api/tag/group-tag/count?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00&size=2。

image-20230523161253226

一定规模的tag组的点赞数

GET /api/tag/group-tag/upvote

请求参数:from(必填)、end(必填)、size(必填)。

响应参数:Json格式数据,tags是tag组的所有tag字典序排序后通过逗号分割拼起来的字符串,count是这个tag组的点赞数。

示例http://localhost:8080/api/tag/group-tag/upvote?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00&size=2。

image-20230523161501871

一定规模的tag组的浏览量

GET /api/tag/group-tag/view

请求参数:from(必填)、end(必填)、size(必填)。

响应参数:Json格式数据,tags是tag组的所有tag字典序排序后通过逗号分割拼起来的字符串,count是这个tag组的浏览量。

示例http://localhost:8080/api/tag/group-tag/view?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00&size=2。

image-20230523161535025

Users

问题讨论涉及到的用户数量分布

GET /api/user/participation-distribution

请求参数:from(必填)、end(必填)。

响应参数:二元组集合,表示的是每一个特定用户参与数的问题数量。如[1, 32]表示的是仅有一个用户参与的问题数量有32个。值得注意的是,这里不统计没有其它用户参与的问题。

示例http://localhost:8080/api/user/participation-distribution?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523161921799

问题讨论涉及到的回答者数量的分布

GET /api/user/post-answer-distribution

请求参数:from(必填)、end(必填)。

响应参数:二元组集合,表示的是每一个特定回答者参与数的问题数量。如[1, 54]表示的是仅有一个回答者的问题数量有54个。值得注意的是,这里不统计没有回答的问题。

示例http://localhost:8080/api/user/post-answer-distribution?from=2022-12-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523162022117

问题讨论涉及到的评论者数量的分布

GET api/user/post-comment-distribution

请求参数:from(必填)、end(必填)。

响应参数:二元组集合,表示的是每一个特定评论者参与数的问题数量。如[1, 394]表示的是仅有一个评论者的问题数量有394个。值得注意的是,这里不统计没有评论的问题。

示例http://localhost:8080/api/user/post-comment-distribution?from=2022-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523162136467

参与问题讨论的用户的活跃值

GET /api/user/activity

请求参数:from(必填)、end(必填)。

响应参数:Json格式数据,activity是用户的参与活跃数,user下是用户在Stack Overflow上的相关数据,包括头像、accountIduserId等数据信息。

示例http://localhost:8080/api/user/activity?from=2023-01-31T00:00:00&end=2023-02-01T00:00:00。

image-20230523162339274

Java API

查询不同的Java API出现次数

GET /api/api/count

请求参数:from(必填)、end(必填)。

响应参数:Json格式数据,api是Java API的完整路径,count是统计出现的次数。

示例http://localhost:8080/api/api/count?from=2023-01-01T00:00:00&end=2023-02-01T00:00:00。

image-20230523162436996

About

A stackoverflow web application practise which is the project of course CS209A Spring in SUSTech.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published