{"id":19522074,"url":"https://github.com/seiginonakama/retryrequestinterceptor-for-okhttp","last_synced_at":"2025-04-26T09:32:03.880Z","repository":{"id":42218632,"uuid":"59565010","full_name":"seiginonakama/RetryRequestInterceptor-for-OkHttp","owner":"seiginonakama","description":"a interceptor for OkHttp which can save failed request in storage and will retry request until success or retry times over limit , or request live time over limit","archived":false,"fork":false,"pushed_at":"2017-06-06T09:38:07.000Z","size":92,"stargazers_count":44,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-04T10:33:15.722Z","etag":null,"topics":["interceptor","okhttp","retry-library","retry-requests"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seiginonakama.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-24T10:51:23.000Z","updated_at":"2023-05-06T02:04:18.000Z","dependencies_parsed_at":"2022-09-18T22:56:06.922Z","dependency_job_id":null,"html_url":"https://github.com/seiginonakama/RetryRequestInterceptor-for-OkHttp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seiginonakama%2FRetryRequestInterceptor-for-OkHttp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seiginonakama%2FRetryRequestInterceptor-for-OkHttp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seiginonakama%2FRetryRequestInterceptor-for-OkHttp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seiginonakama%2FRetryRequestInterceptor-for-OkHttp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seiginonakama","download_url":"https://codeload.github.com/seiginonakama/RetryRequestInterceptor-for-OkHttp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250967193,"owners_count":21515558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interceptor","okhttp","retry-library","retry-requests"],"created_at":"2024-11-11T00:37:02.750Z","updated_at":"2025-04-26T09:32:03.494Z","avatar_url":"https://github.com/seiginonakama.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RetryRequestInterceptor for OkHttp2， OkHttp3\n\u003c/br\u003e\na RetryRequestInterceptor for okHttp2, OkHttp3, has those features:\n\n* will retry request until success or retry times over limit , or request live time over limit; \n* you can listen retry result by provide a RetryResultListener;\n* you can provide a encrypt storage to keep retry request safe;\n* invoke retry action by trigger, no loop thread, no waste cpu.\n\n---\n\n## Import\n```gradle\nrepositories {\n  jcenter()\n}\n```\nfor OkHttp2:\n```gradle\ncompile 'me.touko.okHttp2:RetryRequestInterceptorOkHttp2:1.0.0'\n```\nfor OkHttp3:\n```gradle\ncompile 'me.touko.okHttp3:RetryRequestInterceptorOkHttp3:1.0.0'\n```\n\n---\n## Usage\n\n### Step 1 : init RetryRequestInterceptor before use\nyou can simple init RetryRequestInterceptor in Application.onCreate() method\n\n```java\n  @Override\n  public void onCreate() {\n    super.onCreate();\n    RetryRequestInterceptor.getInstance().init(this, new RetryConfig() {\n      /**\n       * min duration for retry request\n       *\n       * @return duration in unix times\n       */\n      @Override\n      public long minRetryDuration() {\n        return 1000L * 10;\n      }\n\n      /**\n       * the life of retry request, if life \u003c 0, request will live forever\n       *\n       * @return life in unix time\n       */\n      @Override\n      public long life() {\n        return -1; //the life of retry request, if life \u003c 0, request will live forever\n      }\n\n      /**\n       * max retry times of request, if maxRetryTimes \u003c 0, will retry unLimit times\n       *\n       * @return max retry times\n       */\n      @Override\n      public int maxRetryTimes() {\n        return 10;\n      }\n\n      /**\n       * judge whether to retry request when {@link #isSuccess(Request, Response)} return false\n       *\n       * @return whether to retry request\n       */\n      @Override\n      public boolean isRetryRequest(Request request) {\n        return request.url.toString().equals(\"http://api.exapmle.com/payresult/upload\")\n         \u0026\u0026 request.method.equals(\"POST\"); //judge whether to retry request\n      }\n    }));\n  }\n```\n### Step 2 : add RetryRequestInterceptor to your OkHttpClient\n\n```java\n    mOkHttpClient.interceptors().add(RetryRequestInterceptor.getInstance());\n```\n\n### Step 3 : invoke retry action by random time point\n\nyou can simple invoke retry action in Activity.onPause() and Activity.onResume() method， or use my other library [RandomEvent](https://github.com/lqcandqq13/RandomEvent)\n\n```java\n@Override\npublic void onPause() {\n  super.onPause();\n  RetryRequestInterceptor.getInstance().retryTrigger();\n}\n\n@Override\npublic void onResume() {\n  super.onResume();\n  RetryRequestInterceptor.getInstance().retryTrigger();\n}\n```\n\n### (Optional)Step 4 : add RetryResultListener\n\n```java\n    RetryRequestInterceptor.getInstance().addRetryResultListener(new RetryResultListener() {\n      @Override\n      public void onRetrySuccess(Request request, Response response) {\n        \n      }\n\n      @Override\n      public void onRetryError(Request request, IOException exception) {\n\n      }\n\n      @Override\n      public void onRetryFailed(Request request, Response response) {\n\n      }\n\n      @Override\n      public void onAbortRetry(Request request, long deadLine, int retryTimes) {\n\n      }\n    });\n```\n\n### (Optional)Step 5 : Override more default RetryConfig method in Step 1 to make retry more customizable\n```java\nRetryRequestInterceptor.getInstance().init(this, new RetryConfig() {\n    \n    ......\n    \n    /**\n     * the storage to store retry requests, you can override this method to provide customize storage,\n     * like encrypt storage {@link me.touko.okhttp.retryinterceptor.storage.EncryptFileStorage} etc..\n     *\n     * @return storage {@link Storage} {@link FileStorage}\n     */\n    protected Storage storage(Context context) {\n      return new FileStorage(new File(context.getFilesDir(), \"retryInterceptor\").getAbsolutePath(), 0);\n    }\n\n    /**\n     * the okHttpClient to send retry requests, you can override this method to provide your customize OkHttpClient\n     *\n     * @return okHttpClient {@link OkHttpClient}\n     */\n    protected OkHttpClient okHttpClient() {\n      return new OkHttpClient();\n    }\n\n    /**\n     * the default method to judge whether should retry request, you can override this method to judge by your logic\n     *\n     * @param request  the retry request\n     * @param response the retry response\n     * @return if return true, means the request retry succeed, else should continue retry\n     */\n    protected boolean isSuccess(Request request, Response response) {\n      return response != null \u0026\u0026 response.isSuccessful();\n    }\n}\n```\n\nLicense\n-------\n     Copyright (C) 2017 seiginonakama (https://github.com/seiginonakama).\n\n     Licensed under the Apache License, Version 2.0 (the \"License\");\n     you may not use this file except in compliance with the License.\n     You may obtain a copy of the License at\n    \n        http://www.apache.org/licenses/LICENSE-2.0\n    \n     Unless required by applicable law or agreed to in writing, software\n     distributed under the License is distributed on an \"AS IS\" BASIS,\n     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n     See the License for the specific language governing permissions and\n     limitations under the License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseiginonakama%2Fretryrequestinterceptor-for-okhttp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseiginonakama%2Fretryrequestinterceptor-for-okhttp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseiginonakama%2Fretryrequestinterceptor-for-okhttp/lists"}