Medusa小程序开发手册
一、前言
1. 背景
本文档主要面向Medusa小程序的开发人员,以帮助他们更好地使用Medusa Application Editor来开发小程序。本教程将首先向您介绍Medusa小程序的基本概念,原理。然后通过一个实际的例子教您一步步地进行小程序开发,它基本涵盖了Medusa小程序开发的所有概念。最后是Medusa提供的API Reference,供您在开发过程中参考。
2. 需要条件
我们假设您对JavaScript有一定的理解,了解其基本的语法,函数调用等等。其次,如果想制作复杂的小程序,就需要对Java有比较深的理解,尤其是对Java UI以及Script Engine的理解。不过对于大多数的简单应用,仅仅使用JavaScript就足够了。如果您想进行开发,请先确认自己对相关知识是否了解。如果不太了解的话,请参考相关的JavaScript以及Java资料。
3. 联系作者
如果您在Medusa小程序开发过程中遇到任何问题,或者发现任何Bug,或者对Medusa有任何的意见或建议,欢迎您联系作者。联系方式:
作者: 王凯迪
QQ: 524805605
Mail: dakiler@163.com
一、Medusa基本概念
1. 概述
Medusa是
一个小程序的容器与运行环境。原先有一些需要人们手动做的操作,现在可以由小程序来自动完成。每个小程序做自己独立的工作,比如获取一个网站的最新新闻,
或者下载最近更新的电影等等,然后提示用户有新的内容,而不需要用户自己去关注。这样用户就可以节省很多时间。您可以在Medusa的主界面中看到有很多小程序,如下:
这些小程序在容器的管理下,按一定的方式运行着,每个小程序包括以下部分:
l 元信息
l 运行配置
l 属性配置
l 数据
l 执行代码/显示代码
l 菜单配置
这一章剩下部分会详细介绍这些部分。
2. 元信息
元信息记录了小程序的基本信息。这些信息仅仅是为了显示之用。主要有以下部分:
l 小程序的名字。用来唯一标识这个小程序,不同的小程序应该有不同的名字。
l 小程序的作者。
l 小程序的描述。描述这个程序的功能,便于用户理解程序的功能与使用方法。
l 所属的标签。描述这个小程序属于哪些标签,便于用户根据标签搜索,查找需要的小程序。
3. 运行配置
运行配置是用来配置小程序是如何运行的。目前支持以下的三种方式:
l 无。即程序不会自动运行。
l 每隔一段时间运行。一旦超过一段时间,程序会被执行。
l 定时运行。一旦到达了一天中的某个时间点,程序会被执行。
一旦满足运行配置中的条件,执行代码就会被Medusa容器自动执行。
4. 属性配置(Properties)
小程序在执行过程可能需要一些参数,而这些参数在小程序制作过程中是未知的,需要最终用户来设置。所以在Medusa中引入了属性。小程序制作者可以在脚本中引用到这些参数,然后这些参数可以由最终用户进行设置(提供一个可视化的界面)。举个例子,比如有一个查询天气的小程序,点击一下按钮,就会跳出一个城市的天气预报的网页,当时用户所在的城市是未知的,这个时候就可以设置一个叫city的属性,由最终用户来填写,然后程序开发者在代码中可以引用到这个变量。
5. 数据
一些小程序在执行过程中需要保存少量的持久化数据。这些数据可能要在将来的执行过程中会使用到。比如一个获取网页最新新闻的小程序,它在一次执行过程中,就需要将一些已经访问的网址记录下来,通过比对以前访问过的网址,分析出最新的链接,并且提示给用户。所以我们在Medusa中引入了持久化少量数据的概念。
6. 执行代码/显示代码(executeCode/trayCode)
前面在“运行配置”中提到一旦满足运行条件,这里的执行代码就会被容器执行。当用户点击了右下角的托盘时,显示代码会被执行。关于代码如何编写,请参考第四章。
7. 菜单配置
除了执行代码与显示代码以外.Medusa 允许自定义菜单的配置。您可以看到,在主界面中,对一个小程序点击鼠标右键,可以看到除了下面的几个菜单项是相同的以外,最上面的菜单项是小程序可以自己定义的。小程序的制作者可以定义显示的菜单文本与对应执行的脚本代码,给小程序提供更加强大的功能。
8. 总结
以上介绍了Medusa小程序的基本概念,小程序的各部分信息会被保存在一个文件中,后缀名为.app.注意这个文件不是普通的文本文件,而是二进制的,所以不能用普通的文本编辑器编辑。下一章我们将介绍如何使用Medusa Application Editor来进行开发。