Android开发干货

Android项目规范文档

2017-04-24  本文已影响157人  黄海佳
1.项目结构

现在的MVP模式越来越流行。就默认采用了。如果项目比较小的话：

如果项目比较大，上面的方式一定会造成presenter和view里近百个文件。看瞎眼系列。推荐下列方式：

2.配置主题

对于不遵守Material Design的项目无视这一步。
1.先在color.xml中写好需要的颜色：

<resources> 
  <color name="Orange">#ff5722</color> 
  <color name="DeepPurple">#673AB7</color> 
  <color name="DeepPurple900">#311B92</color> 
  <color name="White">#fff</color> 
  <color name="Gray">#888888</color> 
  <color name="Gray100">#dddddd</color> 
  <color name="Gray600">#999999</color>
</resources>

注意color.xml是配色表。应该是描述颜色而不是对字体颜色，背景颜色等的定义。这样能防止相近的颜色重复定义。而导致界面颜色不统一。

2.在style.xml里定义主题：
<style name="AppTheme.Base" parent="Theme.AppCompat.Light.NoActionBar"> 
  <!-- Customize your theme here. --> 
  <item name="colorPrimary">@color/DeepPurple</item> 
  <item name="colorPrimaryDark">@color/DeepPurple900</item> 
  <item name="colorAccent">@color/Orange</item>
</style>

<style name="AppTheme" parent="AppTheme.Base"></style>

在res目录下，创建一个values-v21目录，再创建一个style.xml:

<style name="AppTheme" parent="AppTheme.Base">
    <item name="android:windowDrawsSystemBarBackgrounds">true</item> 
    <item name="android:statusBarColor">?colorPrimaryDark</item>
</style>

然后在AndroidManifest.xml文件中修改application的theme属性为上面定义的AppTheme.即可实现沉浸式状态栏。

3.依赖库与SDK

常选的库:

融云——即时通讯
友盟——数据统计,推送，意见反馈，自动更新，第三方分享及登录,社区
七牛——云存储
Mob——短信验证
Bmob——做后台不求人

依赖这一大堆库和SDK以后。建议在合适的时机初始化他们，而不是全堆在Application的onCreate()里面。这样会导致启动时间过长。启动后也会较卡。虽然是不会影响功能正常使用。

4.配置Gradle

某些SDK运行时需要检查签名是否正确。所以在debug模式时也必须用正式KEY签名。而把签名放进版本控制不是明智的做法。所以推荐下面的做法：在app的gradle加入下面代码

Properties props = new Properties()
props.load(new FileInputStream(file("signing.properties")))
android { 
  signingConfigs { 
    release{ 
      keyAlias props['KEY_ALIAS'] 
      keyPassword props['KEY_PASSWORD'] 
      storeFile file(props['KEYSTORE_FILE']) 
      storePassword props['KEYSTORE_PASSWORD'] 
    } 
   } 
  buildTypes { 
    release { 
      signingConfig signingConfigs.release 
    } 
    debug { 
        signingConfig signingConfigs.release 
      } 
   }
}

在app的gradle文件同级目录新建signing.properties文件，里面填入你的key的相应信息

KEYSTORE_FILE = C:\\Users\\Mr.Jude\\Documents\\Android\\HelloWorld.jksKEYST
ORE_PASSWORD = xxxxxx
KEY_ALIAS = xxxxxx
KEY_PASSWORD = xxxxxx

将signing.properties添加进忽略目录。其他人pull下来代码后。自己新建signing.properties填入相应信息后即可编译成功。

5.制定开发规范
命名规范
private static final String TAG = "XXXX"

MainActivity,InstalledAppDetails

activity_main
fragment_account
item_person
include_toolbar
view_progress

不过对于庞大项目的开发。近百个activity开头的layout列表还是会眼瞎。所以那种情况会在前面加上模块名。
id命名，例

btn_send
tv_name
list_persons
et_password

mAdapter

class LoginActivity extends Activity{}

protected ContentResolver mContentResolver;

button->btnLogin,或者bt_login;

btnNext

PagerSlidingTabStrip
编码规范
提交规范
[CAUSE]     :
[SOLUTION]  :
[REVIEW]    : Own
[SIDEEFFECT]: without side effects
[PROJECT]   : V3
[CR]        :V3 SM-2182
[MODULAR]   :
modified:   src/com/android/settings/applications/InstalledAppDetails.java
架构设计规范

为了避免合作开发写的代码风格迥异。或做出了多套开发模式。下面是个例子。毕竟是为了高效开发而制定的。适合自己项目的才是最好。

AccountFragment
UserDetailActivity

android:windowSoftInputMode="stateHidden|adjustResize"
维护性

1.代码规范 2.框架稳定性 3.封装 4.耦合

扩展性:

1.抽象接口 2.元素重用 3.单一职责 4.替换性 5.耦合

安全性:

1.数据安全性 数据安全就包括数据抓取、数据拦截以及数据修改 2.操作安全性 避免对一个操作重复执行

6.style 文件

针对style文件越来越大，可以将其分离如styles.xml, styles_home.xml, styles_item_details.xml, styles_forms.xml不同的资源目录在res/values中是任意的

7.意识到WebView的问题
8.测试框架

其他

android:screenOrientation="portrait"  //强制竖屏（只针对activity）
android:exported="true"//在Activity中该属性用来标示：当前Activity是否可以被另一个Application的组件启动：true允许被启动；false不允许被启动。（四大组件都有这个属性）
android:launchMode="singleTask"//主界面

android:largeHeap="true"  //可以使用的最大内存值
android:hardwareAccelerated="true"  //启动硬件加速,(占用内存)
android:windowSoftInputMode="adjustPan|stateHidden"//输入法问题
android:supportsRtl="true"//支持从右到左right-to-left )的布局
android:process="com.github.obsessive.simplifyreader.application"   //应用进程

android:animateLayoutChanges="true"//View的伸展动画
android:hardwareAccelerated="true"
上一篇 下一篇

猜你喜欢

热点阅读