APP技术规范1.1完整版.docx

PAGE PAGE 1 哈银消费金融公司内部使用 PAGE PAGE 2 目录 TOC \o 1-3 \h \u 1432 1 概述 2 11065 1.1 修订目录 2 13527 1.2 编写目的 2 25770 2 技术规范 3 31388 2.1 开发规范 3 26163 2.1.1 实施规范 3 536 2.1.2 代码规范 3 7581 2.1.3 命名规范 4 7135 2.2 架构规范 5 4950 2.2.1 项目框架搭建 5 26669 2.2.2 安全策略 10 16929 2.2.3 日志管理 12 19529 2.2.4 终端适配 12 16761 2.3 质量规范 14 21476 2.4 版本控制规范 15 32732 2.5 客户端监控 15  概述 修订目录 版本 修订内容 修订人 修订日期 V1.0 创建文档 张平 2017-11-16 V1.1 修改优化格式排版；补充日志管理、终端适配 张平 2017-11-20 编写目的 该文档阅读对象为APP Android开发人员。通过制定技术规范，提高哈银消费金融团队开发效率、规范开发流程、提高产品质量。 本文从项目实施流程规范、编程规范、质量管理规范、线上监控规范等方面论述，涵盖从项目框架搭建到版本控制、基线管理到上线全流程的行为约束及技术规范。  技术规范 开发规范 实施规范 实施规范规定了在APP项目开发过程中如何保证APP开发顺利进行，避免因需求变更带来开发紊乱、工作延期。具体要求如下： 必须保证需求文档和编码的一致性。编码以需求文档为基础，必须保证所有的需求都被编码实现，同时当需求发生变更时必须修改编码。 必须保证设计文档和编码的一致性。当代码的修改已经造成设计更改时，必须修订设计文档。 在代码已经基线化后，对代码的更改必须通过评审，并保存评审记录。 代码规范 统一使用Android Studio作为开发工具； 编码格式统一为UTF-8； java代码中不出现中文，最多注释中可以出现中文，提示文字要提取到string.xml中； 服务端可以实现的，就不要放在客户端； 引用第三方库要慎重，避免应用大容量的第三方库，导致客户端包非常大； 处理应用全局异常和错误，将错误发送给服务端； 数据一定要校验后使用，例如字符型转数字型，如果转换失败一定要有缺省值；服务端响应数据是否有效判断； 对于未完成的方法，使用TODO加以标记，不可直接提交svn或git； 若代码存在严重问题或仅用于调试，使用FIXME加以标记； 方法基本上都按照调用的先后顺序在各自区块中排列； 提取公共方法方法, 去除重复代码。对于必要的工具类抽取也很重要，这在以后的项目中是可以重用的； 禁止使用 System.out 输出，而是使用 Log 中的方法；如果使用开源Log库一定要自己做外层封装； 使用 BuildConfig.DEBUG 标记对 Log 进行封装，只在调试时输出重要信息，正式版不输出； catch 块不得为空，至少应当将异常信息输出； 程序中不允许出现魔鬼数字，例如switch中使用数字或缺乏含义的标识，应定义常量来标识每一项； 注释规范及其他代码规范详见《哈银消费金融Android开发规范》。 命名规范 1、命名方式采用驼峰式命名； 2、包名、类名、方法名、常量名、变量、参数、资源文件、布局等的命名要严格按照《哈银消费金融Android开发规范》进行。 详见《哈银消费金融Android开发规范》。 架构规范 项目框架搭建 Android本身就是MVC，建议框架搭建时遵循按照职责分层的原则，保证系统的稳定性、可扩展性、可维护性，并为业务扩展、快速迭代奠定基础。 基础框架搭建 模块要求 分类 要求 备注 组织目录结构 按职责定义包名 可根据业务场景灵活变动 基类封装 1、抽象方法提取、公共方法继承、事件总线、注解框架的初始化； 2、Activity栈管理器创建。 不可随意更改基类中方法和结构； 生命周期管理 1、使用Activity栈管理activity，保证在一个生命周期中只存在一个Activity； 2、封装正确的APP退出方式。 坚决杜绝Activity重复创建造成生命周期紊乱；正确使用Activity启动模式 公共方法提取 1、一个方法超过两次调用要提取到工具类中； 2、尽量使用接口回调、事件总线、广播处理跨页面通信，保证代码逻辑清晰。 事件总线EventBus、Otto使用时一定做好注释，便于溯源 Adapter封装 列表适配器使用频次高，封装公共BaseAdapter避免大量重复代码 此处建议使用开源库： BaseRecycleViewAdapterHelp