Android组开发规范-参考95%参考阿里

Android组开发规范

本文参考借鉴阿里Android规范

一、目标

Android组开发规范用以指导团队成员，更高效，高质量的对APP进行开发，以保证开发出性能优异，稳定性佳，安全性高的产品

• 防范于未然，提升质量意识，降低故障率与维护成本；
• 统一标准，提高协作效率；
• 匠人精神，打磨精品代码；

二、Android资源文件命名与使用（统一以小写单词加下划线方式命名）

1.资源文件统一携带模块名(module)前缀（所有前缀通过小组会议提前确定，并登记JIRA报备统计）

2.layout文件的命名方式

• Activity 的 layout 使用 module_activity_类名，如通用 使用 common_activity_业务描述
• Fragment 的 layout 使用 module_fragment_类名，如通用 使用 common_fragment_业务描述
• Dialog 的 layout 使用 module_dialog_类名/业务描述，如通用 使用 common_dialog_业务描述
• include 的 layout 使用 module_include_类名/业务描述，如通用 使用 common_include_业务描述
• RecyclerView 的 layout 使用 module_item_类名/业务描述，如通用 使用 common_item_业务描述

3.drawable资源统一存放在drawable-xxhdpi内，由系统自动缩放

• 非通用情况下，采用 module_业务功能描述_状态
• 通用情况下，采用 common_业务功能描述_状态

4.anim资源存放在drawable内

• 非通用情况下，采用 module_功能描述_状态
• 通用情况下，采用 common_功能描述_状态

5.color资源使用具体argb内容命名，不区分模块

• 无a部分，c_000000
• 有a部分，c_ff000000
• 如果有一套完整统一的主题色，可使用主题色名称命名，c_module_xx

6.暂不考虑dimens资源

7.style资源采用 ‘父style点当前style’命名，写入module_styles.xml文件中

8.string资源文件或者文本用到的字符串全部写入module_strings.xml文件中

• 采用 module_业务描述

9.id资源，以控件View的缩写为前缀+模块+功能命名

控件	缩写
LinearLayout	ll
RelativeLayout	rl
ConstraintLayout	cl
FrameLayout	fl
ListView	recyclerView代替
RecyclerView	rv
ScrollView	sv
TextView	tv
Button	btn
ImageView	iv
CheckBox	cb
RadioButton	rb
EditText	et
ProgressBar	pb
DatePicker	dp

• 如：ll_module_功能

三、基本组件

1.Activity数据传递基本类型 可使用Intent，小对象推荐Pacelable序列化，大对象可以考虑使用EventBus等方案

2.Activity#onSaveInstanceState()方法不是 Activity 生命周期方法，也不保证
一定会被调用。它是用来在 Activity 被意外销毁时保存 UI 状态的，只能用于保存临
时性数据，例如 UI 控件的属性等，不能跟数据的持久化存储混为一谈。持久化存储
应该在 Activity#onPause()/onStop()中实行。

3.Activity 间通过隐式 Intent 的跳转，在发出 Intent 之前必须通过 resolveActivity
检查，避免找不到合适的调用组件，造成 ActivityNotFoundException 的异常。

public void viewUrl(String url, String mimeType) {
 Intent intent = new Intent(Intent.ACTION_VIEW);
 intent.setDataAndType(Uri.parse(url), mimeType);
 if (getPackageManager().resolveActivity(intent, PackageManager.MATCH_DEFAULT_
ONLY) != null) {
 startActivity(intent);
 }else {
 // 找不到指定的 Activity
 }
}

4.避免在 Service#onStartCommand()/onBind()方法中执行耗时操作，如果确
实有需求，应改用 IntentService 或采用其他异步机制完成。

public class MainActivity extends Activity {
 @Override
 public void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.main);
 }
 public void startIntentService(View source) {
 Intent intent = new Intent(this, MyIntentService.class);
 startService(intent);
 }
}
public class MyIntentService extends IntentService {
 public MyIntentService() {
 super("MyIntentService");
 }
 @Override
 protected void onHandleIntent(Intent intent) {
 synchronized (this) {
 try {
  ......
     } catch (Exception e) {
     }
  }
 }
}

5.避免在 BroadcastReceiver#onReceive()中执行耗时操作，如果有耗时工作，
应该创建 IntentService 完成，而不应该在 BroadcastReceiver 内创建子线程去做。
说明：
由于该方法是在主线程执行，如果执行耗时操作会导致 UI 不流畅。可以使用
IntentService 、创建 HandlerThread 或者调用 Context#registerReceiver
(BroadcastReceiver, IntentFilter, String, Handler)方法等方式，在其他 Wroker 线程
执行 onReceive 方法。BroadcastReceiver#onReceive()方法耗时超过 10 秒钟，可
能会被系统杀死。

IntentFilter filter = new IntentFilter();
filter.addAction(LOGIN_SUCCESS);
this.registerReceiver(mBroadcastReceiver, filter); 
mBroadcastReceiver = new BroadcastReceiver() {
 @Override
 public void onReceive(Context context, Intent intent) {
 Intent userHomeIntent = new Intent();
 userHomeIntent.setClass(this, UserHomeService.class);
 this.startService(userHomeIntent);
 }
};

6.避免使用隐式 Intent 广播敏感信息，信息可能被其他注册了对应
BroadcastReceiver 的 App 接收。
说明：
通过 Context#sendBroadcast()发送的隐式广播会被所有感兴趣的 receiver 接收，恶
意应用注册监听该广播的 receiver 可能会获取到 Intent 中传递的敏感信息，并进行
其他危险操作。如果发送的广播为使用 Context#sendOrderedBroadcast()方法发送
的有序广播，优先级较高的恶意 receiver 可能直接丢弃该广播，造成服务不可用，
或者向广播结果塞入恶意数据。
如果广播仅限于应用内，则可以使用 LocalBroadcastManager#sendBroadcast()实
现，避免敏感信息外泄和 Intent 拦截的风险。

Intent intent = new Intent("my-sensitive-event");
intent.putExtra("event", "this is a test event");
LocalBroadcastManager.getInstance(this).sendBroadcast(intent);

7.添 加 Fragment 时，确保 FragmentTransaction#commit() 在

Activity#onPostResume()或者 FragmentActivity#onResumeFragments()内调用。

不要随意使用 FragmentTransaction#commitAllowingStateLoss()来代替，任何

commitAllowingStateLoss()的使用必须经过 code review，确保无负面影响。

说明：

Activity 可能因为各种原因被销毁， Android 支持页 面被销毁前通过

Activity#onSaveInstanceState() 保存自己的状态。但如果

FragmentTransaction.commit()发生在 Activity 状态保存之后，就会导致 Activity 重

建、恢复状态时无法还原页面状态，从而可能出错。为了避免给用户造成不好的体验，系统会抛出 IllegalStateExceptionStateLoss 异常。推荐的做法是在 Activity 的

onPostResume() 或 onResumeFragments() （ 对 FragmentActivity ）里执行

FragmentTransaction.commit()，如有必要也可在 onCreate()里执行。不要随意改用

FragmentTransaction.commitAllowingStateLoss() 或者直接使用 try-catch 避 免

crash，这不是问题的根本解决之道，当且仅当你确认 Activity 重建、恢复状态时，

本次 commit 丢失不会造成影响时才可这么做。

public class MainActivity extends FragmentActivity {
 FragmentManager fragmentManager;
 @Override
 protected void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.activity_main2);
 fragmentManager = getSupportFragmentManager();
 FragmentTransaction ft = fragmentManager.beginTransaction();
 MyFragment fragment = new MyFragment();
 ft.replace(R.id.fragment_container, fragment);
 ft.commit();
 }
}

8.不要在 Activity#onDestroy()内执行释放资源的工作，例如一些工作线程的

销毁和停止，因为 onDestroy()执行的时机可能较晚。可根据实际需要，在

Activity#onPause()/onStop()中结合 isFinishing()的判断来执行。

9.如非必须，避免使用嵌套的 Fragment。

嵌套Fragment是在Android API 17添加到SDK以及Support库中的功能，Fragment

嵌套使用会有一些坑，容易出现 bug，比较常见的问题有如下几种：

1. onActivityResult()方法的处理错乱，内嵌的 Fragment 可能收不到该方法的回调，

需要由宿主 Fragment 进行转发处理；

2. 突变动画效果；

3. 被继承的 setRetainInstance()，导致在 Fragment 重建时多次触发不必要的逻

辑。

非必须的场景尽可能避免使用嵌套 Fragment，如需使用请注意上述问题。

FragmentManager fragmentManager = getFragmentManager();
Fragment fragment = fragmentManager.findFragmentByTag(FragmentB.TAG);
if (null == fragment) {
 FragmentB fragmentB = new FragmentB();
 FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
 fragmentTransaction.add(R.id.fragment_container, fragmentB, FragmentB.TAG).
commit();
}

10.总是使用显式 Intent 启动或者绑定 Service，且不要为服务声明 Intent Filter，

保证应用的安全性。如果确实需要使用隐式调用，则可为 Service 提供 Intent Filter

并从 Intent 中排除相应的组件名称，但必须搭配使用 Intent#setPackage()方法设置

Intent 的指定包名，这样可以充分消除目标服务的不确定性。

11.Service 需要以多线程来并发处理多个启动请求，建议使用 IntentService，

可避免各种复杂的设置。

说明：

Service 组件一般运行主线程，应当避免耗时操作，如果有耗时操作应该在 Worker

线程执行。可以使用 IntentService 执行后台任务。

public class SingleIntentService extends IntentService {
 public SingleIntentService() {
 super("single-service thread");
}
 @Override
 protected void onHandleIntent(Intent intent) {
 try {
 ......
 } catch (InterruptedException e) {
 e.printStackTrace();
 }
 }
}

12.对于只用于应用内的广播，优先使用 LocalBroadcastManager 来进行注册

和发送，LocalBroadcastManager 安全性更好，同时拥有更高的运行效率。

说明：

对于使用 Context#sendBroadcast()等方法发送全局广播的代码进行提示。如果该广

播仅用于应用内，则可以使用 LocalBroadcastManager 来避免广播泄漏以及广播被

拦截等安全问题，同时相对全局广播本地广播的更高效。

public class MainActivity extends ActionBarActivity {
 private MyReceiver receiver;
 private IntentFilter filter;
 private Context context;
 private static final String MY_BROADCAST_TAG = "com.example.localbroadcast";
 @Override
 protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstsanceState);
    context = this;
    setContentView(R.layout.activity_main);
    receiver = new MyReceiver();
    filter = new IntentFilter();
    filter.addAction(MY_BROADCAST_TAG);
    Button button = (Button) findViewById(R.id.button);
    button.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {
        Intent intent = new Intent();
        intent.setAction(MY_BROADCAST_TAG);
        LocalBroadcastManager.getInstance(context).sendBroadcast(intent);
    }
 });
}
 @Override
 protected void onResume() {
    super.onResume();
    LocalBroadcastManager.getInstance(context).registerReceiver(receiver, filter);
}
 @Override
 protected void onPause() {
    super.onPause();
    LocalBroadcastManager.getInstance(context).unregisterReceiver(receiver);
}
 class MyReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context arg0, Intent arg1) {
    // message received
 }
 }
}

13.当前 Activity 的 onPause 方法执行结束后才会创建（onCreate）或恢复

（onRestart）别的 Activity，所以在 onPause 方法中不适合做耗时较长的工作，这

会影响到页面之间的跳转效率。

14.Activity或者Fragment中动态注册BroadCastReceiver时，registerReceiver()

和 unregisterReceiver()要成对出现。

说明：

如果 registerReceiver()和 unregisterReceiver()不成对出现，则可能导致已经注册的

receiver 没有在合适的时机注销，导致内存泄漏，占用内存空间，加重 SystemService

负担。

部分华为的机型会对 receiver 进行资源管控，单个应用注册过多 receiver 会触发管

控模块抛出异常，应用直接崩溃。

Activity 的生命周期不对应，可能出现多次 onResume 造成 receiver 注册多个，但

最终只注销一个，其余 receiver 产生内存泄漏。

public class MainActivity extends AppCompatActivity {
 private static MyReceiver myReceiver = new MyReceiver();
 ...
 @Override
 protected void onResume() {
 super.onResume();
 IntentFilter filter = new IntentFilter("com.example.myservice");
 registerReceiver(myReceiver, filter);
}
 @Override
 protected void onPause() {
 super.onPause();
 unregisterReceiver(myReceiver);
 }
 ...
}

15.Android 基础组件如果使用隐式调用，应在 AndroidManifest.xml 中使用

或在代码中使用 IntentFilter 增加过滤。

说明：

如果浏览器支持 Intent Scheme Uri 语法，如果过滤不当，那么恶意用户可能通过浏

览器 js 代码进行一些恶意行为，比如盗取 cookie 等。如果使用了 Intent.parseUri

函数，获取的 intent 必须严格过滤。

// 将 intent scheme URL 转换为 intent 对象
Intent intent = Intent.parseUri(uri); 
// 禁止没有 BROWSABLE category 的情况下启动 activity
intent.addCategory("android.intent.category.BROWSABLE"); 
intent.setComponent(null); 
intent.setSelector(null); 
// 使用 intent 启动 activity
context.startActivityIfNeeded(intent, -1)

四、UI与布局

1.布局中不得不使用 ViewGroup 多重嵌套时，不要使用 LinearLayout 嵌套，
改用 RelativeLayout，最好使用ConstraintLayout约束布局，可以有效降低嵌套数。
说明：
Android 应用页面上任何一个 View 都需要经过 measure、layout、draw 三个步骤
才能被正确的渲染。从 xml layout 的顶部节点开始进行 measure，每个子节点都需
要向自己的父节点提供自己的尺寸来决定展示的位置，在此过程中可能还会重新
measure（由此可能导致measure的时间消耗为原来的2-3倍）。节点所处位置越深，
嵌套带来的 measure 越多，计算就会越费时。这就是为什么扁平的 View 结构会性
能更好。
同时，页面拥上的 View 越多，measure、layout、draw 所花费的时间就越久。要缩
短这个时间，关键是保持 View 的树形结构尽量扁平，而且要移除所有不需要渲染的
View。理想情况下，总共的 measure，layout，draw 时间应该被很好的控制在 16ms
以内，以保证滑动屏幕时 UI 的流畅。
要找到那些多余的 View（增加渲染延迟的 view），可以用 Android Studio Monitor
里的 Hierarchy Viewer 工具，可视化的查看所有的 view。

2.在 Activity 中显示对话框或弹出浮层时，尽量使用 DialogFragment，而非
Dialog/AlertDialog，这样便于随Activity生命周期管理对话框/弹出浮层的生命周期。

public void showPromptDialog(String text) {
 DialogFragment promptDialog = new DialogFragment() {
 @Override
 public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle
savedInstanceState) {
 getDialog().requestWindowFeature(Window.FEATURE_NO_TITLE);
 View view = inflater.inflate(R.layout.fragment_prompt, container);
 return view;
  }
 };
 promptDialog.show(getFragmentManager(), text);
}

3.源文件统一采用 UTF-8 的形式进行编码。

4.禁止在非 UI 线程进行 View 相关操作。

5.文本大小使用单位 dp，View 大小使用单位 dp。对于 TextView，如果在文
字大小确定的情况下推荐使用 wrap_content 布局避免出现文字显示不全的适配问
题。
说明：
之所以文本大小也推荐使用 dp 而非 sp，因为 sp 是 Android 早期推荐使用的，但其
实 sp 不仅和 dp 一样受屏幕密度的影响，还受到系统设置里字体大小的影响，所以
使用 dp 对于应用开发会更加保证 UI 的一致性和还原度。

6.禁止在设计布局时多次为子 View 和父 View 设置同样背景进而造成页面过
度绘制，推荐将不需要显示的布局进行及时隐藏。

7.灵活使用布局，推荐 merge、ViewStub 来优化布局，尽可能多的减少 UI
布局层级，推荐使用 FrameLayout，LinearLayout、RelativeLayout 次之。

8.在需要时刻刷新某一区域的组件时，建议通过以下方式避免引发全局 layout
刷新:

1. 设置固定的 View 大小的宽高，如倒计时组件等；
2. 调用 View 的 layout 方法修改位置，如弹幕组件等；
3. 通过修改 Canvas 位置并且调用 invalidate(int l, int t, int r, int b)等方式限定刷新
   区域；
4. 通过设置一个是否允许requestLayout的变量，然后重写控件的requestlayout、
   onSizeChanged 方法，判断控件的大小没有改变的情况下，当进入
   requestLayout 的时候，直接返回而不调用 super 的 requestLayout 方法。

9.不能在 Activity 没有完全显示时显示 PopupWindow 和 Dialog。
说明：
Android Activity 创建时的生命周期，按照 onCreate() -> onStart() -> onResume() ->
onAttachedToWindow() -> onWindowFocusChanged() 的顺序，其中在
Activity#onAttachedToWindow() 时，Activity 会与它的 Window 关联，这时 UI 才
会开始绘制，在 Activity#onWindowFocusChanged() 时，UI 才变成可交互状态，
可以提示用户使用。如果在 Window 未关联时就创建对话框，UI 可能显示异常。
推荐的做法是在 Activity#onAttachedToWindow() 之后（其实最好是
Activity#onWindowFocusChanged() 之后）才创建对话框。

10.尽量不要使用 AnimationDrawable，它在初始化的时候就将所有图片加载
到内存中，特别占内存，并且还不能释放，释放之后下次进入再次加载时会报错。
说明：
Android 的帧动画可以使用 AnimationDrawable 实现，但是如果你的帧动画中如果
包含过多帧图片，一次性加载所有帧图片所导致的内存消耗会使低端机发生 OOM
异常。帧动画所使用的图片要注意降低内存消耗，当图片比较大时，容易出现 OOM。
图片数量较少的 AnimationDrawable 还是可以接受的。

11.不能使用 ScrollView 包裹 ListView/GridView/ExpandableListVIew;因为这
样会把 ListView 的所有 Item 都加载到内存中，要消耗巨大的内存和 cpu 去绘制图
面。
说明：
ScrollView 中嵌套 List 或 RecyclerView 的做法官方明确禁止。除了开发过程中遇到
的各种视觉和交互问题，这种做法对性能也有较大损耗。ListView 等 UI 组件自身有
垂直滚动功能，也没有必要在嵌套一层 ScrollView。目前为了较好的 UI 体验，更贴
近 Material Design 的设计，推荐使用 NestedScrollView。

 
 
 
 ...
 
 
 

12.不要在 Android 的 Application 对象中缓存数据。基础组件之间的数据共享
请使用 Intent 等机制，也可使用 SharedPreferences 等数据持久化机制。

13.使用 Toast 时，建议定义一个全局的 Toast 对象，这样可以避免连续显示
Toast 时不能取消上一次 Toast 消息的情况。即使需要连续弹出 Toast，也应避免直
接调用 Toast#makeText。

14.使用 Adapter 的时候，如果你使用了 ViewHolder 做缓存，在 getView()的
方法中无论这项 convertView 的每个子控件是否需要设置属性(比如某个 TextView
设置的文本可能为 null，某个按钮的背景色为透明，某控件的颜色为透明等)，都需
要为其显式设置属性(Textview 的文本为空也需要设置 setText("")，背景透明也需要
设置)，否则在滑动的过程中，因为 adapter item 复用的原因，会出现内容的显示错
乱。

@Override 
public View getView(int position, View convertView, ViewGroup parent) {
 ViewHolder myViews;
 if (convertView == null) {
 myViews = new ViewHolder();
 convertView = mInflater.inflate(R.layout.list_item, null);
 myViews.mUsername = (TextView)convertView.findViewById(R.id.username);
 convertView.setTag(myViews);
 } else {
 myViews = (ViewHolder)convertView.getTag();
 }
 Info p = infoList.get(position);
 String dn = p.getDisplayName;
 myViews.mUsername.setText(StringUtils.isEmpty(dn) ? "" : dn);
 return convertView;
 }
static class ViewHolder {
 private TextView mUsername;
}

五、进程、线程与消息通信

1.不要通过 Intent 在 Android 基础组件之间传递大数据（binder transaction
缓存为 1MB），可能导致 OOM。

2.在 Application 的业务初始化代码加入进程判断，确保只在自己需要的进程
初始化。特别是后台进程减少不必要的业务初始化。

public class MyApplication extends Application {
 @Override
 public void onCreate() {
 //在所有进程中初始化
 ....
 //仅在主进程中初始化
 if (mainProcess) {
 ...
 }
 //仅在后台进程中初始化
 if (bgProcess) {
 ...
 }
 }
}

3.新建线程时，必须通过线程池提供（AsyncTask 或者 ThreadPoolExecutor
或者其他形式自定义的线程池），不允许在应用中自行显式创建线程。
说明：
使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解
决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致
消耗完内存或者“过度切换”的问题。另外创建匿名线程不便于后续的资源使用分析，
对性能分析等会造成困扰。

int NUMBER_OF_CORES = Runtime.getRuntime().availableProcessors();
int KEEP_ALIVE_TIME = 1;
TimeUnit KEEP_ALIVE_TIME_UNIT = TimeUnit.SECONDS;
BlockingQueue taskQueue = new LinkedBlockingQueue();
ExecutorService executorService = new ThreadPoolExecutor(NUMBER_OF_CORES, 
NUMBER_OF_CORES*2, KEEP_ALIVE_TIME, KEEP_ALIVE_TIME_UNIT, taskQueue, 
new BackgroundThreadFactory(), new DefaultRejectedExecutionHandler());
//执行任务
executorService.execute(new Runnnable() {
 ...
});

4.线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方
式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
说明：
Executors 返回的线程池对象的弊端如下：

1. FixedThreadPool 和 SingleThreadPool ： 允许的请求队列长度为
   Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM；
2. CachedThreadPool 和 ScheduledThreadPool ： 允许的创建线程数量为
   Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

int NUMBER_OF_CORES = Runtime.getRuntime().availableProcessors();
int KEEP_ALIVE_TIME = 1;
TimeUnit KEEP_ALIVE_TIME_UNIT = TimeUnit.SECONDS;
BlockingQueue taskQueue = new LinkedBlockingQueue();
ExecutorService executorService = new ThreadPoolExecutor(NUMBER_OF_CORES, 
NUMBER_OF_CORES*2, KEEP_ALIVE_TIME, KEEP_ALIVE_TIME_UNIT, 
taskQueue, new BackgroundThreadFactory(), new DefaultRejectedExecutionHandler());

5.子线程中不能更新界面，更新界面必须在主线程中进行，网络操作不能在
主线程中调用。

6.尽量减少不同 APP 之间的进程间通信及拉起行为。拉起导致占用系统资源，
影响用户体验。

7.新建线程时，定义能识别自己业务的线程名称，便于性能优化和问题排查。

public class MyThread extends Thread {
 public MyThread(){
 super.setName("ThreadName");
 …
 }
}

8.禁止在多进程之间用 SharedPreferences 共享数据，虽然可以
(MODE_MULTI_PROCESS)，但官方已不推荐。

9.谨慎使用 Android 的多进程，多进程虽然能够降低主进程的内存压力，但
会遇到如下问题：

1. 首次进入新启动进程的页面时会有延时的现象（有可能黑屏、白屏几秒，是白
   屏还是黑屏和新 Activity 的主题有关）；
2. 应用内多进程时，Application 实例化多次，需要考虑各个模块是否都需要在所
   有进程中初始化。

六、文件与数据库

1.任何时候不要硬编码文件路径，请使用 Android 文件系统 API 访问。
说明：
Android 应用提供内部和外部存储，分别用于存放应用自身数据以及应用产生的用
户数据。可以通过相关 API 接口获取对应的目录，进行文件操作。

android.os.Environment#getExternalStorageDirectory()
android.os.Environment#getExternalStoragePublicDirectory()
android.content.Context#getFilesDir()
android.content.Context#getCacheDir()

public File getDir(String alName) {
 File file = new File(Environment.getExternalStoragePublicDirectory(Environment.
DIRECTORY_PICTURES), alName);
 if (!file.mkdirs()) {
 Log.e(LOG_TAG, "Directory not created");
 }
 return file;
}

2.当使用外部存储时，必须检查外部存储的可用性。

// 读/写检查
public boolean isExternalStorageWritable() {
 String state = Environment.getExternalStorageState();
 if (Environment.MEDIA_MOUNTED.equals(state)) {
 return true;
 }
 return false;
}
// 只读检查
public boolean isExternalStorageReadable() {
 String state = Environment.getExternalStorageState();
 if (Environment.MEDIA_MOUNTED_READ_ONLY.equals(state)) {
 return true;
 }
 return false;
}

3.应用间共享文件时，不要通过放宽文件系统权限的方式去实现，而应使用
FileProvider。

 ...
 
 ...
 
 
 
 ...
 



 

void getAlbumImage(String imagePath) {
 File image = new File(imagePath);
 Intent getAlbumImageIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
 Uri imageUri = FileProvider.getUriForFile(
 this,
 "com.example.provider",
 image);
 getAlbumImageIntent.putExtra(MediaStore.EXTRA_OUTPUT, imageUri);
 startActivityForResult(takePhotoIntent, REQUEST_GET_ALBUMIMAGE);
}

4.SharedPreference 中只能存储简单数据类型（int、boolean、String 等），
复杂数据类型建议使用文件、数据库等其他方式存储。

public void updateSettings() {
 SharedPreferences mySharedPreferences = getSharedPreferences("settings",
Activity.MODE_PRIVATE);
 SharedPreferences.Editor editor = mySharedPreferences.edit();
 editor.putString("id", "foo");
 editor.putString("nick", "bar");
 //不要把复杂数据类型转成 String 存储
 editor.apply();
}

5.SharedPreference 提交数据时，尽量使用 Editor#apply() ，而非
Editor#commit()。一般来讲，仅当需要确定提交结果，并据此有后续操作时，才使
用 Editor#commit()。
说明：
SharedPreference 相关修改使用 apply 方法进行提交会先写入内存，然后异步写入
磁盘，commit 方法是直接写入磁盘。如果频繁操作的话 apply 的性能会优于 commit，
apply 会将最后修改内容写入磁盘。但是如果希望立刻获取存储操作的结果，并据此
做相应的其他操作，应当使用 commit。
不过，还是推荐commit来操作，保证数据存储的可靠性，牺牲部分性能

public void updateSettingsAsync() {
 SharedPreferences mySharedPreferences = getSharedPreferences("settings",
Activity.MODE_PRIVATE);
 SharedPreferences.Editor editor = mySharedPreferences.edit();
 editor.putString("id", "foo");
 editor.apply();
}
public void updateSettings() {
 SharedPreferences mySharedPreferences = getSharedPreferences("settings",
Activity.MODE_PRIVATE);
 SharedPreferences.Editor editor = mySharedPreferences.edit();
 editor.putString("id", "foo");
 if (!editor.commit()) {
 Log.e(LOG_TAG, "Failed to commit setting changes");
 }
}

6.数据库 Cursor 必须确保使用完后关闭，以免内存泄漏。
说明：
Cursor 是对数据库查询结果集管理的一个类，当查询的结果集较小时，消耗内存不
易察觉。但是当结果集较大，长时间重复操作会导致内存消耗过大，需要开发者在
操作完成后手动关闭 Cursor。
数据库 Cursor 在创建及使用时，可能发生各种异常，无论程序是否正常结束，必须
在最后确保 Cursor 正确关闭，以避免内存泄漏。同时，如果 Cursor 的使用还牵涉
多线程场景，那么需要自行保证操作同步。

public void handlePhotos(SQLiteDatabase db, String userId) {
 Cursor cursor;
 try {
 cursor = db.query(TUserPhoto, new String[] { "userId", "content" }, "userId=?", new
String[] { userId }, null, null, null);
 while (cursor.moveToNext()) {
 // TODO
 }
 } catch (Exception e) {
 // TODO
 } finally {
 if (cursor != null) {
 cursor.close();
 }
 }
}

7.多线程操作写入数据库时，需要使用事务，以免出现同步问题。
说明：
通过 SQLiteOpenHelper 获取数据库 SQLiteDatabase 实例，Helper 中会自动缓存
已经打开的 SQLiteDatabase 实例，单个 App 中应使用 SQLiteOpenHelper 的单例
模式确保数据库连接唯一。由于 SQLite 自身是数据库级锁，单个数据库操作是保证
线程安全的（不能同时写入），transaction 是一次原子操作，因此处于事务中的操作
是线程安全的。
若同时打开多个数据库连接，并通过多线程写入数据库，会导致数据库异常，提示
数据库已被锁住。

public void insertUserPhoto(SQLiteDatabase db, String userId, String content) {
 ContentValues cv = new ContentValues();
 cv.put("userId", userId);
 cv.put("content", content);
 db.beginTransaction();
 try {
 db.insert(TUserPhoto, null, cv);
 // 其他操作
 db.setTransactionSuccessful();
 } catch (Exception e) {
 // TODO
 } finally {
 db.endTransaction();
 }
}

8.大数据写入数据库时，请使用事务或其他能够提高 I/O 效率的机制，保证执
行速度。

public void insertBulk(SQLiteDatabase db, ArrayList users) {
 db.beginTransaction();
 try {
 for (int i = 0; i < users.size; i++) {
 ContentValues cv = new ContentValues();
 cv.put("userId", users[i].userId);
 cv.put("content", users[i].content);
 db.insert(TUserPhoto, null, cv);
 }
 // 其他操作
 db.setTransactionSuccessful();
 } catch (Exception e) {
 // TODO
 } finally {
 db.endTransaction();
 }
}

9.执行 SQL 语句时，应使用 SQLiteDatabase#insert()、update()、delete()，
不要使用 SQLiteDatabase#execSQL()，以免 SQL 注入风险。

public int updateUserPhoto(SQLiteDatabase db, String userId, String content) {
 ContentValues cv = new ContentValues();
 cv.put("content", content);
 String[] args = {String.valueOf(userId)};
 return db.update(TUserPhoto, cv, "userId=?", args);
}

10.如果 ContentProvider 管理的数据存储在 SQL 数据库中，应该避免将不受
信任的外部数据直接拼接在原始 SQL 语句中。

// 使用一个可替换参数
String mSelectionClause = "var = ?";
String[] selectionArgs = {""};
selectionArgs[0] = mUserInput;

七、Bitmap、Drawable与动画

1.加载大图片或者一次性加载多张图片，应该在异步线程中进行。图片的加
载，涉及到 IO 操作，以及 CPU 密集操作，很可能引起卡顿。

class BitmapWorkerTask extends AsyncTask {
 ...
 // 在后台进行图片解码
 @Override
 protected Bitmap doInBackground(Integer... params) {
 final Bitmap bitmap = BitmapFactory.decodeFile("some path");
 return bitmap;
 }
 ...
}

2.在 ListView，ViewPager，RecyclerView，GirdView 等组件中使用图片时，
应做好图片的缓存，避免始终持有图片导致内存溢出，也避免重复创建图片，引起
性能问题。建议 使 用 Fresco （ https://github.com/facebook/fresco ）、 Glide
（https://github.com/bumptech/glide） 等图片库。
例如使用系统 LruCache 缓存，参考：
https://developer.android.com/topic/performance/graphics/cache-bitmap.html

private LruCache mMemoryCache;
@Override
protected void onCreate(Bundle savedInstanceState) {
 ...
 // 获取可用内存的最大值，使用内存超出这个值将抛出 OutOfMemory 异常。LruCache 通
过构造函数传入缓存值，以 KB 为单位。
 final int maxMemory = (int) (Runtime.getRuntime().maxMemory() / 1024);
 // 把最大可用内存的 1/8 作为缓存空间
 final int cacheSize = maxMemory / 8;
 mMemoryCache = new LruCache(cacheSize) {
 @Override
 protected int sizeOf(String key, Bitmap bitmap) {
 return bitmap.getByteCount() / 1024;
 }
 };
 ...
}
public void addBitmapToMemoryCache(String key, Bitmap bitmap) {
 if (getBitmapFromMemCache(key) == null) {
 mMemoryCache.put(key, bitmap);
 }
}
public Bitmap getBitmapFromMemCache(String key) {
 return mMemoryCache.get(key);
}

public void loadBitmap(int resId, ImageView imageView) {
 final String imageKey = String.valueOf(resId);
 final Bitmap bitmap = getBitmapFromMemCache(imageKey);
 if (bitmap != null) {
 mImageView.setImageBitmap(bitmap);
 } else {
 mImageView.setImageResource(R.drawable.image_placeholder);
 BitmapWorkerTask task = new BitmapWorkerTask(mImageView);
 task.execute(resId);
 }
}
class BitmapWorkerTask extends AsyncTask {
 ...
 // 在后台进行图片解码
 @Override
 protected Bitmap doInBackground(Integer... params) {
 final Bitmap bitmap = decodeSampledBitmapFromResource(getResources(),
params[0], 100, 100));
 addBitmapToMemoryCache(String.valueOf(params[0]), bitmap);
 return bitmap;
 }
 ...
}

3.png 图片使用 TinyPNG 或者类似工具压缩处理，减少包体积。对于我们蓝湖下载切图时，必须选择高质量压缩

4.应根据实际展示需要，压缩图片，而不是直接显示原图。手机屏幕比较小，
直接显示原图，并不会增加视觉上的收益，但是却会耗费大量宝贵的内存。

public static Bitmap decodeSampledBitmapFromResource(Resources res, int resId,
int reqWidth, int reqHeight) {
 // 首先通过 inJustDecodeBounds=true 获得图片的尺寸
 final BitmapFactory.Options options = new BitmapFactory.Options();
 options.inJustDecodeBounds = true;
 BitmapFactory.decodeResource(res, resId, options);
 // 然后根据图片分辨率以及我们实际需要展示的大小，计算压缩率
 options.inSampleSize = calculateInSampleSize(options, reqWidth, reqHeight);
 // 设置压缩率，并解码
 options.inJustDecodeBounds = false;
 return BitmapFactory.decodeResource(res, resId, options);
}

5.使用完毕的图片，应该及时回收，释放宝贵的内存。

Bitmap bitmap = null;
loadBitmapAsync(new OnResult(result){
 bitmap = result;
});
...使用该 bitmap...
// 使用结束，在 2.3.3 及以下需要调用 recycle()函数，在 2.3.3 以上 GC 会自动管理，除非你明确不需要再用。
if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.GINGERBREAD_MR1) {
 bitmap.recycle();
}
bitmap = null;

6.在 Activity#onPause()或 Activity#onStop()回调中，关闭当前 activity 正在执
行的的动画。

public class MyActivity extends Activity {
 ImageView mImageView;
 Animation mAnimation;
 Button mBtn;
 @Override
 public void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.main);
 mImageView = (ImageView)findViewById(R.id.ImageView01);
 mAnimation = AnimationUtils.loadAnimation(this, R.anim.anim);
 mBtn= (Button)findViewById(R.id.Button01);
 mBtn.setOnClickListener(new View.OnClickListener() {
 @Override
 public void onClick(View v) {
 mImageView.startAnimation(mAnimation);
 }
 });
}

@Override
 public void onPause() {
 //页面退出，及时清理动画资源
 mImageView.clearAnimation()
 }
}

7.在动画或者其他异步任务结束时，应该考虑回调时刻的环境是否还支持业
务处理。例如 Activity 的 onStop()函数已经执行，且在该函数中主动释放了资源，
此时回调中如果不做判断就会空指针崩溃。

public class MyActivity extends Activity {
 private ImageView mImageView;
 private Animation mAnimation;
 @Override
 public void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.main);
 mImageView = (ImageView)findViewById(R.id.ImageView01);
 mAnimation = AnimationUtils.loadAnimation(this, R.anim.anim);
 mAnimation.setAnimationListener(new AnimationListener() {
 @Override
 public void onAnimationEnd(Animation arg0) {
 //判断一下资源是否被释放了
 if (mImageView != null) {
  mImageView.clearAnimation();
 }
 }
 });
 mImageView.startAnimation(mAnimation);
 }
}

8.使用 inBitmap 重复利用内存空间，避免重复开辟新内存。

public static Bitmap decodeSampledBitmapFromFile(String filename, int reqWidth, int
reqHeight, ImageCache cache) {
 final BitmapFactory.Options options = new BitmapFactory.Options();
 ...
 BitmapFactory.decodeFile(filename, options);
 ...
 // 如果在 Honeycomb 或更新版本系统中运行，尝试使用 inBitmap
 if (Utils.hasHoneycomb()) {
 addInBitmapOptions(options, cache);
 }
 ...
 return BitmapFactory.decodeFile(filename, options);
}
private static void addInBitmapOptions(BitmapFactory.Options options,
 ImageCache cache) {
 // inBitmap 只处理可变的位图，所以强制返回可变的位图
 options.inMutable = true;
 if (cache != null) {
 Bitmap inBitmap = cache.getBitmapFromReusableSet(options);
 if (inBitmap != null) {
 options.inBitmap = inBitmap;
 }
 }
}

9.使用 RGB_565 代替 RGB_888，在不怎么降低视觉效果的前提下，减少内
存占用。
说明：
android.graphics.Bitmap.Config 类中关于图片颜色的存储方式定义：

1. ALPHA_8 代表 8 位 Alpha 位图；
2. ARGB_4444 代表 16 位 ARGB 位图；
3. ARGB_8888 代表 32 位 ARGB 位图；
4. RGB_565 代表 8 位 RGB 位图。
   位图位数越高，存储的颜色信息越多，图像也就越逼真。大多数场景使用的是
   ARGB_8888 和 RGB_565，RGB_565 能够在保证图片质量的情况下大大减少内存
   的开销，是解决 OOM 的一种方法。
   但是一定要注意 RGB_565 是没有透明度的，如果图片本身需要保留透明度，那么
   就不能使用 RGB_565。

Config config = drawableSave.getOpacity() != PixelFormat.OPAQUE ? Config.ARGB_8565 : 
Config.RGB_565; 
Bitmap bitmap = Bitmap.createBitmap(w, h, config);

10.尽量减少 Bitmap（BitmapDrawable）的使用，尽量使用纯色（ColorDrawable）、
渐变色（GradientDrawable）、StateSelector（StateListDrawable）等与 Shape 结
合的形式构建绘图。

11.谨慎使用 gif 图片，注意限制每个页面允许同时播放的 gif 图片，以及单个
gif 图片的大小。

12.大图片资源不要直接打包到 apk，可以考虑通过文件仓库远程下载，减小包
体积。可不考虑

13.根据设备性能，选择性开启复杂动画，以实现一个整体较优的性能和体验；

14.在有强依赖 onAnimationEnd 回调的交互时，如动画播放完毕才能操作页
面 ， onAnimationEnd 可能会因各种异常没被回调 （参考：
https://stackoverflow.com/questions/5474923/onanimationend-is-not-getting-called-onanimationstart-works-fine ），建议加上超时保护或通过 postDelay 替 代
onAnimationEnd。

View v = findViewById(R.id.xxxViewID);
final FadeUpAnimation anim = new FadeUpAnimation(v);
anim.setInterpolator(new AccelerateInterpolator());
anim.setDuration(1000);
anim.setFillAfter(true);
new Handler().postDelayed(new Runnable() {
 public void run() {
 if (v != null) {
 v.clearAnimation();
 }
 }
}, anim.getDuration());
v.startAnimation(anim);

15.当 View Animation 执行结束时，调用 View.clearAnimation()释放相关资源。

View v = findViewById(R.id.xxxViewID);
final FadeUpAnimation anim = new FadeUpAnimation(v);
anim.setInterpolator(new AccelerateInterpolator());
anim.setDuration(1000);
anim.setFillAfter(true);
anim.setAnimationListener(new AnimationListener() {
 @Override
 public void onAnimationEnd(Animation arg0) {
 //判断一下资源是否被释放了
 if (v != null) {
 v.clearAnimation();
 }
 }
});
v.startAnimation(anim);

八、安全

1.禁止使用常量初始化矢量参数构建 IvParameterSpec，建议 IV 通过随机方
式产生。
说明：
使用常量初始化向量，密码文本的可预测性会高得多，容易受到字典式攻击。iv 的
作用主要是用于产生密文的第一个 block，以使最终生成的密文产生差异（明文相同
的情况下），使密码攻击变得更为困难。

byte[] rand = new byte[16];
SecureRandom r = new SecureRandom();
r.nextBytes(rand);
IvParameterSpec iv = new IvParameterSpec(rand);

2.将 android:allowbackup 属性必须设置为 false，阻止应用数据被导出。
说明：
android:allowBackup 原本是 Android 提供的 adb 调试功能，如果设置为 true，
可以导出应用数据备份并在任意设备上恢复。这对应用安全性和用户数据隐私构成
极大威胁，所以必须设置为 false，防止数据泄露。

3.如果使用自定义 HostnameVerifier 实现类，必须在 verify()方法中校验服务
器主机名的合法性，否则可能受到中间人攻击。
说明：
在与服务器建立 https 连接时，如果 URL 的主机名和服务器的主机名不匹配，则
可通过该回调接口来判断是否应该允许建立连接。如果回调内实现不恰当，没有有
效校验主机名，甚至默认接受所有主机名，会大大增加安全风险。

HostnameVerifier hnv = new HostnameVerifier() {
@Override
public boolean verify(String hostname, SSLSession session) {
 // 不做校验，接受任意域名服务器
 return true;
 }
};
HttpsURLConnection.setDefaultHostnameVerifier(hnv);

4.如果使用自定义 X509TrustManager 实现类，必须在 checkServerTrusted()
方法中校验服务端证书的合法性，否则可能受到中间人攻击。
说明：
常见误区是 checkServerTrusted()方法根本没有实现，这将导致 X509TrustManager
形同虚设。该方法中需要实现完备的校验逻辑，对于证书错误抛出
CertificateException 。

HostnameVerifier hnv = new HostnameVerifier() {
 @Override
 public boolean verify(String hostname, SSLSession session) {
  if("yourhostname".equals(hostname)){ 
 return true; 
 } else { 
 HostnameVerifier hv = HttpsURLConnection.getDefaultHostnameVerifier();
 return hv.verify(hostname, session);
 }
 }
};

5.在 SDK 支持的情况下，Android 应用必须使用 V2 签名，这将对 APK 文
件的修改做更多的保护。

6.所有的 Android 基本组件（Activity、Service、BroadcastReceiver、
ContentProvider 等）都不应在没有严格权限控制的情况下，将 android:exported 设
置为 true。

7.WebView 应设置 WebView#getSettings()#setAllowFileAccess(false)、
WebView#getSettings()#setAllowFileAccessFromFileURLs(false) 、
WebView#getSettings()#setAllowUniversalAccessFromFileURLs(false)，阻止 file
scheme URL 的访问。

8.不要把敏感信息打印到 log 中。
说明：
在开发过程中，为了方便调试，通常会使用 log 函数输出一些关键流程的信息，这
些信息中通常会包含敏感内容，让攻击者更加容易了解 APP 内部结构，方便破解和
攻击，甚至直接获取到有价值的敏感信息。

9.确保应用发布版本的 android:debuggable 属性设置为 false。

10.本地加密秘钥不能硬编码在代码中，更不能使用 SharedPreferences 等本
地持久化机制存储。应选择 Android 自身的秘钥库（KeyStore）机制或者其他安全
性更高的安全解决方案保存。
说明：
应用程序在加解密时，使用硬编码在程序中的密钥，攻击者通过反编译拿到密钥可
以轻易解密 APP 通信数据。

11.addJavascriptInterface() 可以添加 JS 对本地 Java 方法的调用，但这本身
会导致恶意代码的攻击。在 Android 4.2（API Level 17）以下，不应再使用这样的
调用方式。在 Android 4.2 及以上，需要对本地被远程调用的方法显式添加
@JavascriptInterface annotation。

12.使用 Android 的 AES/DES/DESede 加密算法时，不要使用 ECB 加密模式，
应使用 CBC 或 CFB 加密模式。
说明：
加密模式有 ECB、CBC、CFB、OFB 等，其中 ECB 的安全性较弱，如果使用固
定的密钥，相同的明文将会生成相同的密文，容易受到字典攻击，建议使用 CBC、
CFB 或 OFB 等模式。

1. ECB：Electronic codebook，电子密码本模式
2. CBC：Cipher-block chaining，密码分组链接模式
3. CFB：Cipher feedback，密文反馈模式
4. OFB：Output feedback，输出反馈模式

13.Android APP 在 HTTPS 通信中，验证策略需要改成严格模式。
说明：
Android APP 在 HTTPS 通信中，使用 ALLOW_ALL_HOSTNAME_VERIFIER，表
示允许和所有的 HOST 建立 SSL 通信，这会存在中间人攻击的风险，最终导致敏感
信息可能会被劫持，以及其他形式的攻击。
ALLOW_ALL_HOSTNAME_VERIFIER 关闭 host 验证，允许和所有的 host 建立
SSL 通信，BROWSER_COMPATIBLE_HOSTNAME_VERIFIER 和浏览器兼容的
验证策略，即通配符能够匹配所有子域名 ，STRICT_HOSTNAME_VERIFIER 严
格匹配模式，hostname 必须匹配第一个 CN 或者任何一个 subject-alts，以上例子
使用了 ALLOW_ALL_HOSTNAME_VERIFIER，需要改成 STRICT_HOSTNAME_
VERIFIER。

14.在 Android 4.2（API Level 17）及以上，对安全性要求较高的应用可在 Activity
中，对 Activity 所关联的 Window 应用 WindowManager.LayoutParams.FLAG_
SECURE，防止被截屏、录屏。但要注意的是，一个 Activity 关联的 Window 可
能不止一个，如果使用了 Dialog / DialogFragment 等控件弹出对话框，它们本身
也会创建一个新的 Window，也一样需要保护。

15.zip 中不要包含 ../../file 这样的路径，可能被篡改目录结构，造成攻击。
说明：
当 zip 压缩包中允许存在"../"的字符串，攻击者可以利用多个"../"在解压时改变 zip 文
件存放的位置，当文件已经存在是就会进行覆盖，如果覆盖掉的文件是 so、dex 或
者 odex 文件，就有可能造成严重的安全问题。
对路径进行判断，存在".."时抛出异常。

//对重要的 Zip 压缩包文件进行数字签名校验，校验通过才进行解压
String entryName = entry.getName();
if (entryName.contains("..")){
 throw new Exception("unsecurity zipfile!");
}

16.MD5 和 SHA-1、SHA-256 等常用算法是 Hash 算法，有一定的安全性，
但不能代替加密算法。敏感信息的存储和传输，需要使用专业的加密机制。

九、其他

1.不能使用 System.out.println 打印 log。

Log.d(TAG, "Some Android Debug info ...");

2.Log 的 tag 不能是" "。
说明：
日志的 tag 是空字符串没有任何意义，也不利于过滤日志。

private static String TAG = "LoginActivity";
Log.e(TAG, "Login failed!");