Android开发规范参考文档

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

Android开发参考文档一、Android编码规范1.java代码中不出现中文,最多注释中可以出现中文.xml代码中注释!----2.成员变量,局部变量、静态成员变量命名、常量(宏)命名1).成员变量:activity中的成员变量以m开头,后面的单词首字母大写(如ButtonmBackButton;StringmName);实体类和自定义View的成员变量可以不以m开头(如ImageViewimageView,Stringname),2).局部变量命名:只能包含字母,组合变量单词首字母出第一个外,都为大写,其他字母都为小写3).常量(宏)命名:只能包含字母和_,字母全部大写,单词之间用_隔开UMENG_APP_KEY3.Application命名项目名称+App,如SlimApp,里面可以存放全局变量,但是杜绝存放过大的实体对象4.activity和其中的view变量命名activity命名模式为:逻辑名称+Activityview命名模式为:逻辑名称+View建议:如果layout文件很复杂,建议将layout分成多个模块,每个模块定义一个moduleViewHolder,其成员变量包含所属view5.layout及其id命名规则layout命名模式:activity_逻辑名称,或者把对应的activity的名字用“_”把单词分开。命名模式为:view缩写_模块名称_view的逻辑名称,用单词首字母进行缩写view的缩写详情如下LayoutView:lvRelativeView:rvTextView:tvImageView:ivImageButton:ibButton:btn6.strings.xml中的1).id命名模式:activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称,strings.xml中,使用activity名称注释,将文件内容区分开来2).strings.xml中使用%1$s实现字符串的通配,合起来写7.drawable中的图片命名命名模式:activity名称_逻辑名称/common_逻辑名称/ic_逻辑名称(逻辑名称:这是一个什么样的图片,展示功能是什么)8.styles.xml将layout中不断重现的style提炼出通用的style通用组件,放到styles.xml中;9.使用layer-list和selector,主要是ViewonCclickonTouch等事件界面反映10.切图需求1).多图片组合的,尽量分拆成多个可重用的图片,避免一个图片太大.2).尽量使用.9图片,自动适配适配界面。11.服务端可以实现的,就不要放在客户端1).图片过大时,服务端压缩图片后返回来可减少很多问题出现2).及时更新的数据,尽管本地有缓存12.引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大,或者其他非本应用的信息会出现,影响体验。13.处理应用全局异常和错误,将错误以邮件的形式发送给服务端14.使用静态变量方式实现界面间共享要慎重15.Log(TAG,详细描述),加开关,打包时关掉log,提高运行速度。如if(SlimConf.DEBUG){Log.d(TAG,plan_init_enabled=+plan_init_enabled);}16.单元测试(逻辑测试、界面测试),避免次生问题随着解决问题增加。17.不要重用父类的handler,对应一个类的handler也不应该让其子类用到,否则会导致msg.what冲突,方法是声明父类handler为private18.activity中的ListenerActivity只用一个View.OnClickListener,View.OnTouchListener等Listener中处理所有控件的逻辑,即,XXActivityimplimentsOnClickListener方式实现接口,绑定周期,减少接口实例数量注意:尽量不要给每个点击控件设置一个View.OnClickListener实例19.如果多个Activity中包含共同的UI处理,那么可以提炼一个AbsXXActivity.java或者XXActivityBase.java,可以是一个抽象类,把通用部分叫由它来处理,其他activity只要继承它即可,可以是一个抽象activity,子类定义具体需求的函数(重载或者重写)20.使用button+activitgroup实现tab效果时,使用Button.setSelected(true),确保按钮处于选择状态,并使activitygroup的当前activity与该button对应21.如果所开发的为通用组件,为避免冲突,将drawable/layout/menu/values目录下的文件名增加前缀22.数据一定要效验,例如字符型转数字型,如果转换失败一定要有缺省值;if(objectinstanceofUser)服务端响应数据是否有效判断;23.有的按钮要避免重复点击,避免重复发送几个http请求或耗时任务等。方法:点击之后setEnable(false),一段时间之后setEnable(true),24.复杂循环体超过8行时,需要在外部加注释;25.方法,函数名字尽量体现其功能含义(函数名能完全体现功能是可以不要注释;函数中的注释一定按照缩进格式注释。函数内部单行注释写在该行上面);26.函数行数尽量不能超过100(if,for语句中的行数不能超过50,超过时,提出来作为函数使用(Switch除外))。27.同一个类文件中不能出现雷同的code段,相同的部分提出来作为函数使用,或者使用函数重载,用参数的数量和类型来控制其功能区别。二、Android性能优化1.http可以用gzip压缩,设置连接超时时间和响应超时时间http请求按照业务需求,分为是否可以缓存和不可缓存,那么在无网络的环境中,仍然通过缓存的httpresponse浏览部分数据,实现离线阅读。可以存在数据库,下次继续使用2.listview性能优化1).Adapter的getView中复用convertView在getView中,判断convertView是否为空,如果不为空,可复用。如果couvertview中的view需要添加listerner,代码一定要在if(convertView==null){}之外。不要在里面轻易地new对象,其数量随着item数量增加2).异步加载图片item中如果包含有webimage,那么最好异步加载3).快速滑动时不显示图片当快速滑动列表时(SCROLL_STATE_FLING),item中的图片或获取需要消耗资源的view,可以不显示出来;而处于其他两种状态(SCROLL_STATE_IDLE和SCROLL_STATE_TOUCH_SCROLL),则将那些view显示出来4).list中异步加载的图片,当不在可视范围内,按照一定的算法及时回收(如在当前可视范围的上下10条item以外的图片进行回收,或者将图片进行缓存,设置一个大小,按照最近最少使用原则超过部分进行回收)5).BaseAdapter避免内存溢出如果BaseAdapter的实体类有属性非常消耗内存,可以将保存到文件;为提高性能,可以进行缓存,并限制缓存大小,退出界面后释放资源。3.使用线程池,分为核心线程池和普通线程池,下载图片等耗时任务放置在普通线程池,避免耗时任务阻塞线程池后,导致所有异步任务都必须等待4.异步任务,分为核心任务和普通任务,只有核心任务中出现的系统级错误才会报错,异步任务的ui操作需要判断原activity是否处于激活状态,否则,跳出run函数1).主线程不要进行网络处理;2).主线程不要进行数据库处理;3).主线程不要进行文件处理;newThread处理完成后,sendmessagetoHandlernotifyUIthreadtoupdateUI5.尽量避免static成员变量引用资源耗费过多的实例,比如Context,多以引用的的形式出现。1)不要在projectApplication的子类中使用过多或者过大的实体变量2)需要使用较大的全局变量时,使用单例instance来实现,保持项目中只有一份实例6.使用WeakReference或SoftReference代替强引用,弱引用可以让您保持对对象的引用,同时允许GC在必要时释放对象,回收内存。对于那些创建便宜但耗费大量内存的对象,即希望保持该对象,又要在应用程序需要时使用,同时希望GC必要时回收时,可以考虑使用弱引用。如:1.Aa=newA();2.a.str=Hello,reference;3.WeakReferenceAweak=newWeakReferenceA(a);7.占内存的Bitmap及时的销毁(Activity的onDestroy时将bitmap回收,在被UI组件使用后马上进行回收会抛RuntimeException:Canvas:tryingtousearecycledbitmapandroid.graphics.Bitmap)设置一定的采样率(有开发者提供的图片无需进行采样,对于有用户上传或第三方的大小不可控图片,可进行采样减少图片所占的内存),从服务端返回图片,建议同时反馈图片的size巧妙的运用软引用drawable对应resid的资源,bitmap对应其他资源任何类型的图片,如果获取不到(例如文件不存在,或者读取文件时跑OutOfMemory异常),应该有对应的默认图片(默认图片放在在apk中,通过resid获取);8.Drawable目录下的图片ui组件需要用到的图片是apk包自带的drawable-目录下的图片,那么一律用setImageResource或者setBackgroundResource,而不要根据resourceid,无形中构造了对象注意:get(getResources(),R.drawable.btn_achievement_normal)该方法通过resid转换为drawable,需要考虑回收的问题,如果drawable是对象私有对象,在对象销毁前是肯定不会释放内存的。9.保证Cursor占用的内存被及时的释放掉,而不是等待GC来处理。并且Android明显是倾向于编程者手动的将Cursorclose掉(但是不要翻来覆去的打开和关闭数据库,耗时)10.线程也是造成内存泄露的一个重要的源头。线程产生内存泄露的主要原因在于线程生命周期的不可控,设置开关booleanflag,退出界面,或者应用是跳出线程。避免莫名其妙的更新UI,造成错误11.如果ImageView的图片是来自网络,进行异步加载,注意,尽量缓存,减少请求次数12.应用开发中自定义View的时候,交互部分,千万不要写成线程不断刷新界面显示(如onResume()函数中刷新),而是根据TouchListener事件主动触发界面的更新13.复用、回收Activity对象临时的activity及时手动finish主界面设置为singleTask一般界面设置为singleTop14.位置信息获取用户的地理位置信息时,在需要获取数据的时候打开GPS,之后及时关闭掉15.在onResume时设置该界面的电源管理,在onPause时取消设置16.模块之间的交互使用接口来定义,上下层次关系,数据层与控制层之间外部调用只关注接口函数名和参数,内部实现不考虑,外人调用出现问题时,负责人修改内部实现,调用者不要轻易修改,免得引发次生问题,(仅限于以上关系,其他另外考虑)17.工具类的函数名要根据功能来起名,尽量加上注释,方便以后调用,修改。1)类似功能的要用重载,用参数来控制功能区别2)同一个文件(甚至项目中)不要出现相同的代码段,可以提出来当函数公用./***downloadimagebitmapfromnet,andaddtocache,files*@paramcontext*@paramurl*@paramhandler*@p

1 / 9
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功