AppCanMAS README

本插件为AppCan 的MAS 开发环境，可以创建MAS服务、工程及接口，也可以运行及调试。

使用过程：
1、新建文件夹
2、使用vscode打开这个文件夹
3、创建服务---右键创建AppCan MAS服务
4、创建工程---右键创建AppCan MAS工程
5、在工程上创建接口---右键创建AppCan MAS接口
6、校验MAS服务---右键运行校验MAS服务（校验调试用的node及环境变量信息）
7、运行---ctrl+f5或者右键AppCan MAS运行服务
8、断点调试---f5或者右键AppCan MAS调试服务
9、打包---右键打包MAS工程

功能菜单截图如下：

打开MAS的服务文件夹

如果想编辑开发已有的MAS服务，我们可以直接打开它，如果想重头开始开发一个，那就新建一个文件夹，并打开它。如下图：

上图是创建了一个test的文件夹，并且打开了它

创建服务

MAS服务工程的标准模式为一个服务中，创建多个工程，每个工程下可以创建多个接口。

首先在这个空文件夹下新建一个服务。如下图所示，在资源管理器区域右键选择创建MAS服务，然后在打开创建服务的页面中按照步骤创建服务。

下图为创建好的服务代码，其中mas.js文件为入口js，service.js是配置文件，.vscode文件夹下的launch.json文件是调试运行的配置文件，这些文件在一个MAS服务下只有一个。

创建工程

服务创建完毕后，需要在这个服务下创建工程。如下图所示，在资源管理器区域右键选择创建MAS工程，然后如同创建服务一样按照步骤进行。

上图中firstProject文件夹就是创建的工程基础代码文件，其中interface.xml文件包括这个工程下的所有接口配置，目前图中还未创建接口，所以目前为空。

firstProject工程可以在当前服务的service.json文件中看到，如下图：

创建接口

在之前创建的工程文件夹下创建接口。同样在资源管理器区域右键创建MAS接口，之后按照步骤创建接口。接口必须选在工程文件夹下。

图中在工程文件夹下的if_firstInterface文件夹及if.js文件就是创建的接口，这个接口信息可以在interface.xml文件里看到。

校验调试服务

创建接口，开发过程中需要进行代码调试，代码调试依赖.vscode下的launch.json文件，内部配置了调试服务所使用的node和环境变量。如下图：

通常在创建服务的时候，当前的node和环境变量是和本机匹配的，但是当我们使用svn或者git等工具对MAS代码进行管理，协同开发时，每个开发人员下载代码后，这个文件中的配置就会不同，需要使用校验调试服务，从而更正当前电脑的配置。

校验调试服务的方法就是在资源管理器区域右键，选择校验调试服务就可以了。

断点调试

MAS服务代码是node服务，进行断点调试时与其他node服务调试习惯一样，使用快捷键F5或者在资源管理器区域右键选择调试代码即可。

上图中运行调试后，在调试控制台输出日志，【firstProject/firstInterface】为可以访问的接口地址，【1234】为创建服务时输入的端口号，我们在浏览器输入以下地址：

在firstInterface接口的if.js文件中设置断点，这时访问上图的浏览器地址，断点效果如下：

断点时，可以在调试控制台查看看日志输出，可以单步等断点调试。跳过断点后查看输出结果如下：

运行代码

当我们需要启动服务，请求进来后不需要进入断点，这是我们只要使用ctrl+F5或者右键选择运行服务即可。 在浏览器中我们可以调用接口，数据及时返回，调试控制台日志同时显示日志。

停止运行/调试

服务启动运行或者调试过程中，我们使用shift+F5或者右键选择停止运行/调试来达到停止服务的目的。

打包

当我们在vscode中MAS开发环境中开发完成MAS接口后，需要把开发好的接口部署到服务器上。MAS服务器上真正部署的是我们开发的接口工程，这时就需要把开发环境的接口工程进行打包，其形式就是把每一个接口工程文件夹进行压缩成zip。

首先在资源管理器中右键选择打包，在弹出的选择框中，选择压缩包的输出文件夹，如下图：

选择完后，就会对当前服务中的接口工程进行打包操作，打包完成，系统直接打开打包后生成的zip压缩包所在的文件夹。如下图：

总结

打好包后，拿到zip文件就可以发给实施人员部署到服务器了，我们的开发工作完成。

在vscode中开发MAS接口，需要注意以下几点：

1. MAS开发一定要使用单一的工作空间，即vscode打开的服务文件夹。
2. 谨遵MAS服务工程的目录结构
3. 代码检出后第一次运行或者调试一定要先运行校验调试服务功能。
4. 进行MAS接口开发时，请查阅MAS的api文档。