让Activity更加简洁第（二）篇---AsyncTask的使用姿势

AsyncTask的参数介绍

AsyncTask 是轻量级的异步任务类，轻松地在 UI 线程控制后台操作和后台操作所返回结果，无需使用 Thread 和 Handler 这样的组合来进行切换。实际上 AsyncTask 是为我们所设计的关于 Thread 和 Handler 的帮助类。

AsyncTask 是经过 Android 封装、简化的异步任务实现方式，内部实现也是由 Thread 和 Handler 来实现异步任务和切换线程的。

使用：
AsyncTask 的一般使用代码写法形式如下：

private class MyTask extends AsyncTask<Params, Progress, Result> { ... }
MyTask task = new MyTask();
task.execute(Params...) ;

如果我们想要快速弄懂 AsyncTask ，只需明白三个参数和四个步骤即可。

在异步任务中的三个参数如下：

Params: 执行任务时传入的参数类型
Progress: 后台操作执行过程中发回主线程中的阶段性结果返回类型
Result: 后台操作完全结束时返回给主线程的期待的返回类型
在异步任务中被调用四个步骤的顺序如下：

onPreExecute(): 在后台任务即 doInBackground(Params…) 执行前被调用，一般用于初始化某些值，例如可以是在交互页面上显示一个 ProgressBar 来提示将要进行后台任务。

doInBackground(Params…): 它将在 onPreExecute() 被调用后马上调用，后台耗时操作真正是被放在这里执行。这边的可变参数 Params 正是三个参数中的第一个参数传入到这边的，另外会在任务执行结束后 return 第三个泛型参数 Result。过程中还可以调用 publishProgress(Progress…) 来发送返回阶段性结果，给处于主线程中调用的 onProgressUpdate(Progress…) 中使用。

onProgressUpdate(Progress…)：它会在执行 publishProgress(Progress…) 后被主线程调用起，这时仍在后台执行的任务会发回一个或多个阶段性进度结果，这个是可以用来去更新交互页面。

onPostExecute(Result)：当后台任务完全结束时会在主线程调用，这里的 Result 正是 doInBackground() 的返回值传入。

这些方法中参数包含 … 的，是在 Java 中使用 … 表示参数数量不固定，是一种数组型参数。

AsyncTask<Params, Progress, Result>的三个参数

doInBackground(Params...)

publishProgress(Progress...)

onProgressUpdate(Progress...)

onPostExecute(Result)

看这四个方法的参数你就知道上面的三个参数是给谁用的了！

AsyncTask的四个方法(步骤)

1、onPreExecute()：这个方法是在任务开始前进行的，它由UI线程（主线程）调用，即可以进行UI操作。在最后，我会给出Log的打印信息。

2、doInBackground(Params...)：这个方法是onPreExecute()完成后，立即在后台进行的，用以执行任务，并将Result传给onPostExecute(Result)。另外，在此期间，可以调用publishProgress(Progress...)，这个方法能够传递一些数据给onProgressUpdate(Progress...)。

3、onProgressUpdate(Progress...)：在publishProgress(Progress...)被调用之后，此方法会由UI线程调用。所以利用publishProgress(Progress...)和onProgressUpdate(Progress...)就能够做出在加载或读取网络数据时的等待或缓冲的UI效果。我在最后给出的效果图有类似的功能。

4、onPostExecute(Result)：在doInBackground(Params...)完成后，由UI线程调用，在这里处理Result。

泛型参数可以是任何类型，那多参数怎么传呢？

public class GetCityListTask extends AsyncTask<String, Integer, String> {

    public String ResultStr;

    ///这个方法是onPreExecute()完成后，立即在后台进行的，用以执行任务，并将Result传给onPostExecute(Result)。
    ///另外，在此期间，可以调用publishProgress(Progress...)，这个方法能够传递一些数据给onProgressUpdate(Progress...)。
    @Override
    protected String doInBackground(String... params) {      
　　　　　　 String x=params[0];
　　　　　　return null;
　　　　　　　　
    }
}

在主线程获取返回值

1 创建一个接口

import java.util.List;

public interface AsyncResponse {
    void onDataReceivedSuccess(List<String> listData);
    void onDataReceivedFailed();
}

2 在AsyncTask中通过此接口获取到onPostExecute中的数值

class SocketConnAsync extends AsyncTask<String, Void, String>
    {
        public AsyncResponse asyncResponse;    
        public void setOnAsyncResponse(AsyncResponse asyncResponse)
        {
            this.asyncResponse = asyncResponse;
        }

        @Override
        protected String doInBackground(String... params) {
            dataReceived = something;
            return dataReceived;            
        }

        @Override
        protected void onPostExecute(String msg) {          
            super.onPostExecute(msg);       
            if (msg != null)
            {               
                List<String> listData = new ArrayList<String>();            
                listData = parseJsonResponse(msg);//解析msg的一个函数
                asyncResponse.onDataReceivedSuccess(listData);//将结果传给回调接口中的函数
            }
            else {
                asyncResponse.onDataReceivedFailed();
            }

        }               
    }

3 在Activity中实现此接口即可

public class MainActivity extends Activity 
{
    private ListView environListView;   
    private List<String> environmentList = null;//listview上显示的数据源
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        requestWindowFeature(Window.FEATURE_NO_TITLE);
        setContentView(R.layout.listview_environment);      
        sendRequestForListData();   
    }
    private void sendRequestForListData()
    {

        try {
            final SocketConnAsync socketConn = new SocketConnAsync();
            socketConn.execute(params);
            socketConn.setOnAsyncResponse(new AsyncResponse() {
                //通过自定义的接口回调获取AsyncTask中onPostExecute返回的结果变量
                @Override
                public void onDataReceivedSuccess(List<String> listData) {                  
                    Log.d(TAG, "onDataReceivedSuccess");
                    environmentList = listData;//如此，我们便把onPostExecute中的变量赋给了成员变量environmentList 
                }

                @Override
                public void onDataReceivedFailed() {
                    ToastUtil.show(MainActivity.this, "data received failed!");             
                }
            });

        } catch (Exception e) {
            e.printStackTrace();
        }   
    }
}

如果你点开的这篇文章，那么 AsyncTask 的基本用法肯定是掌握了的。这篇文章不是分析 AsyncTask的内部原理，而是侧重于如何使用，让我们视图层中的Activity看起来更舒适。本文的项目地址请移步：https://github.com/herojing/JokeTask 下面结合项目谈谈自己的使用心得。

一、使用后效果如何？

老规矩，DEMO 实现的是一个列表，效果跟上篇 MVP 模式的博客一样，如下图所示，列表的内容是一些笑话信息，效果很怂，不过我们不是看外表的，是看内涵的！

项目效果图.png

实现上面这个普通的列表，Activity 的代码如下：

public class MainActivity extends BaseActivity implements TaskCallBack {
    // 不做分页加载的操作，所以这两个参数写死
    public static final String PAGE_NUM = "1";

    public static final String PAGE_SIZE = "20";

    private ListView mListView;

    private ArrayList<JokeInfo> mJokeInfoArrayList = null;

    @Override
    public void initVariables() {
        mJokeInfoArrayList = new ArrayList<>();
    }

    @Override
    public void initView() {
        setContentView(R.layout.activity_main);
        Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);
        if (toolbar != null) {
            setSupportActionBar(toolbar);
            toolbar.setTitle(R.string.app_name);
        }
        mListView = (ListView) findViewById(R.id.main_page_joke_lv);
    }

    @Override
    public void loaderData() {
        JokeTask joketask = new JokeTask(this);
        joketask.execute(PAGE_NUM, PAGE_SIZE);
    }

    @Override
    public void onTaskFinished(TaskResult result) {
        if (result != null) {
            int action = result.action;
            switch (action) {
               //如果这个界面有多个Task要进行，可以用action进行区分
                case Constants.TASK_ACTION_GET_JOKE_CONTENT:
                    if (result.data instanceof Joke) {
                        Joke joke= (Joke) result.data;
                        mJokeInfoArrayList=joke.getResult().getJokeInfoArrayList();
                        JokeAdapter jokeAdapter = new JokeAdapter(this, mJokeInfoArrayList);
                        mListView.setAdapter(jokeAdapter);
                    }
                    break;
            }
        }
    }
}

   加上空行，整个界面大概50+行代码就够了，其中initVariables、initView、loaderData是在BaseAcivity中的onCreate中定义的抽象方法，如果这个界面如果更多个Task同时请求，那么只需增加几行代码就OK了，如果你觉得还不错、那么请继续向下看。

二、具体实现步骤

在说实现之前，先看一下项目结构，如下图。

项目结构图.png

本DEMO总体来说比较简单，重点部分集中在task包中，utils包中放的Http静态工具类，用于请求网络数据。根据项目结构图，看下面的内容，主要有三点需要注意，一是每个模块的Task如何封装，二是每个模块的Client如何编写，三是怎么通知Activity进行界面更新。OK，开始吧！
1、Task实现
AsyncTask使用了模板方法设计模式，由于每个的Task逻辑差不多，有必要进行一下封装,如下。

public abstract class BaseTask extends AsyncTask<String, Integer, TaskResult> {

    private final TaskCallBack mTaskCallBack;

    public BaseTask(TaskCallBack mTaskCallBack) {
        this.mTaskCallBack = mTaskCallBack;
    }

    @Override
    protected void onPostExecute(TaskResult result) {
        if (mTaskCallBack != null) {
            mTaskCallBack.onTaskFinished(result);
        }
    }
}

其中TaskCallBack是请求成功后的结果回调，在Activity中实现，通知更新界面。如下

public interface TaskCallBack {
    void onTaskFinished(TaskResult result);
}

AsyncTask泛型中第三个参数TaskResult是对请求结果的封装，如下，两个成员，其中action 代表当前的结果由哪一个异步任务来返回的，data 代表Object异步任务的返回结果对象，在TaskCallBack的实现中要进行强转。

public class TaskResult {

    public  int action;

    public Object data;
}

在BaseTask定义好了之后，每一个Task子类都需要继承BaseTask，重点重写doInBackground方法。

public class JokeTask extends BaseTask {

    public JokeTask(TaskCallBack mTaskCallBack) {
        super(mTaskCallBack);
    }

    @Override
    protected TaskResult doInBackground(String... params) {
        TaskResult result = null;
        if (params != null) {
            result = new TaskResult();
            //给异步任务标识赋值，一个界面可能有多个接口需要请求
            result.action = Constants.TASK_ACTION_GET_JOKE_CONTENT;
            JSONObject jokeContent = JokeClient.getJokeContent(params[0], params[1]);
            //获取笑话内容并解析，给异步任务结果赋值
            result.data = parseJson(jokeContent);
        }
        return result;
    }

    private Joke parseJson(JSONObject pObject) {
        Joke ret = null;
        if (pObject != null) {
            Gson gson = new Gson();
            ret = gson.fromJson(pObject.toString(), new TypeToken<Joke>() {}.getType());
        }
        return ret;
    }
}

2、Client实现
Client中是网络数据请求的模块，JokeClient的实现如下：

public class JokeClient {

    // API接口
    private static final String API_BASE_URL = "http://api.jisuapi.com/xiaohua/text?";

    public static final String  APPKEY       = "&appkey=9814b57c706d0a23";

    private JokeClient() {
    }

    /**
     * 接口 1 获取笑话内容
     * <p/>
     * //http://api.jisuapi.com/xiaohua/text?pagenum=10&pagesize=3&appkey=9814b57c706d0a23
     * 
     * @return JSONObject
     */
    public static JSONObject getJokeContent(String pNum, String pSize) {

        JSONObject ret = null;
        String url = API_BASE_URL + "pagenum=" + pNum + "&" + "pagesize=" + pSize + "&sort=addtime" + APPKEY;
        byte[] bytes = HttpUtil.doGet(url);
        if (bytes != null) {
            try {
                String str = new String(bytes, "UTF-8");
                ret = new JSONObject(str);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return ret;
    }
}

备注：HttpUtil是JSON请求工具类

三、总结

   如果以这种思路去编写一个小项目，我觉得还是比较好的。假设一个阅读类APP中有三个功能模块（推荐、热点、我的

posted on 2020-05-22 10:51 大西瓜3721 阅读(527) 评论(0) 编辑收藏举报

刷新页面返回顶部

登录后才能查看或发表评论，立即登录或者逛逛博客园首页

历史上的今天：
2019-05-22 Java与WCF交互（一)：Java客户端调用WCF服务

大西瓜3721

让Activity更加简洁第（二）篇---AsyncTask的使用姿势

AsyncTask的参数介绍

AsyncTask<Params, Progress, Result>的三个参数

AsyncTask的四个方法(步骤)

泛型参数可以是任何类型，那多参数怎么传呢？

在主线程获取返回值

一、使用后效果如何？

二、具体实现步骤

三、总结

导航

我的标签

随笔分类

随笔档案

评论排行榜

推荐排行榜

最新评论