├── .circleci
└── config.yml
├── .editorconfig
├── .github
└── workflows
│ ├── build.yml
│ ├── docs.yml
│ └── issues-stale.yml
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── app
├── .gitignore
├── build.gradle.kts
├── proguard-rules.pro
├── release
│ ├── app-release.apk
│ └── output-metadata.json
└── src
│ ├── androidTest
│ └── java
│ │ └── com
│ │ └── king
│ │ └── mvvmframe
│ │ └── ExampleInstrumentedTest.kt
│ ├── main
│ ├── AndroidManifest.xml
│ ├── ic_launcher-web.png
│ ├── java
│ │ └── com
│ │ │ └── king
│ │ │ └── mvvmframe
│ │ │ ├── App.kt
│ │ │ ├── app
│ │ │ ├── MainActivity.kt
│ │ │ ├── adapter
│ │ │ │ ├── BindingAdapter.kt
│ │ │ │ ├── BindingHolder.kt
│ │ │ │ └── SearchHistoryAdapter.kt
│ │ │ ├── base
│ │ │ │ └── BaseViewModel.kt
│ │ │ ├── city
│ │ │ │ ├── CityActivity.kt
│ │ │ │ └── CityViewModel.kt
│ │ │ ├── dictionary
│ │ │ │ ├── DictionaryActivity.kt
│ │ │ │ └── DictionaryViewModel.kt
│ │ │ └── oil
│ │ │ │ ├── OilPriceActivity.kt
│ │ │ │ └── OilPriceViewModel.kt
│ │ │ ├── config
│ │ │ └── AppConfigModule.kt
│ │ │ ├── constant
│ │ │ └── Constants.kt
│ │ │ ├── data
│ │ │ ├── database
│ │ │ │ ├── AppDatabase.kt
│ │ │ │ └── dao
│ │ │ │ │ └── SearchHistoryDao.kt
│ │ │ ├── model
│ │ │ │ ├── City.kt
│ │ │ │ ├── DictionaryInfo.java
│ │ │ │ ├── OilPrice.kt
│ │ │ │ ├── Result.kt
│ │ │ │ └── SearchHistory.kt
│ │ │ ├── repository
│ │ │ │ ├── CityRepository.kt
│ │ │ │ ├── DictionaryRepository.kt
│ │ │ │ └── OilPriceRepository.kt
│ │ │ └── service
│ │ │ │ ├── CityService.kt
│ │ │ │ ├── DictionaryService.kt
│ │ │ │ └── OilPriceService.kt
│ │ │ └── util
│ │ │ └── RandomUtil.kt
│ └── res
│ │ ├── drawable-v24
│ │ └── ic_launcher_foreground.xml
│ │ ├── drawable-xxhdpi
│ │ ├── btn_delete_normal.png
│ │ └── btn_delete_pressed.png
│ │ ├── drawable
│ │ ├── btn_delete_selector.xml
│ │ ├── dialog_bg.xml
│ │ ├── ic_launcher_background.xml
│ │ ├── list_divider.xml
│ │ ├── list_divider_8.xml
│ │ ├── tag_bg_normal.xml
│ │ ├── tag_bg_pressed.xml
│ │ └── tag_bg_selector.xml
│ │ ├── layout
│ │ ├── city_activity.xml
│ │ ├── dictionary_activity.xml
│ │ ├── main_activity.xml
│ │ ├── oil_price_activity.xml
│ │ ├── rv_city_item.xml
│ │ ├── rv_dictionary_item.xml
│ │ ├── rv_oil_price_item.xml
│ │ └── search_history_item.xml
│ │ ├── menu
│ │ └── search_view_menu.xml
│ │ ├── mipmap-anydpi-v26
│ │ ├── ic_launcher.xml
│ │ └── ic_launcher_round.xml
│ │ ├── mipmap-hdpi
│ │ ├── ic_launcher.png
│ │ ├── ic_launcher_foreground.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-mdpi
│ │ ├── ic_launcher.png
│ │ ├── ic_launcher_foreground.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xhdpi
│ │ ├── ic_launcher.png
│ │ ├── ic_launcher_foreground.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxhdpi
│ │ ├── ic_launcher.png
│ │ ├── ic_launcher_foreground.png
│ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxxhdpi
│ │ ├── ic_launcher.png
│ │ ├── ic_launcher_foreground.png
│ │ └── ic_launcher_round.png
│ │ ├── values
│ │ ├── colors.xml
│ │ ├── ic_launcher_background.xml
│ │ ├── strings.xml
│ │ └── styles.xml
│ │ └── xml
│ │ └── network_security_config.xml
│ └── test
│ └── java
│ └── com
│ └── king
│ └── mvvmframe
│ └── ExampleUnitTest.kt
├── art
└── mvvm_architecture.jpg
├── build.gradle.kts
├── build_docs.sh
├── gradle.properties
├── gradle
├── libs.versions.toml
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── jitpack.yml
├── mkdocs.yml
├── mvvmframe-plugin
├── .gitignore
├── build.gradle.kts
├── gradle.properties
└── src
│ └── main
│ └── java
│ └── com
│ └── king
│ └── frame
│ └── mvvmframe
│ └── plugin
│ ├── MvvmFrameExtension.kt
│ ├── MvvmFramePlugin.kt
│ └── internal
│ ├── DependencyExt.kt
│ ├── PluginId.kt
│ └── Version.kt
├── mvvmframe
├── .gitignore
├── build.gradle.kts
├── gradle.properties
├── proguard-rules.pro
└── src
│ ├── androidTest
│ └── java
│ │ └── com
│ │ └── king
│ │ └── frame
│ │ └── mvvm
│ │ └── ExampleInstrumentedTest.kt
│ ├── main
│ ├── AndroidManifest.xml
│ ├── java
│ │ └── com
│ │ │ └── king
│ │ │ └── frame
│ │ │ └── mvvmframe
│ │ │ ├── base
│ │ │ ├── BaseActivity.kt
│ │ │ ├── BaseAndroidViewModel.kt
│ │ │ ├── BaseApplication.kt
│ │ │ ├── BaseDialogFragment.kt
│ │ │ ├── BaseFragment.kt
│ │ │ ├── BaseProgressDialog.kt
│ │ │ ├── BaseViewModel.kt
│ │ │ ├── ContentActivity.kt
│ │ │ ├── Ext.kt
│ │ │ ├── IView.kt
│ │ │ └── controller
│ │ │ │ ├── CombinedController.kt
│ │ │ │ ├── Controller.kt
│ │ │ │ ├── DefaultCombinedController.kt
│ │ │ │ ├── DefaultDialogController.kt
│ │ │ │ ├── DefaultLoadingController.kt
│ │ │ │ ├── DefaultToastController.kt
│ │ │ │ ├── DialogController.kt
│ │ │ │ ├── LoadingController.kt
│ │ │ │ └── ToastController.kt
│ │ │ ├── config
│ │ │ ├── AppliesOptions.kt
│ │ │ ├── Config.kt
│ │ │ ├── FrameConfigModule.kt
│ │ │ └── ManifestParser.kt
│ │ │ ├── data
│ │ │ ├── DataRepository.kt
│ │ │ ├── Repository.kt
│ │ │ └── datasource
│ │ │ │ ├── DataSource.kt
│ │ │ │ └── DefaultDataSource.kt
│ │ │ ├── di
│ │ │ └── module
│ │ │ │ ├── ConfigModule.kt
│ │ │ │ ├── DataSourceModule.kt
│ │ │ │ ├── HttpModule.kt
│ │ │ │ └── RepositoryModule.kt
│ │ │ └── util
│ │ │ └── JumpDebounce.kt
│ └── res
│ │ ├── anim
│ │ ├── mvvmframe_dialog_in.xml
│ │ └── mvvmframe_dialog_out.xml
│ │ ├── drawable
│ │ ├── mvvmframe_loading.xml
│ │ └── mvvmframe_progress.xml
│ │ ├── layout
│ │ ├── mvvmframe_content_activity.xml
│ │ ├── mvvmframe_loading.xml
│ │ └── mvvmframe_progress_dialog.xml
│ │ └── values
│ │ ├── colors.xml
│ │ └── styles.xml
│ └── test
│ └── java
│ └── com
│ └── king
│ └── frame
│ └── mvvm
│ └── ExampleUnitTest.kt
└── settings.gradle.kts
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | version: 2.1
2 |
3 | orbs:
4 | android: circleci/android@2.4.0
5 |
6 | jobs:
7 | build:
8 | docker:
9 | - image: cimg/android:2023.08
10 | steps:
11 | - checkout
12 | - run:
13 | command: ./gradlew build
14 |
15 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | indent_style = space
5 | indent_size = 4
6 | charset = utf-8
7 | trim_trailing_whitespace = true
8 | insert_final_newline = true
9 |
10 | [*.{yml,yaml}]
11 | indent_size = 2
12 |
13 | [*.{kt, kts}]
14 | ij_kotlin_imports_layout = *
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: build
2 |
3 | on:
4 | push:
5 | branches: [ master ]
6 | pull_request:
7 | branches: [ master ]
8 |
9 | env:
10 | JAVA_VERSION: 17
11 |
12 | jobs:
13 | build:
14 | runs-on: ubuntu-latest
15 |
16 | steps:
17 | - name: Checkout
18 | uses: actions/checkout@v4
19 | with:
20 | fetch-depth: 0
21 |
22 | - name: Configure JDK
23 | uses: actions/setup-java@v4
24 | with:
25 | distribution: 'zulu'
26 | java-version: ${{ env.JAVA_VERSION }}
27 | - name: Build with Gradle
28 | run: ./gradlew build
29 |
--------------------------------------------------------------------------------
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
1 | name: docs
2 |
3 | on:
4 | push:
5 | branches:
6 | - master
7 |
8 | env:
9 | JAVA_VERSION: 17
10 | PYTHON_VERSION: 3.x
11 | GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"
12 |
13 | permissions:
14 | contents: write
15 | id-token: write
16 | pages: write
17 |
18 | jobs:
19 | docs:
20 | environment:
21 | name: github-pages
22 | url: ${{ steps.deployment.outputs.page_url }}
23 | runs-on: ubuntu-latest
24 | if: github.ref == 'refs/heads/master'
25 |
26 | steps:
27 | - name: Checkout
28 | uses: actions/checkout@v4
29 | with:
30 | fetch-depth: 0
31 |
32 | - name: Configure JDK
33 | uses: actions/setup-java@v4
34 | with:
35 | distribution: 'zulu'
36 | java-version: ${{ env.JAVA_VERSION }}
37 |
38 | - name: Install Python
39 | uses: actions/setup-python@v5
40 | with:
41 | python-version: ${{ env.PYTHON_VERSION }}
42 |
43 | - name: Install MkDocs Material
44 | run: pip install mkdocs-material
45 |
46 | - name: Generate Docs
47 | run: ./build_docs.sh
48 |
49 | - name: Upload to GitHub Pages
50 | uses: actions/upload-pages-artifact@v3
51 | with:
52 | path: site
53 |
54 | - name: Deploy to GitHub Pages
55 | id: deployment
56 | uses: actions/deploy-pages@v4
57 |
--------------------------------------------------------------------------------
/.github/workflows/issues-stale.yml:
--------------------------------------------------------------------------------
1 | name: 'Close stale issues and PRs'
2 | on:
3 | schedule:
4 | - cron: '0 16 * * *'
5 |
6 | jobs:
7 | stale:
8 | runs-on: ubuntu-latest
9 | permissions:
10 | issues: write
11 | pull-requests: write
12 | steps:
13 | - uses: actions/stale@v5
14 | with:
15 | stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
16 | days-before-stale: 30
17 | days-before-close: 5
18 | exempt-all-pr-milestones: true
19 | exempt-issue-labels: 'help wanted'
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /local.properties
4 | /.idea
5 | .DS_Store
6 | /build
7 | /captures
8 | .externalNativeBuild
9 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: android
2 | dist: trusty
3 | jdk: oraclejdk8
4 | sudo: false
5 |
6 | env:
7 | global:
8 | - ANDROID_API_LEVEL=30
9 | - ANDROID_BUILD_TOOLS_VERSION=30.0.3
10 | - TRAVIS_SECURE_ENV_VARS=true
11 |
12 | before_install:
13 | - chmod +x gradlew
14 | - mkdir "$ANDROID_HOME/licenses" || true
15 | # Hack to accept Android licenses
16 | - yes | sdkmanager "platforms;android-$ANDROID_API_LEVEL"
17 |
18 |
19 | android:
20 | components:
21 | # The BuildTools version used by your project
22 | - tools
23 | - platform-tools
24 | - build-tools-$ANDROID_BUILD_TOOLS_VERSION
25 | # The SDK version used to compile your project
26 | - android-$ANDROID_API_LEVEL
27 | - extra-android-m2repository
28 | - extra-google-android-support
29 |
30 | script:
31 | - ./gradlew clean
32 | - ./gradlew assembleRelease
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | ## 版本日志
2 |
3 | #### v3.1.0：2025-3-23
4 | * 优化插件配置
5 | * 优化一些细节
6 | * 更新gradle至v8.9
7 | * 更新kotlin至v1.9.24
8 | * 更新appcompat至v1.7.0
9 | * 更新core-ktx至v1.13.1
10 | * 更新fragment-ktx至v1.8.6
11 | * 更新lifecycle-ktx至v2.8.7
12 | * 更新hilt至v2.52
13 | * 更新retrofit至v2.11.0
14 | * 更新gson至v2.12.1
15 |
16 | #### v3.0.0：2024-3-3
17 | * 统一改为使用`kotlin`进行了重构
18 | * 移除所有`LiveData`相关代码改用`Flow`
19 | * 支持插件配置
20 | * 更新编译SDK至34
21 | * 更新Gradle至v8.0
22 | * 新增core-ktx依赖（v1.12.0）
23 | * 新增fragment-ktx依赖（v1.6.2）
24 | * 新增lifecycle-ktx相关依赖（v2.7.0）
25 | * 更新Okhttp至v4.12.0
26 | * 更新Hilt至v2.51
27 | * 更新Gson至v2.10.1
28 | * 更新Room至v2.6.1
29 | * 更新retrofit-helper至v1.1.0
30 |
31 | #### v2.2.1：2022-4-21
32 | * 更新Okhttp至v4.9.3
33 | * 更新Hilt至v2.41
34 | * 更新Gson至v2.9.0
35 |
36 | #### v2.2.0：2021-11-18
37 | * minSdk要求从 16+ 改为 21+
38 | * 更新编译SDK至30
39 | * 更新Gradle至v6.7.1
40 | * 更新Okhttp至v4.9.2
41 | * 更新Hilt至v2.40.1
42 | * 更新Gson至v2.8.9
43 | * 更新Timber至v5.0.1
44 |
45 | #### v2.1.1：2021-6-29
46 | * 更新Hilt至v2.37
47 | * 更新Gson至v2.8.7
48 | * 优化细节
49 |
50 | #### v2.1.0：2021-4-28 (从v2.1.0开始不再发布至JCenter)
51 | * 更新Hilt至v2.35
52 | * 移除androidx.hilt:hilt-lifecycle-viewmodel [移除原因请查看Dagger v2.34更新说明](https://github.com/google/dagger/releases)
53 | * 更新Lifecycle至v2.3.1
54 | * 更新Room至v2.3.0
55 | * 更新RetrofitHelper至v1.0.1
56 | * 发布至Maven Central
57 |
58 | #### v2.0.0：2021-1-15
59 | * 使用Hilt简化Dagger依赖注入用法
60 |
61 | #### v1.1.4：2020-12-14
62 | * 优化细节
63 | * 更新Dagger至v2.30.1
64 |
65 | #### v1.1.3：2020-6-1
66 | * 支持配置多个BaseUrl，且支持动态改变（详情查看 [RetrofitHelper](https://github.com/jenly1314/RetrofitHelper)）
67 | * 对外暴露更多配置，（详情查看 FrameConfigModule）
68 | * 优化细节
69 | * 更新Retrofit至v2.9.0
70 |
71 | #### v1.1.2：2020-4-5
72 | * 优化细节
73 | * 更新Gradle至v5.6.4
74 | * 更新Lifecycle至v2.2.0
75 | * 更新Room至v2.2.5
76 | * 更新Dagger至v2.27
77 | * 更新Retrofit至v2.8.1
78 |
79 | #### v1.1.1：2019-11-4
80 | * 优化部分细节
81 | * 更新编译SDK至29
82 | * 更新Gradle至v5.4.1
83 | * 更新Lifecycle至v2.2.0-rc01
84 | * 更新Room至v2.2.1
85 | * 更新Dagger至v2.25.2
86 | * 更新Retrofit至v2.6.2
87 | * 更新Gson至v2.8.6
88 |
89 | #### v1.1.0：2019-7-22
90 | * 更新Dagger至v2.23.2
91 | * 更新Gradle至v5.1.1
92 | * 完全迁移至AndroidX版本
93 |
94 | #### v1.0.2：2019-7-22
95 | * 更新Dagger至v2.19
96 | * 为迁移至AndroidX做准备（下一版本将直接发布AndroidX版）
97 |
98 | #### v1.0.1：2019-7-9
99 | * Retrofit更新至v2.6.0
100 |
101 | #### v1.0.0：2018-12-12
102 | * MVVMFrame初始版本
103 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2017 Jenly Yu
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.application)
3 | alias(libs.plugins.kotlin.android)
4 | alias(libs.plugins.kapt)
5 | alias(libs.plugins.ksp)
6 | alias(libs.plugins.mvvmframe)
7 | }
8 |
9 | android {
10 | namespace = "com.king.mvvmframe"
11 | compileSdk = libs.versions.compileSdk.get().toInt()
12 |
13 | defaultConfig {
14 |
15 | applicationId = "com.king.mvvmframe"
16 | minSdk = libs.versions.minSdk.get().toInt()
17 | targetSdk = libs.versions.targetSdk.get().toInt()
18 | versionCode = properties["VERSION_CODE"].toString().toInt()
19 | versionName = properties["VERSION_NAME"].toString()
20 |
21 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
22 |
23 | vectorDrawables {
24 | useSupportLibrary = true
25 | }
26 | }
27 |
28 | buildTypes {
29 | release {
30 | isMinifyEnabled = false
31 | proguardFiles(
32 | getDefaultProguardFile("proguard-android.txt"),
33 | "proguard-rules.pro"
34 | )
35 | }
36 | }
37 |
38 | buildFeatures{
39 | dataBinding = true
40 | buildConfig = true
41 | }
42 |
43 | compileOptions {
44 | sourceCompatibility = JavaVersion.VERSION_17
45 | targetCompatibility = JavaVersion.VERSION_17
46 | }
47 | kotlinOptions {
48 | jvmTarget = JavaVersion.VERSION_17.toString()
49 | }
50 | }
51 |
52 | dependencies {
53 |
54 | // test
55 | testImplementation(libs.junit)
56 | androidTestImplementation(libs.androidx.junit)
57 | androidTestImplementation(libs.androidx.espresso)
58 |
59 | implementation(libs.material)
60 | implementation(libs.androidx.appcompat)
61 | implementation(libs.swiperefreshlayout)
62 | implementation(libs.recyclerview)
63 | implementation(libs.constraintlayout)
64 |
65 | implementation(libs.base.util)
66 | implementation(libs.base.adapter)
67 |
68 | implementation(libs.android.ktx)
69 |
70 | implementation(libs.flowlayout)
71 |
72 | implementation(libs.logx)
73 |
74 | //leakCanary
75 | debugImplementation(libs.leakcanary)
76 |
77 | ksp(libs.room.compiler)
78 |
79 | // MVVMFrame
80 | implementation(project(":mvvmframe"))
81 |
82 | }
83 |
84 | mvvmFrame {
85 | //..
86 | }
87 |
88 | kapt {
89 | correctErrorTypes = true
90 | }
91 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.kts.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
22 |
--------------------------------------------------------------------------------
/app/release/app-release.apk:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/release/app-release.apk
--------------------------------------------------------------------------------
/app/release/output-metadata.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": 3,
3 | "artifactType": {
4 | "type": "APK",
5 | "kind": "Directory"
6 | },
7 | "applicationId": "com.king.mvvmframe",
8 | "variantName": "release",
9 | "elements": [
10 | {
11 | "type": "SINGLE",
12 | "filters": [],
13 | "attributes": [],
14 | "versionCode": 18,
15 | "versionName": "3.1.0",
16 | "outputFile": "app-release.apk"
17 | }
18 | ],
19 | "elementType": "File",
20 | "baselineProfiles": [
21 | {
22 | "minApi": 28,
23 | "maxApi": 30,
24 | "baselineProfiles": [
25 | "baselineProfiles/1/app-release.dm"
26 | ]
27 | },
28 | {
29 | "minApi": 31,
30 | "maxApi": 2147483647,
31 | "baselineProfiles": [
32 | "baselineProfiles/0/app-release.dm"
33 | ]
34 | }
35 | ],
36 | "minSdkVersionForDexing": 21
37 | }
38 |
--------------------------------------------------------------------------------
/app/src/androidTest/java/com/king/mvvmframe/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe
2 |
3 | import androidx.test.platform.app.InstrumentationRegistry
4 | import androidx.test.ext.junit.runners.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("com.king.mvvmframe", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
20 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
40 |
41 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/app/src/main/ic_launcher-web.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/ic_launcher-web.png
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/App.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe
2 |
3 | import com.king.frame.mvvmframe.base.BaseApplication
4 | import com.king.logx.LogX
5 | import com.king.mvvmframe.constant.Constants
6 | import com.king.retrofit.retrofithelper.RetrofitHelper
7 | import dagger.hilt.android.HiltAndroidApp
8 | import timber.log.Timber
9 |
10 | /**
11 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
12 | *
13 | * 你需要参照如下方式添加 @HiltAndroidApp 注解
14 | *
15 | * ```
16 | * // 示例
17 | * @HiltAndroidApp
18 | * class YourApplication : BaseApplication() {
19 | *
20 | * }
21 | * ```
22 | *
23 | * @author Jenly
24 | *
25 | * Follow me
26 | */
27 | @HiltAndroidApp
28 | class App : BaseApplication() {
29 |
30 |
31 | override fun onCreate() {
32 | super.onCreate()
33 | initLog()
34 | //------------------------------
35 | // 如果你没有使用FrameConfigModule中的第一中方式初始化BaseUrl，也可以通过第二种方式来设置BaseUrl（二选其一即可）
36 | // RetrofitHelper.getInstance().setBaseUrl(Constants.BASE_URL)
37 | // 设置动态BaseUrl
38 | RetrofitHelper.getInstance().apply {
39 | putDomain(Constants.DOMAIN_DICTIONARY, Constants.DICTIONARY_BASE_URL)
40 | putDomain(Constants.DOMAIN_JENLY, Constants.JENLY_BASE_URL)
41 | }
42 | }
43 |
44 | /**
45 | * 初始化
46 | */
47 | private fun initLog() {
48 | // 初始化日志打印
49 | Timber.plant(object : Timber.DebugTree() {
50 | override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
51 | LogX.offset(4).log(priority, message)
52 | }
53 | })
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app
2 |
3 | import android.os.Bundle
4 | import android.view.View
5 | import androidx.databinding.ViewDataBinding
6 | import com.king.android.ktx.activity.startActivity
7 | import com.king.frame.mvvmframe.base.BaseActivity
8 | import com.king.frame.mvvmframe.base.BaseViewModel
9 | import com.king.mvvmframe.R
10 | import com.king.mvvmframe.app.city.CityActivity
11 | import com.king.mvvmframe.app.dictionary.DictionaryActivity
12 | import com.king.mvvmframe.app.oil.OilPriceActivity
13 | import dagger.hilt.android.AndroidEntryPoint
14 |
15 | /**
16 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
17 | *
18 | * Hilt大幅简化了 Dagger2 的用法，使得我们不用通过 @Component 注解去编写桥接层的逻辑，但是也因此限定了注入功能只能从几个 Android 固定的入口点开始，
19 | * Hilt一共支持6个入口点，分别是：
20 | * Application
21 | * Activity
22 | * Fragment
23 | * View
24 | * Service
25 | * BroadcastReceiver
26 | *
27 | * 其中，只有Application这个入口点是使用@HiltAndroidApp注解来声明，示例如下
28 | *
29 | * Example: Application
30 | *
31 | * ```
32 | * @HiltAndroidApp
33 | * class YourApplication : Application() {
34 | *
35 | * }
36 | * ```
37 | * 其他的入口点，都是用@AndroidEntryPoint注解来声明，示例如下
38 | *
39 | * Example: Activity
40 | * ```
41 | * @AndroidEntryPoint
42 | * class YourActivity : BaseActivity() {
43 | *
44 | * }
45 | * ```
46 | * Example: Fragment
47 | * ```
48 | * @AndroidEntryPoint
49 | * class YourFragment : BaseFragment() {
50 | *
51 | * }
52 | * ```
53 | * 主要示例请查看 [OilPriceActivity] 和 [OilPriceViewModel]
54 | *
55 | * @author Jenly
56 | *
57 | * Follow me
58 | */
59 | @AndroidEntryPoint
60 | class MainActivity : BaseActivity() {
61 |
62 | override fun getLayoutId(): Int {
63 | return R.layout.main_activity
64 | }
65 |
66 | override fun isBinding(): Boolean {
67 | // 不覆写此方法时，默认返回true，这里返回false表示不使用DataBinding，因为当前界面比较简单，完全没有必要用
68 | return false
69 | }
70 |
71 | override fun initData(savedInstanceState: Bundle?) {
72 |
73 | }
74 |
75 | fun onClick(v: View) {
76 | when (v.id) {
77 | R.id.btn1 -> startActivity(OilPriceActivity::class.java)
78 | R.id.btn2 -> startActivity(DictionaryActivity::class.java)
79 | R.id.btn3 -> startActivity(CityActivity::class.java)
80 | }
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/adapter/BindingAdapter.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.adapter
2 |
3 | import android.annotation.SuppressLint
4 | import android.content.Context
5 | import androidx.databinding.ViewDataBinding
6 | import androidx.recyclerview.widget.DiffUtil
7 | import com.king.base.adapter.BaseRecyclerAdapter
8 | import com.king.mvvmframe.BR
9 |
10 | /**
11 | * @author Jenly
12 | *
13 | * Follow me
14 | */
15 | class BindingAdapter : BaseRecyclerAdapter> {
16 | constructor(context: Context, layoutId: Int) : super(context, layoutId)
17 | constructor(context: Context, listData: MutableList?, layoutId: Int) : super(
18 | context,
19 | listData,
20 | layoutId
21 | )
22 |
23 | override fun bindViewDatas(holder: BindingHolder, item: T, position: Int) {
24 | holder.binding?.also {
25 | it.setVariable(BR.data, item)
26 | it.executePendingBindings()
27 | }
28 | }
29 |
30 | fun getItem(position: Int): T? {
31 | return listData.getOrNull(position)
32 | }
33 |
34 | fun refreshData(list: List?) {
35 | val diffResult = DiffUtil.calculateDiff(ItemDiffCallback(listData, list.orEmpty()))
36 | if (list != null) {
37 | setListData(list)
38 | } else {
39 | listData.clear()
40 | }
41 | diffResult.dispatchUpdatesTo(this)
42 | }
43 |
44 | class ItemDiffCallback(
45 | private val oldList: List,
46 | private val newList: List,
47 | ) : DiffUtil.Callback() {
48 | override fun getOldListSize(): Int {
49 | return oldList.size
50 | }
51 |
52 | override fun getNewListSize(): Int {
53 | return newList.size
54 | }
55 |
56 | override fun areItemsTheSame(oldPosition: Int, newPosition: Int): Boolean {
57 | return oldList[oldPosition] == newList[newPosition]
58 | }
59 |
60 | override fun areContentsTheSame(oldPosition: Int, newPosition: Int): Boolean {
61 | return oldList[oldPosition] == newList[newPosition]
62 | }
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/adapter/BindingHolder.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.adapter
2 |
3 | import android.view.View
4 | import androidx.databinding.DataBindingUtil
5 | import androidx.databinding.ViewDataBinding
6 | import com.king.base.adapter.holder.ViewHolder
7 |
8 | /**
9 | * @author Jenly
10 | *
11 | * Follow me
12 | */
13 | class BindingHolder(convertView: View) : ViewHolder(convertView) {
14 |
15 | val binding by lazy {
16 | DataBindingUtil.bind(convertView)
17 | }
18 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/adapter/SearchHistoryAdapter.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.adapter
2 |
3 | import android.view.LayoutInflater
4 | import android.view.View
5 | import android.widget.TextView
6 | import com.king.mvvmframe.R
7 | import com.king.mvvmframe.constant.Constants
8 | import com.king.mvvmframe.data.model.SearchHistory
9 | import com.king.mvvmframe.util.RandomUtil.randomColor
10 | import com.zhy.view.flowlayout.FlowLayout
11 | import com.zhy.view.flowlayout.TagAdapter
12 |
13 | /**
14 | * @author Jenly
15 | *
16 | * Follow me
17 | */
18 | class SearchHistoryAdapter(list: MutableList) : TagAdapter(list) {
19 |
20 | override fun getView(parent: FlowLayout, position: Int, data: SearchHistory): View {
21 | val tv = LayoutInflater.from(parent.context)
22 | .inflate(R.layout.search_history_item, parent, false) as TextView
23 | tv.text = data.word
24 | tv.setTextColor(randomColor(Constants.COLOR_RGB_MIN, Constants.COLOR_RGB_MAX))
25 | return tv
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/base/BaseViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.base
2 |
3 | import android.app.Application
4 | import androidx.lifecycle.viewModelScope
5 | import com.king.base.util.SystemUtils
6 | import com.king.frame.mvvmframe.base.BaseAndroidViewModel
7 | import com.king.mvvmframe.data.model.Result
8 | import com.king.mvvmframe.R
9 | import dagger.hilt.android.lifecycle.HiltViewModel
10 | import kotlinx.coroutines.launch
11 | import timber.log.Timber
12 | import java.net.ConnectException
13 | import java.net.SocketTimeoutException
14 | import javax.inject.Inject
15 | import kotlin.coroutines.CoroutineContext
16 | import kotlin.coroutines.EmptyCoroutineContext
17 |
18 | /**
19 | * 基类
20 | *
21 | * @author Jenly
22 | *
23 | * Follow me
24 | */
25 | @HiltViewModel
26 | open class BaseViewModel @Inject constructor(application: Application) : BaseAndroidViewModel(application) {
27 |
28 | /**
29 | * 是否成功
30 | */
31 | fun isSuccess(result: Result<*>, showError: Boolean = true): Boolean {
32 | if (result.isSuccess()) {
33 | return true
34 | }
35 | if (showError) {
36 | sendMessage(result.message)
37 | }
38 | return false
39 | }
40 |
41 | /**
42 | * 启动一个协程
43 | */
44 | fun launch(
45 | showLoading: Boolean = true,
46 | context: CoroutineContext = EmptyCoroutineContext,
47 | error: suspend (Throwable) -> Unit = {
48 | Timber.w(it)
49 | if (SystemUtils.isNetWorkActive(getApplication())) {
50 | when (it) {
51 | is SocketTimeoutException -> sendMessage(R.string.result_connect_timeout_error)
52 | is ConnectException -> sendMessage(R.string.result_connect_failed_error)
53 | else -> sendMessage(R.string.result_error)
54 | }
55 | } else {
56 | sendMessage(R.string.result_network_unavailable_error)
57 | }
58 | },
59 | block: suspend () -> Unit,
60 | ) = viewModelScope.launch(context = context) {
61 | try {
62 | if (showLoading) {
63 | showLoading()
64 | }
65 | block()
66 | } catch (e: Throwable) {
67 | error(e)
68 | } finally {
69 | if (showLoading) {
70 | hideLoading()
71 | }
72 | }
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/city/CityActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.city
2 |
3 | import android.os.Bundle
4 | import androidx.lifecycle.flowWithLifecycle
5 | import androidx.lifecycle.lifecycleScope
6 | import androidx.recyclerview.widget.LinearLayoutManager
7 | import com.king.base.adapter.divider.DividerItemDecoration
8 | import com.king.frame.mvvmframe.base.BaseActivity
9 | import com.king.mvvmframe.R
10 | import com.king.mvvmframe.app.adapter.BindingAdapter
11 | import com.king.mvvmframe.data.model.City
12 | import com.king.mvvmframe.databinding.CityActivityBinding
13 | import dagger.hilt.android.AndroidEntryPoint
14 | import kotlinx.coroutines.launch
15 |
16 | /**
17 | * 示例
18 | *
19 | * @author Jenly
20 | *
21 | * Follow me
22 | */
23 | @AndroidEntryPoint
24 | class CityActivity : BaseActivity() {
25 |
26 | private val mAdapter by lazy {
27 | BindingAdapter(getContext(), R.layout.rv_city_item)
28 | }
29 |
30 | override fun getLayoutId(): Int {
31 | return R.layout.city_activity
32 | }
33 |
34 | override fun initData(savedInstanceState: Bundle?) {
35 | with(binding.recyclerView) {
36 | layoutManager = LinearLayoutManager(context)
37 | addItemDecoration(
38 | DividerItemDecoration(
39 | context,
40 | DividerItemDecoration.VERTICAL,
41 | R.drawable.list_divider_8
42 | )
43 | )
44 | adapter = mAdapter
45 | }
46 |
47 | mAdapter.setOnItemClickListener { _, position ->
48 | showToast(mAdapter.getItem(position)!!.name)
49 | }
50 |
51 | lifecycleScope.launch {
52 | viewModel.cityFlow.flowWithLifecycle(lifecycle).collect {
53 | mAdapter.refreshData(it)
54 | }
55 | }
56 |
57 | binding.srl.setOnRefreshListener {
58 | viewModel.getHotCities()
59 | }
60 |
61 | viewModel.getHotCities()
62 | }
63 |
64 | override fun showLoading() {
65 | if (!binding.srl.isRefreshing) {
66 | super.showLoading()
67 | }
68 | }
69 |
70 | override fun hideLoading() {
71 | super.hideLoading()
72 | binding.srl.isRefreshing = false
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/city/CityViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.city
2 |
3 | import android.app.Application
4 | import com.king.mvvmframe.app.base.BaseViewModel
5 | import com.king.mvvmframe.data.model.City
6 | import com.king.mvvmframe.data.repository.CityRepository
7 | import dagger.hilt.android.lifecycle.HiltViewModel
8 | import kotlinx.coroutines.flow.MutableStateFlow
9 | import kotlinx.coroutines.flow.asSharedFlow
10 | import javax.inject.Inject
11 |
12 | /**
13 | * 示例
14 | *
15 | * @author Jenly
16 | *
17 | * Follow me
18 | */
19 | @HiltViewModel
20 | class CityViewModel @Inject constructor(
21 | private val cityRepository: CityRepository,
22 | application: Application
23 | ) : BaseViewModel(application) {
24 |
25 | private val _cityFlow = MutableStateFlow>(emptyList())
26 | val cityFlow = _cityFlow.asSharedFlow()
27 |
28 | /**
29 | * 获取热门城市
30 | */
31 | fun getHotCities() {
32 | launch {
33 | cityRepository.getHotCities().also {
34 | _cityFlow.emit(it)
35 | }
36 | }
37 | }
38 |
39 | }
40 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/dictionary/DictionaryActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.dictionary
2 |
3 | import android.annotation.SuppressLint
4 | import android.os.Bundle
5 | import android.text.InputFilter
6 | import android.text.InputFilter.LengthFilter
7 | import android.view.Menu
8 | import android.view.View
9 | import androidx.appcompat.widget.SearchView
10 | import androidx.appcompat.widget.SearchView.SearchAutoComplete
11 | import androidx.lifecycle.flowWithLifecycle
12 | import androidx.lifecycle.lifecycleScope
13 | import androidx.recyclerview.widget.LinearLayoutManager
14 | import com.king.base.adapter.divider.DividerItemDecoration
15 | import com.king.base.util.StringUtils
16 | import com.king.frame.mvvmframe.base.BaseActivity
17 | import com.king.mvvmframe.R
18 | import com.king.mvvmframe.app.adapter.BindingAdapter
19 | import com.king.mvvmframe.app.adapter.SearchHistoryAdapter
20 | import com.king.mvvmframe.data.model.SearchHistory
21 | import com.king.mvvmframe.databinding.DictionaryActivityBinding
22 | import dagger.hilt.android.AndroidEntryPoint
23 | import kotlinx.coroutines.launch
24 |
25 | /**
26 | * 示例
27 | *
28 | * @author Jenly
29 | *
30 | * Follow me
31 | */
32 | @AndroidEntryPoint
33 | class DictionaryActivity : BaseActivity() {
34 |
35 | private var searchView: SearchView? = null
36 |
37 | private val mAdapter by lazy {
38 | BindingAdapter(getContext(), R.layout.rv_dictionary_item)
39 | }
40 |
41 | private val listHistory = mutableListOf()
42 |
43 | private val mSearchHistoryAdapter by lazy {
44 | SearchHistoryAdapter(listHistory)
45 | }
46 |
47 | private var word: String = ""
48 |
49 | override fun getLayoutId(): Int {
50 | return R.layout.dictionary_activity
51 | }
52 |
53 | override fun initData(savedInstanceState: Bundle?) {
54 | binding.recyclerView.layoutManager = LinearLayoutManager(getContext())
55 | binding.recyclerView.addItemDecoration(
56 | DividerItemDecoration(
57 | getContext(),
58 | DividerItemDecoration.VERTICAL
59 | )
60 | )
61 | binding.recyclerView.adapter = mAdapter
62 |
63 | binding.tflHistory.adapter = mSearchHistoryAdapter
64 |
65 | binding.tflHistory.setOnTagClickListener { _, position, _ ->
66 | search(mSearchHistoryAdapter.getItem(position).word)
67 | true
68 | }
69 |
70 | binding.srl.setOnRefreshListener {
71 | search(word)
72 | }
73 |
74 | lifecycleScope.launch {
75 | viewModel.dictionaryFlow.flowWithLifecycle(lifecycle).collect {
76 | mAdapter.refreshData(it?.xiangjie)
77 | }
78 | }
79 |
80 | lifecycleScope.launch {
81 | viewModel.getSearchHistoryFlow().flowWithLifecycle(lifecycle).collect {
82 | listHistory.clear()
83 | listHistory.addAll(it)
84 | mSearchHistoryAdapter.notifyDataChanged()
85 | }
86 | }
87 | }
88 |
89 | private fun search(key: String) {
90 | if (StringUtils.isNotBlank(key)) {
91 | searchView?.setQuery(key, true)
92 | } else {
93 | binding.srl.isRefreshing = false
94 | }
95 | }
96 |
97 | @SuppressLint("RestrictedApi")
98 | override fun onCreateOptionsMenu(menu: Menu): Boolean {
99 | menuInflater.inflate(R.menu.search_view_menu, menu)
100 | val searchItem = menu.findItem(R.id.searchItem)
101 | //通过MenuItem得到SearchView
102 | searchView = searchItem.actionView as SearchView?
103 | val searchSrcTextView = searchView?.findViewById(R.id.search_src_text)
104 | searchSrcTextView?.also {
105 | it.filters = arrayOf(LengthFilter(1))
106 | }
107 | searchView?.queryHint = getString(R.string.word_search_hint)
108 | searchView?.setOnQueryTextListener(object : SearchView.OnQueryTextListener {
109 | override fun onQueryTextSubmit(s: String): Boolean {
110 | if (StringUtils.isNotBlank(s)) {
111 | word = s
112 | viewModel.getDictionaryInfo(word)
113 | searchView?.clearFocus()
114 | } else {
115 | showToast(getString(R.string.tips_search_content))
116 | }
117 | return true
118 | }
119 |
120 | override fun onQueryTextChange(s: String): Boolean {
121 | return false
122 | }
123 | })
124 | return super.onCreateOptionsMenu(menu)
125 | }
126 |
127 | override fun showLoading() {
128 | if (!binding.srl.isRefreshing) {
129 | super.showLoading()
130 | }
131 | }
132 |
133 | override fun hideLoading() {
134 | super.hideLoading()
135 | binding.srl.isRefreshing = false
136 | }
137 |
138 | private fun clearSearchHistory() {
139 | viewModel.clearSearchHistory()
140 | mAdapter.refreshData(null)
141 | word = ""
142 | searchView?.setQuery(word, false)
143 | }
144 |
145 | fun onClick(v: View) {
146 | when (v.id) {
147 | R.id.ivDeleteHistory -> clearSearchHistory()
148 | }
149 | }
150 | }
151 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/dictionary/DictionaryViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.dictionary
2 |
3 | import android.app.Application
4 | import com.king.mvvmframe.R
5 | import com.king.mvvmframe.app.base.BaseViewModel
6 | import com.king.mvvmframe.data.model.DictionaryInfo
7 | import com.king.mvvmframe.data.repository.DictionaryRepository
8 | import dagger.hilt.android.lifecycle.HiltViewModel
9 | import javax.inject.Inject
10 | import kotlinx.coroutines.flow.MutableStateFlow
11 | import kotlinx.coroutines.flow.asSharedFlow
12 |
13 | /**
14 | * 示例
15 | *
16 | * @author Jenly
17 | *
18 | * Follow me
19 | */
20 | @HiltViewModel
21 | class DictionaryViewModel @Inject constructor(
22 | private val dictionaryRepository: DictionaryRepository,
23 | application: Application
24 | ) : BaseViewModel(application) {
25 |
26 | private val _dictionaryFlow = MutableStateFlow(null)
27 | val dictionaryFlow = _dictionaryFlow.asSharedFlow()
28 |
29 | /**
30 | * 获取字典信息
31 | */
32 | fun getDictionaryInfo(word: String) {
33 | launch {
34 | val result = dictionaryRepository.getDictionaryInfo(word)
35 | if (isSuccess(result)) {
36 | _dictionaryFlow.emit(result.data)
37 | }
38 | }
39 | }
40 |
41 | /**
42 | * 获取搜索历史
43 | */
44 | fun getSearchHistoryFlow() = dictionaryRepository.getSearchHistoryFlow()
45 |
46 | /**
47 | * 删除搜索历史
48 | */
49 | fun clearSearchHistory() {
50 | launch {
51 | dictionaryRepository.clearSearchHistory()
52 | sendMessage(R.string.cleared)
53 | }
54 | }
55 |
56 | }
57 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/oil/OilPriceActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.oil
2 |
3 | import android.os.Bundle
4 | import androidx.lifecycle.flowWithLifecycle
5 | import androidx.lifecycle.lifecycleScope
6 | import androidx.recyclerview.widget.LinearLayoutManager
7 | import com.king.base.adapter.divider.DividerItemDecoration
8 | import com.king.frame.mvvmframe.base.BaseActivity
9 | import com.king.mvvmframe.R
10 | import com.king.mvvmframe.app.adapter.BindingAdapter
11 | import com.king.mvvmframe.data.model.OilPrice
12 | import com.king.mvvmframe.databinding.OilPriceActivityBinding
13 | import dagger.hilt.android.AndroidEntryPoint
14 | import kotlinx.coroutines.launch
15 |
16 | /**
17 | * 示例
18 | *
19 | * @author Jenly
20 | *
21 | * Follow me
22 | */
23 | @AndroidEntryPoint
24 | class OilPriceActivity : BaseActivity() {
25 |
26 | private val mAdapter by lazy {
27 | BindingAdapter(getContext(), R.layout.rv_oil_price_item)
28 | }
29 |
30 | override fun getLayoutId(): Int {
31 | return R.layout.oil_price_activity
32 | }
33 |
34 | override fun initData(savedInstanceState: Bundle?) {
35 | with(binding.recyclerView) {
36 | layoutManager = LinearLayoutManager(context)
37 | addItemDecoration(
38 | DividerItemDecoration(
39 | context,
40 | DividerItemDecoration.VERTICAL,
41 | R.drawable.list_divider_8
42 | )
43 | )
44 | adapter = mAdapter
45 | }
46 |
47 | mAdapter.setOnItemClickListener { _, position ->
48 | showToast(mAdapter.getItem(position)!!.city)
49 | }
50 |
51 | lifecycleScope.launch {
52 | viewModel.oilPriceFlow.flowWithLifecycle(lifecycle).collect {
53 | mAdapter.refreshData(it)
54 | }
55 | }
56 |
57 | binding.srl.setOnRefreshListener {
58 | viewModel.getOilPriceInfo()
59 | }
60 |
61 | viewModel.getOilPriceInfo()
62 | }
63 |
64 | override fun showLoading() {
65 | if (!binding.srl.isRefreshing) {
66 | super.showLoading()
67 | }
68 | }
69 |
70 | override fun hideLoading() {
71 | super.hideLoading()
72 | binding.srl.isRefreshing = false
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/app/oil/OilPriceViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.app.oil
2 |
3 | import android.app.Application
4 | import com.king.mvvmframe.app.base.BaseViewModel
5 | import com.king.mvvmframe.data.model.OilPrice
6 | import com.king.mvvmframe.data.repository.OilPriceRepository
7 | import dagger.hilt.android.lifecycle.HiltViewModel
8 | import kotlinx.coroutines.flow.MutableStateFlow
9 | import kotlinx.coroutines.flow.asSharedFlow
10 | import javax.inject.Inject
11 |
12 | /**
13 | * 示例
14 | *
15 | * @author Jenly
16 | *
17 | * Follow me
18 | */
19 | @HiltViewModel
20 | class OilPriceViewModel @Inject constructor(
21 | private val oilPriceRepository: OilPriceRepository,
22 | application: Application
23 | ) : BaseViewModel(application) {
24 |
25 |
26 | private val _oilPriceFlow = MutableStateFlow>(emptyList())
27 | val oilPriceFlow = _oilPriceFlow.asSharedFlow()
28 |
29 | /**
30 | * 获取油价信息
31 | */
32 | fun getOilPriceInfo() {
33 | launch {
34 | val result = oilPriceRepository.getOilPriceInfo()
35 | if (isSuccess(result)) {
36 | result.data?.also {
37 | _oilPriceFlow.emit(it)
38 | }
39 | }
40 | }
41 | }
42 |
43 | }
44 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/config/AppConfigModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.config
2 |
3 | import android.content.Context
4 | import androidx.room.RoomDatabase
5 | import com.google.gson.GsonBuilder
6 | import com.king.frame.mvvmframe.config.AppliesOptions
7 | import com.king.frame.mvvmframe.config.AppliesOptions.GsonOptions
8 | import com.king.frame.mvvmframe.config.AppliesOptions.OkHttpClientOptions
9 | import com.king.frame.mvvmframe.config.AppliesOptions.RetrofitOptions
10 | import com.king.frame.mvvmframe.config.AppliesOptions.RoomDatabaseOptions
11 | import com.king.frame.mvvmframe.config.Config
12 | import com.king.frame.mvvmframe.config.FrameConfigModule
13 | import com.king.frame.mvvmframe.di.module.ConfigModule
14 | import com.king.mvvmframe.BuildConfig
15 | import com.king.mvvmframe.constant.Constants
16 | import com.king.retrofit.retrofithelper.RetrofitHelper
17 | import okhttp3.OkHttpClient
18 | import okhttp3.logging.HttpLoggingInterceptor
19 | import retrofit2.Retrofit
20 |
21 | /**
22 | * 全局配置
23 | *
24 | * @author Jenly
25 | *
26 | * Follow me
27 | */
28 | class AppConfigModule : FrameConfigModule() {
29 | override fun applyOptions(context: Context, builder: ConfigModule.Builder) {
30 | /**
31 | * > 目前通过设置 BaseUrl 的入口主要有两种：
32 | * >> 1.一种是通过在 Manifest 中配置 meta-data 的来自定义 FrameConfigModule,在里面 通过 [ConfigModule.Builder.baseUrl]来配置 BaseUrl。（一次设置，全局配置）
33 | * >
34 | * >> 2.一种就是通过RetrofitHelper [RetrofitHelper.setBaseUrl] 或 [RetrofitHelper.setBaseUrl] 来配置 BaseUrl。（可多次设置，动态全局配置，有前提条件）
35 | * >
36 | * > 以上两种配置 BaseUrl 的方式都可以达到目的。但是你可以根据不同的场景选择不同的配置方式。
37 | * >
38 | * > 主要场景与选择如下：
39 | * >
40 | * >> 一般场景：对于只使用单个不变的 BaseUrl的
41 | * >>> 场景1:如果本库的默认已满足你的需求，无需额外自定义配置的。
42 | * > 选择：建议你直接使用 [RetrofitHelper.setBaseUrl] 或 [RetrofitHelper.setBaseUrl] 来初始化 BaseUrl，切记在框架配置初始化 BaseUrl之前，建议在你自定义的 [Application.onCreate]中初始化。
43 | * >
44 | * >>> 场景2:如果本库的默认配置不满足你的需求，你需要自定义一些配置的。（比如需要使用 RxJava相关）
45 | * > 选择：建议你在自定义配置中通过 [ConfigModule.Builder.baseUrl] 来初始化 BaseUrl。
46 | * >
47 | * >> 二般场景：对于只使用单个 BaseUrl 但是，BaseUrl中途会变动的。
48 | * >>> 场景3：和一般场景一样，也能分两种，所以选择也和一般场景也可以是一样的。
49 | * > 选择：两种选择都行，但当 BaseUrl需要中途变动时，还需将 [RetrofitHelper.setDynamicDomain] 设置为 `true` 才能支持动态改变 BaseUrl。
50 | * >
51 | * >> 特殊场景：对于支持多个 BaseUrl 且支持动态可变的。
52 | * >>> 选择：这个场景的选择，主要涉及到另外的方法，请查看 [RetrofitHelper.putDomain] 和 [RetrofitHelper.putDomain]相关详情
53 | * >
54 | */
55 | // 通过第一种方式初始化BaseUrl
56 | builder.baseUrl(Constants.BASE_URL) // TODO 配置Retrofit中的baseUrl
57 |
58 | builder.retrofitOptions(object : RetrofitOptions {
59 | override fun applyOptions(builder: Retrofit.Builder) {
60 | // TODO 配置Retrofit
61 |
62 | }
63 | })
64 | .okHttpClientOptions(object : OkHttpClientOptions {
65 | override fun applyOptions(builder: OkHttpClient.Builder) {
66 | // TODO 配置OkHttpClient
67 | }
68 | })
69 | .gsonOptions(object : GsonOptions {
70 | override fun applyOptions(builder: GsonBuilder) {
71 | // TODO 配置Gson
72 | }
73 | })
74 | .roomDatabaseOptions(object : RoomDatabaseOptions {
75 | override fun applyOptions(builder: RoomDatabase.Builder) {
76 | // TODO 配置RoomDatabase
77 | builder.fallbackToDestructiveMigration()
78 | }
79 | })
80 | .configOptions(object : AppliesOptions.ConfigOptions {
81 | override fun applyOptions(builder: Config.Builder) {
82 | // TODO 配置Config
83 | builder.httpLoggingLevel(
84 | if (BuildConfig.DEBUG) {
85 | HttpLoggingInterceptor.Level.BODY
86 | } else {
87 | HttpLoggingInterceptor.Level.NONE
88 | }
89 | )
90 | }
91 | })
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/constant/Constants.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.constant
2 |
3 | /**
4 | * @author Jenly
5 | *
6 | * Follow me
7 | */
8 | object Constants {
9 |
10 | const val BASE_URL = "http://apis.juhe.cn"
11 |
12 | const val DICTIONARY_BASE_URL = "http://v.juhe.cn"
13 |
14 | const val JENLY_BASE_URL = "https://jenly1314.gitlab.io"
15 |
16 | const val TAG = "Jenly"
17 |
18 | const val OIL_PRICE_KEY = "402e469d939079d5bb758fc5ca65967d"
19 | const val DICTIONARY_KEY = "e38e852fe9307822a50e66763afdc593"
20 |
21 | const val COLOR_RGB_MIN = 20
22 | const val COLOR_RGB_MAX = 230
23 |
24 | const val DOMAIN_DICTIONARY = "dictionary"
25 | const val DOMAIN_JENLY = "jenly1314"
26 | }
27 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/database/AppDatabase.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.database
2 |
3 | import androidx.room.Database
4 | import androidx.room.RoomDatabase
5 | import com.king.mvvmframe.data.model.SearchHistory
6 | import com.king.mvvmframe.data.database.dao.SearchHistoryDao
7 |
8 | /**
9 | * 数据库
10 | *
11 | * @author Jenly
12 | *
13 | * Follow me
14 | */
15 | @Database(entities = [SearchHistory::class], version = 1, exportSchema = false)
16 | abstract class AppDatabase : RoomDatabase() {
17 | /**
18 | * SearchHistoryDao
19 | */
20 | abstract val searchHistoryDao: SearchHistoryDao
21 | }
22 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/database/dao/SearchHistoryDao.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.database.dao
2 |
3 | import androidx.room.Dao
4 | import androidx.room.Insert
5 | import androidx.room.OnConflictStrategy
6 | import androidx.room.Query
7 | import com.king.mvvmframe.data.model.SearchHistory
8 | import kotlinx.coroutines.flow.Flow
9 |
10 | /**
11 | * 搜索历史
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | @Dao
18 | interface SearchHistoryDao {
19 | /**
20 | * 插入一条历史数据
21 | * @param searchHistory
22 | */
23 | @Insert(onConflict = OnConflictStrategy.REPLACE)
24 | suspend fun insert(searchHistory: SearchHistory)
25 |
26 | /**
27 | * 删除所有历史数据
28 | */
29 | @Query("DELETE FROM SearchHistory")
30 | suspend fun deleteAll()
31 |
32 | /**
33 | * 获取历史数据对应的[Flow]
34 | *
35 | * @param size 获取历史记录的条数
36 | */
37 | @Query("SELECT * FROM SearchHistory ORDER BY timestamp DESC LIMIT :size")
38 | fun getHistoryFlow(size: Int): Flow?>
39 | }
40 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/model/City.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.model
2 |
3 | /**
4 | * 城市
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | data class City(
11 | val id: String,
12 | val name: String,
13 | )
14 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/model/DictionaryInfo.java:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.model;
2 |
3 | import java.util.List;
4 |
5 | /**
6 | * @author Jenly
7 | */
8 | public class DictionaryInfo {
9 |
10 | /**
11 | * zi : 聚
12 | * py : ju
13 | * wubi : bcti
14 | * pinyin : jù
15 | * bushou : 耳
16 | * bihua : 14
17 | * jijie : ["聚","jù","会合，集合：聚合。聚会。聚积。聚集。聚谈。聚拢。聚齐。聚餐。欢聚一堂。物以类聚。凝聚。聚沙成塔。","散","","笔画数：14；","部首：耳；","笔顺编号：12211154323334"]
18 | * xiangjie : ["聚","jù","【名】","(形声。小篆,下面是三个人,表示人多;上面的\u201c取\u201d,作声符。本义:村落)","同本义〖village〗","聚,会也。\u2014\u2014《说文》。按,邑落曰聚,今曰邨,曰镇,北方曰集皆是。","一年而所居成聚。\u2014\u2014《史记·五帝纪》","聚曰序。\u2014\u2014《史记·平帝纪》","所止聚落化其德。\u2014\u2014《后汉书·王扶传》。注:\u201c小于乡曰聚。\u201d","乡聚里中人哀而救之。\u2014\u2014刘向《说苑》","禹无十户之聚,以王诸侯。\u2014\u2014枚乘《上书谏吴王》","又如:聚落(村落里邑,人群聚居的地方)","众;集团;一伙〖group〗","我是以有辅氏之聚。\u2014\u2014《左传·成公十三年》","陈人恃其聚。\u2014\u2014《左传·哀公十七年》","又如:聚观(群聚观看);聚口(犹齐声)","地名〖Jucity〗。在今山西省绛县东南","","聚","jù","【动】","会合;聚集〖assemble;flocktogether;gather;gettogether〗","而发于众心之所聚。\u2014\u2014《管子·君臣上》","聚室而谋日。\u2014\u2014《列子·汤问》","以王命聚之。\u2014\u2014唐·柳宗元《捕蛇者说》","鸣锣聚众。\u2014\u2014《广东军务记》","聚至百有余乡。","又如:聚散浮生(指人生聚散无定。浮生:人活着的时候是虚浮无定的);聚麀之诮(比喻和不三不四的女人鬼混在一起,遭人耻笑。麀:母鹿,泛指母兽);聚寇(聚集起来的盗寇)","积蓄,累积〖accumulate〗","聚菽粟。\u2014\u2014《墨子·尚贤中》","我今将畜积并聚之于仓廪。\u2014\u2014《荀子·王制》","又如:聚沙成塔;聚米(堆积米粒做成模型以说明军事形势,运筹决策;米堆。形容矮小);聚货(聚集货物)","征集〖collect〗","太医以王命聚之。\u2014\u2014柳宗元《捕蛇者说》","使民众聚居〖assemble;dwellingroups〗","大叔完聚。(完;修好城墙。)\u2014\u2014《左传》","","聚宝盆","jùbǎopén","〖treasurebowl〗民间传说中装有金银珠宝而且取之不尽的盆儿,比喻资源丰富的地方","聚变","jùbiàn","〖fusion〗某些轻元素结合时形成较重核并导致大量能量释放的原子核的结合","聚餐","jùcān","〖luncheon〗通常在公共食堂为集体而供应的一种比较正规的便餐(如遇到俱乐部的聚会或业务上的会议)","聚餐","jùcān","〖dinetogether〗聚在一起在公共食堂吃比较正规的便餐","聚赌","jùdǔ","〖operate〗多人聚集在一起赌博","聚光","jùguāng","〖condensation〗∶光的聚焦式准直","〖spotlight〗∶对一个物体的小面积进行照明的强光束","聚光灯","jùguāngdēng","〖spotlight〗类似小探照灯的一种设备,有一个可调反光镜,通常装有白炽灯或弧光灯,用于在室内将一窄束强光射在一个选定的小区域内(如舞台或待照相的对象等)","聚合","jùhé","〖gettogether〗∶分散的聚集到一起","〖polymerize〗∶化学结合〖小分子〗成为大分子,尤其非常大的分子;使受到聚合作用","聚会","jùhuì","〖gettogether〗聚集会合","几个老同学聚会","聚伙","jùhuǒ","〖gatheracrowd〗多人合成一伙","聚伙抢劫","聚积","jùjī","〖buildup〗∶聚蓄;积蓄","聚积革命力量","〖accumulate〗∶累积,经年累月,一点一滴地累积","他由于工作努力和投资适当,聚积了大量财富","聚集","jùjí","〖gather;assemble;collect〗集合","机场上聚集着数千人","聚歼","jùjiān","〖roundupandannihilate〗把敌人包围起来全部消灭","聚焦","jùjiāo","〖focus〗使光线或电子束等集中于一点","聚居","jùjū","〖inhabitaregion〗集中居住","少数民族聚居的地方","聚敛","jùliǎn","〖amasswealthbyheavytaxation〗课重税来搜刮(民财)","季氏富于周公,而求也为之聚敛而附益之。\u2014\u2014《论语·先进》","聚拢","jùlǒng","〖gathertogether〗会聚合拢起来","聚齐","jùqí","〖calltogether〗〖在约定地点〗全体集合","参观的人八时在展览馆对面聚齐","聚散","jùsàn","〖meetingandparting〗会聚与分散","人生聚散无常","聚谈","jùtán","〖gettogetherandtalkover〗聚在一起交谈","好久不得如此聚谈快意了!","聚头","jùtóu","〖gettogether;meet〗聚首;会面;人碰在一起","不是冤家不聚头","聚晤","jùwù","〖meet〗会晤","聚晤一堂,谈笑风生","聚议","jùyì","〖gettogetheranddiscuss〗聚集在一起商议","聚议大事","聚义","jùyì","〖gettogetheranduprise〗旧指为正义事业而聚集在一起","聚义英雄","聚饮","jùyǐn","〖gettogetheranddrink〗聚集在一起喝酒取乐","聚众","jùzhòng","〖mob;gatheracrowd〗聚集群众;把许多人聚集在一起","聚众闹事"]
19 | */
20 |
21 | private String zi;
22 | private String py;
23 | private String wubi;
24 | private String pinyin;
25 | private String bushou;
26 | private String bihua;
27 | private List jijie;
28 | private List xiangjie;
29 |
30 | public String getZi() {
31 | return zi;
32 | }
33 |
34 | public void setZi(String zi) {
35 | this.zi = zi;
36 | }
37 |
38 | public String getPy() {
39 | return py;
40 | }
41 |
42 | public void setPy(String py) {
43 | this.py = py;
44 | }
45 |
46 | public String getWubi() {
47 | return wubi;
48 | }
49 |
50 | public void setWubi(String wubi) {
51 | this.wubi = wubi;
52 | }
53 |
54 | public String getPinyin() {
55 | return pinyin;
56 | }
57 |
58 | public void setPinyin(String pinyin) {
59 | this.pinyin = pinyin;
60 | }
61 |
62 | public String getBushou() {
63 | return bushou;
64 | }
65 |
66 | public void setBushou(String bushou) {
67 | this.bushou = bushou;
68 | }
69 |
70 | public String getBihua() {
71 | return bihua;
72 | }
73 |
74 | public void setBihua(String bihua) {
75 | this.bihua = bihua;
76 | }
77 |
78 | public List getJijie() {
79 | return jijie;
80 | }
81 |
82 | public void setJijie(List jijie) {
83 | this.jijie = jijie;
84 | }
85 |
86 | public List getXiangjie() {
87 | return xiangjie;
88 | }
89 |
90 | public void setXiangjie(List xiangjie) {
91 | this.xiangjie = xiangjie;
92 | }
93 |
94 | @Override
95 | public String toString() {
96 | return "DictionaryInfo{" +
97 | "zi='" + zi + '\'' +
98 | ", py='" + py + '\'' +
99 | ", wubi='" + wubi + '\'' +
100 | ", pinyin='" + pinyin + '\'' +
101 | ", bushou='" + bushou + '\'' +
102 | ", bihua='" + bihua + '\'' +
103 | ", jijie=" + jijie +
104 | ", xiangjie=" + xiangjie +
105 | '}';
106 | }
107 | }
108 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/model/OilPrice.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.model
2 |
3 | import com.google.gson.annotations.SerializedName
4 |
5 | /**
6 | * 石油价格
7 | *
8 | * @author Jenly
9 | *
10 | * Follow me
11 | */
12 | data class OilPrice(
13 | var city: String,
14 | @SerializedName("92h")
15 | val oil92: String,
16 | @SerializedName("95h")
17 | val oil95: String,
18 | @SerializedName("98h")
19 | val oil98: String,
20 | @SerializedName("0h")
21 | val oil0: String,
22 | ) {
23 | fun getOil92Str() = "¥ $oil92"
24 |
25 | fun getOil95Str() = "¥ $oil95"
26 |
27 | fun getOil98Str() = "¥ $oil98"
28 |
29 | fun getOil0Str() = "¥ $oil0"
30 | }
31 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/model/Result.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.model
2 |
3 | import com.google.gson.annotations.SerializedName
4 |
5 | /**
6 | * 结果
7 | *
8 | * @author Jenly
9 | *
10 | * Follow me
11 | */
12 | data class Result(
13 | @SerializedName("error_code")
14 | val code: Int,
15 | @SerializedName("reason")
16 | var message: String? = null,
17 | @SerializedName("result")
18 | var data: T? = null
19 | ) {
20 | /**
21 | * 是否成功
22 | */
23 | fun isSuccess() = code == 0
24 | }
25 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/model/SearchHistory.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.model
2 |
3 | import androidx.room.Entity
4 | import androidx.room.Index
5 | import androidx.room.PrimaryKey
6 |
7 | /**
8 | * 搜索历史
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | */
14 | @Entity(indices = [Index(value = ["word"], unique = true)])
15 | data class SearchHistory(
16 | @PrimaryKey(autoGenerate = true)
17 | val id: Long = 0,
18 | val word: String,
19 | val timestamp: Long,
20 | )
21 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/repository/CityRepository.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.repository
2 |
3 | import com.king.frame.mvvmframe.data.datasource.DataSource
4 | import com.king.mvvmframe.data.model.City
5 | import com.king.mvvmframe.data.service.CityService
6 | import javax.inject.Inject
7 | import javax.inject.Singleton
8 |
9 | /**
10 | * 城市数据仓库
11 | *
12 | * @author Jenly
13 | *
14 | * Follow me
15 | */
16 | @Singleton
17 | class CityRepository @Inject constructor(private val dataSource: DataSource) {
18 |
19 | private val cityService: CityService by lazy {
20 | dataSource.getRetrofitService(CityService::class.java)
21 | }
22 |
23 | /**
24 | * 获取热门城市列表
25 | */
26 | suspend fun getHotCities(): List {
27 | return cityService.getHotCities()
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/repository/DictionaryRepository.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.repository
2 |
3 | import com.king.frame.mvvmframe.data.datasource.DataSource
4 | import com.king.mvvmframe.constant.Constants
5 | import com.king.mvvmframe.data.database.AppDatabase
6 | import com.king.mvvmframe.data.model.DictionaryInfo
7 | import com.king.mvvmframe.data.model.Result
8 | import com.king.mvvmframe.data.model.SearchHistory
9 | import com.king.mvvmframe.data.service.DictionaryService
10 | import javax.inject.Inject
11 | import javax.inject.Singleton
12 | import kotlinx.coroutines.flow.Flow
13 | import kotlinx.coroutines.flow.filterNotNull
14 |
15 | /**
16 | * 城市数据仓库
17 | *
18 | * @author Jenly
19 | *
20 | * Follow me
21 | */
22 | @Singleton
23 | class DictionaryRepository @Inject constructor(private val dataSource: DataSource) {
24 |
25 | private val dictionaryService: DictionaryService by lazy {
26 | dataSource.getRetrofitService(DictionaryService::class.java)
27 | }
28 |
29 | private val searchHistoryDao by lazy {
30 | dataSource.getRoomDatabase(AppDatabase::class.java).searchHistoryDao
31 | }
32 |
33 | /**
34 | * 获取热门城市列表
35 | */
36 | suspend fun getDictionaryInfo(
37 | word: String,
38 | key: String = Constants.DICTIONARY_KEY
39 | ): Result {
40 | searchHistoryDao.insert(
41 | SearchHistory(
42 | word = word,
43 | timestamp = System.currentTimeMillis()
44 | )
45 | )
46 | return dictionaryService.getDictionaryInfo(word, key)
47 | }
48 |
49 | /**
50 | * 获取搜索历史
51 | */
52 | fun getSearchHistoryFlow(size: Int = 10): Flow> {
53 | return searchHistoryDao.getHistoryFlow(size).filterNotNull()
54 | }
55 |
56 | /**
57 | * 清空搜索历史
58 | */
59 | suspend fun clearSearchHistory() {
60 | searchHistoryDao.deleteAll()
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/repository/OilPriceRepository.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.repository
2 |
3 | import com.king.frame.mvvmframe.data.datasource.DataSource
4 | import com.king.mvvmframe.constant.Constants
5 | import com.king.mvvmframe.data.model.OilPrice
6 | import com.king.mvvmframe.data.model.Result
7 | import com.king.mvvmframe.data.service.OilPriceService
8 | import javax.inject.Inject
9 | import javax.inject.Singleton
10 |
11 | /**
12 | * 油价价格数据仓库
13 | *
14 | * @author Jenly
15 | *
16 | * Follow me
17 | */
18 | @Singleton
19 | class OilPriceRepository @Inject constructor(private val dataSource: DataSource) {
20 |
21 | private val oilPriceService: OilPriceService by lazy {
22 | dataSource.getRetrofitService(OilPriceService::class.java)
23 | }
24 |
25 | /**
26 | * 获取查询国内油价
27 | */
28 | suspend fun getOilPriceInfo(key: String = Constants.OIL_PRICE_KEY): Result> {
29 | return oilPriceService.getOilPriceInfo(key)
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/service/CityService.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.service
2 |
3 | import com.king.mvvmframe.constant.Constants
4 | import com.king.mvvmframe.data.model.City
5 | import com.king.retrofit.retrofithelper.annotation.DomainName
6 | import com.king.retrofit.retrofithelper.annotation.Timeout
7 | import retrofit2.http.GET
8 |
9 | /**
10 | * 城市API
11 | *
12 | * @author Jenly
13 | *
14 | * Follow me
15 | */
16 | interface CityService {
17 |
18 | /**
19 | * 动态改变 BaseUrl 示例
20 | * @return
21 | */
22 | @DomainName(Constants.DOMAIN_JENLY)
23 | @Timeout(connectTimeout = 10, readTimeout = 15, writeTimeout = 10)
24 | @GET("api/city/hotCities.json")
25 | suspend fun getHotCities(): List
26 | }
27 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/service/DictionaryService.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.service
2 |
3 | import com.king.mvvmframe.constant.Constants
4 | import com.king.mvvmframe.data.model.DictionaryInfo
5 | import com.king.mvvmframe.data.model.Result
6 | import com.king.retrofit.retrofithelper.annotation.DomainName
7 | import retrofit2.http.GET
8 | import retrofit2.http.Query
9 |
10 | /**
11 | * 字典API
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | interface DictionaryService {
18 |
19 | /**
20 | * 获取字典信息- 新华字典
21 | * @param key
22 | * @return
23 | */
24 | @DomainName(Constants.DOMAIN_DICTIONARY)
25 | @GET("xhzd/query")
26 | suspend fun getDictionaryInfo(
27 | @Query("word") word: String,
28 | @Query("key") key: String,
29 | ): Result
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/data/service/OilPriceService.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.data.service
2 |
3 | import com.king.mvvmframe.data.model.OilPrice
4 | import com.king.mvvmframe.data.model.Result
5 | import retrofit2.http.GET
6 | import retrofit2.http.Query
7 |
8 | /**
9 | * 石油价格API
10 | *
11 | * @author Jenly
12 | *
13 | * Follow me
14 | */
15 | interface OilPriceService {
16 |
17 | /**
18 | * 查询国内油价
19 | */
20 | @GET("gnyj/query")
21 | suspend fun getOilPriceInfo(@Query("key") key: String): Result>
22 |
23 | }
24 |
--------------------------------------------------------------------------------
/app/src/main/java/com/king/mvvmframe/util/RandomUtil.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe.util
2 |
3 | import android.graphics.Color
4 | import androidx.annotation.ColorInt
5 | import androidx.annotation.IntRange
6 | import java.util.Random
7 |
8 | /**
9 | * @author Jenly
10 | *
11 | * Follow me
12 | */
13 | object RandomUtil {
14 |
15 | private val random by lazy {
16 | Random()
17 | }
18 |
19 | @ColorInt
20 | fun randomColor(
21 | @IntRange(from = 0, to = 255) min: Int,
22 | @IntRange(from = 0, to = 255) max: Int
23 | ): Int {
24 | return Color.rgb(random(min, max), random(min, max), random(min, max))
25 | }
26 |
27 | fun random(min: Int, max: Int): Int {
28 | return random.nextInt(max - min + 1) + min
29 | }
30 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
12 |
13 |
19 |
11 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #008577
4 | #00574B
5 | #01847f
6 |
7 | #333333
8 | #666666
9 | #999999
10 |
11 | #008577
12 |
13 | #f3f3f3
14 |
15 | #eeeeee
16 | #d2d2d2
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/app/src/main/res/values/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFFFFF
4 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | MVVMFrame
3 |
4 |
5 | 服务器连接失败，请稍后再试。
6 | 服务器连接超时，请稍后再试。
7 | 系统繁忙，请稍后再试。
8 | 网络不给力，请检查网络。
9 |
10 | 获取失败
11 |
12 | 历史查询
13 | 查询结果
14 |
15 | 输入需要查询的汉字
16 | 输入的内容不能为空
17 |
18 | 已清空
19 |
20 | 关闭
21 |
22 | 92号：
23 | 95号：
24 | 98号：
25 | 0号：
26 |
27 |
--------------------------------------------------------------------------------
/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
12 |
13 |
14 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/app/src/main/res/xml/network_security_config.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/test/java/com/king/mvvmframe/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package com.king.mvvmframe
2 |
3 | import org.junit.Assert.assertEquals
4 | import org.junit.Test
5 |
6 | /**
7 | * Example local unit test, which will execute on the development machine (host).
8 | *
9 | * See [testing documentation](http://d.android.com/tools/testing).
10 | */
11 | class ExampleUnitTest {
12 | @Test
13 | fun addition_isCorrect() {
14 | assertEquals(4, 2 + 2)
15 | }
16 | }
--------------------------------------------------------------------------------
/art/mvvm_architecture.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/art/mvvm_architecture.jpg
--------------------------------------------------------------------------------
/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.application) apply false
3 | alias(libs.plugins.android.library) apply false
4 | alias(libs.plugins.kotlin.android) apply false
5 | alias(libs.plugins.kapt) apply false
6 | alias(libs.plugins.ksp) apply false
7 | alias(libs.plugins.dagger.hilt.android) apply false
8 | alias(libs.plugins.mvvmframe) apply false
9 | alias(libs.plugins.dokka) apply false
10 | alias(libs.plugins.maven.publish) apply false
11 | }
12 |
--------------------------------------------------------------------------------
/build_docs.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -ex
4 |
5 | # Generate the API docs
6 | ./gradlew dokkaHtml
7 |
8 | mkdir -p docs/api
9 | mv mvvmframe/build/dokka/html/* docs/api
10 |
11 | # Copy in special files that GitHub wants in the project root.
12 | GITHUB_URL=https://github.com/jenly1314/MVVMFrame/
13 | echo $GITHUB_URL
14 | sed "//q" README.md > docs/index.md
15 | sed -i "s|app/src/main/ic_launcher-web.png|ic_logo.png|g" docs/index.md
16 | sed -i "s|](app|](${GITHUB_URL}blob/master/app|g" docs/index.md
17 | sed -i "s|](mvvmframe|](${GITHUB_URL}blob/master/mvvmframe|g" docs/index.md
18 | cat CHANGELOG.md | grep -v '## 版本日志' > docs/changelog.md
19 |
20 | cp app/src/main/ic_launcher-web.png docs/ic_logo.png
21 | mkdir -p docs/art
22 | cp art/mvvm_architecture.jpg docs/art/mvvm_architecture.jpg
23 |
24 | # Build the site locally
25 | mkdocs build
26 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs = -Xmx1536m
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | android.useAndroidX=true
15 | android.enableJetifier=true
16 |
17 | android.nonTransitiveRClass=false
18 | android.nonFinalResIds=false
19 |
20 | VERSION_NAME=3.1.0
21 | VERSION_CODE=18
22 | GROUP=com.github.jenly1314
23 |
24 | POM_DESCRIPTION=MVVMFrame for Android
25 | POM_URL=https://github.com/jenly1314/MVVMFrame
26 |
27 | POM_SCM_URL=https://github.com/jenly1314/MVVMFrame
28 | POM_SCM_CONNECTION=scm:git@github.com:jenly1314/MVVMFrame.git
29 | POM_SCM_DEV_CONNECTION=scm:git@github.com:jenly1314/MVVMFrame.git
30 |
31 | POM_LICENCE_NAME=The MIT License
32 | POM_LICENCE_URL=https://opensource.org/licenses/mit-license.php
33 | #POM_LICENCE_NAME=The Apache Software License, Version 2.0
34 | #POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
35 | POM_LICENSE_DIST=repo
36 |
37 | POM_DEVELOPER_ID=jenly
38 | POM_DEVELOPER_NAME=Jenly Yu
39 | POM_DEVELOPER_URL=https://github.com/jenly1314/
40 |
41 | SONATYPE_HOST=S01
42 |
43 | RELEASE_REPOSITORY_URL=https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/
44 | SNAPSHOT_REPOSITORY_URL=https://s01.oss.sonatype.org/content/repositories/snapshots/
45 |
46 | RELEASE_SIGNING_ENABLED=false
47 |
48 |
49 |
--------------------------------------------------------------------------------
/gradle/libs.versions.toml:
--------------------------------------------------------------------------------
1 | [versions]
2 | minSdk = "21"
3 | targetSdk = "34"
4 | compileSdk = "34"
5 |
6 | agp = "8.7.2"
7 | kotlin = "1.9.24"
8 |
9 | coreKtx = "1.13.1"
10 | material = "1.12.0"
11 | appcompat = "1.7.0"
12 | fragmentKtx = "1.8.6"
13 | swiperefreshlayout = "1.1.0"
14 | recyclerview = "1.3.2"
15 | constraintLayout = "2.2.1"
16 | lifecycleKtx="2.8.7"
17 |
18 | junit = "4.13.2"
19 | androidJunit = "1.2.1"
20 | espresso = "3.6.1"
21 |
22 | room = "2.6.1"
23 | daggerHilt = "2.52"
24 | okhttp = "4.12.0"
25 | retrofit = "2.11.0"
26 | gson = "2.12.1"
27 | leakcanary = "2.14"
28 | javapoet = "1.13.0"
29 | base = "3.2.1-androidx"
30 | retrofitHelper = "1.1.0"
31 | logx = "1.1.0"
32 |
33 | dokka = "1.9.20"
34 | mavenPublish = "0.31.0"
35 |
36 | mvvmFrame = "3.1.0"
37 |
38 | [libraries]
39 | kotlin-stdlib = { group = "org.jetbrains.kotlin", name = "kotlin-stdlib", version.ref = "kotlin" }
40 | kotlin-android = { group = "org.jetbrains.kotlin.android", name = "org.jetbrains.kotlin.android.gradle.plugin", version.ref = "kotlin" }
41 | kotlin-kapt = { group = "org.jetbrains.kotlin.kapt", name = "org.jetbrains.kotlin.kapt.gradle.plugin", version.ref = "kotlin" }
42 |
43 | androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
44 | junit = { group = "junit", name = "junit", version.ref = "junit" }
45 | androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "androidJunit" }
46 | androidx-espresso = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espresso" }
47 |
48 | material = { group = "com.google.android.material", name = "material", version.ref = "material" }
49 | androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "appcompat" }
50 | androidx-fragment-ktx = { group = "androidx.fragment", name = "fragment-ktx", version.ref = "fragmentKtx" }
51 | swiperefreshlayout = { group = "androidx.swiperefreshlayout", name = "swiperefreshlayout", version.ref = "swiperefreshlayout" }
52 | recyclerview = { group = "androidx.recyclerview", name = "recyclerview", version.ref = "recyclerview" }
53 | constraintlayout = { group = "androidx.constraintlayout", name = "constraintlayout", version.ref = "constraintLayout" }
54 | lifecycle-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleKtx" }
55 | lifecycle-viewmodel-ktx = { group = "androidx.lifecycle", name = "lifecycle-viewmodel-ktx", version.ref = "lifecycleKtx" }
56 |
57 | room-runtime = { group = "androidx.room", name = "room-runtime", version.ref = "room" }
58 | room-ktx = { group = "androidx.room", name = "room-ktx", version.ref = "room" }
59 | room-compiler = { group = "androidx.room", name = "room-compiler", version.ref = "room" }
60 |
61 | dagger-hilt-android = { group = "com.google.dagger", name = "hilt-android", version.ref = "daggerHilt" }
62 | dagger-hilt-compiler = { group = "com.google.dagger", name = "hilt-compiler", version.ref = "daggerHilt" }
63 | dagger-hilt-android-plugin = { group = "com.google.dagger", name = "hilt-android-gradle-plugin", version.ref = "daggerHilt" }
64 |
65 | okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp" }
66 | okhttp-logging-interceptor = { group = "com.squareup.okhttp3", name = "logging-interceptor", version.ref = "okhttp" }
67 |
68 | retrofit = { group = "com.squareup.retrofit2", name = "retrofit", version.ref = "retrofit" }
69 | retrofit-converter-gson = { group = "com.squareup.retrofit2", name = "converter-gson", version.ref = "retrofit" }
70 |
71 | gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }
72 |
73 | leakcanary = { group = "com.squareup.leakcanary", name = "leakcanary-android", version.ref = "leakcanary" }
74 | javapoet = { group = "com.squareup", name = "javapoet", version.ref = "javapoet" }
75 |
76 | base-adapter = { group = "com.github.jenly1314.Base", name = "adapter", version.ref = "base" }
77 | base-util = { group = "com.github.jenly1314.Base", name = "util", version.ref = "base" }
78 | retrofit-helper = { group = "com.github.jenly1314", name = "retrofit-helper", version.ref = "retrofitHelper" }
79 |
80 | logx = { group = "com.github.jenly1314", name = "logx", version.ref = "logx" }
81 |
82 | timber = { group = "com.jakewharton.timber", name = "timber", version = "5.0.1" }
83 |
84 | android-ktx = { group = "io.github.androidktx", name = "android-ktx", version = "1.1.0" }
85 | toaster = { group = "com.github.getActivity", name = "Toaster", version = "12.8" }
86 | flowlayout = { group = "com.github.hongyangAndroid", name = "FlowLayout", version = "master" }
87 |
88 | [plugins]
89 | android-application = { id = "com.android.application", version.ref = "agp" }
90 | android-library = { id = "com.android.library", version.ref = "agp" }
91 | kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
92 |
93 | kapt = { id = "org.jetbrains.kotlin.kapt", version.ref = "kotlin" }
94 | ksp = { id = "com.google.devtools.ksp", version = "1.9.24-1.0.20" }
95 |
96 | dagger-hilt-android = { id = "com.google.dagger.hilt.android", version.ref = "daggerHilt" }
97 | dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
98 | maven-publish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
99 |
100 | mvvmframe = { id = "com.github.jenly1314.mvvmframe", version.ref = "mvvmFrame" }
101 |
102 |
103 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenly1314/MVVMFrame/e3d343fa4adf1fc5b073f9e36c5e5942be8352b5/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Sun Apr 05 15:41:45 CST 2020
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
7 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/jitpack.yml:
--------------------------------------------------------------------------------
1 | jdk:
2 | - openjdk17
3 |
--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
1 | # Project information
2 | site_name: MVVMFrame
3 | site_url: https://jenly1314.github.io/MVVMFrame/
4 | site_description: "MVVMFrame for Android"
5 | site_author: Jenly
6 | remote_branch: gh-pages
7 | edit_uri: ""
8 |
9 | # Repository
10 | repo_name: MVVMFrame
11 | repo_url: https://github.com/jenly1314/MVVMFrame
12 |
13 | # Copyright
14 | copyright: 'Copyright © 2016 - 2024 Jenly'
15 |
16 | # Configuration
17 | theme:
18 | name: 'material'
19 | favicon: https://jenly1314.github.io/favicon.png
20 | logo: https://jenly1314.github.io/medias/logo.png
21 | icon:
22 | repo: fontawesome/brands/github
23 | language: zh
24 | palette:
25 | - media: "(prefers-color-scheme: light)"
26 | scheme: default
27 | primary: teal
28 | accent: blue
29 | toggle:
30 | icon: octicons/sun-24
31 | name: "切换到深色模式"
32 | - media: "(prefers-color-scheme: dark)"
33 | scheme: slate
34 | primary: teal
35 | accent: blue
36 | toggle:
37 | icon: octicons/moon-24
38 | name: "切换到浅色模式"
39 | features:
40 | - navigation.instant
41 | - navigation.instant.progress
42 | - navigation.tabs
43 | - content.code.copy
44 |
45 | extra:
46 | generator: false
47 | social:
48 | - icon: material/home-circle
49 | link: https://jenly1314.github.io/
50 | - icon: simple/github
51 | link: https://github.com/jenly1314/
52 | - icon: simple/gitee
53 | link: https://gitee.com/jenly1314/
54 | - icon: fontawesome/solid/paper-plane
55 | link: mailto:jenly1314@gmail.com
56 |
57 | markdown_extensions:
58 | - smarty
59 | - footnotes
60 | - meta
61 | - toc:
62 | permalink: true
63 | - attr_list
64 | - pymdownx.betterem:
65 | smart_enable: all
66 | - pymdownx.caret
67 | - pymdownx.emoji:
68 | emoji_index: !!python/name:materialx.emoji.twemoji
69 | emoji_generator: !!python/name:materialx.emoji.to_svg
70 | - pymdownx.inlinehilite
71 | - pymdownx.magiclink
72 | - pymdownx.smartsymbols
73 | - pymdownx.superfences
74 | - pymdownx.tilde
75 | - pymdownx.tabbed:
76 | alternate_style: true
77 | - tables
78 |
79 | # Plugins
80 | plugins:
81 | - search
82 |
83 | nav:
84 | - '概览': index.md
85 | - 'API文档': api/index.html
86 | - '版本日志': changelog.md
87 |
88 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | `kotlin-dsl`
3 | alias(libs.plugins.maven.publish)
4 | }
5 |
6 | val javaVersion = 17
7 |
8 | java {
9 | toolchain {
10 | languageVersion.set(JavaLanguageVersion.of(javaVersion))
11 | }
12 | }
13 |
14 | tasks.withType {
15 | kotlinOptions {
16 | jvmTarget = javaVersion.toString()
17 | }
18 | }
19 |
20 | dependencies {
21 | implementation(gradleApi())
22 | implementation(libs.kotlin.stdlib)
23 | implementation(libs.kotlin.android)
24 | implementation(libs.kotlin.kapt)
25 | implementation(libs.dagger.hilt.android.plugin)
26 | implementation(libs.javapoet)
27 | }
28 |
29 | gradlePlugin {
30 | plugins {
31 | create("mvvmFramePlugin") { // 插件配置
32 | id = "com.github.jenly1314.mvvmframe" // 插件 ID
33 | implementationClass = "com.king.frame.mvvmframe.plugin.MvvmFramePlugin" // 插件实现类
34 | }
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/gradle.properties:
--------------------------------------------------------------------------------
1 | POM_NAME=MvvmFramePlugin
2 | POM_ARTIFACT_ID=mvvmframe-plugin
3 | POM_PACKAGING=gradle-plugin
4 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/src/main/java/com/king/frame/mvvmframe/plugin/MvvmFrameExtension.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.plugin
2 |
3 | import com.king.frame.mvvmframe.plugin.internal.Version
4 |
5 | /**
6 | * mvvmFrame插件配置
7 | *
8 | * @author Jenly
9 | *
10 | * Follow me
11 | */
12 | open class MvvmFrameExtension {
13 | /**
14 | * room版本
15 | */
16 | var roomVersion = Version.ROOM_VERSION
17 |
18 | /**
19 | * 是否启用依赖：androidx.room:room-runtime
20 | */
21 | var enabledRoomRuntime = true
22 |
23 | /**
24 | * 是否启用依赖：androidx.room:room-compiler
25 | */
26 | var enabledRoomCompiler = true
27 | }
28 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/src/main/java/com/king/frame/mvvmframe/plugin/MvvmFramePlugin.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.plugin
2 |
3 | import com.king.frame.mvvmframe.plugin.internal.PluginId
4 | import com.king.frame.mvvmframe.plugin.internal.Version
5 | import com.king.frame.mvvmframe.plugin.internal.hasDependency
6 | import com.king.frame.mvvmframe.plugin.internal.implementation
7 | import com.king.frame.mvvmframe.plugin.internal.kapt
8 | import org.gradle.api.Plugin
9 | import org.gradle.api.Project
10 |
11 | /**
12 | * MVVMFrame插件
13 | *
14 | * @author Jenly
15 | *
16 | * Follow me
17 | */
18 | class MvvmFramePlugin : Plugin {
19 |
20 | override fun apply(target: Project) {
21 |
22 | val mvvmFrame = target.extensions.create(MVVM_FRAME, MvvmFrameExtension::class.java)
23 |
24 | target.pluginManager.apply {
25 | if (!hasPlugin(PluginId.KOTLIN_ANDROID)) {
26 | apply(PluginId.KOTLIN_ANDROID)
27 | }
28 | if (!hasPlugin(PluginId.KOTLIN_KAPT)) {
29 | apply(PluginId.KOTLIN_KAPT)
30 | }
31 | if (!hasPlugin(PluginId.HILT_ANDROID)) {
32 | apply(PluginId.HILT_ANDROID)
33 | }
34 | }
35 |
36 | target.plugins.withId(PluginId.HILT_ANDROID) {
37 | target.dependencies.apply {
38 | implementation(DAGGER_GROUP, HILT_ANDROID, Version.HILT_VERSION)
39 | kapt(DAGGER_GROUP, HILT_COMPILER, Version.HILT_VERSION)
40 | }
41 | }
42 |
43 | target.afterEvaluate {
44 | target.dependencies.apply {
45 | val roomVersion = mvvmFrame.roomVersion
46 | if (mvvmFrame.enabledRoomRuntime && !target.hasDependency(ROOM_GROUP, ROOM_RUNTIME)) {
47 | implementation(ROOM_GROUP, ROOM_RUNTIME, roomVersion)
48 | }
49 | if (mvvmFrame.enabledRoomCompiler && !target.hasDependency(ROOM_GROUP, ROOM_COMPILER)) {
50 | kapt(ROOM_GROUP, ROOM_COMPILER, roomVersion)
51 | }
52 | }
53 | }
54 | }
55 |
56 | companion object {
57 | private const val MVVM_FRAME = "mvvmFrame"
58 |
59 | private const val DAGGER_GROUP = "com.google.dagger"
60 | private const val HILT_ANDROID = "hilt-android"
61 | private const val HILT_COMPILER = "hilt-compiler"
62 | private const val ROOM_GROUP = "androidx.room"
63 | private const val ROOM_RUNTIME = "room-runtime"
64 | private const val ROOM_COMPILER = "room-compiler"
65 | }
66 |
67 | }
68 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/src/main/java/com/king/frame/mvvmframe/plugin/internal/DependencyExt.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.plugin.internal
2 |
3 | import org.gradle.api.Project
4 | import org.gradle.api.artifacts.dsl.DependencyHandler
5 |
6 | /**
7 | * 依赖相关扩展函数
8 | *
9 | * @author Jenly
10 | *
11 | * Follow me
12 | */
13 | internal fun Project.hasDependency(group: String, name: String): Boolean {
14 | return configurations.any { configuration ->
15 | configuration.dependencies.any { dependency ->
16 | dependency.group == group && dependency.name == name
17 | }
18 | }
19 | }
20 |
21 | /**
22 | * implementation
23 | */
24 | internal fun DependencyHandler.implementation(
25 | group: String,
26 | artifact: String,
27 | version: String
28 | ) {
29 | add(IMPLEMENTATION, group, artifact, version)
30 | }
31 |
32 | /**
33 | * kapt
34 | */
35 | internal fun DependencyHandler.kapt(
36 | group: String,
37 | artifact: String,
38 | version: String
39 | ) {
40 | add(KAPT, group, artifact, version)
41 | }
42 |
43 | /**
44 | * 添加依赖
45 | */
46 | internal fun DependencyHandler.add(
47 | configurationName: String,
48 | group: String,
49 | artifact: String,
50 | version: String
51 | ) {
52 | add(configurationName, "$group:$artifact:$version")
53 | }
54 |
55 | private const val IMPLEMENTATION = "implementation"
56 | private const val KAPT = "kapt"
57 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/src/main/java/com/king/frame/mvvmframe/plugin/internal/PluginId.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.plugin.internal
2 |
3 | /**
4 | * 插件
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | internal object PluginId {
11 | const val KOTLIN_ANDROID = "org.jetbrains.kotlin.android"
12 | const val KOTLIN_KAPT = "org.jetbrains.kotlin.kapt"
13 | const val HILT_ANDROID = "com.google.dagger.hilt.android"
14 | }
15 |
--------------------------------------------------------------------------------
/mvvmframe-plugin/src/main/java/com/king/frame/mvvmframe/plugin/internal/Version.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.plugin.internal
2 |
3 | /**
4 | * 版本
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | internal object Version {
11 | const val HILT_VERSION = "2.52"
12 | const val ROOM_VERSION = "2.6.1"
13 | }
14 |
--------------------------------------------------------------------------------
/mvvmframe/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/mvvmframe/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.library)
3 | alias(libs.plugins.kotlin.android)
4 | alias(libs.plugins.kapt)
5 | alias(libs.plugins.ksp)
6 | alias(libs.plugins.dagger.hilt.android)
7 | alias(libs.plugins.dokka)
8 | alias(libs.plugins.maven.publish)
9 | }
10 |
11 | android {
12 | namespace = "com.king.frame.mvvmframe"
13 | compileSdk = libs.versions.compileSdk.get().toInt()
14 |
15 | defaultConfig {
16 | minSdk = libs.versions.minSdk.get().toInt()
17 |
18 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
19 | consumerProguardFiles("consumer-rules.pro")
20 | }
21 |
22 | buildTypes {
23 | release {
24 | isMinifyEnabled = false
25 | proguardFiles(
26 | getDefaultProguardFile("proguard-android.txt"),
27 | "proguard-rules.pro"
28 | )
29 | }
30 | }
31 |
32 | buildFeatures{
33 | dataBinding = true
34 | }
35 |
36 | compileOptions {
37 | sourceCompatibility = JavaVersion.VERSION_17
38 | targetCompatibility = JavaVersion.VERSION_17
39 | }
40 | kotlinOptions {
41 | jvmTarget = JavaVersion.VERSION_17.toString()
42 | }
43 |
44 | }
45 |
46 | dependencies {
47 |
48 | // test
49 | testImplementation(libs.junit)
50 | androidTestImplementation(libs.androidx.junit)
51 | androidTestImplementation(libs.androidx.espresso)
52 |
53 | // appcompat
54 | compileOnly(libs.androidx.appcompat)
55 |
56 | api(libs.androidx.core.ktx)
57 | api(libs.androidx.fragment.ktx)
58 |
59 | // okhttp
60 | api(libs.okhttp)
61 | api(libs.okhttp.logging.interceptor)
62 |
63 | // retrofit
64 | api(libs.retrofit)
65 | api(libs.retrofit.converter.gson)
66 | api(libs.gson)
67 |
68 | // retrofit-helper
69 | api(libs.retrofit.helper)
70 |
71 | // lifecycle
72 | api(libs.lifecycle.ktx)
73 | api(libs.lifecycle.viewmodel.ktx)
74 |
75 | // room
76 | api(libs.room.runtime)
77 | api(libs.room.ktx)
78 | ksp(libs.room.compiler)
79 |
80 | // hilt
81 | api(libs.dagger.hilt.android)
82 | kapt(libs.dagger.hilt.compiler)
83 |
84 | // log
85 | api(libs.timber)
86 | // toast
87 | implementation(libs.toaster)
88 | }
89 |
90 | kapt {
91 | correctErrorTypes = true
92 | }
93 |
--------------------------------------------------------------------------------
/mvvmframe/gradle.properties:
--------------------------------------------------------------------------------
1 | POM_NAME=MVVMFrame
2 | POM_ARTIFACT_ID=mvvmframe
3 | POM_PACKAGING=aar
--------------------------------------------------------------------------------
/mvvmframe/src/androidTest/java/com/king/frame/mvvm/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvm
2 |
3 | import androidx.test.platform.app.InstrumentationRegistry
4 | import androidx.test.ext.junit.runners.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("com.king.frame.mvvm.test", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/mvvmframe/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Dialog
4 | import android.content.Context
5 | import android.content.Intent
6 | import android.os.Bundle
7 | import android.view.View
8 | import android.view.Window
9 | import androidx.appcompat.app.AppCompatActivity
10 | import androidx.databinding.DataBindingUtil
11 | import androidx.databinding.ViewDataBinding
12 | import androidx.lifecycle.ViewModel
13 | import androidx.lifecycle.ViewModelProvider
14 | import androidx.lifecycle.flowWithLifecycle
15 | import androidx.lifecycle.lifecycleScope
16 | import com.king.frame.mvvmframe.base.BaseViewModel.Companion.getVMClass
17 | import com.king.frame.mvvmframe.base.controller.CombinedController
18 | import com.king.frame.mvvmframe.base.controller.DefaultCombinedController
19 | import com.king.frame.mvvmframe.util.JumpDebounce
20 | import kotlinx.coroutines.launch
21 |
22 | /**
23 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
24 | *
25 | * 如果您继承使用了 BaseActivity 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解标记，来进行注入
26 | *
27 | * ```
28 | * // 示例
29 | * @AndroidEntryPoint
30 | * class YourActivity: BaseActivity() {
31 | *
32 | * }
33 | * ```
34 | *
35 | * @author Jenly
36 | *
37 | * Follow me
38 | */
39 | abstract class BaseActivity : AppCompatActivity(),
40 | IView, CombinedController {
41 |
42 | protected open val combinedController: CombinedController by lazy {
43 | DefaultCombinedController(this)
44 | }
45 |
46 | private val jumpDebounce by lazy {
47 | JumpDebounce()
48 | }
49 |
50 | lateinit var viewModel: VM
51 | private set
52 |
53 | var viewDataBinding: VDB? = null
54 | private set
55 |
56 | val binding: VDB
57 | get() = viewDataBinding!!
58 |
59 | override fun onCreate(savedInstanceState: Bundle?) {
60 | super.onCreate(savedInstanceState)
61 | initContentView()
62 | initViewModel()
63 | initData(savedInstanceState)
64 | lifecycle.addObserver(combinedController)
65 | }
66 |
67 | override fun onDestroy() {
68 | super.onDestroy()
69 | viewDataBinding?.unbind()
70 | }
71 |
72 | /**
73 | * 初始化ContentView；
74 | */
75 | open fun initContentView() {
76 | if (isBinding()) {
77 | viewDataBinding = DataBindingUtil.setContentView(this, getLayoutId())
78 | } else {
79 | setContentView(getLayoutId())
80 | }
81 | }
82 |
83 | /**
84 | * 初始化[viewModel]
85 | */
86 | private fun initViewModel() {
87 | viewModel = createViewModel()
88 | lifecycleScope.launch {
89 | viewModel.loadingState.flowWithLifecycle(lifecycle).collect {
90 | if (it) {
91 | showLoading()
92 | } else {
93 | hideLoading()
94 | }
95 | }
96 | }
97 | lifecycleScope.launch {
98 | viewModel.messageEvent.flowWithLifecycle(lifecycle).collect {
99 | showToast(it)
100 | }
101 | }
102 | }
103 |
104 | /**
105 | * 是否使用 ViewDataBinding；默认为：true
106 | */
107 | override fun isBinding(): Boolean {
108 | return true
109 | }
110 |
111 | /**
112 | * 创建ViewModel
113 | */
114 | override fun createViewModel(): VM {
115 | return obtainViewModel(getVMClass())
116 | }
117 |
118 | /**
119 | * 获取ViewModel
120 | */
121 | fun obtainViewModel(vmClass: Class): T {
122 | return ViewModelProvider(
123 | viewModelStore,
124 | defaultViewModelProviderFactory,
125 | defaultViewModelCreationExtras
126 | )[vmClass]
127 | }
128 |
129 | override fun showLoading() {
130 | combinedController.showLoading()
131 | }
132 |
133 | override fun hideLoading() {
134 | combinedController.hideLoading()
135 | }
136 |
137 | override fun showProgressDialog(layoutId: Int, cancel: Boolean) {
138 | combinedController.showProgressDialog(layoutId, cancel)
139 | }
140 |
141 | override fun dismissProgressDialog() {
142 | combinedController.dismissProgressDialog()
143 | }
144 |
145 | override fun showDialog(
146 | contentView: View,
147 | styleId: Int,
148 | gravity: Int,
149 | widthRatio: Float,
150 | x: Int,
151 | y: Int,
152 | horizontalMargin: Float,
153 | verticalMargin: Float,
154 | horizontalWeight: Float,
155 | verticalWeight: Float,
156 | backCancel: Boolean
157 | ) {
158 | combinedController.showDialog(
159 | contentView = contentView,
160 | styleId = styleId,
161 | gravity = gravity,
162 | widthRatio = widthRatio,
163 | x = x,
164 | y = y,
165 | horizontalMargin = horizontalMargin,
166 | verticalMargin = verticalMargin,
167 | horizontalWeight = horizontalWeight,
168 | verticalWeight = verticalWeight,
169 | backCancel = backCancel,
170 | )
171 | }
172 |
173 | override fun setWindow(
174 | window: Window?,
175 | gravity: Int,
176 | widthRatio: Float,
177 | x: Int,
178 | y: Int,
179 | horizontalMargin: Float,
180 | verticalMargin: Float,
181 | horizontalWeight: Float,
182 | verticalWeight: Float
183 | ) {
184 | combinedController.setWindow(
185 | window = window,
186 | gravity = gravity,
187 | widthRatio = widthRatio,
188 | x = x,
189 | y = y,
190 | horizontalMargin = horizontalMargin,
191 | verticalMargin = verticalMargin,
192 | horizontalWeight = horizontalWeight,
193 | verticalWeight = verticalWeight,
194 | )
195 | }
196 |
197 | override fun dismissDialog() {
198 | combinedController.dismissDialog()
199 | }
200 |
201 | override fun dismissDialog(dialog: Dialog?) {
202 | combinedController.dismissDialog(dialog)
203 | }
204 |
205 | override fun showToast(text: CharSequence) {
206 | combinedController.showToast(text)
207 | }
208 |
209 | override fun showToast(resId: Int) {
210 | combinedController.showToast(resId)
211 | }
212 |
213 | @Suppress("DEPRECATION")
214 | @Deprecated("DeprecatedIsStillUsed")
215 | override fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?) {
216 | if (jumpDebounce.isIgnoreJump(intent)) {
217 | return
218 | }
219 | super.startActivityForResult(intent, requestCode, options)
220 | }
221 |
222 | /**
223 | * 获取[Context]
224 | */
225 | fun getContext() = this
226 | }
227 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseAndroidViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Application
4 | import androidx.annotation.StringRes
5 | import com.king.frame.mvvmframe.base.controller.ToastController
6 | import dagger.hilt.android.lifecycle.HiltViewModel
7 | import javax.inject.Inject
8 |
9 | /**
10 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
11 | *
12 | * 如果您继承使用了 BaseAndroidViewModel 或其子类，你需要参照如下方式添加 @HiltViewModel 和 @Inject 注解标记，来进行注入
13 | *
14 | * ```
15 | * // 示例
16 | * @HiltViewModel
17 | * class YourViewModel @Inject constructor(): BaseAndroidViewModel() {
18 | *
19 | * }
20 | * ```
21 | *
22 | * @author Jenly
23 | *
24 | * Follow me
25 | */
26 | @HiltViewModel
27 | open class BaseAndroidViewModel @Inject constructor(private val application: Application) :
28 | BaseViewModel() {
29 |
30 | /**
31 | * 获取[Application]
32 | */
33 | @Suppress("UNCHECKED_CAST")
34 | fun getApplication(): T {
35 | return application as T
36 | }
37 |
38 | /**
39 | * 发送消息；如果消息内容不为空，则将消息发送到页面，通过[ToastController.showToast]进行显示
40 | * @param resId 消息资源ID
41 | */
42 | fun sendMessage(@StringRes resId: Int) {
43 | sendMessage(application.stringResIdToString(resId))
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseApplication.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Application
4 | import android.view.Gravity
5 | import com.hjq.toast.Toaster
6 |
7 | /**
8 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
9 | *
10 | * 你需要参照如下方式添加 @HiltAndroidApp 注解
11 | *
12 | * ```
13 | * // 示例
14 | * @HiltAndroidApp
15 | * class YourApplication : BaseApplication() {
16 | *
17 | * }
18 | * ```
19 | * PS：如果由于某种原因，导致你不能继承[BaseApplication]；你也可以在你自定义的Application的onCreate函
20 | * 数中通过调用[BaseApplication.initAppConfig]来进行初始化
21 | *
22 | * @author Jenly
23 | *
24 | * Follow me
25 | */
26 | open class BaseApplication : Application() {
27 |
28 | override fun onCreate() {
29 | super.onCreate()
30 | initAppConfig(this)
31 | }
32 |
33 | companion object {
34 | /**
35 | * 初始化App配置
36 | */
37 | @JvmStatic
38 | fun initAppConfig(application: Application) {
39 | // 初始化Toaster
40 | Toaster.init(application)
41 | val offsetY = application.resources.displayMetrics.heightPixels / 6
42 | Toaster.setGravity(Gravity.BOTTOM, 0, offsetY)
43 | }
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseDialogFragment.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Dialog
4 | import android.content.Intent
5 | import android.os.Bundle
6 | import android.view.LayoutInflater
7 | import android.view.View
8 | import android.view.ViewGroup
9 | import android.view.Window
10 | import androidx.annotation.IdRes
11 | import androidx.databinding.DataBindingUtil
12 | import androidx.databinding.ViewDataBinding
13 | import androidx.fragment.app.DialogFragment
14 | import androidx.lifecycle.ViewModel
15 | import androidx.lifecycle.ViewModelProvider
16 | import androidx.lifecycle.flowWithLifecycle
17 | import androidx.lifecycle.lifecycleScope
18 | import com.king.frame.mvvmframe.base.BaseViewModel.Companion.getVMClass
19 | import com.king.frame.mvvmframe.base.controller.CombinedController
20 | import com.king.frame.mvvmframe.base.controller.DefaultCombinedController
21 | import com.king.frame.mvvmframe.util.JumpDebounce
22 | import kotlinx.coroutines.launch
23 |
24 | /**
25 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
26 | *
27 | * 如果您继承使用了 BaseDialogFragment 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解标记，来进行注入
28 | *
29 | * ```
30 | * // 示例
31 | * @AndroidEntryPoint
32 | * class YourFragment: BaseDialogFragment() {
33 | *
34 | * }
35 | * ```
36 | *
37 | * @author Jenly
38 | *
39 | * Follow me
40 | */
41 | @Suppress("unused")
42 | abstract class BaseDialogFragment : DialogFragment(),
43 | IView, CombinedController {
44 |
45 | protected open val combinedController: CombinedController by lazy {
46 | DefaultCombinedController(requireContext()).also {
47 | lifecycle.addObserver(it)
48 | }
49 | }
50 |
51 | private val jumpDebounce by lazy {
52 | JumpDebounce()
53 | }
54 |
55 | var rootView: View? = null
56 | private set
57 |
58 | lateinit var viewModel: VM
59 | private set
60 |
61 | var viewDataBinding: VDB? = null
62 | private set
63 |
64 | val binding: VDB
65 | get() = viewDataBinding!!
66 |
67 | override fun onCreateView(
68 | inflater: LayoutInflater,
69 | container: ViewGroup?,
70 | savedInstanceState: Bundle?
71 | ): View? {
72 | rootView = createRootView(inflater, container, savedInstanceState)
73 | if (isBinding()) {
74 | viewDataBinding = DataBindingUtil.bind(rootView!!)
75 | }
76 |
77 | return rootView
78 | }
79 |
80 | override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
81 | super.onViewCreated(view, savedInstanceState)
82 | initViewModel()
83 | initData(savedInstanceState)
84 | lifecycle.addObserver(combinedController)
85 | }
86 |
87 | override fun onDestroy() {
88 | super.onDestroy()
89 | viewDataBinding?.unbind()
90 | }
91 |
92 | /**
93 | * 创建 [rootView]
94 | */
95 | open fun createRootView(
96 | inflater: LayoutInflater,
97 | container: ViewGroup?,
98 | savedInstanceState: Bundle?
99 | ): View {
100 | return inflater.inflate(getLayoutId(), container, false)
101 | }
102 |
103 | /**
104 | * 初始化[viewModel]
105 | */
106 | private fun initViewModel() {
107 | viewModel = createViewModel()
108 | lifecycleScope.launch {
109 | viewModel.loadingState.flowWithLifecycle(lifecycle).collect {
110 | if (it) {
111 | showLoading()
112 | } else {
113 | hideLoading()
114 | }
115 | }
116 | }
117 | lifecycleScope.launch {
118 | viewModel.messageEvent.flowWithLifecycle(lifecycle).collect {
119 | showToast(it)
120 | }
121 | }
122 | }
123 |
124 | /**
125 | * 是否使用 ViewDataBinding；默认为：true
126 | */
127 | override fun isBinding(): Boolean {
128 | return true
129 | }
130 |
131 | /**
132 | * 创建ViewModel
133 | */
134 | override fun createViewModel(): VM {
135 | return obtainViewModel(getVMClass())
136 | }
137 |
138 | /**
139 | * 获取ViewModel
140 | */
141 | fun obtainViewModel(vmClass: Class): T {
142 | return ViewModelProvider(
143 | viewModelStore,
144 | defaultViewModelProviderFactory,
145 | defaultViewModelCreationExtras
146 | )[vmClass]
147 | }
148 |
149 | /**
150 | * 获取Activity持有的[ViewModel]
151 | */
152 | fun obtainActivityViewModel(vmClass: Class): T {
153 | return ViewModelProvider(
154 | requireActivity().viewModelStore,
155 | requireActivity().defaultViewModelProviderFactory,
156 | requireActivity().defaultViewModelCreationExtras
157 | )[vmClass]
158 | }
159 |
160 | override fun showLoading() {
161 | combinedController.showLoading()
162 | }
163 |
164 | override fun hideLoading() {
165 | combinedController.hideLoading()
166 | }
167 |
168 | override fun showProgressDialog(layoutId: Int, cancel: Boolean) {
169 | combinedController.showProgressDialog(layoutId, cancel)
170 | }
171 |
172 | override fun dismissProgressDialog() {
173 | combinedController.dismissProgressDialog()
174 | }
175 |
176 | override fun showDialog(
177 | contentView: View,
178 | styleId: Int,
179 | gravity: Int,
180 | widthRatio: Float,
181 | x: Int,
182 | y: Int,
183 | horizontalMargin: Float,
184 | verticalMargin: Float,
185 | horizontalWeight: Float,
186 | verticalWeight: Float,
187 | backCancel: Boolean
188 | ) {
189 | combinedController.showDialog(
190 | contentView = contentView,
191 | styleId = styleId,
192 | gravity = gravity,
193 | widthRatio = widthRatio,
194 | x = x,
195 | y = y,
196 | horizontalMargin = horizontalMargin,
197 | verticalMargin = verticalMargin,
198 | horizontalWeight = horizontalWeight,
199 | verticalWeight = verticalWeight,
200 | backCancel = backCancel,
201 | )
202 | }
203 |
204 | override fun setWindow(
205 | window: Window?,
206 | gravity: Int,
207 | widthRatio: Float,
208 | x: Int,
209 | y: Int,
210 | horizontalMargin: Float,
211 | verticalMargin: Float,
212 | horizontalWeight: Float,
213 | verticalWeight: Float
214 | ) {
215 | combinedController.setWindow(
216 | window = window,
217 | gravity = gravity,
218 | widthRatio = widthRatio,
219 | x = x,
220 | y = y,
221 | horizontalMargin = horizontalMargin,
222 | verticalMargin = verticalMargin,
223 | horizontalWeight = horizontalWeight,
224 | verticalWeight = verticalWeight,
225 | )
226 | }
227 |
228 | override fun dismissDialog() {
229 | combinedController.dismissDialog()
230 | }
231 |
232 | override fun dismissDialog(dialog: Dialog?) {
233 | combinedController.dismissDialog(dialog)
234 | }
235 |
236 | override fun showToast(text: CharSequence) {
237 | combinedController.showToast(text)
238 | }
239 |
240 | override fun showToast(resId: Int) {
241 | combinedController.showToast(resId)
242 | }
243 |
244 | @Suppress("DEPRECATION")
245 | @Deprecated("DeprecatedIsStillUsed")
246 | override fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?) {
247 | if (jumpDebounce.isIgnoreJump(intent)) {
248 | return
249 | }
250 | super.startActivityForResult(intent, requestCode, options)
251 | }
252 |
253 | fun findViewById(@IdRes id: Int): T? {
254 | return rootView?.findViewById(id)
255 | }
256 |
257 | fun finish() {
258 | requireActivity().finish()
259 | }
260 |
261 | }
262 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseFragment.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Dialog
4 | import android.content.Intent
5 | import android.os.Bundle
6 | import android.view.LayoutInflater
7 | import android.view.View
8 | import android.view.ViewGroup
9 | import android.view.Window
10 | import androidx.annotation.IdRes
11 | import androidx.databinding.DataBindingUtil
12 | import androidx.databinding.ViewDataBinding
13 | import androidx.fragment.app.Fragment
14 | import androidx.lifecycle.ViewModel
15 | import androidx.lifecycle.ViewModelProvider
16 | import androidx.lifecycle.flowWithLifecycle
17 | import androidx.lifecycle.lifecycleScope
18 | import com.king.frame.mvvmframe.base.BaseViewModel.Companion.getVMClass
19 | import com.king.frame.mvvmframe.base.controller.CombinedController
20 | import com.king.frame.mvvmframe.base.controller.DefaultCombinedController
21 | import com.king.frame.mvvmframe.util.JumpDebounce
22 | import kotlinx.coroutines.launch
23 |
24 | /**
25 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
26 | *
27 | * 如果您继承使用了 BaseFragment 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解标记，来进行注入
28 | *
29 | * ```
30 | * // 示例
31 | * @AndroidEntryPoint
32 | * class YourFragment: BaseFragment() {
33 | *
34 | * }
35 | * ```
36 | *
37 | * @author Jenly
38 | *
39 | * Follow me
40 | */
41 | @Suppress("unused")
42 | abstract class BaseFragment : Fragment(), IView,
43 | CombinedController {
44 |
45 | protected open val combinedController: CombinedController by lazy {
46 | DefaultCombinedController(requireContext()).also {
47 | lifecycle.addObserver(it)
48 | }
49 | }
50 |
51 | private val jumpDebounce by lazy {
52 | JumpDebounce()
53 | }
54 |
55 | var rootView: View? = null
56 | private set
57 |
58 | lateinit var viewModel: VM
59 | private set
60 |
61 | var viewDataBinding: VDB? = null
62 | private set
63 |
64 | val binding: VDB
65 | get() = viewDataBinding!!
66 |
67 | override fun onCreateView(
68 | inflater: LayoutInflater,
69 | container: ViewGroup?,
70 | savedInstanceState: Bundle?
71 | ): View? {
72 | rootView = createRootView(inflater, container, savedInstanceState)
73 | if (isBinding()) {
74 | viewDataBinding = DataBindingUtil.bind(rootView!!)
75 | }
76 |
77 | return rootView
78 | }
79 |
80 | override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
81 | super.onViewCreated(view, savedInstanceState)
82 | initViewModel()
83 | initData(savedInstanceState)
84 | lifecycle.addObserver(combinedController)
85 | }
86 |
87 | override fun onDestroy() {
88 | super.onDestroy()
89 | viewDataBinding?.unbind()
90 | }
91 |
92 | /**
93 | * 创建 [rootView]
94 | */
95 | open fun createRootView(
96 | inflater: LayoutInflater,
97 | container: ViewGroup?,
98 | savedInstanceState: Bundle?
99 | ): View {
100 | return inflater.inflate(getLayoutId(), container, false)
101 | }
102 |
103 | /**
104 | * 初始化[viewModel]
105 | */
106 | private fun initViewModel() {
107 | viewModel = createViewModel()
108 | lifecycleScope.launch {
109 | viewModel.loadingState.flowWithLifecycle(lifecycle).collect {
110 | if (it) {
111 | showLoading()
112 | } else {
113 | hideLoading()
114 | }
115 | }
116 | }
117 | lifecycleScope.launch {
118 | viewModel.messageEvent.flowWithLifecycle(lifecycle).collect {
119 | showToast(it)
120 | }
121 | }
122 | }
123 |
124 | /**
125 | * 是否使用 ViewDataBinding；默认为：true
126 | */
127 | override fun isBinding(): Boolean {
128 | return true
129 | }
130 |
131 | /**
132 | * 创建ViewModel
133 | */
134 | override fun createViewModel(): VM {
135 | return obtainViewModel(getVMClass())
136 | }
137 |
138 | /**
139 | * 获取ViewModel
140 | */
141 | fun obtainViewModel(vmClass: Class): T {
142 | return ViewModelProvider(
143 | viewModelStore,
144 | defaultViewModelProviderFactory,
145 | defaultViewModelCreationExtras
146 | )[vmClass]
147 | }
148 |
149 | /**
150 | * 获取Activity持有的[ViewModel]
151 | */
152 | fun obtainActivityViewModel(vmClass: Class): T {
153 | return ViewModelProvider(
154 | requireActivity().viewModelStore,
155 | requireActivity().defaultViewModelProviderFactory,
156 | requireActivity().defaultViewModelCreationExtras
157 | )[vmClass]
158 | }
159 |
160 | override fun showLoading() {
161 | combinedController.showLoading()
162 | }
163 |
164 | override fun hideLoading() {
165 | combinedController.hideLoading()
166 | }
167 |
168 | override fun showProgressDialog(layoutId: Int, cancel: Boolean) {
169 | combinedController.showProgressDialog(layoutId, cancel)
170 | }
171 |
172 | override fun dismissProgressDialog() {
173 | combinedController.dismissProgressDialog()
174 | }
175 |
176 | override fun showDialog(
177 | contentView: View,
178 | styleId: Int,
179 | gravity: Int,
180 | widthRatio: Float,
181 | x: Int,
182 | y: Int,
183 | horizontalMargin: Float,
184 | verticalMargin: Float,
185 | horizontalWeight: Float,
186 | verticalWeight: Float,
187 | backCancel: Boolean
188 | ) {
189 | combinedController.showDialog(
190 | contentView = contentView,
191 | styleId = styleId,
192 | gravity = gravity,
193 | widthRatio = widthRatio,
194 | x = x,
195 | y = y,
196 | horizontalMargin = horizontalMargin,
197 | verticalMargin = verticalMargin,
198 | horizontalWeight = horizontalWeight,
199 | verticalWeight = verticalWeight,
200 | backCancel = backCancel,
201 | )
202 | }
203 |
204 | override fun setWindow(
205 | window: Window?,
206 | gravity: Int,
207 | widthRatio: Float,
208 | x: Int,
209 | y: Int,
210 | horizontalMargin: Float,
211 | verticalMargin: Float,
212 | horizontalWeight: Float,
213 | verticalWeight: Float
214 | ) {
215 | combinedController.setWindow(
216 | window = window,
217 | gravity = gravity,
218 | widthRatio = widthRatio,
219 | x = x,
220 | y = y,
221 | horizontalMargin = horizontalMargin,
222 | verticalMargin = verticalMargin,
223 | horizontalWeight = horizontalWeight,
224 | verticalWeight = verticalWeight,
225 | )
226 | }
227 |
228 | override fun dismissDialog() {
229 | combinedController.dismissDialog()
230 | }
231 |
232 | override fun dismissDialog(dialog: Dialog?) {
233 | combinedController.dismissDialog(dialog)
234 | }
235 |
236 | override fun showToast(text: CharSequence) {
237 | combinedController.showToast(text)
238 | }
239 |
240 | override fun showToast(resId: Int) {
241 | combinedController.showToast(resId)
242 | }
243 |
244 | @Suppress("DEPRECATION")
245 | @Deprecated("DeprecatedIsStillUsed")
246 | override fun startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?) {
247 | if (jumpDebounce.isIgnoreJump(intent)) {
248 | return
249 | }
250 | super.startActivityForResult(intent, requestCode, options)
251 | }
252 |
253 | fun findViewById(@IdRes id: Int): T? {
254 | return rootView?.findViewById(id)
255 | }
256 |
257 | fun finish() {
258 | requireActivity().finish()
259 | }
260 |
261 | }
262 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseProgressDialog.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Dialog
4 | import android.content.Context
5 | import android.view.Gravity
6 | import com.king.frame.mvvmframe.R
7 |
8 | /**
9 | * 对话框基类
10 | *
11 | * @author Jenly
12 | *
13 | * Follow me
14 | */
15 | open class BaseProgressDialog : Dialog {
16 | constructor(context: Context) : this(context, R.style.mvvmframe_progress_dialog)
17 | constructor(context: Context, themeResId: Int) : super(context, themeResId) {
18 | window?.attributes?.gravity = Gravity.CENTER
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import androidx.lifecycle.ViewModel
4 | import androidx.lifecycle.viewModelScope
5 | import com.king.frame.mvvmframe.base.controller.ToastController
6 | import dagger.hilt.android.lifecycle.HiltViewModel
7 | import java.lang.reflect.ParameterizedType
8 | import kotlinx.coroutines.flow.Flow
9 | import kotlinx.coroutines.flow.MutableSharedFlow
10 | import kotlinx.coroutines.flow.MutableStateFlow
11 | import kotlinx.coroutines.flow.asSharedFlow
12 | import kotlinx.coroutines.flow.asStateFlow
13 | import kotlinx.coroutines.launch
14 | import javax.inject.Inject
15 |
16 | /**
17 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
18 | *
19 | * 如果您继承使用了 BaseViewModel 或其子类，你需要参照如下方式添加 @HiltViewModel 和 @Inject 注解标记，来进行注入
20 | *
21 | * ```
22 | * // 示例
23 | * @HiltViewModel
24 | * class YourViewModel @Inject constructor(): BaseViewModel() {
25 | *
26 | * }
27 | * ```
28 | *
29 | * @author Jenly
30 | *
31 | * Follow me
32 | */
33 | @HiltViewModel
34 | open class BaseViewModel @Inject constructor() : ViewModel() {
35 |
36 | /**
37 | * 加载状态
38 | */
39 | private val _loadingState: MutableStateFlow = MutableStateFlow(false)
40 |
41 | /**
42 | * 加载状态
43 | */
44 | val loadingState: Flow = _loadingState.asStateFlow()
45 |
46 | /**
47 | * 消息事件
48 | */
49 | private val _messageEvent: MutableSharedFlow = MutableSharedFlow()
50 |
51 | /**
52 | * 消息事件
53 | */
54 | val messageEvent: Flow = _messageEvent.asSharedFlow()
55 |
56 | /**
57 | * 显示加载状态
58 | */
59 | fun showLoading() {
60 | _loadingState.tryEmit(true)
61 | }
62 |
63 | /**
64 | * 隐藏加载状态
65 | */
66 | fun hideLoading() {
67 | _loadingState.tryEmit(false)
68 | }
69 |
70 | /**
71 | * 发送消息；如果消息内容不为空，则将消息发送到页面，通过[ToastController.showToast]进行显示
72 | * @param message 消息内容
73 | */
74 | fun sendMessage(message: String?) {
75 | message?.also {
76 | viewModelScope.launch {
77 | _messageEvent.emit(it)
78 | }
79 | }
80 | }
81 |
82 | companion object {
83 |
84 | /**
85 | * 获取泛型VM对应的类
86 | */
87 | @Suppress("UNCHECKED_CAST")
88 | internal fun Any.getVMClass(): Class {
89 | var cls: Class<*>? = this.javaClass
90 | var vmClass: Class? = null
91 | while (vmClass == null && cls != null) {
92 | vmClass = getVMClass(cls)
93 | cls = cls.superclass
94 | }
95 | if (vmClass == null) {
96 | vmClass = BaseViewModel::class.java as Class
97 | }
98 | return vmClass
99 | }
100 |
101 | /**
102 | * 根据传入的 cls 获取泛型VM对应的类
103 | */
104 | @Suppress("UNCHECKED_CAST")
105 | private fun getVMClass(cls: Class<*>): Class? {
106 | val type = cls.genericSuperclass
107 | if (type is ParameterizedType) {
108 | val types = type.actualTypeArguments
109 | for (t in types) {
110 | if (t is Class<*>) {
111 | if (BaseViewModel::class.java.isAssignableFrom(t)) {
112 | return t as? Class
113 | }
114 | } else if (t is ParameterizedType) {
115 | val rawType = t.rawType
116 | if (rawType is Class<*>) {
117 | if (BaseViewModel::class.java.isAssignableFrom(rawType)) {
118 | return rawType as? Class
119 | }
120 | }
121 | }
122 | }
123 | }
124 | return null
125 | }
126 | }
127 | }
128 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/ContentActivity.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.app.Activity
4 | import android.content.Intent
5 | import android.os.Bundle
6 | import androidx.annotation.IdRes
7 | import androidx.databinding.ViewDataBinding
8 | import androidx.fragment.app.Fragment
9 | import com.king.frame.mvvmframe.R
10 |
11 | /**
12 | * 用于容纳 [Fragment] 的通用 [Activity]，相当于一个 [Fragment] 容器，通过 [Intent] 传递参数和标识，
13 | * 然后实现 [switchFragment] 函数来处理对应的逻辑
14 | *
15 | * MVVMFrame 框架基于 Google 官方的 JetPack 构建，在使用 MVVMFrame 时，需遵循一些规范：
16 | *
17 | * 如果您继承使用了 BaseActivity 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解标记，来进行注入
18 | *
19 | * ```
20 | * // 示例
21 | * @AndroidEntryPoint
22 | * class YourActivity: ContentActivity() {
23 | *
24 | * }
25 | * ```
26 | *
27 | * @author Jenly
28 | *
29 | * Follow me
30 | */
31 | @Suppress("unused")
32 | abstract class ContentActivity : BaseActivity() {
33 |
34 | override fun getLayoutId(): Int {
35 | return R.layout.mvvmframe_content_activity
36 | }
37 |
38 | override fun initData(savedInstanceState: Bundle?) {
39 | switchFragment(intent)
40 | }
41 |
42 | override fun isBinding(): Boolean {
43 | return false
44 | }
45 |
46 | /**
47 | * 通过[getSupportFragmentManager]将布局替换成[Fragment]，如在[switchFragment]方法中使用
48 | */
49 | open fun replaceFragment(fragment: Fragment) {
50 | replaceFragment(R.id.fragmentContent, fragment)
51 | }
52 |
53 | /**
54 | * 通过[getSupportFragmentManager]将布局替换成[Fragment]
55 | */
56 | open fun replaceFragment(@IdRes id: Int, fragment: Fragment) {
57 | supportFragmentManager.beginTransaction().replace(id, fragment).commit()
58 | }
59 |
60 | /**
61 | * 切换Fragment
62 | * @param intent 通过[Intent] 传递参数和标记来判断对应展示某个[Fragment]
63 | */
64 | abstract fun switchFragment(intent: Intent)
65 | }
66 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/Ext.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.content.Context
4 | import android.content.res.Resources
5 |
6 | /**
7 | * 扩展函数
8 | *
9 | * @author Jenly
10 | *
11 | * Follow me
12 | */
13 |
14 | /**
15 | * 通过id获取对应的String资源
16 | */
17 | internal fun Context.stringResIdToString(id: Int): String {
18 | return resources.stringResIdToString(id)
19 | }
20 |
21 | /**
22 | * 通过id获取对应的String资源
23 | */
24 | internal fun Resources.stringResIdToString(id: Int): String {
25 | return try {
26 | this.getString(id)
27 | } catch (e: Resources.NotFoundException) {
28 | // 当找不到ID对应的资源时，则直接返回ID本身
29 | return id.toString()
30 | }
31 | }
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/IView.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base
2 |
3 | import android.os.Bundle
4 | import androidx.annotation.LayoutRes
5 | import androidx.lifecycle.ViewModel
6 |
7 | /**
8 | * 视图层定义一些共性需要实现的函数
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | */
14 | interface IView {
15 |
16 | /**
17 | * 获取根布局ID
18 | * @return
19 | */
20 | @LayoutRes
21 | fun getLayoutId(): Int
22 |
23 | /**
24 | * 初始化数据
25 | * @param savedInstanceState
26 | */
27 | fun initData(savedInstanceState: Bundle?)
28 |
29 | /**
30 | * 是否使用 ViewDataBinding
31 | */
32 | fun isBinding(): Boolean
33 |
34 | /**
35 | * 创建 [ViewModel]
36 | */
37 | fun createViewModel(): VM
38 |
39 | }
40 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/CombinedController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | /**
4 | * 组合控制器；默认实现请查看[DefaultCombinedController]
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | interface CombinedController : DialogController, LoadingController, ToastController
11 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/Controller.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import androidx.lifecycle.Lifecycle
4 | import androidx.lifecycle.LifecycleEventObserver
5 | import androidx.lifecycle.LifecycleOwner
6 |
7 | /**
8 | * 控制器定义
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | */
14 | interface Controller : LifecycleEventObserver {
15 |
16 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
17 |
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/DefaultCombinedController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.content.Context
4 | import androidx.lifecycle.Lifecycle
5 | import androidx.lifecycle.LifecycleOwner
6 |
7 | /**
8 | * 组合控制器
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | */
14 | class DefaultCombinedController(
15 | private val context: Context,
16 | private val dialogController: DialogController = DefaultDialogController(context),
17 | private val loadingController: LoadingController = DefaultLoadingController(context),
18 | private val toastController: ToastController = DefaultToastController(context),
19 | ) : CombinedController, DialogController by dialogController,
20 | LoadingController by loadingController,
21 | ToastController by toastController {
22 |
23 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
24 | dialogController.onStateChanged(source, event)
25 | loadingController.onStateChanged(source, event)
26 | toastController.onStateChanged(source, event)
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/DefaultDialogController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.app.Dialog
4 | import android.content.Context
5 | import android.content.DialogInterface
6 | import android.view.KeyEvent
7 | import android.view.View
8 | import android.view.Window
9 | import androidx.annotation.StyleRes
10 | import androidx.lifecycle.Lifecycle
11 | import androidx.lifecycle.LifecycleOwner
12 | import com.king.frame.mvvmframe.base.BaseProgressDialog
13 |
14 | /**
15 | * 对话框控制器
16 | *
17 | * @author Jenly
18 | *
19 | * Follow me
20 | */
21 | class DefaultDialogController(private val context: Context) : DialogController {
22 |
23 | private var dialog: Dialog? = null
24 |
25 | private var progressDialog: Dialog? = null
26 |
27 | /**
28 | * 显示进度对话框
29 | */
30 | override fun showProgressDialog(
31 | layoutId: Int,
32 | cancel: Boolean,
33 | ) {
34 | dismissProgressDialog()
35 | progressDialog = BaseProgressDialog(context).also {
36 | it.setContentView(layoutId)
37 | it.setCanceledOnTouchOutside(cancel)
38 | it.show()
39 | }
40 | }
41 |
42 | /**
43 | * 关闭进度对话框
44 | */
45 | override fun dismissProgressDialog() {
46 | dismissDialog(progressDialog)
47 | }
48 |
49 | /**
50 | * 显示对话框
51 | * @param contentView 弹框内容视图
52 | * @param styleId Dialog样式
53 | * @param gravity Dialog的对齐方式
54 | * @param widthRatio 宽度比例，根据屏幕宽度计算得来
55 | * @param x x轴偏移量，需与 gravity 结合使用
56 | * @param y y轴偏移量，需与 gravity 结合使用
57 | * @param horizontalMargin 水平方向边距
58 | * @param verticalMargin 垂直方向边距
59 | * @param horizontalWeight 水平方向权重
60 | * @param verticalWeight 垂直方向权重
61 | * @param backCancel 返回键是否可取消（默认为true，false则拦截back键）
62 | */
63 | override fun showDialog(
64 | contentView: View,
65 | @StyleRes styleId: Int,
66 | gravity: Int,
67 | widthRatio: Float,
68 | x: Int,
69 | y: Int,
70 | horizontalMargin: Float,
71 | verticalMargin: Float,
72 | horizontalWeight: Float,
73 | verticalWeight: Float,
74 | backCancel: Boolean,
75 | ) {
76 | dismissDialog()
77 | dialog = Dialog(context, styleId).also {
78 | it.setContentView(contentView)
79 | it.setCanceledOnTouchOutside(false)
80 | it.setOnKeyListener(DialogInterface.OnKeyListener { _, keyCode, _ ->
81 | if (keyCode == KeyEvent.KEYCODE_BACK) {
82 | if (backCancel) {
83 | dismissDialog()
84 | }
85 | return@OnKeyListener true
86 | }
87 | false
88 | })
89 | setWindow(
90 | window = it.window,
91 | gravity = gravity,
92 | widthRatio = widthRatio,
93 | x = x,
94 | y = y,
95 | horizontalMargin = horizontalMargin,
96 | verticalMargin = verticalMargin,
97 | horizontalWeight = horizontalWeight,
98 | verticalWeight = verticalWeight
99 | )
100 | it.show()
101 | }
102 |
103 | }
104 |
105 | /**
106 | * 设置 Window 布局相关参数
107 | * @param window [Window]
108 | * @param gravity Dialog的对齐方式
109 | * @param widthRatio 宽度比例，根据屏幕宽度计算得来
110 | * @param x x轴偏移量，需与 gravity 结合使用
111 | * @param y y轴偏移量，需与 gravity 结合使用
112 | * @param horizontalMargin 水平方向边距
113 | * @param verticalMargin 垂直方向边距
114 | * @param horizontalWeight 水平方向权重
115 | * @param verticalWeight 垂直方向权重
116 | */
117 | override fun setWindow(
118 | window: Window?,
119 | gravity: Int,
120 | widthRatio: Float,
121 | x: Int,
122 | y: Int,
123 | horizontalMargin: Float,
124 | verticalMargin: Float,
125 | horizontalWeight: Float,
126 | verticalWeight: Float,
127 | ) {
128 | window?.attributes?.let {
129 | it.width = (context.resources.displayMetrics.widthPixels * widthRatio).toInt()
130 | it.gravity = gravity
131 | it.x = x
132 | it.y = y
133 | it.horizontalMargin = horizontalMargin
134 | it.verticalMargin = verticalMargin
135 | it.horizontalWeight = horizontalWeight
136 | it.verticalWeight = verticalWeight
137 | window.attributes = it
138 | }
139 | }
140 |
141 | override fun dismissDialog() {
142 | dismissDialog(dialog)
143 | }
144 |
145 | /**
146 | * 关闭对话框
147 | */
148 | override fun dismissDialog(dialog: Dialog?) {
149 | dialog?.dismiss()
150 | }
151 |
152 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
153 | super.onStateChanged(source, event)
154 | when (event) {
155 | Lifecycle.Event.ON_DESTROY -> {
156 | dismissProgressDialog()
157 | dismissDialog()
158 | }
159 |
160 | else -> Unit
161 | }
162 | }
163 | }
164 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/DefaultLoadingController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.app.Dialog
4 | import android.content.Context
5 | import androidx.lifecycle.Lifecycle
6 | import androidx.lifecycle.LifecycleOwner
7 | import com.king.frame.mvvmframe.R
8 | import com.king.frame.mvvmframe.base.BaseProgressDialog
9 |
10 | /**
11 | * 加载控制器
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | class DefaultLoadingController(private val context: Context) : LoadingController {
18 |
19 | private var loadingDialog: Dialog? = null
20 |
21 | override fun showLoading() {
22 | hideLoading()
23 | loadingDialog = BaseProgressDialog(context).also {
24 | it.setContentView(R.layout.mvvmframe_loading)
25 | it.setCanceledOnTouchOutside(false)
26 | it.show()
27 | }
28 | }
29 |
30 | override fun hideLoading() {
31 | loadingDialog?.dismiss()
32 | }
33 |
34 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
35 | super.onStateChanged(source, event)
36 | when (event) {
37 | Lifecycle.Event.ON_DESTROY -> {
38 | hideLoading()
39 | }
40 |
41 | else -> Unit
42 | }
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/DefaultToastController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.content.Context
4 | import android.widget.Toast
5 | import androidx.lifecycle.Lifecycle
6 | import androidx.lifecycle.LifecycleOwner
7 | import com.hjq.toast.Toaster
8 | import com.king.frame.mvvmframe.base.stringResIdToString
9 |
10 | /**
11 | * 默认的Toast控制器
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | class DefaultToastController(private val context: Context) : ToastController {
18 |
19 | private var toast: Toast? = null
20 | private var isDestroy = false
21 |
22 | override fun showToast(text: CharSequence) {
23 | if (Toaster.isInit()) {
24 | Toaster.show(text)
25 | } else {
26 | show(text)
27 | }
28 | }
29 |
30 | override fun showToast(resId: Int) {
31 | showToast(context.applicationContext.stringResIdToString(resId))
32 | }
33 |
34 | private fun show(text: CharSequence) {
35 | if (isDestroy) {
36 | return
37 | }
38 | toast?.cancel()
39 | toast = Toast.makeText(context, text, Toast.LENGTH_SHORT)
40 | toast?.show()
41 | }
42 |
43 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
44 | super.onStateChanged(source, event)
45 | when (event) {
46 | Lifecycle.Event.ON_DESTROY -> {
47 | isDestroy = true
48 | toast?.cancel()
49 | toast = null
50 | }
51 |
52 | else -> Unit
53 | }
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/DialogController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.app.Dialog
4 | import android.view.Gravity
5 | import android.view.View
6 | import android.view.Window
7 | import androidx.annotation.StyleRes
8 | import com.king.frame.mvvmframe.R
9 |
10 | /**
11 | * 对话框控制器；默认实现请查看[DefaultDialogController]
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | interface DialogController : Controller {
18 |
19 | /**
20 | * 显示进度对话框
21 | */
22 | fun showProgressDialog(
23 | layoutId: Int = R.layout.mvvmframe_progress_dialog,
24 | cancel: Boolean = false,
25 | )
26 |
27 | /**
28 | * 关闭进度对话框
29 | */
30 | fun dismissProgressDialog()
31 |
32 | /**
33 | * 显示对话框
34 | * @param contentView 弹框内容视图
35 | * @param styleId Dialog样式
36 | * @param gravity Dialog的对齐方式
37 | * @param widthRatio 宽度比例，根据屏幕宽度计算得来
38 | * @param x x轴偏移量，需与 gravity 结合使用
39 | * @param y y轴偏移量，需与 gravity 结合使用
40 | * @param horizontalMargin 水平方向边距
41 | * @param verticalMargin 垂直方向边距
42 | * @param horizontalWeight 水平方向权重
43 | * @param verticalWeight 垂直方向权重
44 | * @param backCancel 返回键是否可取消（默认为true，false则拦截back键）
45 | */
46 | fun showDialog(
47 | contentView: View,
48 | @StyleRes styleId: Int = R.style.mvvmframe_dialog,
49 | gravity: Int = Gravity.NO_GRAVITY,
50 | widthRatio: Float = 0.85f,
51 | x: Int = 0,
52 | y: Int = 0,
53 | horizontalMargin: Float = 0f,
54 | verticalMargin: Float = 0f,
55 | horizontalWeight: Float = 0f,
56 | verticalWeight: Float = 0f,
57 | backCancel: Boolean = true
58 | )
59 |
60 | /**
61 | * 设置 Window 布局相关参数
62 | * @param window [Window]
63 | * @param gravity Dialog的对齐方式
64 | * @param widthRatio 宽度比例，根据屏幕宽度计算得来
65 | * @param x x轴偏移量，需与 gravity 结合使用
66 | * @param y y轴偏移量，需与 gravity 结合使用
67 | * @param horizontalMargin 水平方向边距
68 | * @param verticalMargin 垂直方向边距
69 | * @param horizontalWeight 水平方向权重
70 | * @param verticalWeight 垂直方向权重
71 | */
72 | fun setWindow(
73 | window: Window?,
74 | gravity: Int = Gravity.NO_GRAVITY,
75 | widthRatio: Float = 0.85f,
76 | x: Int = 0,
77 | y: Int = 0,
78 | horizontalMargin: Float = 0f,
79 | verticalMargin: Float = 0f,
80 | horizontalWeight: Float = 0f,
81 | verticalWeight: Float = 0f
82 | )
83 |
84 | /**
85 | * 关闭对话框
86 | */
87 | fun dismissDialog()
88 |
89 | /**
90 | * 关闭对话框
91 | */
92 | fun dismissDialog(dialog: Dialog?)
93 |
94 | }
95 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/LoadingController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | /**
4 | * 加载控制器；默认实现请查看[DefaultLoadingController]
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | interface LoadingController : Controller {
11 |
12 | /**
13 | * 显示加载中
14 | */
15 | fun showLoading()
16 |
17 | /**
18 | * 隐藏加载中
19 | */
20 | fun hideLoading()
21 |
22 | }
23 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/base/controller/ToastController.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.base.controller
2 |
3 | import android.widget.Toast
4 | import androidx.annotation.StringRes
5 |
6 | /**
7 | * Toast控制器；默认实现请查看[DefaultToastController]
8 | *
9 | * @author Jenly
10 | *
11 | * Follow me
12 | */
13 | interface ToastController : Controller {
14 |
15 | /**
16 | * 通过[Toast]显示提示信息
17 | */
18 | fun showToast(text: CharSequence)
19 |
20 | /**
21 | * 通过[Toast]显示提示信息
22 | */
23 | fun showToast(@StringRes resId: Int)
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/config/AppliesOptions.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.config
2 |
3 | import android.content.Context
4 | import androidx.room.RoomDatabase
5 | import com.google.gson.Gson
6 | import com.google.gson.GsonBuilder
7 | import com.king.frame.mvvmframe.di.module.ConfigModule
8 | import okhttp3.OkHttpClient
9 | import retrofit2.Retrofit
10 |
11 | /**
12 | * MVVMFrame全局配置
13 | *
14 | * @author Jenly
15 | *
16 | * Follow me
17 | */
18 | interface AppliesOptions {
19 | /**
20 | * 为框架提供一些配置参数入口
21 | * @param context
22 | * @param builder
23 | */
24 | fun applyOptions(context: Context, builder: ConfigModule.Builder)
25 |
26 | /**
27 | * 为框架中的[Retrofit]提供配置参数入口
28 | */
29 | interface RetrofitOptions {
30 | fun applyOptions(builder: Retrofit.Builder)
31 | }
32 |
33 | /**
34 | * 为框架中的[OkHttpClient]提供配置参数入口
35 | */
36 | interface OkHttpClientOptions {
37 | fun applyOptions(builder: OkHttpClient.Builder)
38 | }
39 |
40 | /**
41 | * 为框架中的[Gson]提供配置参数入口
42 | */
43 | interface GsonOptions {
44 | fun applyOptions(builder: GsonBuilder)
45 | }
46 |
47 | /**
48 | * 为框架中的[Config]提供配置参数入口
49 | */
50 | interface ConfigOptions {
51 | fun applyOptions(builder: Config.Builder)
52 | }
53 |
54 | /**
55 | * 为框架中的[RoomDatabase]提供配置参数入口
56 | */
57 | interface RoomDatabaseOptions {
58 | fun applyOptions(builder: RoomDatabase.Builder)
59 | }
60 | }
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/config/Config.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.config
2 |
3 | import androidx.collection.LruCache
4 | import androidx.room.RoomDatabase
5 | import com.king.frame.mvvmframe.data.datasource.DataSource
6 | import okhttp3.logging.HttpLoggingInterceptor
7 | import okhttp3.logging.HttpLoggingInterceptor.Level
8 | import retrofit2.converter.gson.GsonConverterFactory
9 |
10 | /**
11 | * 配置
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | class Config(builder: Builder) {
18 |
19 | internal val httpLoggingLevel: Level
20 | internal val isAddGsonConverterFactory: Boolean
21 | internal val retrofitServiceMaxCacheSize: Int
22 | internal val roomDatabaseMaxCacheSize: Int
23 |
24 | init {
25 | isAddGsonConverterFactory = builder.isAddGsonConverterFactory
26 | httpLoggingLevel = builder.httpLoggingLevel
27 | retrofitServiceMaxCacheSize = builder.retrofitServiceMaxCacheSize
28 | roomDatabaseMaxCacheSize = builder.roomDatabaseMaxCacheSize
29 | }
30 |
31 | /**
32 | * [Config.Builder]
33 | */
34 | @Suppress("unused")
35 | class Builder {
36 |
37 | internal var isAddGsonConverterFactory: Boolean = true
38 | internal var httpLoggingLevel: Level = Level.NONE
39 | internal var retrofitServiceMaxCacheSize = DEFAULT_RETROFIT_SERVICE_MAX_SIZE
40 | internal var roomDatabaseMaxCacheSize = DEFAULT_ROOM_DATABASE_MAX_SIZE
41 |
42 | /**
43 | * 配置是否添加 [GsonConverterFactory]；默认为：true
44 | */
45 | fun addGsonConverterFactory(addGsonConverterFactory: Boolean): Builder {
46 | this.isAddGsonConverterFactory = addGsonConverterFactory
47 | return this
48 | }
49 |
50 | /**
51 | * 配置 http日志级别 [HttpLoggingInterceptor]；默认为：[Level.BASIC]
52 | */
53 | fun httpLoggingLevel(level: Level): Builder {
54 | this.httpLoggingLevel = level
55 | return this
56 | }
57 |
58 | /**
59 | * [DataSource]中通过[DataSource.getRetrofitService]获取 service 实例的最大可缓存数量，
60 | * 采用[LruCache]缓存策略；默认值为：[DEFAULT_RETROFIT_SERVICE_MAX_SIZE]
61 | */
62 | fun retrofitServiceMaxCacheSize(size: Int): Builder {
63 | this.retrofitServiceMaxCacheSize = size
64 | return this
65 | }
66 |
67 | /**
68 | * [DataSource]中 通过 [DataSource.getRoomDatabase] 获取 [RoomDatabase] 实例的最大缓存数量，
69 | * 采用[LruCache]缓存策略；默认值为：[DEFAULT_ROOM_DATABASE_MAX_SIZE]
70 | */
71 | fun roomDatabaseMaxCacheSize(size: Int): Builder {
72 | this.roomDatabaseMaxCacheSize = size
73 | return this
74 | }
75 |
76 | /**
77 | * 构建[Config]
78 | */
79 | fun build(): Config {
80 | return Config(this)
81 | }
82 |
83 | override fun toString(): String {
84 | return "Builder(isAddGsonConverterFactory=$isAddGsonConverterFactory, " +
85 | "httpLoggingLevel=$httpLoggingLevel, " +
86 | "retrofitServiceMaxCacheSize=$retrofitServiceMaxCacheSize, " +
87 | "roomDatabaseMaxCacheSize=$roomDatabaseMaxCacheSize)"
88 | }
89 |
90 | }
91 |
92 | companion object {
93 |
94 | internal const val DEFAULT_RETROFIT_SERVICE_MAX_SIZE = 60
95 |
96 | internal const val DEFAULT_ROOM_DATABASE_MAX_SIZE = 10
97 | }
98 | }
99 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/config/FrameConfigModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.config
2 |
3 | /**
4 | * MVVMFrame全局配置
5 | *
6 | * @author Jenly
7 | *
8 | * Follow me
9 | */
10 | abstract class FrameConfigModule : AppliesOptions {
11 | /**
12 | * 是否启用解析配置
13 | * @return 默认返回{@code true}
14 | */
15 | open fun isManifestParsingEnabled(): Boolean {
16 | return true
17 | }
18 | }
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/config/ManifestParser.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.config
2 |
3 | import android.content.Context
4 | import android.content.pm.PackageManager
5 | import timber.log.Timber
6 |
7 | /**
8 | * Manifest解析器；实现参考 [ManifestParse](https://github.com/bumptech/glide/blob/f7d860412f061e059aa84a42f2563a01ac8c303b/library/src/main/java/com/bumptech/glide/module/ManifestParser.java)
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | *
14 | */
15 | class ManifestParser(private val context: Context) {
16 |
17 | /**
18 | * 解析
19 | */
20 | @Suppress("DEPRECATION")
21 | fun parse(): List {
22 | Timber.d("Loading MVVMFrame modules")
23 | val modules: MutableList = ArrayList()
24 | try {
25 | val appInfo = context.packageManager.getApplicationInfo(
26 | context.packageName,
27 | PackageManager.GET_META_DATA
28 | )
29 | if (appInfo.metaData == null) {
30 | Timber.d("Got null app info metadata")
31 | return modules
32 | }
33 | Timber.v("Got app info metadata: " + appInfo.metaData)
34 | for (key in appInfo.metaData.keySet()) {
35 | if (CONFIG_MODULE_VALUE == appInfo.metaData[key]) {
36 | modules.add(parseModule(key))
37 | Timber.d("Loaded MVVMFrame module: $key")
38 | }
39 | }
40 | } catch (e: PackageManager.NameNotFoundException) {
41 | throw RuntimeException("Unable to find metadata to parse FrameConfigModules", e)
42 | }
43 | Timber.d("Finished loading MVVMFrame modules")
44 | return modules
45 | }
46 |
47 | private fun parseModule(className: String): FrameConfigModule {
48 | val clazz = try {
49 | Class.forName(className)
50 | } catch (e: ClassNotFoundException) {
51 | throw IllegalArgumentException("Unable to find FrameConfigModule implementation", e)
52 | }
53 | val module = try {
54 | clazz.getDeclaredConstructor().newInstance()
55 | } catch (e: InstantiationException) {
56 | throw RuntimeException(
57 | "Unable to instantiate FrameConfigModule implementation for $clazz",
58 | e
59 | )
60 | } catch (e: IllegalAccessException) {
61 | throw RuntimeException(
62 | "Unable to instantiate FrameConfigModule implementation for $clazz",
63 | e
64 | )
65 | }
66 | if (module !is FrameConfigModule) {
67 | throw RuntimeException("Expected instanceof FrameConfigModule, but found: $module")
68 | }
69 | return module
70 | }
71 |
72 | companion object {
73 | private const val CONFIG_MODULE_VALUE = "FrameConfigModule"
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/data/DataRepository.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.data
2 |
3 | import androidx.room.Database
4 | import androidx.room.Room
5 | import androidx.room.RoomDatabase
6 | import com.king.frame.mvvmframe.data.datasource.DataSource
7 | import com.king.frame.mvvmframe.data.datasource.DefaultDataSource
8 | import javax.inject.Inject
9 | import javax.inject.Singleton
10 | import retrofit2.Retrofit
11 |
12 | /**
13 | * 数据仓库
14 | *
15 | * -------------------------------------------------
16 | *
17 | * 此类从v3.1.0版本开始已标记为废弃，后续版本可能会移除；
18 | *
19 | * 为了更适用于大型项目，所以细化了分层粒度；新增了数据源层：[DataSource]，然后将本类中原来提供获取
20 | * 的[getRetrofitService]和[getRoomDatabase]已迁移到[DataSource]，迁移后分层看起来更清晰。
21 | *
22 | * 后续获取[getRetrofitService]和[getRoomDatabase]请使用[DataSource]；通常在定义的Repository中
23 | * 持有[DataSource]即可。
24 | *
25 | * -------------------------------------------------
26 | *
27 | * @author Jenly
28 | *
29 | * Follow me
30 | */
31 | @Deprecated(
32 | "This Class is deprecated. Use DataSourceImpl instead",
33 | replaceWith = ReplaceWith(
34 | expression = "DataSourceImpl",
35 | imports = ["com.king.frame.mvvmframe.data.datasource.DataSourceImpl"]
36 | )
37 | )
38 | @Singleton
39 | open class DataRepository @Inject constructor() : Repository {
40 |
41 | @Inject
42 | internal lateinit var dataSource: DefaultDataSource
43 |
44 | /**
45 | * 传入API接口类的Class，通过[Retrofit.create] 获得对应的Class
46 | *
47 | * @param service [Retrofit] 对应的API接口定义
48 | * @param T 泛型[T]为具体的接口对象类型
49 | * @return [Retrofit.create]
50 | */
51 | override fun getRetrofitService(service: Class): T {
52 | return dataSource.getRetrofitService(service)
53 | }
54 |
55 | /**
56 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
57 | *
58 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
59 | * @param T 泛型[T]为数据库对象的类型
60 | */
61 | override fun getRoomDatabase(database: Class): T {
62 | return dataSource.getRoomDatabase(database)
63 | }
64 |
65 | /**
66 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
67 | *
68 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
69 | * @param dbName 数据库文件名称，当传值为空时，则文件名默认为[DefaultDataSource.DEFAULT_DATABASE_NAME]
70 | * @param T 泛型[T]为数据库对象的类型
71 | */
72 | override fun getRoomDatabase(database: Class, dbName: String?): T {
73 | return dataSource.getRoomDatabase(database, dbName)
74 | }
75 |
76 | }
77 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/data/Repository.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.data
2 |
3 | import androidx.room.Database
4 | import androidx.room.Room
5 | import androidx.room.RoomDatabase
6 | import com.king.frame.mvvmframe.data.datasource.DataSource
7 | import retrofit2.Retrofit
8 |
9 | /**
10 | * 数据仓库；具体实现请查看：[DataRepository]
11 | *
12 | * -------------------------------------------------
13 | *
14 | * 此类从v3.1.0版本开始已标记为废弃，后续版本可能会移除；
15 | *
16 | * 为了更适用于大型项目，所以细化了分层粒度；新增了数据源层：[DataSource]，然后将本类中原来提供获取
17 | * 的[getRetrofitService]和[getRoomDatabase]已迁移到[DataSource]，迁移后分层看起来更清晰。
18 | *
19 | * 后续获取[getRetrofitService]和[getRoomDatabase]请使用[DataSource]；通常在定义的Repository中
20 | * 持有[DataSource]即可。
21 | *
22 | * -------------------------------------------------
23 | *
24 | * @author Jenly
25 | *
26 | * Follow me
27 | *
28 | */
29 | @Deprecated(
30 | "This Class is deprecated. Use DataSource instead",
31 | replaceWith = ReplaceWith(
32 | expression = "DataSource",
33 | imports = ["com.king.frame.mvvmframe.data.datasource.DataSource"]
34 | )
35 | )
36 | interface Repository {
37 |
38 | /**
39 | * 传入API接口类的Class，通过[Retrofit.create] 获得对应的Class
40 | *
41 | * @param service [Retrofit] 对应的API接口定义
42 | * @param T 泛型[T]为具体的接口对象类型
43 | * @return [Retrofit.create]
44 | */
45 | fun getRetrofitService(service: Class): T
46 |
47 | /**
48 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
49 | *
50 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
51 | * @param T 泛型[T]为数据库对象的类型
52 | */
53 | fun getRoomDatabase(database: Class): T
54 |
55 | /**
56 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
57 | *
58 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
59 | * @param dbName 数据库文件名称
60 | * @param T 泛型[T]为数据库对象的类型
61 | */
62 | fun getRoomDatabase(database: Class, dbName: String?): T
63 |
64 | }
65 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/data/datasource/DataSource.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.data.datasource
2 |
3 | import androidx.room.Database
4 | import androidx.room.Room
5 | import androidx.room.RoomDatabase
6 | import retrofit2.Retrofit
7 |
8 | /**
9 | * 数据源；默认实现请查看：[DefaultDataSource]
10 | *
11 | * @author Jenly
12 | *
13 | * Follow me
14 | */
15 | interface DataSource {
16 |
17 | /**
18 | * 传入API接口类的Class，通过[Retrofit.create] 获得对应的Class
19 | *
20 | * @param service [Retrofit] 对应的API接口定义
21 | * @param T 泛型[T]为具体的接口对象类型
22 | * @return [Retrofit.create]
23 | */
24 | fun getRetrofitService(service: Class): T
25 |
26 | /**
27 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
28 | *
29 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
30 | * @param T 泛型[T]为数据库对象的类型
31 | */
32 | fun getRoomDatabase(database: Class): T
33 |
34 | /**
35 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
36 | *
37 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
38 | * @param dbName 数据库文件名称
39 | * @param T 泛型[T]为数据库对象的类型
40 | */
41 | fun getRoomDatabase(database: Class, dbName: String?): T
42 |
43 | }
44 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/data/datasource/DefaultDataSource.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.data.datasource
2 |
3 | import android.content.Context
4 | import androidx.collection.LruCache
5 | import androidx.room.Database
6 | import androidx.room.Room
7 | import androidx.room.Room.databaseBuilder
8 | import androidx.room.RoomDatabase
9 | import com.king.frame.mvvmframe.config.AppliesOptions.RoomDatabaseOptions
10 | import com.king.frame.mvvmframe.config.Config
11 | import dagger.hilt.android.qualifiers.ApplicationContext
12 | import javax.inject.Inject
13 | import javax.inject.Singleton
14 | import retrofit2.Retrofit
15 |
16 | /**
17 | * 默认的数据源
18 | *
19 | * @author Jenly
20 | *
21 | * Follow me
22 | */
23 | @Singleton
24 | open class DefaultDataSource @Inject constructor(
25 | @ApplicationContext private val context: Context,
26 | private val retrofit: Retrofit,
27 | private val config: Config,
28 | private val roomDatabaseOptions: RoomDatabaseOptions?,
29 | ) : DataSource {
30 |
31 | /**
32 | * 缓存 Retrofit Service
33 | */
34 | private val retrofitServiceCache: LruCache, Any> by lazy {
35 | LruCache(config.retrofitServiceMaxCacheSize)
36 | }
37 |
38 | /**
39 | * 缓存 RoomDatabase
40 | */
41 | private val roomDatabaseCache: LruCache, Any> by lazy {
42 | LruCache(config.roomDatabaseMaxCacheSize)
43 | }
44 |
45 | /**
46 | * 传入API接口类的Class，通过[Retrofit.create] 获得对应的Class
47 | *
48 | * @param service [Retrofit] 对应的API接口定义
49 | * @param T 泛型[T]为具体的接口对象类型
50 | * @return [Retrofit.create]
51 | */
52 | @Suppress("UNCHECKED_CAST")
53 | override fun getRetrofitService(service: Class): T {
54 | var retrofitService = retrofitServiceCache[service] as? T
55 | if (retrofitService == null) {
56 | synchronized(retrofitServiceCache) {
57 | retrofitService = retrofit.create(service)
58 | // 缓存
59 | retrofitServiceCache.put(service, retrofitService!!)
60 | }
61 | }
62 | return retrofitService!!
63 | }
64 |
65 | /**
66 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
67 | *
68 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
69 | * @param T 泛型[T]为数据库对象的类型
70 | */
71 | override fun getRoomDatabase(database: Class): T {
72 | return getRoomDatabase(database, null)
73 | }
74 |
75 | /**
76 | * 传入数据库类的Class，通过[Room.databaseBuilder]获得对应的[RoomDatabase] 实现
77 | *
78 | * @param database 数据库抽象类；用注解[Database]注释并继承[RoomDatabase]的抽象类
79 | * @param dbName 数据库文件名称，当传值为空时，则文件名默认为[DEFAULT_DATABASE_NAME]
80 | * @param T 泛型[T]为数据库对象的类型
81 | */
82 | @Suppress("UNCHECKED_CAST")
83 | override fun getRoomDatabase(database: Class, dbName: String?): T {
84 | var roomDatabase = roomDatabaseCache[database] as? T
85 | if (roomDatabase == null) {
86 | synchronized(roomDatabaseCache) {
87 | val builder: RoomDatabase.Builder = databaseBuilder(
88 | context = context,
89 | klass = database,
90 | name = dbName?.takeIf { it.isNotBlank() } ?: DEFAULT_DATABASE_NAME
91 | )
92 | roomDatabaseOptions?.applyOptions(builder)
93 |
94 | roomDatabase = builder.build().also {
95 | // 缓存
96 | roomDatabaseCache.put(database, it)
97 | }
98 | }
99 | }
100 | return roomDatabase!!
101 | }
102 |
103 | companion object {
104 | internal const val DEFAULT_DATABASE_NAME = "room.dp"
105 | }
106 | }
107 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/di/module/ConfigModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.di.module
2 |
3 | import android.content.Context
4 | import androidx.room.RoomDatabase
5 | import com.king.frame.mvvmframe.config.AppliesOptions.ConfigOptions
6 | import com.king.frame.mvvmframe.config.AppliesOptions.GsonOptions
7 | import com.king.frame.mvvmframe.config.AppliesOptions.OkHttpClientOptions
8 | import com.king.frame.mvvmframe.config.AppliesOptions.RetrofitOptions
9 | import com.king.frame.mvvmframe.config.AppliesOptions.RoomDatabaseOptions
10 | import com.king.frame.mvvmframe.config.ManifestParser
11 | import com.king.retrofit.retrofithelper.RetrofitHelper
12 | import dagger.Module
13 | import dagger.Provides
14 | import dagger.hilt.InstallIn
15 | import dagger.hilt.android.qualifiers.ApplicationContext
16 | import dagger.hilt.components.SingletonComponent
17 | import okhttp3.HttpUrl
18 | import okhttp3.HttpUrl.Companion.toHttpUrl
19 | import java.util.Objects
20 | import javax.inject.Singleton
21 |
22 | /**
23 | * 配置注入
24 | *
25 | * @author Jenly
26 | *
27 | * Follow me
28 | */
29 | @InstallIn(SingletonComponent::class)
30 | @Module
31 | object ConfigModule {
32 | @Singleton
33 | @Provides
34 | fun provideBaseUrl(builder: Builder): HttpUrl {
35 | var baseUrl = builder.baseUrl
36 | if (baseUrl == null) { // 如果 mBaseUrl 为空表示没有在自定义配置 FrameConfigModule 中配过 BaseUrl
37 | // 尝试去 RetrofitHelper 中取一次 BaseUrl，这里相当于多支持一种配置 BaseUrl 的方式
38 | baseUrl = RetrofitHelper.getInstance().baseUrl
39 | }
40 | // 再次检测 mBaseUrl 是否为空，如果依旧为空，表示两种配置方式都没有配置过，则直接抛出异常
41 | Objects.requireNonNull(baseUrl, "baseUrl == null")
42 | return baseUrl!!
43 | }
44 |
45 | @Singleton
46 | @Provides
47 | fun provideRetrofitOptions(builder: Builder): RetrofitOptions? {
48 | return builder.retrofitOptions
49 | }
50 |
51 | @Singleton
52 | @Provides
53 | fun provideOkHttpClientOptions(builder: Builder): OkHttpClientOptions? {
54 | return builder.okHttpClientOptions
55 | }
56 |
57 | @Singleton
58 | @Provides
59 | fun provideGsonOptions(builder: Builder): GsonOptions? {
60 | return builder.gsonOptions
61 | }
62 |
63 | @Singleton
64 | @Provides
65 | fun provideConfigOptions(builder: Builder): ConfigOptions? {
66 | return builder.configOptions
67 | }
68 |
69 | @Singleton
70 | @Provides
71 | fun provideRoomDatabaseOptions(builder: Builder): RoomDatabaseOptions? {
72 | return builder.roomDatabaseOptions
73 | }
74 |
75 | @Singleton
76 | @Provides
77 | fun provideConfigModuleBuilder(@ApplicationContext context: Context): Builder {
78 | val builder = Builder()
79 | // 解析配置
80 | val modules = ManifestParser(context).parse()
81 | // 遍历配置
82 | for (configModule in modules) {
83 | // 如果启用则申请配置参数
84 | if (configModule.isManifestParsingEnabled()) {
85 | configModule.applyOptions(context, builder)
86 | }
87 | }
88 | return builder
89 | }
90 |
91 | class Builder {
92 | internal var baseUrl: HttpUrl? = null
93 | internal var retrofitOptions: RetrofitOptions? = null
94 | internal var okHttpClientOptions: OkHttpClientOptions? = null
95 | internal var gsonOptions: GsonOptions? = null
96 | internal var configOptions: ConfigOptions? = null
97 | internal var roomDatabaseOptions: RoomDatabaseOptions? = null
98 | fun baseUrl(baseUrl: String): Builder {
99 | this.baseUrl = baseUrl.toHttpUrl()
100 | return this
101 | }
102 |
103 | fun baseUrl(baseUrl: HttpUrl): Builder {
104 | this.baseUrl = baseUrl
105 | return this
106 | }
107 |
108 | fun retrofitOptions(retrofitOptions: RetrofitOptions): Builder {
109 | this.retrofitOptions = retrofitOptions
110 | return this
111 | }
112 |
113 | fun okHttpClientOptions(okHttpClientOptions: OkHttpClientOptions): Builder {
114 | this.okHttpClientOptions = okHttpClientOptions
115 | return this
116 | }
117 |
118 | fun gsonOptions(gsonOptions: GsonOptions): Builder {
119 | this.gsonOptions = gsonOptions
120 | return this
121 | }
122 |
123 | fun configOptions(configOptions: ConfigOptions): Builder {
124 | this.configOptions = configOptions
125 | return this
126 | }
127 |
128 | fun roomDatabaseOptions(roomDatabaseOptions: RoomDatabaseOptions): Builder {
129 | this.roomDatabaseOptions = roomDatabaseOptions
130 | return this
131 | }
132 | }
133 |
134 | }
135 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/di/module/DataSourceModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.di.module
2 |
3 | import com.king.frame.mvvmframe.data.datasource.DataSource
4 | import com.king.frame.mvvmframe.data.datasource.DefaultDataSource
5 | import dagger.Binds
6 | import dagger.Module
7 | import dagger.hilt.InstallIn
8 | import dagger.hilt.components.SingletonComponent
9 |
10 | /**
11 | * 数据源 注入
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | @InstallIn(SingletonComponent::class)
18 | @Module
19 | abstract class DataSourceModule {
20 |
21 | /**
22 | * 绑定DataSource
23 | */
24 | @Binds
25 | abstract fun bindDataSource(dataSource: DefaultDataSource): DataSource
26 | }
27 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/di/module/HttpModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.di.module
2 |
3 | import com.google.gson.Gson
4 | import com.google.gson.GsonBuilder
5 | import com.king.frame.mvvmframe.config.AppliesOptions
6 | import com.king.frame.mvvmframe.config.AppliesOptions.GsonOptions
7 | import com.king.frame.mvvmframe.config.AppliesOptions.OkHttpClientOptions
8 | import com.king.frame.mvvmframe.config.AppliesOptions.RetrofitOptions
9 | import com.king.frame.mvvmframe.config.Config
10 | import com.king.retrofit.retrofithelper.RetrofitHelper
11 | import dagger.Module
12 | import dagger.Provides
13 | import dagger.hilt.InstallIn
14 | import dagger.hilt.components.SingletonComponent
15 | import okhttp3.HttpUrl
16 | import okhttp3.OkHttpClient
17 | import okhttp3.logging.HttpLoggingInterceptor
18 | import retrofit2.Retrofit
19 | import retrofit2.converter.gson.GsonConverterFactory
20 | import timber.log.Timber
21 | import javax.inject.Singleton
22 |
23 | /**
24 | * Http相关注入
25 | *
26 | * @author Jenly
27 | *
28 | * Follow me
29 | */
30 | @InstallIn(SingletonComponent::class)
31 | @Module
32 | object HttpModule {
33 |
34 | @Singleton
35 | @Provides
36 | fun provideRetrofit(builder: Retrofit.Builder, options: RetrofitOptions?): Retrofit {
37 | options?.applyOptions(builder)
38 | return builder.build()
39 | }
40 |
41 | @Singleton
42 | @Provides
43 | fun provideOkHttpClient(
44 | builder: OkHttpClient.Builder,
45 | config: Config,
46 | options: OkHttpClientOptions?
47 | ): OkHttpClient {
48 | options?.applyOptions(builder)
49 | val loggingInterceptor = HttpLoggingInterceptor().apply {
50 | level = config.httpLoggingLevel
51 | }
52 | builder.addInterceptor(loggingInterceptor)
53 | return builder.build()
54 | }
55 |
56 | @Singleton
57 | @Provides
58 | fun provideGson(builder: GsonBuilder, options: GsonOptions?): Gson {
59 | options?.applyOptions(builder)
60 | return builder.create()
61 | }
62 |
63 | @Singleton
64 | @Provides
65 | fun provideConfig(
66 | builder: Config.Builder,
67 | options: AppliesOptions.ConfigOptions?
68 | ): Config {
69 | options?.applyOptions(builder)
70 | return builder.build()
71 | }
72 |
73 | @Singleton
74 | @Provides
75 | fun provideRetrofitBuilder(
76 | httpUrl: HttpUrl,
77 | client: OkHttpClient,
78 | gson: Gson,
79 | config: Config
80 | ): Retrofit.Builder {
81 | val builder = Retrofit.Builder()
82 | builder.baseUrl(httpUrl)
83 | .client(client)
84 | if (config.isAddGsonConverterFactory) {
85 | builder.addConverterFactory(GsonConverterFactory.create(gson))
86 | }
87 | return builder
88 | }
89 |
90 | @Singleton
91 | @Provides
92 | fun provideClientBuilder(): OkHttpClient.Builder {
93 | return RetrofitHelper.getInstance().createClientBuilder()
94 | }
95 |
96 | @Singleton
97 | @Provides
98 | fun provideGsonBuilder(): GsonBuilder {
99 | return GsonBuilder()
100 | }
101 |
102 | @Singleton
103 | @Provides
104 | fun provideConfigBuilder(): Config.Builder {
105 | return Config.Builder()
106 | }
107 |
108 | private const val TAG = "OkHttp"
109 | }
110 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/di/module/RepositoryModule.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.di.module
2 |
3 | import com.king.frame.mvvmframe.data.DataRepository
4 | import com.king.frame.mvvmframe.data.Repository
5 | import dagger.Binds
6 | import dagger.Module
7 | import dagger.hilt.InstallIn
8 | import dagger.hilt.components.SingletonComponent
9 |
10 | /**
11 | * 仓库注入
12 | *
13 | * @author Jenly
14 | *
15 | * Follow me
16 | */
17 | @Deprecated(
18 | "This Class is deprecated. Use DataModule instead",
19 | replaceWith = ReplaceWith(
20 | expression = "DataModule",
21 | imports = ["com.king.frame.mvvmframe.di.module.DataModule"]
22 | )
23 | )
24 | @InstallIn(SingletonComponent::class)
25 | @Module
26 | abstract class RepositoryModule {
27 |
28 | /**
29 | * 绑定Repository
30 | */
31 | @Binds
32 | abstract fun bindRepository(dataRepository: DataRepository): Repository
33 | }
34 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/java/com/king/frame/mvvmframe/util/JumpDebounce.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvmframe.util
2 |
3 | import android.content.Intent
4 | import android.os.SystemClock
5 | import timber.log.Timber
6 |
7 | /**
8 | * 跳转防抖
9 | *
10 | * @author Jenly
11 | *
12 | * Follow me
13 | */
14 | internal class JumpDebounce {
15 | private var lastTag: String? = null
16 | private var lastJumpTime: Long = 0L
17 |
18 | /**
19 | * 是否忽略跳转
20 | */
21 | fun isIgnoreJump(intent: Intent, intervalTime: Int = DEBOUNCE_INTERVAL_TIME): Boolean {
22 | val jumpTag = if (intent.component != null) {
23 | intent.component!!.className
24 | } else if (intent.action != null) {
25 | intent.action
26 | } else {
27 | null
28 | }
29 | if (jumpTag.isNullOrEmpty()) {
30 | return false
31 | }
32 | if (jumpTag == lastTag && lastJumpTime > SystemClock.elapsedRealtime() - intervalTime) {
33 | Timber.d("Ignore Intent:$jumpTag")
34 | return true
35 | }
36 | lastTag = jumpTag
37 | lastJumpTime = SystemClock.elapsedRealtime()
38 | return false
39 | }
40 |
41 | companion object {
42 | const val DEBOUNCE_INTERVAL_TIME = 500
43 | }
44 | }
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/anim/mvvmframe_dialog_in.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/anim/mvvmframe_dialog_out.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/drawable/mvvmframe_loading.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
12 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/drawable/mvvmframe_progress.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
12 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/layout/mvvmframe_content_activity.xml:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/layout/mvvmframe_loading.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/layout/mvvmframe_progress_dialog.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #01847f
4 | @color/colorAccent
5 | @color/colorAccent
6 |
7 |
8 |
--------------------------------------------------------------------------------
/mvvmframe/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
9 |
10 |
11 |
20 |
21 |
22 |
32 |
--------------------------------------------------------------------------------
/mvvmframe/src/test/java/com/king/frame/mvvm/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package com.king.frame.mvvm
2 |
3 | import org.junit.Assert.assertEquals
4 | import org.junit.Test
5 |
6 | /**
7 | * Example local unit test, which will execute on the development machine (host).
8 | *
9 | * See [testing documentation](http://d.android.com/tools/testing).
10 | */
11 | class ExampleUnitTest {
12 | @Test
13 | fun addition_isCorrect() {
14 | assertEquals(4, 2 + 2)
15 | }
16 | }
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | pluginManagement {
2 |
3 | repositories {
4 | // maven { url = uri("https://maven.aliyun.com/repository/gradle-plugin") }
5 | // maven { url = uri("https://maven.aliyun.com/repository/central") }
6 | // maven { url = uri("https://maven.aliyun.com/repository/google") }
7 | gradlePluginPortal()
8 | google()
9 | mavenCentral()
10 | }
11 | }
12 |
13 | dependencyResolutionManagement {
14 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
15 | repositories {
16 | // maven { url = uri("https://maven.aliyun.com/repository/central") }
17 | // maven { url = uri("https://maven.aliyun.com/repository/google") }
18 | google()
19 | mavenCentral()
20 | maven { url = uri("https://jitpack.io") }
21 |
22 | }
23 | }
24 | rootProject.name = "MVVMFrame"
25 | include(":app")
26 | include(":mvvmframe")
27 | include(":mvvmframe-plugin")
28 |
29 |
--------------------------------------------------------------------------------