轻装研发规范(0.0.2)剖析.doc

轻装上阵研发规范 修订记录 版本号 修订人 修订日期 修订描述 V0.0.1 周礼 2016/06/03 草稿 V0.0.2 周礼 2016/06/08 修改，新增 一.流程规范 2 二.接口规范 3 三.异常管理 5 四.命名规范 6 五.数据库规范 7 六.SVN管理规范 8 七.工程规范 9 八 10  一.流程规范 从需求对接开始，项目开发应遵循包含如下7个步骤： 需求初审： 目的：了解背景包含三个方面：项目的由来、原因、展望 需求评审 目的：原型评审 过程：相关人员主要了解交互设计 业务设计 目的：实现产品设计到软件设计的转化整理整合 5.接口设计 目的：定义前后端接口和系统间接口 过程：前后端配合，先完成模块接口的定义，包括接口字段与前后条件转换等内容 输出： 接口说明文档 业务流程图 6.开发实现 在保证其它阶段完善的情况下，着手代码开发工作。 7.需求变更 目的：紧急且重要的需求变更 过程：开发过程中的需求变更需正式申请通知，会议确认后归档记录 输出：需求变更列表与优先级描述 参考： 《用户故事与敏捷方法》 二.接口规范 接口原则 前后端分离：api接口需对前端负责 接口先行：接口需在开发前制定 接口中字段采用小驼峰风格，具体命名主要以后端定义为准，推荐前后端一起制定。 1.URL 说明：原则上采用RESTful API设计风格，采用显式语义化风格，格式如下 域名+项目+功能块+请求 /api/photos/getDetail：获取照片列表 ??? /api/photos/getList：获取照片列表 ??? /api/photos/add：创建照片 ??? /api/photos/delete：删除照片 ??? /api/photos/edit：更新编辑照片 2.请求接口 （1）请求参数尽量一致，命名采用小驼峰 （2）分页参数：? ? ??page : 请求当前页 ? ??limit： 每页显示条数 返回数据 返回格式如下： { code:000000, data:{ name:zl }, message:成功, success:true } 说明：? code: 状态码，000000表示成功，非0表示各种不同的状态。两位系统/项目，两位模块/功能，两位业务/状态 message: 描述信息 （3）data: 成功时返回的数据，类型为对象或数据 4.状态码规范 六位数字（暂定） 00 00 00 系统/项目 模块/功能 业务/状态 系统：00 Promgr：01 User：02 Pay：03 Marketing：04 Wechat：05 Message：06 Cost：07 Cm：08 5.Controller规范 说明：采用Swagger接口配置，接口中需包含接口与参数的注释与说明。 Demo： @ApiOperation( value = 编辑用户信息, notes = 编辑用户信息, httpMethod = POST) @RequestMapping(value = /editUser, method = RequestMethod.POST) public Result editUser( @ApiParam(value = 用户姓名, required = true) @RequestParam String name, @ApiParam(value = 年龄, required = true) @RequestParam Integer age) { ? //1.参数校验：必传，范围等 if (name == null) { return errorResponse(ACK.PARAM_ERROR, [参数异常][name]); } if (age == null) { return errorResponse(ACK.PARAM_ERROR, [参数异常][age]); } //2.服务接口调用：实现功能 ? //3.数据整合：针对前段需求，组合数据结构 ? //4.返回结果 return successResponse(); } @ApiOperation：接口功能说明，请求方法 @ApiParam：请求参数说明 参考： http://swagg