Effect:
Project Description:
Secondary packaging network request frame, now completed based on OkHttp get/post/postJson/uploadFile/downloadFile function such as development, support the extension, the underlying implementation can switch freely;
- ExecutorFactory extensions can be implemented as an IExecutor, which can be OkHttp, HttpClient, or URLConnection.
Usage:
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); Init (new OkHttpExecutorFactory()); // Init (new OkHttpExecutorFactory()); }} / / the get method request private void doGet () {String url = "http://127.0.0.1:8080/test/test"; RequestParams params = new RequestParams.Builder().url(url).method(Method.GET).params("key1", "hello").params("key2", "doGet").tag(this).build(); NetWorkUtils.getInstance().doStart(params, callback); } / / post requests private void the doPost () {String url = "http://127.0.0.1:8080/test/test"; RequestParams params = new RequestParams.Builder().url(url).method(Method.POST).params("key1", "hello").params("key2", "doPost").tag(this).build(); NetWorkUtils.getInstance().doStart(params, callback); } / / postJson way request private void doPostJson () {String url = "http://127.0.0.1:8080/test/test"; String body = "{ \"key1\":\"hello\",\"key2\":\"doPostJson\" }"; RequestParams params = new RequestParams.Builder().url(url).method(Method.POST_JSON).body(body).tag(this).build(); NetWorkUtils.getInstance().doStart(params, callback); } / / file upload private void doUploadFile () {String url = "http://127.0.0.1:8080/test/upload"; String filePath = Environment.getExternalStorageDirectory().getPath() + File.separator + "atlas-master.zip"; RequestParams params = new RequestParams.Builder().url(url).method(Method.UPLOAD).files("fileKey", new File(filePath)).tag(this).build(); NetWorkUtils.getInstance().doStart(params, callback); } / / file download private void doDownload () {String url = "http://127.0.0.1:8080/test/download"; String filePath = Environment.getExternalStorageDirectory().getPath() + File.separator + "atlas-master.zip"; RequestParams params = new RequestParams.Builder().url(url).method(Method.DOWNLOAD).downLoadFilePath(filePath).tag(this).build(); NetWorkUtils.getInstance().doStart(params, callback); } // Request a callback, Private ICallBack callback = new ICallBack() {@override public void onStart() { The d (NetWorkUtils. Class. GetSimpleName (), "the network began to load"); {} @ Override public void onComplite () the d (NetWorkUtils. Class. GetSimpleName (), "network loaded"); } @ Override public void onError (Exception e) {the d (NetWorkUtils. Class. GetSimpleName (), "error"); } @Override public void onSuccess(Object tag, String result) { Log.d(NetWorkUtils.class.getSimpleName(), "result = "+result); / * * * can parse the data according to different tag * if (tag. The equest (" doGet ")) {} * * else if (tag. The equest (" doPost ")) {} * * *... * /} @ Override public void onProgress (float progress) {the d (NetWorkUtils. Class. GetSimpleName (), "upload or download progress: "+progress); }}; Protected void onDestroy() {networkutils.getInstance ().canclerequest (this); super.onDestroy(); }Copy the codeTechnical points:
- Abstract Factory pattern
- Builder pattern
- OkHttp use
- OkHttp upload and download progress monitor
- Thread the callback
Background:
Network request plays a very important role in APP development and is also one of the core technical points. There are also many well-known open source libraries on Github, such as Xutils, AsyncHttpClient, Okhttp, etc. I’m sure many of you, like me, habitually add these open source versions to your projects, but one day, for some reason, we need to make a switch to the network layer, then the problem becomes serious and we need to change a lot of code to accommodate this change. To avoid such problems, we need to re-wrap the network layer;
Project Structure:
- IExecutor request network interface class, defines the get/post/postJson/uploadFile/downloadFile, etc.;
- ExecutorFactory Creation factory of IExecutor, abstract class;
- OkHttpExecutor realized IExecutor interface to achieve the specific get/post/postJson/uploadFile/downloadFile method;
- OkHttpExecutorFactory implements ExecutorFactory and returns an OkHttpExecutor instance;
- MainHandler UI thread callback;
- RequestParams request parameters, using the builder pattern;
- NetWorkUtils Network request utility class, simple interest, globally unique.
Note: the default okHTTP enqueue (call) is followed by the callback in the subline;
Process execution, code analysis:
-
What happens after Networkutils.init (new OkHttpExecutorFactory())?
public static IExecutor executor; public static NetWorkUtils mInstance; private NetWorkUtils(ExecutorFactory factory) { executor = factory.create(); Executorfactory; executorFactory; executorFactory; executorFactory; ExecutorFactory */ public static void init(ExecutorFactory Factory) {if (mInstance == null) { synchronized (NetWorkUtils.class) { if (mInstance == null) { mInstance = new NetWorkUtils(factory); }}}}Copy the codeWe see the simple initialization of NetWorkUtils and the concrete implementation class of IExecutor obtained from the factory;
-
OkHttpExecutorFactory inherits from ExecutorFactory and implements the Create abstract method:
public class OkHttpExecutorFactory extends ExecutorFactory { @Override public IExecutor create() { HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() { @Override public void log(String message) { Log.d(NetWorkUtils.class.getSimpleName(), message); }}); // Builder mode, Generate the configuration object OkhttpConfig config = new OkhttpConfig.Builder().retryOnConnectionFailure(false).connectTimeout(10000).readTimeout(5000).writeTimeout(5000).interc eptors(httpLoggingInterceptor).build(); return new OkHttpExecutor(config); }Copy the codeOkHttpExecutor is created through the OkhttpConfig builder and returns;
-
OkHttpExecutor implements the IExecutor interface and implements all of its methods, so this is the concrete network request implementation:
public static OkHttpClient mClient; public static final Map<Object, ArrayList<Call>> calls = new HashMap<>(); Public OkHttpExecutor(OkhttpConfig config) {// Configure okHttpClient, Okhttpclient. Builder Builder = new OkHttpClient.Builder().retryOnConnectionFailure(config.retryOnConnectionFailure).connectTimeout(config.connectTimeout, TimeUnit.MILLISECONDS) .readTimeout(config.readTimeout, TimeUnit.MILLISECONDS).writeTimeout(config.writeTimeout, TimeUnit.MILLISECONDS); if (config.cache ! = null) { builder.cache(config.cache); } if (config.x509TrustManager ! = null && config.sslSocketFactory ! = null) { builder.sslSocketFactory(config.sslSocketFactory, config.x509TrustManager); } if (config.interceptors ! = null && config.interceptors.size() > 0) { for (int i = 0; i < config.interceptors.size(); i++) { builder.addInterceptor(config.interceptors.get(i)); } } if (config.networkInterceptors ! = null && config.networkInterceptors.size() > 0) { for (int i = 0; i < config.networkInterceptors.size(); i++) { builder.addNetworkInterceptor(config.networkInterceptors.get(i)); } } mClient = builder.build(); } @Override public void doGet(RequestParams requestParams, ICallBack callback) { callback.onStart(); Request request = new Request.Builder().url(OkhttpUtils.getUrlWithParams(requestParams)).get().headers(OkhttpUtils.getHeaders(requestParams)). tag(requestParams.tag).build(); Call call = mClient.newCall(request); call.enqueue(new OkhttpCallback(requestParams)); cacheCall(requestParams, call); } @Override public void doPost(RequestParams requestParams, ICallBack callback) { callback.onStart(); Request request = new Request.Builder().url(requestParams.url).post(OkhttpUtils.getPostBody(requestParams)).headers(OkhttpUtils.getHeaders(req uestParams)).tag(requestParams.tag).build(); Call call = mClient.newCall(request); call.enqueue(new OkhttpCallback(requestParams)); cacheCall(requestParams, call); }Copy the codePart of the code, specific please view the source code;
In the constructor, we instantiate an OkHttpClient using OkhttpConfig, and use OkHttpClient in doGet and doPost for specific network requests. If you are not familiar with okHTTP, you can learn okhttp first.
Note that ICallBack is our custom callback, because I mentioned earlier that the OKHTTP callback is done in a subline, so we need to make it a UI thread callback;
OkhttpCallback this is the Callback that we inherit from okhttp, then switch UI threads in it, and finally Callback to our own ICallBack;
-
OkhttpCallback inherits okhttp’s Callback:
public class OkhttpCallback implements Callback { public static final Handler handler = new MainHandler(Looper.getMainLooper()); RequestParams requestParams; public OkhttpCallback(RequestParams requestParams) { this.requestParams = requestParams; } @Override public void onFailure(Call call, IOException e) { e.printStackTrace(); TempleteBean templeteBean = new TempleteBean(); templeteBean.call = call; templeteBean.e = e; templeteBean.requestParams = requestParams; Message.obtain(handler, MainHandler.FAILD, templeteBean).sendToTarget(); } @Override public void onResponse(Call call, Response response) throws IOException { TempleteBean templeteBean = new TempleteBean(); templeteBean.call = call; templeteBean.response = response; templeteBean.requestParams = requestParams; //downloadfile if (requestParams.method.equals(Method.DOWNLOAD)) { downLoadFile(templeteBean, response); } Message.obtain(handler, MainHandler.SUCCESS, templeteBean).sendToTarget(); }}Copy the codeWe use TempleteBean to encapsulate the data and send it to the UI thread via MainHandler;
New MainHandler(looper.getMainLooper ());
-
MainHandler inherits from android Handler:
public class MainHandler extends Handler { public static final int SUCCESS = 101; public static final int FAILD = 102; public static final int PROGRESS = 103; public MainHandler(Looper looper) { super(looper); } @Override public void handleMessage(Message msg) { switch (msg.what) { case SUCCESS: onSuccess(msg); break; case FAILD: onFaild(msg); break; case PROGRESS: onProgress(msg); break; } } private void onSuccess(Message msg) { TempleteBean bean = (TempleteBean) msg.obj; RequestParams requestParams = bean.requestParams; ICallBack callback = requestParams.callback; Response response = bean.response; if (! response.isSuccessful()) { Log.d(NetWorkUtils.class.getSimpleName(), "! response.isSuccessful()" +response.code()); return; } if (requestParams.method.equals(Method.DOWNLOAD)) { callback.onSuccess(requestParams.tag, requestParams.downLoadFilePath); callback.onComplite(); return; } try { String result = response.body().string(); Log.d(NetWorkUtils.class.getSimpleName(), result); callback.onSuccess(requestParams.tag, result); } catch (Exception e) { e.printStackTrace(); callback.onError(e); } callback.onComplite(); }}Copy the codeThe result of the execution will eventually go to this handler, which is UI threaded, so we get the data through the TempleteBean and call the result back to our own callback.
Now that the request process is complete, let’s go back to NetWorkUtils;
-
NetWorkUtils request utility class, also simple interest, globally unique, we do simple interest initialization in the program entry init:
public void doStart(RequestParams params, ICallBack callBack) { if (params == null || callBack == null) return; params.callback = callBack; switch (params.method) { case GET: executor.doGet(params, callBack); break; case POST: executor.doPost(params, callBack); break; case POST_JSON: executor.doPostJson(params, callBack); break; case UPLOAD: executor.doUploadFile(params, callBack); break; case DOWNLOAD: executor.doDownLoad(params, callBack); break; }}Copy the codeNetworkutils.getinstance ().dostart (params, callback);