1 Star 1 Fork 0

御承扬 / PlayAndroid

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

PlayAndroid

整体介绍

本项目为 Android 开发实践项目,编程难度为中下,适合学习完 Android 基础后的新手进行完整项目的开发体验。 本项目使用的 SDK 版本为 34 即 Android 14.0,以 Kotlin 为开发语言, 采用结合了链式调用和函数式声明的 Jetpack Compose UI 框架,并采用时下流行的 MVVM(Model-View-ViewModel)设计模式。

本项目实现的功能为从指定网站上加载数据,并在指定页面中进行呈现。因为数据是动态加载的, 故而本项目的许多页面不支持在 Android Studio 中进行预览, 需要部署到真机或模拟器中才能观察,因此,建议调试本项目的初学者, 先准备好一台 SDK 版本不低于 24 即 Android 7 的手机或模拟器。

项目结构说明

1、整体结构

alt 项目目录结构 本项目的整体目录结构如上所示, 项目的全部代码主要存放于 app/src/main/java 中,而所使用到的图片等资源文件则存放在 app/src/main/res 中, 而 app/src/main/AndroidManifest.xml 中主要设置应用相关的信息。

对于AndroidManifest.xml, 如果你选择自己手动抄写,一定不要漏了关键的两项, 即申请网络权限的 <uses-permission android:name="android.permission.INTERNET" />, 和 Application 标签中的 android:name=".App"。漏了第一项,会导致应用无法联网而不能正常运行;漏了第二项会导致 dataSources 没有被初始化,进而导致应用奔溃。

对于 res 目录下的东西,可以随着代码的编写逐项添加,也可以换成你自己喜欢的图标资源。

对于 java 目录下的代码文件,原则上,建议逐行编写,这样才是完整的 Android 应用开发体验。

2、com.pyc.playandroid 目录说明

java 目录下的结构,如下图所示:

alt java目录的结构

有四个子目录和四个 Kotlin 脚本。先对四个 Kotlin 脚本进行说明:

  • MainActivity:设置起始页的应用入口文件
  • App: 对 dataSources 进行初始化
  • Nav:实现应用底部导航栏并注册页面路由,由 MainActivity 的 onCreate 方法进行载入
  • Play:是一个获取登录状态的接口

而四个目录分别为 controllerdatalogicui,下面一一说明:

2.1、controller 目录

该目录下面,只有一个 PlayActions 类,供全局调用,实现文章详情页的加载。

2.2、data 目录

该目录的内容稍多,如下所示: alt data目录详情

该目录下的内容都是一些数据类,即 Kotlin 中的 data class,对应着 MVVM 中的第一个 M 即 Model, 而之所以都以 Bean 结尾,是因为我习惯了 Java 的命名习惯,你可以按照自己的习惯进行改名。 每个数据类的详情,还请浏览对应的源码,这里不过多展开。

2.3、logic 目录

alt logic 目录详情

logic 目录的详情如上图所示,一共有 5 个子目录:

  • network:实现网络请求,加载文章数据
  • repository:充当数据中间层,向外提供数据访问接口,实现数据与视图的解耦
  • state:存放状态类,状态用于控制视图页面的渲染行为
  • utils:工具集,存放提供必要辅助功能的工具类
  • viewModel: 存放一个个具体的 ViewModel

在本项目中,network 中的相关实现,充当了数据源的作用,因此,建议你直接复制代码,避免手敲出错导致文章数据加载失败。

2.4、ui 目录

该目录存放的是视图层的实现代码,即用户直接看到的应用页面的实现,其结构详情如下:

alt ui 目录详情

如上所示,共有 4 个子目录:

  • main:实现起始页的视图
  • page:实现各个具体的应用页面
  • theme:存放应用主题相关的代码,如颜色、形状等
  • view:实现可复用的页面组件,如 topAppBar

如果,你所计划从事的是 Android UI 相关的岗位,那么整个 ui 目录下的代码,都应该手动敲一遍, 在敲的过程中积累应用页面的布局经验、交互经验等等;反之,如果你想从事 Android 应用后台相关的岗位, 那么前面的 logic 目录中的代码就应该仔细地手敲。

ui 中的四个目录,需要继续展开详细说明的为 page 目录,下面便就此展开说明:

page 目录

首先,看一下这个承担着用户直接看到的页面的实现的 page 目录下,都有什么内容:

alt page 目录详情

如上所示,page 下有 6 个子目录:

  • article:存放文章详情页面的相关实现代码
  • home:存放应用首页的相关实现代码
  • login:存放登录页面的相关实现代码
  • mine:存放“我的”页面的相关实现代码
  • official:存放 official 页面的相关实现代码
  • project:存放 Project 页面的相关实现代码

而更详细的信息,还请浏览具体的源码文件,下面只针对页面的加载顺序进行说明:

3、应用页面加载顺序说明

受 Nav.kt 的控制,应用一开始会先装载 ui/main/MainPage,而该 MainPage 会加载一个有着四个 Tab 项的底部导航栏, 该底部导航栏实现 Home 页、Project 页、Official 页和 Mine 页的跳转,而 Home 页是应用一打开就加载进来的。

在 Homepage 中,从上到下依次加载页面标题、滚动播放的 banner 和支持上下滑动与打开动作的文章列表, 这些文章列表由 ArticleListPaging 实现,而通过点击文章列表项进入的文章详情页,则是由 ArticlePage 加载。

单击 MainPage 加载的底部导航栏的 Project 项,就会进入 Project 页面,该页面由 ProjectPage(即ArticleListPage) 加载

ProjectPage 和 OfficialPage 实际上和 ArticleListPage 的完全一样,只不过使用的数据不同。因而,在手机上运行时, ProjectPage 和 OfficialPage 的页面布局是相互一致的,从上到下依次为页面标题、可左右滑动的 TopBar 与显示有图片 和文章标题和文章来源信息的文章列表,而列表项都是支持打开动作的。

单击 MainPage 加载的底部导航栏的 Mine 项,就会进入 "我的"页,该页面由位于 MinePage.kt 中的 ProfilePage 加载,

ProfilePage 从上到下依次加载越三分之一屏幕宽的图片、一个指示登录状态的文本和前往登录页的按钮, 以及一个可以跳转到相关博客平台作者主页的列表项,这里的博客地址,可以在 UserInfoFields.kt 中进行修改。

编码指导

本项目虽然不复杂,但也不简单,诸多文件中有的是被调用的,有的是调用别的,所以,如果没有给一个编码顺序的说明, 就会出现某个源码文件编写到一半只能加个 TODO 标志后,转而去编写所依赖的代码文件,体验不是很好。

根据上面介绍的目录结构,我建议你首先去编写 data 中的代码,因为 data 中存放的都是 data class,没有依赖他人。

接着编写 logic 目录中的代码,而其中又以先编写 utils 中的代码为最推荐的顺序,其次是编写 logic/state 中的代码并以 TextFieldState 为最先,而 repository 目录下的代码依赖 network 目录下的代码,因此, network 必须先于 repository 完成。 logic 中 viewModel 中的代码,放在整个 logic 的最后。

这时候,可以回过头来将 controller 中的 PlayAction 写好,之后便可以开始编写 ui 目录下的代码。在 ui 目录中, view 目录下面的代码拥有最高的编写优先级,因为里面存放了可以复用的代码,接着 theme 目录(建议直接拷贝), 然后是 page 目录中的代码。

page 目录下,以子目录为划分,先编写哪一个都可以,只是在具体的子目录中, 避开先编写 ProjectPage、OfficialPage、MinePage、Login、HomePage ArticlePage 和 ArticleListPage, 因为这些文件中的代码都依赖了其他文件中的代码。

整体上的编码顺序,就是上面所描述的,而更具体的,还请通过阅读代码进行确定,总而言之,建议开始编写第一行代码之前, 先看一下后面的代码有无未实现的依赖,若有就应该放弃先写。

使用说明

将本项目的所有文件下载到本地后,若想直接体验一番的,可以用 Android Studio 打开。 Android Studio 中的 Gradle 会根据项目中的 gradle 脚本进行编译和下载相关依赖包,无需过多操作。待编译完成之后,执行找一个符合本项目最低 Android SDK 版本要求的物理机或模拟器,便能够部署和运行应用。

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

项目化的安卓开发体验,采用 Jetpack Compose 进行开发,适合初学者进行学习和体验 展开 收起
Kotlin
MulanPSL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/pengyoucongcode/PlayAndroid.git
git@gitee.com:pengyoucongcode/PlayAndroid.git
pengyoucongcode
PlayAndroid
PlayAndroid
master

搜索帮助