定义移动网关业务接口需遵循的规范移动开发平台maa

考虑到手机端开发环境的限制（尤其是 iOS 系统），以及保持接口定义的简单，服务端在定义移动服务接口时，不能使用 Java 语法的全集。

接口定义规范涉及三类定义：

容器类型不能多层嵌套。

List 或 Map 必须有泛型信息。

List 或 Map 的泛型信息不能是 array 类型

不支持单字节（字节数据 byte [] 是支持的）

不支持对象数组，请用 list 代替。

属性名不能是 data 和 description，会与 iOS 的属性冲突。

Map 类型的 key 必须是 String 类型。

类型不能是抽象类。

类型不能是接口类。

错误的写法：

正确的写法：

不可以引用：

枚举类型

除上文提到的 Map、List、Set 之外的泛型

抽象类

接口类

原生类型的数组

可以引用：

具体的实体类，要求引用类型与实际的对象类型保持一致；不可使用父类引用类型指向子类对象。

内部支持数据类，但数组、Map、List、Set 这些集合类型不可以嵌套。

如下是错误示例：

不可以引用：

枚举类型

除上文提到的 Map、List、Set 之外的泛型

抽象类

接口类

原生类型的数组

可以引用：

具体的数据类，要求引用类型与实际的对象类型保持一致；不可使用父类引用类型指向子类对象，例如，不能用 Object 引用指向其它对象。

如果父类为具体类，生成工具将检查不出此类错误。

使用 @OperationType 注解，未加此注解的方法将被生成工具忽略。

method 不可 overloading。

允许接口类定义的继承关系，但会合并层次关系。

允许但忽略接口类中定义变量。

一个源文件中只能包含一个接口类的定义，不能包含其它类（内部类、匿名类等）的定义。

接口类定义本身和其引用到的类型必须为内部支持数据类或可以从源码获得定义。

不可以引用：

枚举类型

除上文提到的 Map、List、Set 之外的泛型

抽象类

接口类

原生类型的数组

可以引用：

具体的实体类，要求引用类型与实际的对象类型保持一致；不可使用父类引用类型指向子类对象。

修饰符包括 transient 的属性将会被忽略。

final static int 定义的常量（其它不符合该要求定义的常量或静态变量将被忽略）。

不推荐 is 开头的成员变量定义。

可以继承自其它实体类。

允许但忽略用户定义实体类实现的接口。

一个源文件中只能包含一个用户定义实体类的定义，不能包含其它类（内部类、匿名类等）的定义。

接口类定义本身和其引用到的类型必须为内部支持数据类或可以从源码获得定义。

关注阿里云公众号或下载阿里云APP，关注云资讯，随时随地运维管控云服务