基于Python+SQLite实现校园信息化统计平台

一、项目基本情况

概述

本项目以清华大学为预期用户，作为校内信息化统计平台进行服务，建立网页端和移动端校内信息化统计平台，基于Project_1的需求实现。

本项目能够满足校内学生团体的几类统计需求，如活动报名、实验室招募、多规则投票；对于收集到的数据可以进行一定的统计、分析，并且将分析结果进行可视化的展示，为提升校园工作的效率和数据的安全性供帮助。同时也为公司和校外团队提供服务。

开发环境

本项目在前端及javascript部分使用了Bootstrap 3.3.5及jQuery2.1.4等框架，在后端则使用了Python 2.7.10 + Django 1.8.4的框架，并使用了Django框架中自带的SQLite数据库。

运行说明

为了运行本项目，首先需要确保运行的环境已经安装好Python2.7以及Django1.8.4。

若需要在本地运行本项目，进入所在目录的src文件夹，执行如下命令：

$ python manage.py runserver 0.0.0.0 8080

并在浏览器中访问 http://127.0.0.1:8080/ 便可看到登陆界面

二、需求分析

概述

本项目的需求分析基于项目开始前需求方提供的文档《PRJ1-校园信息化统计平台》进行。在对这份进行分析后，我们将所有的需求分为三大块:

问卷系统设计

该部分为本项目最主要的功能，具体表现为活动的发起方可以在线编辑问卷并发布，活动的参与方可以根据发起方发布的有平台生成的信息访问该问卷并进行填写，填写的信息需记录在平台的后台备用。问卷的设计发布功能需满足多种要求。

问卷数据的处理

该部分为本项目的重要功能之一，对问卷平台的活动发布者开放，根据问卷系统中所收集备用的信息处理，并向用户开放数据导出、分析与统计的端口，包括各种可视化实现。

用户系统管理

设置管理员权限用户，使用内置账户登录，可以管理其它普通用户和普通用户发布的问卷，同时需要实现普通用户的个人用户界面。

值得注意的是，由于需求中包括普通要求，提高要求，终极要求等多个等级，而部分提高要求在开始是不在实现计划的范围内，在最后也并未实现，下述的详细需求分析中删去了这部分提高要求的内容，并在本组与需求方讨论后添加了用于优化用户体验的内容。

问卷系统设计

图1: 问卷系统泳道图

其中设置的三种文件模板分别对应需求中提及的报名/信息统计表、实验室对象招募设计以及多规则投票平台。题目的类型特征对应题目类型，包括多选题的选项数，填空题的内容类型（数字，电话号码，邮箱等），若使用投票平台等模板，则此处的问卷问题变为投票的项目。问卷的发布方式为导出链接与二维码，问卷的传播由发布者利用社交工具进行。

问卷数据的处理

图2: 问卷数据处理泳道图

其中可视化表格包括柱状图、饼状图、折线图等，内容包括平均值、方差等简单的计算与简单的数据总量统计。需收集的答卷情况除了答卷本身外，还包括填写者的IP等信息，导出的excel/csv格式数据中包括以上内容。

用户系统管理

图3: 用户系统管理泳道图

该部分要求主要来自与需求方的沟通，管理员由内置账号实现，而清华学生用户由清华账号登陆。管理员主要功能为查看与删除问卷，查看用户信息与发布公告。

三、模块及接口设计

概述

本项目的实现主要分为四个模块，由于本项目由Python2.7.10加上Django1.8.4实现，这四个模块体现为四个app，分别为dance、interface、api以及database。

interface、database以及api三个模块分别负责前端用户界面，数据库，以及连接前端用户界面与数据库，将在本章的其余部分做详细说明。

图4: 模块拓扑关系图

顶层模块dance为Django项目创建时自带的app，主要负责记录Django框架的基本设置，以及保存其余三个模块所通用的URL模板。由于本项目Django设置主要为将其余三个模块app加入顶层模块，设置语言，时区、设置SMTP服务器等，在这一章中不做更多的说明，其具体的设置见技术细节部分。

用户界面interface

interface模块的接口主要在interface文件夹下的views.py中实现，该模块直接与用户进行交互，主要实现的接口功能为响应URL请求并对模板进行渲染后返回，下表以普通用户的权限可以访问的URL接口为例展示接口功能，管理员与游客身份问卷发布者的接口与之类似：

表1：interface模块中普通用户页面的接口名称与功能表

除此之外还定义了一些问卷参与者填写问卷时调用的接口，以及模块内部互相调用的一些函数，如render_ajax与render_sortable，封装了返回一个部件或可排序表格的过程，以及check_indentity和get_username等检查session中信息以实现权限控制的内容。

前后端接口api

api模块位于前端与数据库之间，负责将前端的数据传给数据库，并将数据库的处理结果返回给前端。考虑到实现效率和用户体验问题，发送邮件，请求登录等耗时操作也在此模块中进行，并在这个过程中调用database的接口，api中具体的接口名称与功能如下表，这些接口主要位于api文件夹下的views.py文件中，其中删去了一些内部调用的函数：

表2：api模块的接口名称与接口功能表

后端数据库database

database模块即我们的数据库，其接口为api所调用，主要返回数据库中所存放的信息，这些接口与api接口即功能表中提到的需要访问数据库的接口基本对应，这些接口主要位于database文件夹下的api.py文件中，具体如下。

表3：database模块的接口名与功能表

该表中删去了部分database模块内部调用的接口，这些接口主要负责将数据库中取出的信息制成dict类型，并且将多个这种dict制成一个list。还有部分接口负责进行测试，这些接口也没有在这张接口功能表中被提及。

在api模块与database模块的功能表中多次提到“返回数据库提供的处理结果”以及“返回处理结果”等表述，这里返回的处理结果为一个变量，表示处理流程是否成功完成，用以避免数据库出错或者从interface传入api模块的数据出错所导致的问题。

四、技术细节

概述

本项目的实现主要包括三种类型的代码，分别是作为网站框架的Django+Python代码，前端网页的HTML文件与CSS样式表，以及前端的JavaScript脚本语言。本章将对这三种类型的代码分别展开，介绍本项目的一些重要的技术细节。

本项目所实现的网站的拓扑结构如下图所示，每个模块基本由HTML+CSS加上JavaScript实现，模块间的跳转与准入权限控制等由Django+Python实现，模块间的和模块与后台的数据沟通由JavaScript和Django+Python实现。

图5：清华大学信息化统计平台网站拓扑结构图

Django部分

Django渲染函数

interface文件夹中的views.py文件包含了网站所有页面对应的Django渲染函数，具体的接口名称和功能请见模块与接口设计一章的用户界面interface一节，此处不再赘述，这一节里将重点介绍在前面没有提及的封装的两个渲染函数render_ajax与render_sortable，分别进行Ajax请求的处理以及可排序表格的渲染。

在概述一节中提出的网页拓扑结构图中的链接跳转绝大部分是由Ajax请求完成的，通过Ajax请求载入页面时，在载入网页时不需要刷新整个页面，只需要返回一个部件即可，而当用户进行刷新等操作，或者直接通过URL访问网页时，需要刷新整个页面。render_ajax函数可以解决此类矛盾，通过判断请求是否为Ajax请求，若是，则通过JavaScript实现仅渲染一个部件，若不是，则渲染整个网页，因此对于每个页面存在两种模板文件。

render_ajax函数的调用方法类似render函数，其接口如下：

render_ajax(request，url，params，item_id = ‘ ’)

表4：render_ajax函数的参数表

可排序表格为本项目中一个经常使用的特殊部件，例如用户查看所有自己发布的文件时会需要渲染可排序表格，关于该表格的具体技术细节见HTML与CSS部分。本项目封装了用于渲染可排序表格的函数render_sortable，其接口如下：

render_sortable(request, items, url, params)

表5：render_sortable函数的参数表

可排序表格支持排序顺序的自定义，包括升序和降序，排序内容的筛选，以及关键词搜索。这些参数将会以GET请求从网页中事实获得，并对表格进行刷新。可排序表格中每一个分页的分页信息，即参数调用同一文件内的get_pagination函数获得，其接口如下：

get_pagination(item_total, item_per_page, cur)

表6: get_pagination函数的参数表

该函数根据这些信息打包为一个list，作为params传入render_sortable函数中

Django网页模板

本项目通过Django模板的继承避免了大量的代码重复，下面介绍主要使用到的模板，以及这些模板对应的网页的结构与作用，模板的具体实现将在HTML与CSS部分介绍。

这些模板文件均位于interface模块下的templates文件夹中。publish_base.html与base.html为最主要的两个模板，分别对应问卷填写者，以及问卷发布者，包括清华学生用户，游客，管理员的主界面模板。前者由后者删除user-menu模块与left-column模块后得到，其余部分与base.html基本一致，因此这里仅详细介绍base.html。

base.html模板为大部分其它模板所继承，共包含8个block，如下表所示：

表7: base.html模板的block说明表

由于base.html文件为问卷发布者用户界面的模板，服务于普通清华账号用户，管理员以及游客，本项目对于者三种身份的用户在base.html模板的基础上定制了独特的用户界面。这些定制的用户界面模板均命名为index.html，存放于templates文件夹下的legalUser、manager以及guest等子文件夹中。

又由于其中管理员以及游客界面所使用的用户界面是在普通用户的界面中删去某些部分，或是稍作修改而成，这里首先以普通用户的legalUser文件夹下的模板文件为例介绍用户界面的结构。

legalUser文件夹根目录的情况如下表所示：

表8：legalUser文件夹内容表

其中可排序表格的渲染模板文件如下表所示：

表9：可排序表格渲染模板文件表

阻塞式窗口是为了让用户优先响应某些事件而设立的，如修改题目时的设置表，简单的确认框等，将会在HTML与CSS部分详细介绍，其模板类型如下表所示：

表10：阻塞式窗口渲染模板文件表

问卷问题模板用于在用户编辑时即时显示问题的样式，也用户在问卷填写者填写问卷时显示问题的样式，其模板类型如下表所示：

表11：问卷问题模板文件表

除了已经提到的dashboard与application两个栏目以外，用户界面还设置有其它数个栏目，这些栏目的模板均由一个html文件和一个ajax.html文件组成，应对不同请求：

表12：用户页面界面种类表

除了用户界面外，还有继承了publish_base.html模板的填写问卷界面模板，这些模板文件位于templates目录下的questionnaire文件夹中，该文件夹目录如下表：

表13：questionnaire文件夹目录表

其中publish_qst中的模板与上面提到的显示模板基本一致，但取消了问题操作菜单。

Django 数据模型

使用了Django ORM进行数据库的构建与管理。以下列出所使用的数据模型。

Admin

每条记录表示一名管理员。

User

每条记录代表一名用户。

Questionaire

每条记录代表一张问卷。

questionaire_status域可能的取值与含义如下：

questionaire_type域可能的取值与含义如下：

Question

每条记录代表一个问题。

question_type域可能的取值与含义如下：

Choice

每条记录代表一个选项。

Filler

每条记录代表一次填写。

Answer

每条记录代表一个回答。

HTML与CSS部分

概况

在前端设计部分，本项目使用了开源框架，经过发布者允许后利用了其中的部分html文件模板，经过优化和细节方面的修改，应用于本项目。如上节中提到的base.html文件，这些html文件模板主要用于用户界面。并复用了该项目中使用的多种运行库。同时本项目借鉴了上述开源项目的部分JS代码，并根据自身需求加以修改和优化，这一部分将在下一节JavaScript代码部分重点强调。

本项目用户界面以外的部分由小组成员设计并实现，与使用了该框架的用户界面部分风格有所不用，但是配色等整体印象大体一致，例如登陆界面以及问卷提交成功界面，这些界面基本上由静态HTML文件实现，并没有使用Bootstrap等框架。

主页面情况

本项目的主页面如下图：

图6：清华大学信息化统计平台主页面

页面最顶端为导航栏，左侧为侧边栏，右侧为主页面，对应上一节提到的base.html的block，在legalUser/index.html中具体实现。主页面中每一个方框在html标签中为一个div容器，通过Bootstrap中的col-md标签来控制宽度并自适应高度。

单击左边栏中的按钮会发送Ajax请求，动态的加载对应的主页面部件，如下图所示：

图7：清华大学信息化统计平台问卷设计界面

其它用户界面的风格与实现与之类似，而上文提到的用户登陆界面等其它一些界面的风格与之有所不同，下面以该界面为例，其html与css代码位于login_page.html文件：

图8：清华大学信息化统计平台用户登陆界面

该页面中使用了表单form，图像img和容器div，表单项目input等html标签，css部分主要设置了部件颜色，间距，位置，大小等信息，并根据不同宽度屏幕设置了自适应宽度。

本项目中多次，多处使用了html的form表单标签，后端对表单的处理方式为通过URL请求调用interface模块中的接口，这些接口的具体定义见第三章内容，网页端同时使用JS对表单的提交进行处理，详见本章的JavaScript一节。

阻塞式窗口

阻塞式窗口的设置可以让用户优先响应某些事件，本项目中的阻塞式窗口有两种类型，一种是包含复杂的HTML窗口，具体种类如表11所示，如图9，另一种是简单的确认框。

图9：复杂HTML阻塞式窗口

图10：简单的确认框

移动端优化

本项目对移动端进行了部分优化，这些优化继承于概述中提到的开源项目，并且针对用户体验进行了大幅度的优化，使得手机端的操作更加人性化，加载更加迅速。

图11：移动端访问本网站的效果

移动端优化如隐藏侧边栏为左侧的滑动窗口，一些长度过长的表格进行分页等。移动端的布局基于Bootstrap响应式布局，当页面宽度低于一个固定值768px时会自动切换。

可排序表格

可排序表格为本项目的一个特点，继承于概述中提到的开源项目，并针对本项目的特点进行了优化和重新设计，并且修复了一些运行中的错误，具体效果如下图所示：

图12：可排序表格

整个表格外部被一个div所容纳，搜索框与表示表内项目数的气泡均基于Bootstrap框架实现。表格内部被分为表头和表体两部分，分别由两个HTML文件作为模板，详情见上一节可排序表格的内容，表格的显示与HTML标签原生的表格与Bootstrap框架类似，但通过表格体item的筛选实现可排序功能。表格体内容的筛选通过调用后端interface模块的接口进行，表格体内容的实时加载在后面JavaScript部分会提及。

JavaScript部分

概况

JavaScript部分解决了绝大多数页面逻辑以及交互效果的实现，是本项目中代码量最多的部分。本项目使用了两个核心JS框架，分别为jQuery.js和History.js。

前者是当下最流行的JS库之一，目前能看到的大多数网站都是基于jQuery开发的。它对ECMAScript原生操作进行了很好地包装，提供了操作DOM元素的便捷方法，使前端开发更为方便和快捷。

后者则可以借助HTML5的函数修改浏览器的地址栏与前进/后退历史。由于本项目使用了Ajax技术实现页面切换，在进行跳转的时候只载入了部分页面，避免了实际的链接跳转。因此浏览器不会修改地址栏与前进/后退历史，如此地址栏的URL会一直保持第一个页面的URL，如果用户刷新页面或者点击前进/后退，就会跳转到错误的页面，与预期相应不符。History.js则解决了这个问题，使利用Ajax请求完成页面切换的同时，也能正确响应刷新、前进、后退的操作。

除了两个核心JS框架之外，在实现一些细节功能时本项目还用到了其他JavaScript开源库，比如FusionCharts图表套件、Validator表单验证、TableExport导出文件、icheck美化选框等。再次向各位库作者表示感谢。

另外，关于下文将要提到的JS文件，有一点需要说明的是，在各目录中可能存在一些同名，但是以.min.js结尾的文件。这些文件是对应JS文件压缩之后得到的小体积JS文件，内容上没有任何区别。在实际部署使用时，应当使用这些JS文件。

文件列表

表14：JavaScript文件列表

核心部分介绍

interface模块static/base/js文件夹中的scripts.js是本项目的核心JS文件，里面包括了一些常用的函数以及各页面通用的一些操作，比如Ajax载入、表单提交、绘制图表等。其中也包含了一些自定义的工具函数，方便各个地方调用。下面具体说明几个核心函数的功能和属性：

Ajax载入响应函数

loadContent(url, params, item_selector, load_params, callback)

通过Ajax请求加载指定url的页面内容到#main-page上。

表15：loadContent函数参数列表

loadContentOn(container, url, params, load_params, callback)

通过Ajax请求加载指定url的页面内容到指定DOM对象container上。

表16：loadContentOn函数参数列表

loadContentOfItem(item, load_params, callback)

通过Ajax请求加载左边栏项目对应的主页面。

表17：loadContentOfItem函数参数列表

displayContent(data, params, container, callback)

将Ajax请求得到的页面内容data载入到指定DOM元素container中。

表18：displayContent函数参数列表

表单提交处理函数

handleFormPost(form_selector, post_url, params)

通过Ajax请求加载指定url的页面内容到#main-page上。

表19：handleFormPost函数参数列表

弹出窗口函数

showConfirmModal(title, message, one_button, callback)

弹出Bootstrap风格的对话框。可以弹出只含有一个按钮的提示对话框，也可以弹出包含两个按钮的的确认对话框。后者在点击“确认”按钮时会调用指定的回调函数。

表20：showConfirmModal函数参数列表

showModal(url, id)

弹出指定的URL中的对话框。

表21：showModal函数参数列表

页面更新及处理函数

initAjaxPage(container)

为指定DOM对象container中需要使用Ajax请求完成跳转的链接（.ajax-link）进行点击事件的绑定，通常在刷新页面之后对刷新的DOM对象调用。

loadComplete()

刷新页面内所有的数字气泡（.badge），通常在刷新页面之后调用。

resizeComponents()

页面宽度发生变化时的处理函数，会调整页面的最小高度，并触发左边栏的滚动事件，以更新其坐标。另外，函数还会调整对话框（阻塞式窗口）的暗色背景高度，因此在弹出对话框的函数中也会用到此函数。

图表绘制函数

drawCharts(selected_charts)

对于指定的包含图表的DOM对象，载入其中的FusionCharts图表。详见“可视化图表”部分。

初始化函数

initLeftColumn()

处理左边栏的相关事件，具体包括：

• 绑定移动端界面的弹出左侧边栏按钮的点击事件；
• 处理顶部标题中箭头的方向切换；
• 绑定左侧边栏内部的滚动事件；
• 为侧边栏中非选中项目绑定点击事件；
• 使用jQuery.fixer完成左侧边栏的页面内位置处理。

自定义功能函数

stop_act(act_id, url, item)

停止收集问卷，向后台发送消息并刷新当前页面。

表21：stop_act函数参数列表

resume_act(act_id, url, item)

继续收集问卷，向后台发送消息并刷新当前页面，参数同上。

remove_act(act_id, url, item)

删除问卷，向后台发送消息并刷新当前页面，参数同上。

publish_act(act_id, url, modal_url)

发布问卷，弹出提示框，不要求用户输入邮箱，modal_url为对话框URL。

email_act(act_id, modal_url)

弹出发布问卷的对话框，需要用户输入联系邮箱并将问卷和后台链接发送至邮箱。

callRepeated(callback, cycles, time)

每隔一段时间反复调用指定的函数若干次。

animate(item, animation)

对指定DOM对象施加单次的Animate.css动画（默认情况下动画会循环播放）。

removePx(str)

从字符串中删除末尾的“px“，并转换成数字返回。用于处理CSS的height一类属性。

可视化图表

图表绘制主要使用了FusionCharts开源库（http://www.fusioncharts.com/dev/chart-attributes.html），项目中与其相关的JavaScript文件共有9个：

表22：FusionCharts相关文件列表

其中charts.js中只有一个函数：

renderChart(container, type, data, params, callback)

用于在指定的DOM对象中绘制FusiongCharts图表。具体参数含义基本类似其官方示例，可以参照官网的说明文档。

由于FusionCharts的JS文件体积庞大，加载需要相当长的时间，因此需要使用非阻塞的载入方式。在绘制时先载入所有JS文件，最后载入startrender.js，其中包含开始绘制的指令。

fusioncharts文件夹下的其他文件则是图表主题等配置文件，为开源库自带。

项目中用到图表的页面只有一个，为对单个题目进行分析的页面，其中图表页面被单独分离出来作为一个单独的HTML（legalUser/statistics/charts/charts.html）。这个页面中包含一些调用图表绘制的JavaScript代码，主要作用是初始化页面内的图表组件，并载入其他几个JS文件。图表的信息则是在Django模板渲染时就得到的，以JSON格式存入页面之中。具体来说，该信息转换为字符串存入待绘制的DOM对象的data-json属性中。图表的类型则存在data-type属性中。drawCharts函数会读取DOM对象的这两个属性，并调用renderChart函数完成绘制。

导出表格和美化选框

导出表格使用的是github上TableExport插件，使用非常简单，只需要对需要导出的表格调用tableExport函数即可，具体参数如下：

表23：tableExport函数参数列表

本项目中需要导出的是填写问卷的情况。导出的这个表格包含信息较多，页面上没有哪个显示的表格同时包含这么多的信息，所以单独设置了一个隐藏的表格专门用来导出，在页面上不显示（legalUser/statistics/print_table.html）。其中包含一段JavaScript调用tableExport函数来支持表格导出。使用时只要在需要导出表格的地方使用”{% include ... %}”语法包含该HTML页面即可实现导出。

选框上由于Bootstrap自带的单选和复选框不甚美观，所以使用了iCheck插件来美化选框。在所有使用到选框的页面中加入iCheck的配置语句，即可把选框的样式重新设置为指定的风格。同时该插件还可以自定义增加选框的点击范围，使点击在较小的屏幕上也变得更加容易。插件也支持各种回调函数，用于处理选中和取消选中的事件。

五、总结

这次参与本项目是本小组所有成员第一次接触这种系统的，可以被称作软件工程的软件开发。在本项目开始之前的几年中，我们在大作业中也完成了各种各样的“软件”，例如大一时候完成的中英文字典，FlowFree小游戏，在线五子棋，大二小学期完成的安卓APP等。在完成了本项目之后我们深刻体会到了即使是简化后的软件开发流程也比原先所接触的这些大作业要复杂的多，对软件品质的要求也要高得多。

从十月初理想到十一月末正式完成，这两个月时间的经历中，我们觉得以下几点是给我们感触最大的部分，也是我们在这门课中除了完成课程以外最大的收获。

作为计算机行业的从业人员，学习能力非常重要

本项目开发的过程中，主要使用了Django+Python，HTML与CSS，javaScript三种语言，除了Django+Python的架构一年多之前曾经短暂接触过，并且留下的印象并不深外，其余的语言可以说从来没有接触过。在本次开发的最初阶段，小组成员的主要工作便是学习数门新的语言，并且在没有完全掌握的情况下便投入到了开发中。

为此一度出现了多人工作进度处于停滞状态的现象，以及开始开发时想要获得一个能够被接受的版本非常难。小组某位成员刚开始接触HTML加上CSS，便接手任务绘制用户登陆界面，在最终完成之前被否决了三个版本。在后期开发熟练后情况有了很大好转。

在以后的工作中，作为计算机行业的从业人员，一定也会遇到许多这种情况，会去接触一些新的工具并尝试去使用它，不能有吃老本的思想，一定要贯彻终身学习的方针。

团队工作中，一定要进行充分的沟通

本小组的成员均来自一个班，其中三人更是来自同一个宿舍，按照常理来讲沟通渠道畅通无比，然而在实际开发的过程中还是或多或少出现了沟通方面的问题。这方面的问题主要出现在开发工作的初期，由于所有人对于本项目开发的构想均还没有一个明确的目标，再加上适逢国庆假期，沟通略有不便，因此造成了本项目启动阶段非常缓慢的问题。

在这里要感谢小组长王晨阳个人的努力，他依靠自身的能力率先确立了一个大致的方案，并完成了初步的实现，其余小组成员落实这个方案的实现，最终使我们的开发走上了正轨。但是凡事不能总依靠个人的力量，在实际的开发过程中一定要注意充分的沟通。