2018-01-31

代码格式规范

---

Android Code Style Guide

Google 面向贡献者的 AOSP 代码样式指南

• 欣赏代码之美，养成良好的空格，换行的习惯
• 明确变量的名字，名字就代表变量的意义。单词要拼写准确或者缩写得当。
• 命名要遵守一套习惯，驼峰和下划线不要混用，要有自己的风格并且风格统一。
• 规范类名及方法名, 类要尽量短小精悍，方法名应该是去执行一个动作 。
• 方法应该尽量的短小一次只解决一个问题。
• 常量应该有定义，来表达它自己的含义。

---

移除无用代码

使用git来查看历史代码，把已经注释掉的代码删除。不要害怕代码丢失，因为已经有git来帮我们管理。不用的方法也应该删除。

不要在项目的开发工程里面做自己的练手测试，新建项目去测试，保持项目的tidy and clean。

可以用函数传参的方式减少成员变量，全局变量, 用尽量少的状态标记。

---

模块分离

基本模块：网络层，model层，数据存储层，view层，Activity层，或者Android的Presenter层。

基本分离思想：

每层都做自己的事（单一指责）, 并且应该利用类的继承或者引用的方式完善基本的封装。

比如有基本的网络类，可以封装一层每次请求都携带token的网络类。继续封装做统一错误处理的网络类，继续封装成面向具体业务的网络类，保持每个类目的明确，短小精悍。

当一个类（类对应一个模块部分的具体实现）太大，做的事情太多的时候，就要考虑把一些相关代码移到其他模块，或者用一些辅助类来帮助他做这些事。其他模块提供方法，并且处理相关细节, 如果有返回通过协议（代理，通知）的方式返回。

• 比如activity中的mapView, mapView做了更多的事情，可以把activity中对mapView的操作放到mapView自己的代码里处理。
• 比如可以再次对网络层进行封装, 只返回自己需要的东西。
• 把debug，log 再次封装，做成自己的debug和log类。
• 把一些数据转换类的代码移到工具类中。

成熟框架的更高级的思想

Android肯定有更成熟的框架，更完善的思想。去找一些demo，或者blog看下是怎么写的。

但是肯定大家的目的都是一样的，让代码更简洁，清晰，可测试，在代码阶段解决更多的问题，减少bug，减少维护成本。

未完待续，欢迎指导。