fragmject

Project Url: miaowmiaow/fragmject
Introduction: 适合初学者入门的项目,通过对 Kotlin 的系统运用,实现的一个功能完备符合主流市场标准 App。包含知识点(MVVM 开发架构、单 Activity 多 Fragment 项目设计、暗夜模式、屏幕录制、图片编辑、字节码插桩)。项目结构清晰,代码简洁优雅。
More: Author   ReportBugs   
Tags:

学习Kotlin有一段时间了,想写一个项目总结收获,就有了这个可能是东半球最简洁的玩安卓客户端,在此感谢玩 Android 的开放 API。

简介

适合初学者入门的项目,通过对 Kotlin 的系统运用,实现的一个功能完备符合主流市场标准 App。
虽然本项目的定位是入门级,但是该有的知识点却一点不少,对理解其他项目设计思想和封装技巧也很有帮助。
学习本项目你将有如下收获:

  • Kotlin 实战(函数进阶,泛型,反射,协程...)
  • MVVM 开发架构(ViewBinding,ViewModel,LiveData,RoomDatabase...)
  • 单 Activity 多 Fragment 项目设计
  • 暗夜模式
  • 屏幕录制
  • 图片编辑
  • 字节码插桩

    截图展示

    | 1.jpg | 2.jpg | 3.jpg | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | 4.gif | 5.gif | 6.gif |

    项目目录结构

    ├── app                                  app
    |   └── src 
    |       └── main 
    |       |   └── java                     源码目录
    |       |       ├── activity             Activity 目录
    |       |       |   └── MainActivity     项目唯一 Activity
    |       |       ├── adapter              Adapter 目录
    |       |       ├── fragment             Fragment 目录
    |       |       ├── model                ViewModel 目录
    |       |       └── App                  Application
    |       | 
    |       └── build.gradle                 模块构建配置
    |       └── channel                      渠道配置文件
    |       └── dictionary                   自定义混淆字典
    |       └── proguard-rules.pro           代码混淆配置文件
    | 
    ├── library-base                         基础 library(存放通用的封装源码)
    |   └── src 
    |       └── main 
    |       |   ├── assets                   原生文件目录
    |       |   └── java                     源码目录
    |       |       ├── bus                  消息总线目录
    |       |       ├── dialog               Dialog 目录
    |       |       ├── http                 网络请求目录
    |       |       ├── provider             ContentProvider 目录
    |       |       ├── utils                工具类目录
    |       |       └── view                 自定义 view 目录
    |       | 
    |       └── build.gradle                 模块构建配置
    | 
    ├── library-common                       公共 library(存放各个 module 公共的源码及资源)
    |   └── src 
    |       └── main 
    |       |   └── java                     源码目录
    |       |       ├── bean                 实体类目录
    |       |       └── constant             常量配置目录
    |       | 
    |       └── build.gradle                 模块构建配置
    | 
    ├── miaow-picture                        图片编辑器(目录同 app,不再展开)
    ├── module-faq                           问答模块(目录同 app,不再展开)
    ├── module-home                          首页模块(目录同 app,不再展开)
    ├── module-navigation                    导航模块(目录同 app,不再展开)
    ├── module-project                       项目模块(目录同 app,不再展开)
    ├── module-system                        体系模块(目录同 app,不再展开)
    ├── module-user                          用户模块(目录同 app,不再展开)
    | 
    ├── plugin-statistic                     统计插件模块
    |   └── src 
    |       └── main 
    |           └── groovy                   源码目录
    |           |   ├── bp                   埋点统计目录
    |           |   └── mt                   耗时统计目录
    |           | 
    |           └── resources                配置目录
    |               └── statistic.properties 插件配置
    | 
    ├── repos                                统计插件生成目录
    |
    ├── build.gradle                         项目构建配置
    ├── config.gradle                        gradle 编译文件 gradle 依赖配置
    ├── config.properties                    项目配置
    ├── gradle.properties                    gradle 配置
    └── settings.gradle                      项目依赖配置
    

    ViewBinding

    通过视图绑定功能,您可以更轻松地编写可与视图交互的代码。在模块中启用视图绑定之后,系统会为该模块中的每个 XML 布局文件生成一个绑定类。绑定类的实例包含对在相应布局中具有 ID 的所有视图的直接引用。 与使用 findViewById 相比,视图绑定具有 Null 安全,类型安全等很显著的优点。
  • 轻松使用 ViewBinding

    LiveData

    LiveData 是一种可观察的数据存储器类,它具有生命周期感知能力,意指它遵循其他应用组件(如 Activity、Fragment 或 Service)的生命周期。 LiveData 的优势:不会发生内存泄漏,不会因 Activity 停止而导致崩溃,不再需要手动处理生命周期,数据始终保持最新状态,适当的配置更改,共享资源。
  • 轻松使用 LiveData

    ViewModel

    ViewModel 类旨在以注重生命周期的方式存储和管理界面相关的数据。ViewModel 类让数据可在发生屏幕旋转等配置更改后继续留存。
  • 轻松使用 ViewModel

    协程

    协程是一种并发设计模式,您可以使用它来简化异步执行的代码。 协程的特点包括:轻量,内存泄漏更少,内置取消支持,Jetpack 集成。
  • 轻松使用协程

    Fragment + LiveData + ViewModel + 协程

    以项目中 MainFragment 为例: ``` class MainViewModel : ViewModel() {

    val hotKeyResult = MutableLiveData()

    // 获取热词接口 fun getHotKey() {

      // 通过 viewModelScope 创建一个协程
      viewModelScope.launch {
          // 构建请求体,传入请求参数
          val request = HttpRequest("hotkey/json")
          // 以 get 方式发起网络请求
          val response = get<HotKeyListBean>(request)
          // 通过 LiveData 更新数据
          hotKeyResult.postValue(response)
      }
    

    }

}

```
class MainFragment : Fragment() {

    // 使用 'by viewModels()' Kotlin 属性委托获取 MainViewModel
    private val viewModel: MainViewModel by viewModels()
    private val hotKeyAdapter = HotKeyAdapter()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        // 观察 hotKeyResult 的变化来更新 UI
        viewModel.hotKeyResult.observe(viewLifecycleOwner, { result ->
            result.data?.apply {
                if (result.errorCode == "0") {
                    hotKeyAdapter.setNewData(this)
                }
            }
        })
        // 调用获取热词接口
        viewModel.getHotKey()
    }

}

基于 LiveData 封装的消息总线 LiveDataBus

LiveDataBus 具有生命周期感知,调用者不需要调用反注册,并且没有内存泄漏风险。

    1、发送事件
    LiveDataBus.with<String>("key").postEvent("value")

    2、接收事件
    LiveDataBus.with<String>("key").observe(viewLifecycleOwner, { it ->
        println(it)
    })

    3、接收粘滞事件
    LiveDataBus.with<String>("key").observeSticky(viewLifecycleOwner, { it ->
        println(it)
    })

基于 RoomDatabase 封装的 DBHelper

通过键值对的方式来存储数据,不用再去关心 RoomDatabase 的复杂操作。

    1、存储数据
    DBHelper.set(“key”, "value")

    2、获取数据

     DBHelper.get(“key”)

动态权限申请

如果觉得PictureEditorDialog不能满足需求,还可以通过PictureEditorView来自定义样式

自定义使用

<com.example.miaow.picture.editor.PictureEditorView
    android:id="@+id/pic_editor"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />
picEditor.setBitmapPath(path)
picEditor.setMode(PictureEditorView.Mode.STICKER)
picEditor.setGraffitiColor(Color.parseColor("#ffffff"))
picEditor.setSticker(StickerAttrs(bitmap))
picEditor.graffitiUndo()
picEditor.mosaicUndo()
picEditor.saveBitmap()

如上所示:

  1. 通过setBitmapPath(path)传入图片路径
  2. 通过setMode(mode)设置编辑模式,分别有:涂鸦,橡皮擦,马赛克,贴纸
  3. 通过setGraffitiColor(color)设置涂鸦画笔颜色
  4. 通过`setSticker(StickerAttrs(bitmap))设置贴纸
  5. 通过graffitiUndo()涂鸦撤销
  6. 通过mosaicUndo()马赛克撤销
  7. 通过saveBitmap()保存编辑图片

PictureEditorView就介绍到这里,具体使用请查看PictureEditorDialog

图片裁剪

<com.example.miaow.picture.editor.PictureClipView
    android:id="@+id/clip"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />
clip.setBitmapResource(bitmap)
clip.rotate()
clip.reset()
clip.saveBitmap()

如上所示:

  1. 通过setBitmapResource(bitmap)传入裁剪图片
  2. 通过clip.rotate()图片旋转
  3. 通过clip.reset()图片重置
  4. 通过clip.saveBitmap()保存裁剪框内图片

PictureClipView就介绍到这里,具体使用请查看PictureClipDialog

讲在最后,如无法加载图片,请确认存储权限

主要开源框架

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

https://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. ```

Apps
About Me
GitHub: Trinea
Facebook: Dev Tools