优化细节

Author: jenly1314

README.md

@@ -40,7 +40,7 @@ allprojects {
 #### **v2.x**（使用 **Hilt** 简化 **Dagger2** 依赖注入用法）
 ```gradle
 //AndroidX 版本
-implementation 'com.github.jenly1314:mvvmframe:2.2.0'
+implementation 'com.github.jenly1314:mvvmframe:2.2.1'
 
 ```
 
@@ -545,6 +545,11 @@ public interface ApplicationComponent {
 
 ## 版本记录
 
+#### v2.2.1：2022-04-21
+*  更新Okhttp至v4.9.3
+*  更新Hilt至v2.41
+*  更新Gson至v2.9.0
+
 #### v2.2.0：2021-11-18
 *  minSdk要求从 16+ 改为 21+
 *  更新编译SDK至30

app/release/app-release.apk

@@ -10,8 +10,8 @@
     {
       "type": "SINGLE",
       "filters": [],
-      "versionCode": 12,
-      "versionName": "2.2.0",
+      "versionCode": 13,
+      "versionName": "2.2.1",
       "outputFile": "app-release.apk"
     }
   ]

app/release/output-metadata.json

@@ -34,7 +34,7 @@
  * 其中，只有 Application 这个入口点是使用 @HiltAndroidApp 注解来声明，示例如下
  *
  *
- * @example: Application
+ * Example: Application
  * //-------------------------
  *    @HiltAndroidApp
  *    public class YourApplication extends Application {

app/src/main/java/com/king/mvvmframe/MainActivity.java

@@ -27,6 +27,14 @@ task clean(type: Delete) {
     delete rootProject.buildDir
 }
 
+allprojects {
+    plugins.withId("com.vanniktech.maven.publish") {
+        mavenPublish {
+            sonatypeHost = "S01"
+        }
+    }
+}
+
 allprojects {
     tasks.withType(Javadoc) {
         options{

build.gradle

@@ -14,23 +14,29 @@ org.gradle.jvmargs = -Xmx1536m
 android.useAndroidX=true
 android.enableJetifier=true
 
-VERSION_NAME=2.2.0
-VERSION_CODE=12
+VERSION_NAME=2.2.1
+VERSION_CODE=13
 GROUP=com.github.jenly1314
 
 POM_DESCRIPTION=MVVMFrame for Android
 POM_URL=https://github.com/jenly1314/MVVMFrame
+
 POM_SCM_URL=https://github.com/jenly1314/MVVMFrame
 POM_SCM_CONNECTION=scm:git@github.com:jenly1314/MVVMFrame.git
 POM_SCM_DEV_CONNECTION=scm:git@github.com:jenly1314/MVVMFrame.git
+
 POM_LICENCE_NAME=The MIT License
 POM_LICENCE_URL=https://opensource.org/licenses/mit-license.php
 #POM_LICENCE_NAME=The Apache Software License, Version 2.0
 #POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
+POM_LICENSE_DIST=repo
+
 POM_DEVELOPER_ID=jenly
 POM_DEVELOPER_NAME=Jenly Yu
+POM_DEVELOPER_URL=https://github.com/jenly1314/
+
 RELEASE_REPOSITORY_URL=https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/
 SNAPSHOT_REPOSITORY_URL=https://s01.oss.sonatype.org/content/repositories/snapshots/
-RELEASE_SIGNING_ENABLED=false
 
+RELEASE_SIGNING_ENABLED=false
 

gradle.properties

@@ -45,12 +45,6 @@ task javadoc(type: Javadoc) {
     classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
 }
 
-repositories {
-    flatDir {
-        dirs 'libs' //this way we can find the .aar file in libs folder
-    }
-
-}
 
 
 dependencies {

mvvmframe/build.gradle

@@ -47,7 +47,7 @@
  *
  * <p>如果您继承使用了 BaseActivity 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解
  *
- * <p>Example: BaseActivity
+ * <p>Example:
  * <pre>
  *    &#64;AndroidEntryPoint
  *    public class YourActivity extends BaseActivity {
@@ -60,11 +60,11 @@
 public abstract class BaseActivity<VM extends BaseViewModel,VDB extends ViewDataBinding> extends AppCompatActivity implements IView<VM>, BaseNavigator {
 
     /**
-     * 请通过 {@link #getViewModel()}获取，后续版本 {@link #mViewModel}可能会私有化
+     * 请通过 {@link #getViewModel()}获取
      */
     private VM mViewModel;
     /**
-     * 请通过 {@link #getViewDataBinding()}获取，后续版本 {@link #mBinding}可能会私有化
+     * 请通过 {@link #getViewDataBinding()}获取
      */
     private VDB mBinding;
 
@@ -109,6 +109,10 @@ private void initViewModel(){
         }
     }
 
+    /**
+     * 获取泛型VM对应的类
+     * @return
+     */
     private Class<VM> getVMClass(){
         Class<?> cls = getClass();
         Class<VM> vmClass = null;
@@ -122,6 +126,11 @@ private Class<VM> getVMClass(){
         return vmClass;
     }
 
+    /**
+     * 根据传入的 cls 获取泛型VM对应的类
+     * @param cls
+     * @return
+     */
     private Class getVMClass(Class<?> cls){
         Type type = cls.getGenericSuperclass();
         if(type instanceof ParameterizedType){

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseActivity.java

@@ -8,7 +8,7 @@
  *
  * <p>如果您继承使用了 BaseBroadcastReceiver 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解
  *
- * <p>Example: BaseBroadcastReceiver
+ * <p>Example:
  * <pre>
  *    &#64;AndroidEntryPoint
  *    public class YourBroadcastReceiver extends BaseBroadcastReceiver {

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseBroadcastReceiver.java

@@ -45,7 +45,7 @@
  *
  * <p>如果您继承使用了 BaseDialogFragment 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解
  *
- * <p>Example: BaseDialogFragment
+ * <p>Example:
  * <pre>
  *    &#64;AndroidEntryPoint
  *    public class YourFragment extends BaseDialogFragment {
@@ -58,15 +58,15 @@
 public abstract class BaseDialogFragment<VM extends BaseViewModel,VDB extends ViewDataBinding> extends DialogFragment implements IView<VM>, BaseNavigator {
 
     /**
-     * 请通过 {@link #getViewModel()}获取，后续版本 {@link #mViewModel}可能会私有化
+     * 请通过 {@link #getViewModel()} 获取
      */
     private VM mViewModel;
     /**
-     * 请通过 {@link #getViewDataBinding()}获取，后续版本 {@link #mBinding}可能会私有化
+     * 请通过 {@link #getViewDataBinding()} 获取
      */
     private VDB mBinding;
     /**
-     * 请通过 {@link #getRootView()} ()}获取，后续版本 {@link #mRootView}可能会私有化
+     * 请通过 {@link #getRootView()} 获取
      */
     private View mRootView;
 
@@ -155,6 +155,10 @@ private void initViewModel(){
         }
     }
 
+    /**
+     * 获取泛型VM对应的类
+     * @return
+     */
     private Class<VM> getVMClass(){
         Class<?> cls = getClass();
         Class<VM> vmClass = null;
@@ -168,6 +172,11 @@ private Class<VM> getVMClass(){
         return vmClass;
     }
 
+    /**
+     * 根据传入的 cls 获取泛型VM对应的类
+     * @param cls
+     * @return
+     */
     private Class getVMClass(Class<?> cls){
         Type type = cls.getGenericSuperclass();
         if(type instanceof ParameterizedType){
@@ -320,9 +329,7 @@ private ViewModelProvider createViewModelProvider(@NonNull ViewModelStoreOwner o
 
     //---------------------------------------
     protected void finish(){
-        if(getActivity() != null){
-            getActivity().finish();
-        }
+        requireActivity().finish();
     }
 
     protected Intent newIntent(Class<?> cls){

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseDialogFragment.java

@@ -49,7 +49,7 @@
  *
  * <p>如果您继承使用了 BaseFragment 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解
  *
- * <p>Example: BaseFragment
+ * <p>Example:
  * <pre>
  *    &#64;AndroidEntryPoint
  *    public class YourFragment extends BaseFragment {
@@ -62,15 +62,15 @@
 public abstract class BaseFragment<VM extends BaseViewModel,VDB extends ViewDataBinding> extends Fragment implements IView<VM>, BaseNavigator {
 
     /**
-     * 请通过 {@link #getViewModel()}获取，后续版本 {@link #mViewModel}可能会私有化
+     * 请通过 {@link #getViewModel()} 获取
      */
     private VM mViewModel;
     /**
-     * 请通过 {@link #getViewDataBinding()}获取，后续版本 {@link #mBinding}可能会私有化
+     * 请通过 {@link #getViewDataBinding()} 获取
      */
     private VDB mBinding;
     /**
-     * 请通过 {@link #getRootView()} ()}获取，后续版本 {@link #mRootView}可能会私有化
+     * 请通过 {@link #getRootView()} 获取
      */
     private View mRootView;
 
@@ -138,6 +138,10 @@ private void initViewModel(){
         }
     }
 
+    /**
+     * 获取泛型VM对应的类
+     * @return
+     */
     private Class<VM> getVMClass(){
         Class<?> cls = getClass();
         Class<VM> vmClass = null;
@@ -151,6 +155,11 @@ private Class<VM> getVMClass(){
         return vmClass;
     }
 
+    /**
+     * 根据传入的 cls 获取泛型VM对应的类
+     * @param cls
+     * @return
+     */
     private Class getVMClass(Class<?> cls){
         Type type = cls.getGenericSuperclass();
         if(type instanceof ParameterizedType){
@@ -302,9 +311,7 @@ private ViewModelProvider createViewModelProvider(@NonNull ViewModelStoreOwner o
 
     //---------------------------------------
     protected void finish(){
-        if(getActivity() != null){
-            getActivity().finish();
-        }
+        requireActivity().finish();
     }
 
     protected Intent newIntent(Class<?> cls){

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseFragment.java

@@ -8,7 +8,7 @@
  *
  * <p>如果您继承使用了 BaseIntentService 或其子类，你需要参照如下方式添加 @AndroidEntryPoint 注解
  *
- * <p>Example: BaseIntentService
+ * <p>Example:
  * <pre>
  *    &#64;AndroidEntryPoint
  *    public class YourIntentService extends BaseIntentService {

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseIntentService.java

@@ -16,7 +16,7 @@
  *
  * <p>如果您继承使用了 BaseModel 或其子类，你需要参照如下方式在构造函数上添加 @Inject 注解
  *
- * <p>Example: BaseModel
+ * <p>Example:
  * <pre>
  *    public class YourModel extends BaseModel {
  *        &#64;Inject
@@ -26,7 +26,7 @@
  *    }
  * </pre>
  *
- * <p>标准MVVM模式中的M (Model)层基类
+ * <p>MVVM模式中的M (Model)层基类
  * @author <a href="mailto:jenly1314@gmail.com">Jenly</a>
  */
 public class BaseModel implements IModel {

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseModel.java

@@ -44,14 +44,14 @@
  *    }
  * </pre>
  *
- * <p>标准MVVM模式中的VM (ViewModel)层基类
+ * <p>MVVM模式中的VM (ViewModel)层基类
  * @author <a href="mailto:jenly1314@gmail.com">Jenly</a>
  */
 public class BaseViewModel<M extends BaseModel> extends AndroidViewModel implements IViewModel {
 
 
     /**
-     * 请通过 {@link #getModel()} 获取，后续版本 {@link #mModel}可能会私有化
+     * 请通过 {@link #getModel()} 获取
      */
     private M mModel;
 

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/BaseViewModel.java

@@ -4,13 +4,12 @@
 
 import androidx.annotation.LayoutRes;
 import androidx.annotation.Nullable;
-import androidx.lifecycle.ViewModel;
 
 /**
  * 用来规范 {@link BaseActivity} 和 {@link BaseFragment} 风格。
  * @author <a href="mailto:jenly1314@gmail.com">Jenly</a>
  */
-public interface IView<VM extends ViewModel> {
+public interface IView<VM extends IViewModel> {
 
     /**
      * 根布局id
@@ -26,13 +25,13 @@ public interface IView<VM extends ViewModel> {
     void initData(@Nullable Bundle savedInstanceState);
 
     /**
-     * 是否使用DataBinding
+     * 是否使用 DataBinding
      * @return
      */
     boolean isBinding();
 
     /**
-     * 创建ViewModel
+     * 创建 ViewModel
      * @return
      */
     VM createViewModel();

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/IView.java

@@ -7,7 +7,7 @@
 import androidx.lifecycle.OnLifecycleEvent;
 
 /**
- * 继承LifecycleObserver提供生命周期感知能力
+ * 通过继承LifecycleObserver提供生命周期感知能力
  * @author <a href="mailto:jenly1314@gmail.com">Jenly</a>
  */
 public interface IViewModel extends LifecycleObserver {

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/IViewModel.java

@@ -12,7 +12,7 @@
 import timber.log.Timber;
 
 /**
- * 提供观察单个对象 {@link T} 事件
+ * 提供观察单个对象 {@link T} 事件：适用于一次数据更新，只通知一次的场景
  * @see <a href="https://github.com/googlesamples/android-architecture/blob/6419d4c523b67d020120fc400ed5a7372e5615f2/todoapp/app/src/main/java/com/example/android/architecture/blueprints/todoapp/SingleLiveEvent.java">google sample</a>
  * @author <a href="mailto:jenly1314@gmail.com">Jenly</a>
  */

mvvmframe/src/main/java/com/king/frame/mvvmframe/base/livedata/SingleLiveEvent.java

@@ -52,7 +52,7 @@ interface InterceptorConfigOptions{
         void applyOptions(InterceptorConfig.Builder builder);
     }
     /**
-     * 为框架中的{@link Gson}提供配置参数入口
+     * 为框架中的{@link RoomDatabase}提供配置参数入口
      */
     interface RoomDatabaseOptions<T extends RoomDatabase>{
         void applyOptions(RoomDatabase.Builder<T> builder);