Skip to content

Latest commit

 

History

History
184 lines (168 loc) · 15.5 KB

README_zh.md

File metadata and controls

184 lines (168 loc) · 15.5 KB

安卓应用架构展示 - 基于数据绑定的MVVM架构 (Java 版本) [Kotlin版本] [English Version]

本项目作为安卓应用MVVM架构的例子，展示了如何使用此架构开发一个影视信息网站The Movie DB的客户端。

注意：如果你想运行这个应用，需要设置API key，参见如何开始。

目录

为什么采用 MVVM？

作为客户端应用开发，MVVM是一个比其他的MV*模式（如MVC、MVP）更好的设计模式。

为什么这么说？简单来讲，View Model是对View的数据和行为的抽象，比起其他的MV*模式有更高的抽象层次。另外，View Model对View进行了解耦，并不对View有任何直接依赖，而是通过数据绑定进行通知。更高的抽象层次和更彻底的解耦会带来更清晰简洁的架构。

任何收益都是有代价的，抽象和解耦也不是没有成本。如果应用的复杂程度达到一定水平，这些初始阶段的投入会很快得到回报，带来开发效率的提高。但对于简单的应用，就是杀鸡用牛刀了。

对这个简单的Demo项目来说，采用MVVM看起来是有一点过度设计了。不过我的主要目的是为了展示如何使用MVVM搭建一个实际的应用，以及如何处理其中面对的问题。而且，如果目标是完成一个像"The Movie DB"客户端这样功能完整的应用，这个项目的框架会是一个好的起点。

应用截屏

Now Playing Page Movie Details Page Favorites

应用功能简介

本应用有如下功能：

  • 主页显示三个Tab：正在上映、收藏、设置。
  • 正在上映Tab显示当前正在上映的电影列表。
    • 每个电影显示为网格中的一张海报。图片上有评分的星数。如果电影被收藏，还会有一个心形图标。
    • 列表支持页首下拉刷新，页末上拉加载下一页。
  • 收藏Tab显示本地收藏列表，功能和正在上映列表相同。
  • 点击电影海报会跳转到电影详情页面，显示额外的详细信息，如宽幅背景图，宣传语以及类似电影列表。
    • 页面中的浮动按钮在加载时会显示加载动画。加载完成后会显示收藏状态按钮，点击按钮可以添加/删除收藏。
    • 上拉可加载类似电影列表的下一页。
  • 在设置页面，可以清除应用的缓存（HTTP、图片）以及本地收藏。

应用架构

架构分层

  • 依赖关系
    • 自上而下的单向依赖。下层通过以下形式与上层通讯：
      • View Model通过数据绑定通知UI。
      • Model层通过观察者模式通知View Model层。
      • Repository层则只有通过返回值返回信息给Model层。
    • 依赖关系通过依赖注入 (DI, dependency injection)框架进行注入。View Model以及Model层的类都是可以进行单元测试的。
  • View model层不依赖于任何的UI组件，对Android平台的依赖也越小越好。（现有的依赖：Android数据绑定框架、RxAndroid中的AndroidSchedulers以及SparseArray）
  • Model层是整个应用的领域模型，应与UI和平台无关。换句话说，就是既不依赖于应用的交互及UI设计，也不依赖于安卓平台。（本项目中依赖了SparseArray，但只是出于性能的需要，如果有必要可随时替换。）
  • Repository层是对数据访问的抽象，包括本地数据（Shared Preferences, SQLite数据库）及外部Web APIs。

主要组件

大部分的类名的含义都很明显。不是那么明显的：

应用的关键设计决策

  1. 采用Model-View-ViewModel (MVVM) 结构，利用原生的安卓数据绑定支持。
  2. 用依赖注入解耦：使用Dagger-2框架。
  3. 异步接口：I/O操作在后台线程进行。采用RxJava+RxAndroid实现。
  4. Activity跳转：基于URI，Activity之间无依赖。主要实现见NavigationHelper。
  5. 对象生命周期
    • Model层的实体（Entities）由EntityStore维持WeakReference引用，以保证唯一性（每一部电影只对应一个对象实例）并防止内存泄露。这样同一个实体的不同视图就能通过实体发出的变化通知保持同步。
    • View Model层对象和对应的视图有同样的生命周期，和展示的视图是一一对应的关系。如若不然，一方面会给理解对应关系带来困扰，而且生命周期的不一致会带来各种麻烦（相信我，开始的时候View Model也是唯一的）。

模块/主要目录结构（开发视图）

作为系统结构的开发视图，清晰的模块划分和目录结构（对应Java的包结构）也是构成清晰架构必不可少的一部分。

  • 模块划分
    • app：应用主模块
    • lib-common：通用功能模块
    • lib-databinding：数据绑定支持模块
    • lib-widgets：可重用UI控件模块
  • App模块目录结构
    • di：依赖注入组件
    • models：Model层类定义
    • repository：数据访问层
      • data：用于反序列化JSON的数据类型定义
      • local：本地存储，包括配置文件（SharedPreferences）和数据库
      • util：工具类
      • web：用于访问TMDb的Web API
    • ui：UI层
      • activity：应用中的Activity
      • databinding：数据绑定所需的BindingAdapter
      • fragment：应用中的Fragment
      • nav：跳转辅助工具类NavigationHelper
      • view：项目相关的UI控件
    • viewmodels：View Model层类定义
  • Common模块目录结构
    • objstore：对象池
    • observable：对象及集合的观察者模式实现
    • util：工具类
  • Databinding模块目录结构
    • adapter：RecyclerView的adapter，支持绑定到ObservableList。
    • message：基于数据的消息提示机制，以便通过View Model显示消息（现在是Toast）而不用依赖UI组件。
  • Widgets模块目录结构
    • behaviors：CoordinatorLayout的behavior
    • utils：工具类。现在有ImageLoader。
    • widgets：项目无关、可重用的UI控件。

如何开始

克隆项目（包括submodule）到本地

由于项目包含了一个submodule，所以需要在clone的时候使用参数--recurse-submodules，或者是clone之后运行git submodule update --init --recursive来初始化submodule。

准备TMDb的API key

在你想自己编译运行这个应用之前，需要先按照TMDb的指引去注册一个开发者帐号并拿到API key，然后把API key接入项目的gradle.properties文件中：

# API Key for the TMDb API
API_KEY="xxxxx"

参考：https://developers.themoviedb.org/3/getting-started/authentication

可重用组件

项目无关的可重用组件放在了单独的module里面：

通用功能

  • Observables：支持观察者的注册、注销以及事件通知的分发，通过弱引用以避免内存泄露。
  • ObjectStore以及ModelObjectStore：线程安全的对象池，保证一个key只对应一个对象。

数据绑定支持

UI层

  • DynamicGridView：根据预先设置的单元格宽度，能够自动调整列数的（基于RecyclerView的）GridView。 元素之间的间隙自动调整以便均匀分布，列表头部分则可不留间隙占据所有宽度。
  • FixedAspectRatioImage：保持预先（通过属性）设置的高宽比的AppCompatImageView。
  • ImageLoader：图片加载器（使用Glide）。可根据需要在图片宽度确定后再加载图片。
  • AutoHideWhenScrollDownBehavior：CoordinatorLayout的behavior，可让目标控件（如BottomNavigationView）在窗口向下滑动的时候自动隐藏。

外部依赖：Libraries/Frameworks/Widgets

本项目中展示了如何使用下列常用库、框架以及控件：

代码质量

为保证代码质量，本项目使用了我的另一个项目（作为submodule）：

注意事项

APK签名的设置来自项目的gradle.properties文件。如果你想用自己的签名，需要加入下列属性值：

# signingConfigs for release build
RELEASE_STORE_FILE=xxx.xxx
RELEASE_STORE_PASSWORD=xxx
RELEASE_KEY_ALIAS=xxx
RELEASE_KEY_PASSWORD=xxx

License

Copyright (C) 2018, Brian He

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.