Browse Source

命名规范

drake 3 years ago
parent
commit
f458aef446

+ 1 - 1
docs/auto-dialog.md

@@ -44,7 +44,7 @@ scopeDialog(dialog) {
 
 === "初始配置全局加载框"
     ```kotlin
-    NetConfig.init("http://github.com/") {
+    NetConfig.initialize("http://github.com/") {
             setDialogFactory { // 全局加载对话框
                 ProgressDialog(it).apply {
                     setMessage("我是全局自定义的加载对话框...")

+ 4 - 4
docs/config.md

@@ -11,7 +11,7 @@
     
             // http://google.com/  这是接口全局域名, 可以使用NetConfig.host进行单独的修改
     
-            NetConfig.init("http://github.com/", this) {
+            NetConfig.initialize("http://github.com/", this) {
     
                 // 超时设置
                 connectTimeout(2, TimeUnit.MINUTES)
@@ -38,7 +38,7 @@
                 .setConverter(GsonConvert())
                 .addInterceptor(LogRecordInterceptor(BuildConfig.DEBUG))
     
-            NetConfig.init("http://github.com/", okHttpClientBuilder)
+            NetConfig.initialize("http://github.com/", okHttpClientBuilder)
         }
     }
     ```
@@ -50,7 +50,7 @@
 | 函数 | 描述 |
 |-|-|
 | setLog | 输出网络异常日志 |
-| setHost | 全局域名, 和NetConfig.init("Host")函数中的第一个参数等效 |
+| setHost | 全局域名, 和NetConfig.initialize("Host")函数中的第一个参数等效 |
 | setConverter | [转换器](converter.md), 将网络返回的数据转换成你想要的数据结构 |
 | setRequestInterceptor | [请求拦截器](interceptor.md), 用于添加全局请求头/参数 |
 | setErrorHandler | [全局错误处理](error-handle.md) |
@@ -63,7 +63,7 @@
 但是个别开发者需求指定重试次数则可以添加`RetryInterceptor`拦截器即可实现失败以后会重试指定次数
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     // ... 其他配置
     addInterceptor(RetryInterceptor(3)) // 如果全部失败会重试三次
 }

+ 1 - 1
docs/converter.md

@@ -70,7 +70,7 @@ scopeNetLife {
 
 === "全局"
     ```kotlin hl_lines="2"
-    NetConfig.init("http://github.com/") {
+    NetConfig.initialize("http://github.com/") {
         setConverter(SerializationConverter())
     }
     ```

+ 1 - 1
docs/error-global.md

@@ -1,7 +1,7 @@
 Net可以通过实现`NetErrorHandler`接口来监听全局错误处理, 当你通过`setErrorHandler`后Net就不会再执行默认的错误处理了
 
 ```kotlin
-NetConfig.init("http://localhost:80/") {
+NetConfig.initialize("http://localhost:80/") {
 
     setErrorHandler(object : NetErrorHandler() {
         override fun onError(e: Throwable) {

+ 1 - 1
docs/error-implemention.md

@@ -77,7 +77,7 @@ MyErrorHandler : NetErrorHandler {
 }
 
 // 初始化Net的时候设置错误处理器
-NetConfig.init("host") {
+NetConfig.initialize("host") {
     setErrorHandler(MyErrorHandler()
 }
 ```

+ 1 - 1
docs/exception-track.md

@@ -23,7 +23,7 @@ scopeNetLife {
 在初始化时候可以关闭日志打印
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     setLog(false) // 关闭日志
 }
 ```

+ 2 - 2
docs/https.md

@@ -19,7 +19,7 @@ scopeNetLife {
 === "全局配置"
 
     ```kotlin
-    NetConfig.init("https://www.google.com/"){
+    NetConfig.initialize("https://www.google.com/"){
         trustSSLCertificate() // 信任所有证书
     }
     ```
@@ -42,7 +42,7 @@ scopeNetLife {
 === "全局配置"
 
     ```kotlin
-    NetConfig.init("http://github.com/") {
+    NetConfig.initialize("http://github.com/") {
         val privateCertificate = resources.assets.open("https.certificate")
         setSSLCertificate(privateCertificate)
     }

+ 2 - 2
docs/interceptor.md

@@ -10,7 +10,7 @@ class App : Application() {
     override fun onCreate() {
         super.onCreate()
 
-        NetConfig.init("http://github.com/") {
+        NetConfig.initialize("http://github.com/") {
             addInterceptor { chain -> chain.proceed(chain.request()) }
         }
     }
@@ -31,7 +31,7 @@ RequestInterceptor属于轻量级的请求拦截器, 在每次请求的时候该
 初始化时添加请求拦截器的示例代码
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     setRequestInterceptor(object : RequestInterceptor {
         override fun interceptor(request: BaseRequest) {
             request.param("client", "Net")

+ 1 - 1
docs/kotlin-serialization.md

@@ -26,7 +26,7 @@
 
 === "全局配置"
     ```kotlin
-    NetConfig.init("http://google.com/") {
+    NetConfig.initialize("http://google.com/") {
         setConverter(SerializationConvert())
         // ... 其他配置
     }

+ 2 - 2
docs/log-recorder.md

@@ -17,7 +17,7 @@ Net以下两种方案, 各有优劣
 ## 添加日志拦截器
 
 ```kotlin hl_lines="2"
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     addInterceptor(LogRecordInterceptor(BuildConfig.DEBUG))
 }
 ```
@@ -82,7 +82,7 @@ scopeNetLife {
 然后初始化时添加自己实现拦截器即可
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     addInterceptor(MyLogRecordInterceptor(BuildConfig.DEBUG))
 }
 ```

+ 1 - 1
docs/okhttp-client.md

@@ -13,7 +13,7 @@ object NetConfig {
 ## 全局OkHttpClient
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     // 此处this即为OkHttpClient.Builder
 }
 ```

+ 1 - 1
docs/read-cache.md

@@ -3,7 +3,7 @@ Net_v2基于[Kalle](https://github.com/yanzhenjie/Kalle)开发, 支持Kalle的9
 缓存模式要求在初始化的时候开启
 
 ```kotlin
-NetConfig.init("http://github.com/") {
+NetConfig.initialize("http://github.com/") {
     cacheEnabled() // 开启缓存
 }
 ```

+ 1 - 1
docs/updates.md

@@ -72,7 +72,7 @@ Interval添加cancel函数用于取消计时器, 取消完成不会调用finish
 2. NetCallback具备跟随生命周期自动取消网络请求
 3. 扩展NetCallback来添加DialogCallback/StateCallback/PageCallback
 4. 废弃部分函数, 例如onDialog被废弃, 现在由`NetConfig.dialogFactory`构建全局加载对话框
-5. initNet现在废弃, 由`NetConfig.init`取代. 所有配置信息由NetConfig承载
+5. initNet现在废弃, 由`NetConfig.initialize`取代. 所有配置信息由NetConfig承载
 5. RequestParamsException添加错误码信息
 
 ## 3.0.12

+ 29 - 1
net/src/main/java/com/drake/net/NetConfig.kt

@@ -93,10 +93,38 @@ object NetConfig {
      * @param context 如果应用存在多进程请指定此参数初始化[NetConfig.app]
      * @param config 进行配置网络请求
      */
+    @Deprecated("命名规范", ReplaceWith("initialize(host, context, config)"))
     fun init(
         host: String = "",
         context: Context? = null,
         config: OkHttpClient.Builder.() -> Unit = {}
+    ) = initialize(host, context, config)
+
+    /**
+     * 初始化框架
+     * 不初始化也可以使用, 但是App使用多进程情况下要求为[NetConfig.host]或者[context]赋值, 否则会导致无法正常吐司或其他意外问题
+     * @param host 请求url的主机名
+     * @param context 如果应用存在多进程请指定此参数初始化[NetConfig.app]
+     * @param config 进行配置网络请求
+     */
+    @Deprecated("命名规范", ReplaceWith("initialize(host, context, config)"))
+    fun init(
+        host: String = "",
+        context: Context? = null,
+        config: OkHttpClient.Builder
+    ) = initialize(host, context, config)
+
+    /**
+     * 初始化框架
+     * 不初始化也可以使用, 但是App使用多进程情况下要求为[NetConfig.host]或者[context]赋值, 否则会导致无法正常吐司或其他意外问题
+     * @param host 请求url的主机名
+     * @param context 如果应用存在多进程请指定此参数初始化[NetConfig.app]
+     * @param config 进行配置网络请求
+     */
+    fun initialize(
+        host: String = "",
+        context: Context? = null,
+        config: OkHttpClient.Builder.() -> Unit = {}
     ) {
         NetConfig.host = host
         context?.let { app = it }
@@ -112,7 +140,7 @@ object NetConfig {
      * @param context 如果应用存在多进程请指定此参数初始化[NetConfig.app]
      * @param config 进行配置网络请求
      */
-    fun init(host: String = "", context: Context? = null, config: OkHttpClient.Builder) {
+    fun initialize(host: String = "", context: Context? = null, config: OkHttpClient.Builder) {
         NetConfig.host = host
         context?.let { app = it }
         okHttpClient = config.toNetOkhttp().build()

+ 1 - 1
sample/src/main/java/com/drake/net/sample/base/App.kt

@@ -42,7 +42,7 @@ class App : Application() {
     override fun onCreate() {
         super.onCreate()
 
-        NetConfig.init("http://43.128.31.195/") {
+        NetConfig.initialize("http://43.128.31.195/") {
 
             // 超时设置
             connectTimeout(2, TimeUnit.MINUTES)