AminHong / warm-package

Warm Package for Android

Warm Package 手機暖暖包

這是一個使用 Kotlin 語言撰寫的 Android 專案，此 App 的功能是在畫面上顯示現在的電池溫度，你可以使用 Seekbar 調整想要讓手機發燙到幾度，按了 Float Action Button 後 App 就會開始做事情讓手機發燙，發燙期間你可以離開應用程式，它會在 Service 繼續發燙，你也可以隨時透過 Notification 的資訊得知目前發燙的進度和點擊進入 App 停止程序。

這個專案示範了哪些技能

• Kotlin 常用語法示範
• Android Application 操作
• Android Service 操作
• Android Notification 操作
• MVP 架構
• Generic 泛型操作
• Kotlin 操作 Java 現有 Library 的方式 (GSON、Volley 等)
• 使用 Kotlin 開發專案時的 Unit Test 等測試工作 (待補)

JVM、Java、Kotlin 關係簡介

首先透過一個簡單的表格了解 Kotlin 對於 Java Virtual Machine 與 Android 虛擬機 ( Dalvik / ART ) 的關係，並了解純 Kotlin 語言寫的程式碼能夠做到哪些事、何時該使用 -include-runtime 參數 。

Language	Java	Kotlin
Compiler	javac	kotlinc
Compile commend	javac text.java	kotlinc text.kt -include-runtime -d test.jar
Execution file	Byte Code ( .class / .jar / .dex )
Runtime Environment	JVM / Dalvik / ART
Native Library	Windows / Mac OS / Linux / Solaris / Android

Kotlin 相對於 Java 有什麼優點

• 可以直接市面上使用 Java 撰寫的 Library，轉換成本僅是語言層面，不牽扯到框架層面
• 支援 Functional programming 與 Closure、Property 等概念，相較於 Java 更先進靈巧
• Java 僅能被編譯成 Byte Code 執行在 JVM 上，而 Kotlin 除了可以編譯為 Byte Code 執行在任何 JVM 環境上，例如 Spring、Android 之外，還可以被編譯為 JavaScript 產生 .js 檔案。
• 理論上學一套 Kotlin 就可以吃遍全端

如何開始使用 Kotlin

因為 Kotlin 的函式庫很精簡，撰寫 App 時還是會操作到 Android SDK 與 JDK 中的類別或函式，加上 Kotlin 是編譯出運行在 JVM 之上的執行檔，所以還是要在對應平台上安裝 JDK 與 Java Runtime 後再安裝 Kotlin 編譯器。

如果你只是要拿來開發 Android App 且不打算在其他環境例如 Commend line 中執行，那使用安裝 Android Studio 3.0 以上版本自帶的 Kotlin 編譯器就很足夠了。如果想簡單試驗一些 Kotlin 語法的執行結果，可以在 Kotlin 官方的線上執行環境測試： Try Kotlin

在原有的 Android 專案中，僅需在 build.gradle 加入 plugin 即可

• +apply plugin: 'kotlin-android'
• +apply plugin: 'kotlin-android-extensions'
• implementation 'org.jetbrains.kotlin:kotlin-stdlib-jre7:1.1.51'
• compile org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.1.51

如果在網頁上 Copy 一段 Java 程式碼，貼到 Android Studio 的 .kt 檔案時 IDE 會詢問是否自動翻譯為 Kotlin，這是在操作較不熟悉的 Java base framework 時蠻好用的功能。接著，你要開始習慣指令尾端不再打上分號。

Kotlin 的 Coding Conventions

Kotlin 沒有 Java 的 int、boolean、double、void 這種 Native Type 與 Integer、Boolean、Double、Void 這種類別成員的差異，所以在 Kotlin 中類別名稱一律使用大寫開頭，例如 Int、Boolean、Double、Unit、Nothing 等等，其他基本上與 Java 極為相像，詳情請見 JetBrains 官方文件： Coding Conventions for Kotlin

最基礎必須要懂的 Kotlin 常用語法

Variable 宣告

• WarmApp.kt Line 25

// Java 寫法

String message = "I am Ascii";
final Intent startServiceIntent = new Intent(this, WarmService.class);

// Kotlin 寫法
// 使用編譯器自動推導的形態時可省略 :Type
// 例如 message 變數的 :String 可省略不寫

var message = "I am Ascii"
val startServiceIntent: Intent = Intent(this, WarmService::class.java)

static 成員使用 companion object 取代

• WarmApp.kt Line 14

// Java 寫法

public static final String DEFAULT_CHANNEL_ID = "WarmPackage";

// Kotlin 寫法

companion object {
    val DEFAULT_CHANNEL_ID: String = "WarmPackage"
}

// 如果只是要定義常數，請加上 const 例如

companion object {
    const val DEFAULT_CHANNEL_ID: String = "WarmPackage"
}

Function

• WarmApp.kt Line 34

// Java 寫法

private void createNotificationChannel() {
    notificationManager.createNotificationChannel(notificationChannel);
}

// Kotlin 寫法

private fun createNotificationChannel(): Unit {
    notificationManager.createNotificationChannel(notificationChannel)
}

Function 參數的注意事項

fun main(args: Array<String>) {
    var dd: Double = 0.0
    foo(dd)
}

fun foo(dParam: Double) {
    dParam = 99.9 // 編譯錯誤 Val cannot be reassigned
}

Kotlin 操作 Java Class<T>

• WarmApp.kt Line 43

// Java 寫法

NotificationManager notificationManager = getSystemService(NotificationManager.class);

// Kotlin 寫法

val notificationManager = getSystemService(NotificationManager::class.java)

繼承與實作

• MainActivity.kt Line 21

// Java 寫法

class MainActivity extends AppCompatActivity implements WarmPackageView {

    // override 採用 annotation 的方式指定
    @Override
    public void onResume() {
        super.onResume();
    }
    
}

// Kotlin 寫法

class MainActivity : AppCompatActivity(), WarmPackageView {

    // override 寫在 function 宣告中
    override fun onResume() {
        super.onResume()
    }
    
}

final constant 成員

• MainActivity.kt Line 23

// Java 寫法

private final int MAX_TEMPERATURE = 50;

// Kotlin 寫法
// 採用 val 而非 var 宣告常數值 (val 是 value 的意思)

private val MAX_TEMPERATURE:Int = 50

可為 null 的變數

• MainActivity.kt Line 25

// warmService 這個變數可為 null
// 所有類別成員變數若在建構式前無法給值，一律需宣告為可 null

private var warmService: WarmService? = null

操作可為 null 的變數

• MainActivity.kt Line 62

// 操作物件成員前要使用 ?.
// 意指若 presenter 為 null 時會直接回傳 null 給 targetTemperature

var targetTemperature:Int = presenter?.getTargetTemperature()?.toInt() ?: 0

操作可 null 的變數時若需要預設值

• MainActivity.kt Line 62

// 在 ?: 後提供左側任何環節發生 null 時該提供的預設值

var targetTemperature:Int = presenter?.getTargetTemperature()?.toInt() ?: 0

if not null 判斷的寫法

• MainActivity.kt Line 80

// Java 寫法

if (warmService != null) {
    if (presenter != null) {
        presenter.attachModel(warmService);
        presenter.initial();
    }
}

// Kotlin 寫法
// 多行或需要對非 null 回傳值做運算時用 ?.let { ... }
// 單行時用 ?. 就夠了

warmService?.let {
    presenter?.attachModel(it)
    presenter?.initial()
}

if null 判斷的寫法

• MainActivity.kt Line 86

// Java 寫法

if (warmService == null) {
    updateUIStatus();
}

// Kotlin 寫法

warmService ?: updateUIStatus()

?.let 與 ?: 也可以搭著寫

• MainActivity.kt Line 80

// Java 寫法

if (warmService != null) {
    if (presenter != null) {
        presenter.attachModel(warmService);
        presenter.initial();
    }
} else {
    updateUIStatus();
}

// Kotlin 寫法

warmService?.let {
    presenter?.attachModel(it)
    presenter?.initial()
} ?: updateUIStatus()

function return value 用於判斷式的限制

• MainActivity.kt Line 114

// Java 寫法

if (presenter.getIsRunning()) {
        Log.e(TAG, "is running")
}

// Kotlin 寫法
// 因為 presenter 可能是 null
// 所以不能像 Java 只寫 if (presenter.getIsRunning()) { ... }

if (presenter?.getIsRunning() == true) {
    Log.e(TAG, "is running")
}

// 如果你對 Kotlin 的語法讀起來已經很順暢了，也可以這樣寫

presenter?.takeIf { it.isRunning }?.apply { Log.e(TAG, "is running") }

可為 null 變數用於判斷式的注意事項

• MainActivity.kt Line 46

// 若 presenter 是 null 時，會直接回傳 null
// 也就是說最終拿來判斷是否 == false 的不一定是 getIsRunning() 的值
// 所以這時後你的判斷式如果是 if (presenter?.getIsRunning() != true)
// 可能會發生 null != true 而進去流程的狀況
// 請注意判斷式習慣正向判斷 == true 或 == false，別用 !=

if (presenter?.getIsRunning() == false) {
    presenter?.closeService()
}

更方便的字串語法

• MainActivity.kt Line 94

// 在 "" 雙引號範圍內，可以利用 $ 符號來引入變數

textviewTemperature.setText("$temperature")

// 也可以使用 ${ 運算式 } 例如寫這樣也行

textviewTemperature.setText("${initTargetTemp + progress}")

// 當然也可以用在 String.format("") 中，相對於使用 %d 方便許多

Log.e(tag, String.format("${initTargetTemp + progress}"))

Property 的概念

• MainActivity.kt Line 123

// Java 寫法

textviewCurrentTemperature.setText(currentTemp.toString())

// Kotlin 寫法
// 在 Kotlin 內 getter、setter 是自動產生的
// 所以直接操作 text 其實是操作了自動產生的 text setter
// 而不是真的操作到 TextView 內的 text 這個 member

textviewCurrentTemperature.text = currentTemp.toString()

Switch case 的寫法

• MainActivity.kt Line 130

// 不像 Switch 有 break 可以用
// 有多個條件成立的狀況是用逗號相接
// 例如第二個可以寫成 false, null -> { ... }

when (uiStatus) {
    true -> {
        fab.setEnabled(false)
        seekbarTemperature.setEnabled(false)
        createSnackBar()
    }
    false -> {
        fab.isEnabled = true
        seekbarTemperature.isEnabled = true
        closeSnackBar()
    }
}

沒有回傳值的 function

• MainActivity.kt Line 150

// Java 寫法

private void createSnackBar() {
}

// Kotlin 寫法
// 然後 Unit 可以省略
// 有一個很類似的類別叫 Nothing 可以混用但記得義意是不同的

private fun createSnackBar(): Unit {
}

暱名物件的寫法

• MainActivity.kt Line 153

// Java 寫法

new View.OnClickListener() {

    @Override
    public void onClick(View view) {
        view.setEnabled(false);
    }
    
}

// Kotlin 寫法

object : View.OnClickListener {

    override fun onClick(view: View?) {
        view?.setEnabled(false)
    }
    
}

Android Context 操作中常用的 MainActivity.this

• WarmService.kt Line 66

// Java 寫法

return WarmService.this;

// Kotlin 寫法

return this@WarmService

關於轉型

• WarmService.kt Line 70

// Java 寫法

SensorManager sensorManager = (SensorManager) getSystemService(Context.SENSOR_SERVICE);

// Kotlin 寫法
// 使用 as 轉型，而非在前面使用 (Type)
// 如果想避免 CaseException 也可以改用 as? 在無法轉型時回傳 null

var sensorManager = getSystemService(Context.SENSOR_SERVICE) as SensorManager

for 用於 List 物件的寫法

• WarmService.kt Line 88

// 正常是寫 for (sensor:Sensor in allSensor)
// 但 Kotlin 可自動辨示所以型態可以省略

for (sensor in allSensor) {
    Log.e("Sensor", sensor.toString())
    if (sensor.name.toLowerCase().indexOf("temp") >= 0) {
        temperatureSensor = sensor
        break
    }
}

for 用於整數計算的寫法

• WarmService.kt Line 113

// for (int i=1; i<=30; ++i) 的意思

for (i in 1..30) {
    try {
        var runnable = WarmRunnable()
        threadList.add(runnable)
        Thread(runnable).start()
    } catch (e: Exception) {
        break
    }
}

預設類別建構式

• APIBase.kt Line 11

// 預設建構式有指定參數時，就不再擁有無參數的建構式了
// 以這個例子來看就是 queue: ResquestQueue
// 所以無法用 var api = InvoiceAPI() 來建構，一定要餵個 queue object

abstract class APIBase<APIType: APIBase<APIType, ResultType>, ResultType>(queue: RequestQueue): API<ResultType>

類別成員與建構式參數

• APIBase.kt Line 14

// 類別成員宣告時可以直接調用建構式中的參數

private var requestQueue: RequestQueue = queue

// 如果有要在建構式做其他事的話就是醬寫
// 需要注意 init function 位置必須在操作到的成員變數之下，否則無法編譯

private var requestQueue: RequestQueue? = null

init {
    requestQueue = queue
}

類別建構式 Overloading

• InvoiceAPI.kt Line 12

// 如果需要寫第二種建構式就是醬寫
// 預設建構式以外的建構式都一定要傳入預設建構式所需的參數
// 並且使用 : this(參數) 來執行預設建構式
// 以此為例就是 queue:RequestQueue
// 如果拿掉 queue:RequestQueue 就會無法編譯

constructor(queue:RequestQueue,
            successListener: API.APISuccessListener<InvoiceResult>,
            failListener: API.APIFailListener): this(queue) {
    this.successListener = successListener
    this.failListener = failListener
}

Functional programming 風格的語法

• InvoiceResult.kt Line 20

// Java 寫法

@Override
String getUrl() {
    return "https://asciihuang.github.io/invoice.json";
}

// Kotlin 寫法
// 可以省略 { return "..." } function body
// 背後的概念是指函數可以被賦值

override fun getUrl(): String = "https://asciihuang.github.io/invoice.json"

由反組譯了解 Kotlin 語法

Null Safety

// Kotlin 寫法

private fun closeSnackBar() {
    snackbar?.dismiss()
}

// Compile 後

private final void closeSnackBar()
{
  Snackbar localSnackbar = this.snackbar;
  if (localSnackbar != null) {
    localSnackbar.dismiss();
  }
}

companion object

// Kotlin 寫法

companion object {
   val DEFAULT_CHANNEL_ID: String = "WarmPackage"
}

// Compile 後

public static final Companion Companion = new Companion(null);

@NotNull
public static final String DEFAULT_CHANNEL_ID = "WarmPackage";

@Metadata(bv={1, 0, 2}, d1={"\000\024\n\002\030\002\n\002\020\000\n\002\b\002\n\002\020\016\n\002\b\003\b��\003\030\0002\0020\001B\007\b\002��\006\002\020\002R\024\020\003\032\0020\004X��D��\006\b\n\000\032\004\b\005\020\006��\006\007"}, d2={"Lcom/ascii/warmpackage/WarmApp$Companion;", "", "()V", "DEFAULT_CHANNEL_ID", "", "getDEFAULT_CHANNEL_ID", "()Ljava/lang/String;", "app_debug"}, k=1, mv={1, 1, 7})
public static final class Companion
{
  @NotNull
  public final String getDEFAULT_CHANNEL_ID()
  {
    return WarmApp.access$getDEFAULT_CHANNEL_ID$cp();
  }
}

Class<T>

// Kotlin 寫法

val startServiceIntent: Intent = Intent(this, WarmService::class.java)

// Compile 後

Intent localIntent = new Intent((Context)this, WarmService.class);

for (i in 1..30)

// Kotlin 寫法

for (i in 1..30) {
    try {
        var runnable = WarmRunnable()
        threadList.add(runnable)
        Thread(runnable).start()
    } catch (e: Exception) {
        break
    }
}

// Compile 後

int i = 1;
while (i < 31) {
  try
  {
    WarmRunnable localWarmRunnable = new WarmRunnable();
    this.threadList.add(localWarmRunnable);
    new Thread((Runnable)localWarmRunnable).start();
    i++;
  }
  catch (Exception localException) {}
}

操作 Companion Object

// Kotlin 寫法

val mBuilder = 
    NotificationCompat.Builder(this, WarmApp.DEFAULT_CHANNEL_ID)

// Compile 後

NotificationCompat.Builder localBuilder = 
    new NotificationCompat.Builder((Context)this, 
    WarmApp.Companion.getDEFAULT_CHANNEL_ID())

字串處理語法

// Kotlin 寫法

val contentText:String = String.format("$currentTemperature / ${getTargetTemperature()}")

// Compile 後

String str1 = "" + this.currentTemperature + " / " + getTargetTemperature();

Safety call 與預設值

// Kotlin 寫法

var dValue = presenter?.getTargetTemperature() ?: 99.0
textviewTemperature.setText(dValue.toString())

var sValue = warmService?.getMd5Hash("12345") ?: "Ascii"
textviewTemperature.setText(sValue)

// Compile 後

WarmPackagePresenter localWarmPackagePresenter = this.presenter;
double d;
String str;
if (localWarmPackagePresenter != null)
{
  Double localDouble = localWarmPackagePresenter.getTargetTemperature();
  if (localDouble != null)
  {
    d = localDouble.doubleValue();
    ((TextView)_$_findCachedViewById(R.id.textviewTemperature)).setText((CharSequence)String.valueOf(d));
    WarmService localWarmService = this.warmService;
    if (localWarmService == null) {
      break label115;
    }
    str = localWarmService.getMd5Hash("12345");
    if (str == null) {
      break label115;
    }
  }
}
for (;;)
{
  ((TextView)_$_findCachedViewById(R.id.textviewTemperature)).setText((CharSequence)str);
  return;
  d = 99.0D;
  break;
  label115:
  str = "Ascii";
}

Unit 與 Nothing

// Kotlin 寫法

fun testUnit(): Unit
fun testNothing(): Nothing

// Compile 後

@NotNull
public abstract Void testNothing();  
public abstract void testUnit();