背景:
系统进行前后台分离,前台分APP端、PC端,前台和后台的通讯是通过API中间层来进行的。
1.文档编写应该注意哪些方面
1).手机端APP,需要考虑网络流量的问题,一次不能下发太多数据。
2).手机端APP,是安装在手机上的,是cs结构的,所以升级一次非常困难,有可能会变动的配置和数据尽量要在API服务端进行处理。
3).手机端APP,目前分IOS和Android,而且有各种版本,不同的版本可能对应的接口处理也不一样;不同的手机机型的数据处理可能也会有差异。
4).文档写的时候,可以分协议和准则、接口、实体、字典项、错误码五个模块来写:
协议和准则包括:哪些变量需要放在header里面,时间格式的统一、价格等数值的小数位和单位,用户名和密码的加密算法,变量的命名,实体的命名方式等。以及不同返回类型值为空时应返回的形式(实体为空时就不返回,数组为空时返回[],字符串为空时返回“”等)。
接口:应该包含接口的url,接口请求参数变量,接口的请求方式,请求的返回格式及数据类型最好是(ret,msg,result);url最好能用REST方式的使用REST方式;
实体:对于字典项、最好用两个字段如status,statusName对应值[0:未提交,1:提交]。
错误码:一定要先定义好,在代码中使用宏的写法如static final String ERROR_400001="错误信息!";
5).协议传输的安全问题
后续补充
2.开发过程中遇到的问题和要注意的方面
1).一定要定义好异常,做好异常处理、以及异常的全局管理器,打印出异常信息。
2).详细的日志,记录异常错误日志,打印关键位置、关键数据的调试信息,方便问题的定义查找。
3).文档有问题要勤修改,补充。添加新需求不可怕,一定要邮件确认,记录到文档中。
4).单元测试一定要从control和action做起。
5).做好session控制。