全部产品
云市场

业务接口定义规范

更新时间:2019-09-09 15:14:18

考虑到手机端开发环境的限制(尤其是 iOS 系统),以及保持接口定义的简单,服务端在定义移动服务接口时,不能使用 Java 语法的全集。接口定义规范涉及三类定义:

内部支持数据类规范

不支持的数据类型

  • 容器类型不能多层嵌套。
  • List 或 Map 必须有泛型信息。
  • List 或 Map的泛型信息不能是 array 类型
  • 不支持单字节(字节数据 byte []是支持的。)
  • 不支持对象数组,请用 list 代替。
  • 属性名不能是 data 和 description,会与 iOS 的属性冲突。
  • Map 类型的 key 必须是 String 类型。
  • 类型不能是抽象类。
  • 类型不能是接口类。

错误的写法:

  1. public class Req {
  2. private Map<String,List<Person>> map; //容器类型不能多层嵌套。
  3. private List<Map<Person>> list; //容器类型不能多层嵌套。
  4. private List list1; //List 或 Map 必须有泛型信息。
  5. private Map map1; //List 或 Map 必须有泛型信息。
  6. private List<Person[]> listArray; //List 或 Map 的泛型信息不能是 Array 类型。
  7. private byte b; //不能为单字节
  8. private Person[] personArray; //不支持对象数组,请用 List 代替
  9. private String description; //属性名不能为 description
  10. }

支持的数据类型

  1. boolean, char, double, float, int, long, short
  2. java.lang.Boolean
  3. java.lang.Character
  4. java.lang.Double
  5. java.lang.Float
  6. java.lang.Integer
  7. java.lang.Long
  8. java.lang.Short
  9. java.lang.String
  10. java.util.List,但:必须使用类型参数;不能使用其具体子类 以下简称 List
  11. java.util.Map,但:必须使用类型参数;不能使用其具体子类;key 类型必须是 String 以下简称 Map
  12. Enum
  13. byte[]

正确的写法:

  1. public class Req {
  2. private String s = "ss";
  3. private int i;
  4. private double d;
  5. private Long l;
  6. private long l1;
  7. private boolean b;
  8. private List<String> stringList;
  9. private List<Person> personList;
  10. private Map<String,Person> map;
  11. private byte[] bytes;
  12. private EnumType type;
  13. }
  14. public class Person {
  15. private String name;
  16. private int age;

用户接口类规范

method 的参数

不可以引用:

  • 枚举类型
  • 除上文提到的 Map、List、Set 之外的泛型
  • 抽象类
  • 接口类
  • 原生类型的数组

可以引用:

  • 具体的实体类,要求引用类型与实际的对象类型保持一致;不可使用父类引用类型指向子类对象。
  • 内部支持数据类, 但数组、Map、List、Set这些集合类型不可以嵌套。

如下是错误示例:

  1. Map<String,String[]>
  2. Map<String,List<Person>>(Person为一个具体的实体类)
  3. List<Map<String,Persion>>
  4. List<Persion[]>

method 的返回值

不可以引用:

  • 枚举类型
  • 除上文提到的 Map、List、Set 之外的泛型
  • 抽象类
  • 接口类
  • 原生类型的数组

可以引用:

  • 具体的数据类,要求引用类型与实际的对象类型保持一致;不可使用父类引用类型指向子类对象 (比如,不能用 Object 引用指向其它对象)

    注意:如果父类为具体类,生成工具将检查不出此类错误

  • 内部支持数据类见文章开头定义。数组、Map、List、Set 这些集合类型不可以嵌套,见上文相关示例。

method 的定义

  • 使用 @OperationType 注解,未加此注解的方法将被生成工具忽略。
  • method 不可 overloading。

代码生成工具限制

  • 允许接口类定义的继承关系,但会合并层次关系。
  • 允许但忽略接口类中定义变量。
  • 允许但忽略接口类中的方法声明抛出异常。
  • 一个源文件中只能包含一个接口类的定义,不能包含其它类(内部类、匿名类等)的定义。
  • 接口类定义本身和其引用到的类型必须为内部支持数据类或可以从源码获得定义。

用户定义实体类规范

field 定义

不可以引用:

  • 枚举类型
  • 除上文提到的 Map、List、Set 之外的泛型
  • 抽象类
  • 接口类
  • 原生类型的数组

可以引用:

  • 具体的实体类,要求引用类型与实际的对象类型保持一致;不可使用父类引用类型指向子类对象。
  • 内部支持数据类。 数组、Map、List、Set 这些集合类型不可以嵌套,见上文相关示例。
  • 修饰符包括 transient 的属性将会被忽略。
  • final static int 定义的常量(其它不符合该要求定义的常量或静态变量将被忽略)。

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

类的定义

  • 可以继承自其它实体类。
  • 忽略其方法声明,生成工具将会自动根据实体类字段生成 setter/getter 方法。

代码生成工具限制

  • 属性的声明必须一行一个。
  • 允许但忽略用户定义实体类实现的接口。
  • 一个源文件中只能包含一个用户定义实体类的定义,不能包含其它类(内部类、匿名类等)的定义。
  • 接口类定义本身和其引用到的类型必须为内部支持数据类或可以从源码获得定义。