在Android中，使用Kotlin的 API请求简易方法

原文标题：API request in Android the easy way using Kotlin

原文链接：http://antonioleiva.com/api-request-kotlin/

原文作者：Antonio Leiva（http://antonioleiva.com/about/）

原文发布：2015-07-21

 

Kotlin是功能非常强大的编程语言，其目标是利用较少的模板（boilerplate）编写更多的代码。尤其是在Android开发中。除了编程语言自身和它的类之外，Kotlin还为已有的Java类提供一组好用的扩展。这个例子是请求API和下载结果的方法。

 

我知道已经有许多不同的库可以帮助我们做这些工作，并且因Kotlin与Java的互用性，它也能使用这些库。但是，我们有时候仅仅因为大的库更简单、不易出错，对于小需求也用大库。

 

API请求：Java 与 Kotlin对比

 

我总喜欢把这两种语言进行对比，看看坚持使用Java我们会错过什么。从URL恢复JSON的典型代码是这样：

 

try {
    URL url = new URL("<api call>");
 
    urlConnection = (HttpURLConnection) url.openConnection();
    urlConnection.setRequestMethod("GET");
    urlConnection.connect();
 
    InputStream inputStream = urlConnection.getInputStream();
    StringBuffer buffer = new StringBuffer();
    if (inputStream == null) {
        // Nothing to do.
        return null;
    }
    reader = new BufferedReader(new InputStreamReader(inputStream));
 
    String line;
    while ((line = reader.readLine()) != null) {
        buffer.append(line + "\n");
    }
 
    if (buffer.length() == 0) {
        return null;
    }
    result = buffer.toString();
} catch (IOException e) {
    Log.e("Request", "Error ", e);
    return null;
} finally{
    if (urlConnection != null) {
        urlConnection.disconnect();
    }
    if (reader != null) {
        try {
            reader.close();
        } catch (final IOException e) {
            Log.e("Request", "Error closing stream", e);
        }
    }
}

 

Kotlin标准库为URL类提供了扩展函数，避免我们编写所有代码。前面的代码可以转换为：

 

val result = URL("<api call>").readText()

 

对于大量的响应，不建议使用这个函数，但是在大多数情况下，它是足够了。如果不这样，还有许多其他有趣的扩展函数，如：BufferedReader.forEachLine()，它产生行Sequence，让我们用它们中任何一个一起做些事。或是，你可以通过BufferedReader.lineSequence()得到原始的Sequence<String>。这时，你能够执行Sequence允许的不同转换中的任何一种，如：过滤、排序、映射等等。

 

异步调用

 

如你所知，主线程是负责UI呈现和交互的，我们不应该因其它运行时间长的任务阻塞它，这将会影响UI性能。在HTTP请求情况下， Android SDK甚至通过抛出一个异常来阻止我们这么做。在Android典型的解决方案是使用AsyncTask。AsyncTask有一个doInBackground抽象方法，其在另个线程中执行。

 

除了让AsyncTask正常工作很难这一事实外，由于它自身带来了许多问题，使得通过它扩展创建一个新类、在onDestroy中终止它等等，都是很乏味。这个（你可能需要更多的检查以避免崩溃）非常简单的版本将是：

 

@Override protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
 
    task = new AsyncTask<Void, Void, String>() {
        @Override protected String doInBackground(Void... params) {
            return requestFromServer("<api call>");
        }
 
        @Override protected void onPostExecute(String s) {
            if (!isFinishing() && !isCancelled()) {
                Log.d("Request", s);
                Toast.makeText(ExampleActivity.this, "Request performed", Toast.LENGTH_LONG).show();
            }
        }
    };
}
 
@Override protected void onDestroy() {
    super.onDestroy();
 
    if (task != null) {
        task.cancel(true);
        task = null;
    }
}

 

这实在不清晰也不直观。当我们在Android中用Kotlin开发时，我们不能忘记Anko库。它主要目的是提供DSL方式用代码来创建布局，而不是用XML。我实际使用过XML，所以我现在不使用它了，但是它还是包括一整套非常有用的特性。特别对异步任务有些小的DSL。这样在Kotlin中，前面的代码能够减少为：

 

async {
    val result = URL("<api call>").readText()
    uiThread { 
        Log.d("Request", result)
        longToast("Request performed") 
    }
}

 

实际上，你有async函数，它将在另一个线程中执行代码，并由uiThread给出返回主线的机会。async是Context的扩展函数实现，且使用它弱应用，所以不会阻止GC释放内存。

 

uiThread优势的方面是它依据使用类，以用不同的方式来实现。如果我们从Activity中调用它，假设actiivity.isFinishing()返回true，uiThread代码是不会执行的，并且在此情况下不会崩溃。

 

假设你要用future，Async返回Java Future。如果你需要返回future结果，就可以用asyncResult。

 

你还能够用你自己的执行器：

 

val executor = Executors.newScheduledThreadPool(4)
async(executor) {
    // Some task
}

 

总结

 

用几行代码，我们从一个非常典型的操作得到相同（如果没有更好的话）的结果，如：调用一个API，以String变量得到结果。隐藏在这些扩展函数背后有许多有趣的代码，所以我建议去重读Kotlin和Anko源代码，看看在幕后都做了什么。

 

记住从我写的书《Android开发者的Kotlin》中，你能够学习到Kotlin的这点以及许多其它能力，你将通过从0开始创建Android APP学习Kotlin。