Moodle Mobile实现原理

Moodle是一个开源的课程管理系统,可以用来实现课程资源的分发、作业提交、论坛交流等功能。同类型的系统还有Sakai,也是开源的。

Moodle已经推出了移动客户端Moodle Mobile,它是使用Ionic跨平台框架实现的应用程序,一套代码可以编译成Android、IOS甚至Linux上的应用程序。在Ionic框架上开发应用程序使用的是Web技术,像开发网页那样每个页面都需要编写页面布局(html)、样式(scss)、逻辑处理文件(js或ts, typescript)。

实现客户端最重要的是从服务器获取应用的数据。Moodle网站的数据都存储在数据库中,但显然不能让客户端直接访问数据库,而是让客户端访问API接口,由接口查询数据库,做相应处理,最后返回数据给客户端。Moodle的API接口为Moodle WebService函数。

登录

要访问WebService函数需要有用户身份凭据token,token帮助服务器识别访问者的身份,鉴定是否有访问权限,以及返回特定于用户的数据。token通过登录获得,登录的入口为/login/token.php,需要携带的参数有username、password、service,其中service一般为moodle_mobile_app

假设网站地址为http://cms.zeabin.top,用户名、密码均为student,则获取token的用法为:

http://cms.zeabin.top/login/token.php?username=student&password=student&service=moodle_mobile_app

返回的数据类似:

{
  "token": "4e223d60d78db3f94fd11afaaa21d5b3",
  "privatetoken": null
}

token是后续访问WebService函数都需要携带的参数,privatetoken只在使用https协议的网站上返回,但不清楚有什么用。

调用WebService函数

入口地址为/webservice/rest/server.php,需要的参数有token,moodlewsrestformat,wsfunction以及函数所需的参数。其中token(默认有效时间12周)和moodlewsrestformat(一般为json)相对固定,可以对WebService函数做一个封装。

以管理员身份登入Moodle网站,在网站管理-插件-网络服务可以看到全部WebService函数的功能及参数格式、返回数据格式。下面介绍一些基本的WebService函数

core_webservice_get_site_info:获取token之后,首先需要获取更多的用户信息,该函数返回id,头像等数据,其中id在很多函数中为必须的参数

core_enrol_get_users_courses:该函数返回用户参与的课程的列表

core_course_get_contents:以courseid作为参数,返回对应课程的详细内容,包括各个topic以及topic中的各个模块

mod_assign_get_assignments:返回一个或多个课程中的所有作业数据

mod_assign_get_submission_status:返回一个作业的提交数据,包含提交文件和作业评分

mod_forum_get_forums_by_courses:返回一个或多个课程中的论坛。在Moodle中,一个课程可以包含多个论坛,一个论坛可以包含多个讨论,一个讨论包含多个post。使用mod_forum_get_forum_discussions可以获得一个论坛中的所有讨论;使用mod_forum_get_forum_discussion_posts可以获得讨论的内容。

文件

文件上传:地址/webservice/upload.php
文件下载:一些WebService函数获得的内容中含有文件下载的地址,请求该地址即可下载文件。

消息推送

消息推送是移动应用程序的一大特点。Moodle Mobile的消息推送由Airnotifier系统完成,包含Airnotifier插件和Airnotifier服务器两部分。

Airnotifier插件

Moodle Mobile会通过插件提供的WebService函数将设备信息发送给Moodle服务器,包含设备系统、id等信息。Moodle服务器收到后将设备信息存储到数据库。当接收到消息数据时,从数据库中获取设备消息,发送给配置的Airnotifier服务器。Airnotifier服务器的配置需要在插件的设置中完成,否则插件无法正常工作。

Airnotifier服务器

Airnotifier服务器也是一个开源项目,可以自己架设,也可以使用Moodle提供的推送服务器(https://messages.moodle.net),但需要注册,获取access_key。

Airnotifier服务器接收一条推送消息的消息数据和推送目标的设备信息,根据目标设备的系统,使用相应的协议推送消息。

设备 协议
iPhone/iPad APNS
Android/chrome FCM
Windows WNS

你可能感兴趣的:(Moodle Mobile实现原理)