使用此開發框架須要的一些前置知識java
KCommon提供了兩種便於開發的模板android
導入依賴git
maven { url "https://jitpack.io" }
在自定義的Application類中的onCreate方法中初始化CommonLibrarygithub
//初始化KCommon
CommonLibrary.instance.initLibrary(this,編程
BuildConfig.APP_URL, ApiService::class.java, CacheService::class.java)
* 建議配合一鍵生成相關MVP類的Android Studio模板進行開發,可極大提升開發效率。模板位置 [Android Studio 快速開發模板](https://github.com/BlackFlagBin/KCommonTemplate) ### 詳細說明 * CommonLibrary.instance.initLibrary()
/** * 初始化 * * @param context Application * @param baseUrl retrofit所需的baseUrl * @param apiClass retrofit使用的ApisService::Class.java * @param cacheClass rxcache使用的CacheService::Class.java * @param spName Sharedpreference文件名稱 * @param isDebug 是debug環境仍是release環境。debug環境有網絡請求的日誌,release反之 * @param startPage 分頁列表的起始頁,有多是0,或者是2,這個看後臺 * @param pageSize 分頁大小 * @param headerMap 網絡請求頭的map集合,便於在網絡請求添加統一的請求頭,好比token之類 * @param errorHandleMap 錯誤處理的map集合,便於針對相關網絡請求返回的錯誤碼來作相應的處理,好比錯誤碼401,token失效須要從新登陸 * @param onPageCreateListener 對應頁面activity或fragment相關生命週期的回調,便於在頁面相關時機作一些統一處理,好比加入友盟統計須要在全部頁面的相關生命週期加入一些處理 * @param onPageDestroyListener 對應頁面activity或fragment相關生命週期的回調,便於在頁面相關時機作一些統一處理,好比加入友盟統計須要在全部頁面的相關生命週期加入一些處理 * @param onPageResumeListener 對應頁面activity或fragment相關生命週期的回調,便於在頁面相關時機作一些統一處理,好比加入友盟統計須要在全部頁面的相關生命週期加入一些處理 * @param onPagePauseListener 對應頁面activity或fragment相關生命週期的回調,便於在頁面相關時機作一些統一處理,好比加入友盟統計須要在全部頁面的相關生命週期加入一些處理 * */ fun initLibrary( context: Application, baseUrl: String, apiClass: Class<*>, cacheClass: Class<*>, spName: String = "kcommon", isDebug: Boolean = true, startPage: Int = 1, pageSize: Int = 20, headerMap: Map<String, String>? = null, errorHandleMap: Map<Int, (exception: IApiException) -> Unit>? = null, onPageCreateListener: OnPageCreateListener? = null, onPageDestroyListener: OnPageDestroyListener? = null, onPageResumeListener: OnPageResumeListener? = null, onPagePauseListener: OnPagePauseListener? = null)