author:wangyimiao

desc:添加注释

commonLib/src/main/java/com/common/commonlib/CommonApplication.kt

@@ -4,10 +4,21 @@ import android.annotation.SuppressLint
 import android.app.Application
 import android.content.Context
 
+/**
+ * 基础Application
+ *
+ * @author wangym
+ * @since 2021/7/28
+ */
 @SuppressLint("StaticFieldLeak")
 object CommonApplication : Application() {
     private var commonContext: Context? = null
 
+    override fun onCreate() {
+        super.onCreate()
+        intLibs(this)
+    }
+
     fun intLibs(context: Context) {
         commonContext = context
     }

commonLib/src/main/java/com/common/commonlib/image/config/GlideBaseConfig.kt

@@ -2,6 +2,12 @@ package com.common.commonlib.image.config
 
 import com.bumptech.glide.MemoryCategory
 
+/**
+ * 图片加载基础配置
+ *
+ * @author wangym
+ * @since 2021/7/28
+ */
 object GlideBaseConfig {
 
     enum class MemoryType(var memoryCategory: MemoryCategory) {

commonLib/src/main/java/com/common/commonlib/image/config/GlideHolderConfig.kt

@@ -4,6 +4,9 @@ import android.graphics.drawable.Drawable
 
 /**
  * 占位符配置
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 class GlideHolderConfig {
     /**

commonLib/src/main/java/com/common/commonlib/image/config/GlideTransitionConfig.kt

@@ -5,6 +5,9 @@ import com.bumptech.glide.load.resource.drawable.DrawableTransitionOptions
 /**
  * 转换配置
  * @param time 动画时长
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 class GlideTransitionConfig(time: Int?) {
     val transition: DrawableTransitionOptions = if (time != null) {

commonLib/src/main/java/com/common/commonlib/image/loader/ConfigHelper.kt

@@ -8,9 +8,19 @@ import com.common.commonlib.image.config.GlideBaseConfig
 
 /**
  * 加载配置辅助类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object ConfigHelper {
 
+    /**
+     * 带有过渡效果的加载
+     * @param requestBuilder 请求构建器
+     * @param transformations 过渡效果
+     *
+     * @return 请求构建器
+     */
     fun loadWithTransformation(
         requestBuilder: RequestBuilder<Drawable>,
         transformations: List<BitmapTransformation>
@@ -22,6 +32,13 @@ object ConfigHelper {
         return temp
     }
 
+    /**
+     * 带有缓存模式的加载
+     * @param requestBuilder 请求构建器
+     * @param loadingMode 加载缓存模式
+     *
+     * @return 请求构建器
+     */
     fun loadWithMod(
         requestBuilder: RequestBuilder<Drawable>,
         loadingMode: GlideBaseConfig.LoadMode

commonLib/src/main/java/com/common/commonlib/image/loader/GlobalConfigHelper.kt

@@ -7,9 +7,19 @@ import com.common.commonlib.image.config.GlideHolderConfig
 
 /**
  * 全局配置适配器
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object GlobalConfigHelper {
+    /**
+     * 全局占位符配置
+     */
     var globalHolderConfig: GlideHolderConfig? = null
+
+    /**
+     * 全局过渡效果
+     */
     var globalTransition: DrawableTransitionOptions? = null
 
     fun loadWithGlobalConfig(requestBuilder: RequestBuilder<Drawable>): RequestBuilder<Drawable> {

commonLib/src/main/java/com/common/commonlib/image/loader/ILoader.kt

@@ -6,7 +6,10 @@ import com.common.commonlib.image.config.GlideBaseConfig
 import com.common.commonlib.image.config.GlideHolderConfig
 
 /**
- * 加载器接口
+ * 图片加载器接口
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 interface ILoader {
 
@@ -64,16 +67,19 @@ interface ILoader {
 
     /**
      * 清理内存缓存
+     * @param context 上下文
      */
     fun clearMemoryCache(context: Context)
 
     /**
      * 清理磁盘缓存
+     * @param context 上下文
      */
     fun clearDiskCache(context: Context)
 
     /**
-     * 清理所有缓存
+     * 清理缓存
+     * @param context 上下文
      */
     fun clearAllCache(context: Context)
 }

commonLib/src/main/java/com/common/commonlib/image/loader/ImageLoader.kt

@@ -17,27 +17,54 @@ import kotlinx.coroutines.runBlocking
 
 /**
  * 图片加载类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object ImageLoader : ILoader {
 
+    /**
+     * 初始化Glide基础配置
+     */
     override fun init(
         context: Context, memoryCategory: GlideBaseConfig.MemoryType
     ) {
         Glide.get(context).setMemoryCategory(memoryCategory.memoryCategory)
     }
 
+    /**
+     * 设置全局占位符配置
+     * @param globalHolderConfig 占位符配置
+     */
     fun setGlobalConfig(globalHolderConfig: GlideHolderConfig) {
         GlobalConfigHelper.globalHolderConfig = globalHolderConfig
     }
 
+    /**
+     * 设置全局过渡效果
+     * @param transitionConfig 全局过渡配置
+     */
     fun setGlobalTransition(transitionConfig: GlideTransitionConfig) {
         GlobalConfigHelper.globalTransition = transitionConfig.transition
     }
 
+    /**
+     * 加载图片
+     * @param context 上下文
+     * @param url 图片链接
+     * @param view 图片控件
+     */
     override fun load(context: Context, url: String?, view: ImageView) {
         loadWithMode(context, url, view, GlideBaseConfig.LoadMode.DEFAULT)
     }
 
+    /**
+     * 加载圆角图片
+     * @param context 上下文
+     * @param url 图片链接
+     * @param view 图片控件
+     * @param radius 圆角弧度
+     */
     override fun loadRound(context: Context, url: String?, view: ImageView, radius: Float) {
         var request = GlobalConfigHelper.loadWithGlobalConfig(Glide.with(context).load(url))
         request = ConfigHelper.loadWithMod(request, GlideBaseConfig.LoadMode.DEFAULT)
@@ -48,6 +75,13 @@ object ImageLoader : ILoader {
         loadIntoView(request, view)
     }
 
+    /**
+     * 以模式，加载图片
+     * @param context 上下文
+     * @param url 图片链接
+     * @param view 图片控件
+     * @param loadingMode 加载模式
+     */
     override fun loadWithMode(
         context: Context,
         url: String?,
@@ -59,6 +93,13 @@ object ImageLoader : ILoader {
         loadIntoView(request, view)
     }
 
+    /**
+     * 加载图片，带有占位图
+     * @param context 上下文
+     * @param url 图片链接
+     * @param view 图片控件
+     * @param placeGlideHolder 占位图
+     */
     override fun loadWithPlaceHolder(
         context: Context,
         url: String,
@@ -73,22 +114,39 @@ object ImageLoader : ILoader {
         )
     }
 
+    /**
+     * 加载进控件
+     * @param requestBuilder 请求构建器
+     * @param view 图片控件
+     */
     private fun loadIntoView(requestBuilder: RequestBuilder<Drawable>, view: ImageView) {
         requestBuilder.into(view)
     }
 
-    override fun clearMemoryCache(context: Context){
+    /**
+     * 清理内存缓存
+     * @param context 上下文
+     */
+    override fun clearMemoryCache(context: Context) {
         GlobalScope.launch(Dispatchers.Main) {
             Glide.get(context).clearMemory()
         }
     }
 
+    /**
+     * 清理磁盘缓存
+     * @param context 上下文
+     */
     override fun clearDiskCache(context: Context) = runBlocking<Unit> {
         launch(Dispatchers.Default) {
             Glide.get(context).clearDiskCache()
         }
     }
 
+    /**
+     * 清理缓存
+     * @param context 上下文
+     */
     override fun clearAllCache(context: Context) = runBlocking<Unit> {
         GlobalScope.launch(Dispatchers.Main) {
             Glide.get(context).clearMemory()

commonLib/src/main/java/com/common/commonlib/image/module/OkHttpLibraryGlideModule.kt

@@ -11,6 +11,9 @@ import java.io.InputStream
 
 /**
  * okhttp配置
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 @GlideModule
 class OkHttpLibraryGlideModule : LibraryGlideModule() {

commonLib/src/main/java/com/common/commonlib/log/LogSecureHelper.kt

@@ -2,6 +2,9 @@ package com.common.commonlib.log
 
 /**
  * 日志敏感信息处理
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object LogSecureHelper {
 

commonLib/src/main/java/com/common/commonlib/log/Logger.kt

@@ -2,6 +2,12 @@ package com.common.commonlib.log
 
 import android.util.Log
 
+/**
+ * Log工具类
+ *
+ * @author wangym
+ * @since 2021/7/28
+ */
 object Logger {
     var commonTag = ""
     var needSecurity = false

commonLib/src/main/java/com/common/commonlib/net/BaseObserve.kt

@@ -18,6 +18,9 @@ import javax.net.ssl.SSLHandshakeException
 
 /**
  * 请求基类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 open class BaseObserve<T> {
     /**

commonLib/src/main/java/com/common/commonlib/net/RequestCallBack.kt

@@ -2,6 +2,9 @@ package com.common.commonlib.net
 
 /**
  * 请求回调
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 interface RequestCallBack<T> {
     fun onResult(result: T)

commonLib/src/main/java/com/common/commonlib/net/RequestManager.kt

@@ -11,6 +11,9 @@ import java.util.concurrent.TimeUnit
 
 /**
  * 网络请求管理器
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object RequestManager {
     /**

commonLib/src/main/java/com/common/commonlib/net/bean/BaseResponse.kt

@@ -5,6 +5,9 @@ import kotlinx.android.parcel.Parcelize
 
 /**
  * 基础响应类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 @Parcelize
 open class BaseResponse : Parcelable {

commonLib/src/main/java/com/common/commonlib/net/bean/RequestParam.kt

@@ -2,6 +2,9 @@ package com.common.commonlib.net.bean
 
 /**
  * 请求参数
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 data class RequestParam(var baseUrl: String) {
     var params: Map<String, String>? = null

commonLib/src/main/java/com/common/commonlib/net/interceptor/BaseUrlInterceptor.kt

@@ -14,6 +14,9 @@ import java.util.*
 
 /**
  * HOST拦截器:动态替换HOST
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 class BaseUrlInterceptor : Interceptor {
     /**

commonLib/src/main/java/com/common/commonlib/net/interceptor/RequestHeadInterceptor.kt

@@ -6,6 +6,9 @@ import okhttp3.Response
 
 /**
  * 公共请求拦截器
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 class RequestHeadInterceptor : Interceptor {
     /**

commonLib/src/main/java/com/common/commonlib/net/interceptor/ResponseHeadInterceptor.kt

@@ -1,11 +1,13 @@
 package com.common.commonlib.net.interceptor
 
-import android.util.Log
 import okhttp3.Interceptor
 import okhttp3.Response
 
 /**
  * 响应头部拦截器
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 class ResponseHeadInterceptor(private var callBack: ResponseCallBack?) : Interceptor {
     override fun intercept(chain: Interceptor.Chain): Response {

commonLib/src/main/java/com/common/commonlib/utils/FTPUtils.kt

@@ -10,6 +10,9 @@ import java.io.IOException
 
 /**
  * FTP工具类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object FTPUtils {
     /**

commonLib/src/main/java/com/common/commonlib/utils/SpManager.kt

@@ -6,6 +6,9 @@ import android.content.SharedPreferences
 
 /**
  * sharedPreference管理类
+ *
+ * @author wangym
+ * @since 2021/7/28
  */
 object SpManager {
     const val HAS_INIT = "has_init"

commonLib/src/main/java/com/common/commonlib/view/SpaceItemDecoration.java

@@ -7,6 +7,12 @@ import androidx.recyclerview.widget.RecyclerView;
 
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * rv辅助类
+ *
+ * @author wangym
+ * @since 2021/7/28
+ */
 public class SpaceItemDecoration extends RecyclerView.ItemDecoration {
     /**
      * 默认图片展示单行数量