CodeGym /課程 /Kotlin SELF /Yong shenme qu ti huan null: qianzhi tiaojian, sealed jie...

Yong shenme qu ti huan null: qianzhi tiaojian, sealed jieguo, Result

Kotlin SELF
等級 41, 課堂 1
開放

1. Wei shenme yao ti huan null, ji shi you null-safety

Ru guo ni xie chengxu xie de gou jiu, ni hui fa xian yi ge hen yinqi de shiqing: null bu zhi shi「mei you zhi」. Zai shijian li, null jingchang kai shi yiwei zhe「chu le dian wenti, dan wo lan de jieshi」. Ran hou mo fa jiu kaishi le: diaoyongfang code na dao T? zhi hou, jiu bi xu cai ce zhe dao di shi shenme —「mei zhao dao」、「mei shuru」、「parsing cuowu」、「fangwen bei jujue」、「kaifa zhe wang le shi xian」. Kotlin neng bang wo men fang zhi NPE, dan ta mei fa fang zhi mo hu de contract.

Shexiang ni you yi ge function findExpenseById(id): Expense?. Zhe shi yi ge hao er chengshi de contract: yong zhege id de zhichu keneng bu cunzai. Dan ru guo ni you yi ge function saveExpense(expense): Expense?, er ta zai renhe wenti fa sheng shi dou fan hui null — na jiu biancheng「heixiang」: wei shenme shi null? xia yi bu gai zuo shenme? chong shi? xian shi xiaoxi? zhijie crash? Geng tao yan de shi — cong signature ni genben kan bu chu lai.

Ben jiang wo men tao lun san zhong shi yong de null ti dai fang an, mei yi zhong dou hui hui da yi ge juti wenti:

  • qianzhi tiaojian(require, check, requireNotNull, checkNotNull)hui hui da「zheyang diao yong dao di xing bu xing?」;
  • sealed-jieguo hui hui da「zhe ge caozuo you na xie you yi yi de jieju?」;
  • Result<T> hui hui da「ru he ba chenggong/shi bai dang zuo shuju fan hui, bu rang yiqie dou biancheng exception, hai bu diu diao yuanyin?」.

2. Qianzhi tiaojian: require, check he *NotNull

Qianzhi tiaojian bu shi「yonghu shuru yanzheng」,er shi bao hu ni function de contract. Ta shi yi zhong shuo fa:「ru guo zheli jin lai le huai shuju — zhe bu shi ‘shenghuo zhuangkuang’, zhe shi API bei cuowu shi yong (huo zhe shangceng code de bug). Wo ningke mashang crash, dan gei chu qingchu de message, ye bu yao ba laji yi lu tuo xia qu, ran hou zai 20 hang zhi hou yi ge guai de di fang cai beng」.

Ye yin wei ru ci, qianzhi tiaojian tongchang chu xian zai domain logic neibu(na li anli shang「bu yinggai you huai shuju」),yi ji zai ceng yu ceng de bianjie shang, ni xiang yong yige hen qiangying de fangshi ba「sheng de shijie」he「yan de shijie」qie kai.

require(...): jiancha can shu

Yi ge xiao「yiyi suojie」: require biao shi「ni ba function diao yong cuo le」. Ta hui diu IllegalArgumentException.

Shexiang wo men de jiaoxue CLI zhuan'an (kecheng shijian xiangmu) — zhichu zhuizongqi. Wo men you model:

data class Expense(
    val id: Int,
    val title: String,
    val amountCents: Int
)

Shexiang domain function yao chuangjian yi bi zhichu. Wo men xiang baozheng: title bu neng shi kong, amount bu neng shi fu shu:

fun createExpense(id: Int, title: String, amountCents: Int): Expense {
    require(id > 0) { "id must be positive" }
    require(title.isNotBlank()) { "title must not be blank" }
    require(amountCents > 0) { "amountCents must be positive" }

    return Expense(id = id, title = title.trim(), amountCents = amountCents)
}

Zheli zhongyao de shi, require bu shi「wenrou di chuli」, er shi「ting xia chengxu, yinwei you ren mingxian fan cuo le」. Ru guo ni xianzai xiang:「na bu neng yinwei yonghu shuru jiu crash ba!」— ni shuo de dui. Dan zhe bu shi zai tan shuru. Zhe shi zai tan yi ge ceng: shuru zai dao zheli zhiqian jiu yinggai bei yanzheng guo.

check(...): jiancha zhuangtai he invariant

check biao shi「wo de chengxu jinru le bu keneng de zhuangtai」. Ta hui diu IllegalStateException. Zai zhenzheng xiangmu li, check jingchang yong zai: duixiang yi jing chuangjian bing yinggai shi zhengque de, dan ni xiang fang zhi luoji cuowu.

Bi ru, wo men you yi ge zhichu repository, li mian cun yi ge list. Wo men yuqi id shi weiyi de. Ru guo zhao dao liang bi zhichu yong tong yi ge id, zhe bu shi「yonghu cuo le」, zhe shi wo men luoji de bug:

fun findUniqueById(items: List<Expense>, id: Int): Expense? {
    val matches = items.filter { it.id == id }
    check(matches.size <= 1) { "BUG: duplicate id=$id found (${matches.size} items)" }
    return matches.firstOrNull()
}

Dui, zheli rengran fan hui Expense?, yinwei「mei zhao dao」shi zhengchang qingkuang. Dan tongshi wo men ye bao hu le invariant「bu yinggai you duplicate」.

requireNotNull he checkNotNull: ba T? → T, bu yong !!

Hen changjian de tong dian: ni na dao le String?(bi ru, cong parsing huo cong Map.get() lai de), dan zai zhe ge dian ta jiu bi xu shi fei-null. Bi qi !! geng hao de shi yong requireNotNull/checkNotNull — yinwei ta men bu zhi ba T? biancheng T, hai neng xie yi ge ren hua de message.

fun normalizeCommand(raw: String?): String {
    val text = requireNotNull(raw) { "Command line must not be null" }
    return text.trim()
}

He raw!! xiang bi, zheli crash shi ni hui kan dao you yi yi de yuanyin, er bu shi「NullPointerException zai mou ge bu zhi dao na li」.

Elvis yu Nothing:「bu shi zhi, jiu shi wo men crash」

Ling yi ge you yong pattern shi「Elvis + yi ge yiding hui crash de function」。Zhe ba qianzhi tiaojian de zhu ti he Nothing lian zai yiqi: biao da shi throw ... de expression lei xing shi Nothing, suo yi te bie shi he fang zai Elvis de you bian. Kotlin wen dang chang yong fail(message): Nothing lai shili, zhe ge function yongyuan diu exception.

3. Yong sealed-jieguo qu dai null

You shi hou wenti bu zai yu「mei you zhi」。Wenti zai yu yi ge caozuo you duo zhong jieju, er mei yi zhong dou you yi yi. Ru guo ni quan bu yong null biao da, ni hui diu diao yiyi, hai bi diaoyongfang qu cai.

sealed class ke yi ba contract zuo cheng:「jieguo yongyuan you, zhi shi hui you bu tong xing tai」. Er Kotlin hui qiangzhi ni chu li suo you fen zhi (ke qiong ju de when), zhi yao ni bu liu else zhe ge hou men.

An id shanchu: ji ge zhengchang de jieju

Shanchu yi bi zhichu shi yi ge hen hao de li zi: ke neng you bu tong jieju, bi ru:

  • shanchu chenggong;
  • mei you zhe ge id;
  • id bu heshi (bi ru <= 0) — zhe geng xiang shi API shi yong cuowu.

id bu heshi wo men yong require bao hu, er「mei you zhe bi zhichu」yong yi ge jieguo variant biao da.

sealed class RemoveExpenseResult {
    data object Removed : RemoveExpenseResult()
    data object NotFound : RemoveExpenseResult()
}

fun removeExpenseById(items: MutableList<Expense>, id: Int): RemoveExpenseResult {
    require(id > 0) { "id must be positive" }

    val index = items.indexOfFirst { it.id == id }
    if (index == -1) return RemoveExpenseResult.NotFound

    items.removeAt(index)
    return RemoveExpenseResult.Removed
}

Qing zhu yi: zheli wanquan mei you null. Fan hui de shi mingque yiyi.

Xianzai CLI ceng jiu ke yi youyou ya ya di gei yonghu zu he message:

fun describeRemove(result: RemoveExpenseResult, id: Int): String = when (result) {
    RemoveExpenseResult.Removed -> "Removed expense id=$id"
    RemoveExpenseResult.NotFound -> "No expense with id=$id"
}

when zhi suo yi shi qiong ju de, shi yinwei sealed ba variant de jihe guan si le. Ru guo ni tian jia yi ge xin variant — compiler hui ziji ti xing ni na li lou chu li le. Zhe shi yi zhong「pinzhi naozhong」,ni hen nan wu shi (he TODO handle errors later zhe zhong comment bu yi yang).

Ok/Error pattern, dan bu zai Ok li fang T?

Hen duo ren xi huan Ok/Error template. Ta hen fangbian, dan zheli you yi ge changjian xianjing: zuo cheng Ok(value: T?). Na yang ni you ba nullable tuo jin「chenggong」li, zheng ti xiangfa jiu diu le.

Wo men zuo yi ge「ba zhichu tian jia dao repository」de jieguo. Shexiang wo men bu yun xu id duplicate.

sealed class AddExpenseResult {
    data class Ok(val added: Expense) : AddExpenseResult()
    data class Error(val message: String) : AddExpenseResult()
}

fun addExpense(items: MutableList<Expense>, expense: Expense): AddExpenseResult {
    val exists = items.any { it.id == expense.id }
    if (exists) return AddExpenseResult.Error("Expense with id=${expense.id} already exists")

    items.add(expense)
    return AddExpenseResult.Ok(added = expense)
}

Zheli Ok baozheng yi ding bao han fei-null de Expense. Er Error ba cuowu wenben dang zuo shuju dai chu qu (er bu shi zai function li println — zhe ge deng xia zai「changjian cuowu」li hui ti).

Wei shenme sealed bi null geng shi he biao da「error/not found」

Zui changjian xuan sealed er bu xuan T? de yuanyin shi — dang ni you liang zhong bu tong de「que shao」yiyi:

  • 「mei zhao dao」(zhengchang);
  • 「fa sheng cuowu」(xuyao tongzhi, ke neng hai yao dai yuanyin).

Ru guo ni yong Expense?, ni wu fa fen bian「mei zhao dao」he「yinwei yanzheng/luoji cuowu er mei banfa」. Dui, ni ke yi「da yin dao console」— dan na yang function jiu bian de bu ke ceshi, ye hen chao. Geng hao de shi ba yiyi fang jin type.

4. Result<T>: ba error dang zuo zhi

Result<T> shi Kotlin de biao zhun rongqi: bu shi chenggong de T, jiu shi shi bai de Throwable. Ta te bie shi he yong zai: cuowu ben lai jiu zi ran di yong exception biao da (bi ru yong toInt() parsing shu zi), dan ni xiang ba ta dang zuo shuju fan hui, er bu shi zai dao chu xie try/catch.

Ben zhi shang zhe shi yi ge zhongjian fang an: ni bu shi chedi fangqi exception (ta hai zai rongqi li), dan dui wai gei yi ge ganjing de contract「success/failure」.

Parsing: yong Result<Int> qu dai Int?

Zai kecheng de zao qi, wo men jingchang yong toIntOrNull() ran hou na dao Int?. Dang ni zhi xuyao「cheng gong/shi bai」zhe ge shishi shi, zhe hen OK. Dan you shi hou ni geng zai yi yuanyin: kong zi fu chuan? bu shi shu? tai da? fu shu? Ni xiang qu fen zhe xie qingkuang.

Result ke yi ba exception bao liu xia lai, bing yong mapCatching jia shang zi ji de jiancha.

fun parsePositiveInt(raw: String): Result<Int> {
    return runCatching { raw.trim().toInt() }
        .mapCatching { value ->
            require(value > 0) { "Expected a positive integer" }
            value
        }
}

Zheli you ge guanjian dian: wo men zai mapCatching li yong require, ru guo tiaojian bu manzu — zhe ye hui bian cheng Failure. Zhe hen fangbian, yinwei diaoyongfang na dao de shi tong yi ge chuli ge shi.

Result zai zhichu zhuizongqi de CLI ceng

Shexiang command zhang zheyang: add <id> <title> <amountCents>. Wo men du yi hang zi fu chuan, chai fen, changshi parsing.

fun parseAddArgs(parts: List<String>): Result<Triple<Int, String, Int>> {
    return runCatching {
        val id = parts[1].toInt()
        val title = parts[2]
        val amount = parts[3].toInt()
        Triple(id, title, amount)
    }
}

Dui, zheli ke neng diu IndexOutOfBoundsException huo NumberFormatException, dan ta men hui bei ganjing di bao jin Result li.

Ran hou wo men ba zhe ge jieguo zhuan cheng yonghu kan de dong de message:

fun describeParse(result: Result<Triple<Int, String, Int>>): String {
    return result.fold(
        onSuccess = { "Parsed: id=${it.first}, title=${it.second}, amount=${it.third}" },
        onFailure = { "Bad command arguments: ${it.message ?: "unknown error"}" }
    )
}

Zhe shi yi ge Result te bie shi he yong zai shuru bianjie de li zi: wo men xiang bu yao crash, dan ye bu xiang shenme dou bu shuo.

Wei shenme Result<T?> ji hu zong shi huai zhu yi

Result<T?> zhe zhong zu he de yiyi shi:「caozuo ke neng error; ru guo mei error, hai ke neng mei you zhi」. Zhe hen shao shi yi ge hao contract, yinwei ni zao cheng le liang tiao huxiang duli de bu queding zhou: xian yao gao qingchu you mei you exception, ran hou hai yao gao qingchu wei shenme shi null.

Tongchang geng hao de zuo fa shi xuan yi ge:

  • ru guo shi「ke neng bu cunzai」— yong T? huo yong sealed de Found/Missing;
  • ru guo shi「ke neng hui beng」— yong Result<T> huo yong sealed de Ok/Error.

Zhi you zai ni zhen de xuyao qu fen「chenggong dan shi kong」he「error」(bi ru cha cache: ke neng mei you record, dan zhe bu shi error) de shihou — Result<T?> cai ou'er you dao li. Dan zhe jiu shi yi ge xuyao feichang qingchu wen danghua contract de sheji juece.

5. Ru he xuan ze fang an

Dang ni kaishi yong gezhong fangfa qu ti huan null shi, hui chu xian yi ge xin de weixian: yi kouqi ba suoyou difang dou huan le, rang code bian de「guo du congming」. Suo yi, you yong de shi ji zhu yi ge jian dan de xuan ze si lu: zai ni zhe ge difang,「mei you zhi」dao di shi shenme yiyi, yi ji zeren zai shui — yonghu hai shi chengxuyuan.

Xia mian shi yi zhang shiyong de biao (bu shi「xueshu zhenli」,er shi gongzuo shang de fangxiang cankao):

Qingjing Zui hao de gongju Wei shenme
Zai code neibu, zhe ge zhi bi xu cunzai (weifan jiushi bug/ cuowu diaoyong)
require* / check*
Fail-fast: mashang zai qingchu de weizhi crash
Caozuo you duo ge you yi yi de jieju (zhao dao/mei zhao dao, ok/error, access denied, conflict)
sealed class
Type qiangzhi chu li quan bu variant, yiyi bu diu
Cuowu ben lai zi ran yong exception biao da, dan ni xiang「ba cuowu dang shuju」
Result<T>
Shi he yong zai bianjie, bing bao liu
Throwable

Xianzai lai yi ge guanyu jiegou (architecture) de zhongyao guandian: zhe xie fangfa keyi hun yong, dan zui hao an ceng ci lai zuo.

Zai wo men de zhichu zhuizongqi li, zhe yang fenpei hen heli: parsing yonghu shuru fan hui Result, yinwei shuru shi zang (dirty) erqie bu ke yuce. Domain caozuo fan hui sealed-jieguo, yinwei na li zhongyao de shi yiyi jieju (bi ru「id chongfu」). Er qianzhi tiaojian yong lai bao hu invariant he function contract, yong zai「bu yinggai fa sheng」de difang.

Ba suoyou dongxi chuan qi lai

Xianzai wo men ba zhe xie pinyin zu cheng yi ge xiao liucheng. Shexiang wo men you yi ge「tian jia zhichu」de command. Shuru yong Result parsing, model yong require bao hu chuangjian, repository fan hui sealed-jieguo.

fun handleAddCommand(items: MutableList<Expense>, parts: List<String>): String {
    val parsed = parseAddArgs(parts)
    return parsed.fold(
        onSuccess = { (id, title, amount) ->
            val expense = createExpense(id, title, amount)
            when (val addRes = addExpense(items, expense)) {
                is AddExpenseResult.Ok -> "Added: ${addRes.added}"
                is AddExpenseResult.Error -> "ERROR: ${addRes.message}"
            }
        },
        onFailure = { "ERROR: bad arguments (${it::class.simpleName})" }
    )
}

Zheli you henduo zhidemingbai de difang, sui ran code hen duan: wo men mei you ba null dang zuo「wanneng huida」. Mei yi ceng yong zi ji de yuyan shuohua:

  • parser shuo「success/exception」(Result);
  • domain factory shuo「yaome chuangjian chenggong, yaome jiu shi bug/ weifan contract」(require);
  • repository shuo「chonggong huo business-rule cuowu」(sealed Ok/Error).

Er qie geng zhongyao de shi, diaoyongfang bu yong cai. Ta zhi xuyao an variant chuli jiu hao.

6. Changjian cuowu

Cuowu №1: ba requireNotNull dang zuo「yanzheng yonghu shuru」。
Dang yonghu shu ru bu dui shi, zhe shi zhengchang qingkuang, bu yinggai yinwei IllegalArgumentException jiu crash. Qianzhi tiaojian shi he yong zai: huai shuju yiyi zhe bug huo API bei cuowu shi yong, er bu shi「yonghu shao an le yi ge shu zi」. Dui shuru, geng he shi de shi Result huo sealed Error.

Cuowu №2: zuo le sealed-jieguo, dan ba yiyi you sai hui null li.
Dianxing: sealed class Result { data class Ok(val value: T?) ... }. Biaomian shang ni「li kai le null」,shi ji shang zhi shi ba null zhuang jin le yi ge xie zhe「Ok」de hezi. Ru guo shi Ok, li mian jiu yinggai shi wan zheng de zhi. Ru guo zhi ke neng bu cunzai — na jiu gai shi ling wai yi ge variant (Missing, NotFound).

Cuowu №3: fan hui null, dan ba yuanyin zai function li yong println da yin chu lai.
Zhe zhong code hen nan ceshi, hen nan fuyong, ye meifa zai UI/CLI ceng zhengchang chuli. Function yao me fan hui you yiyi de jieguo bing dai yuanyin (wenben/ cuowu leixing), yao me crash (ru guo shi qianzhi tiaojian), dan bu yao「zai console li qing qing shuo yi ju, ran hou jiu yong null xiaoshi」.

Cuowu №4: ba Result bian cheng「cuowu xiaoyin qi」。
runCatching hen rongyi bian cheng yi tiao ditan, ba suoyou dongxi dou saijin qu. Ru guo ni xie runCatching { ... }.getOrNull() bing mo mo hu lue Failure, ni you hui dao le null, zhi shi xianzai hai ba yuanyin diu le. Ji ran xuan le Result, jiu yao zun zhong ta: chuli onFailure, tian jia context, zu he message.

Cuowu №5: mei you yue ding jiu hun yong fengge, zui hou de dao「san ceng bu queding」。
Bi ru, function fan hui Result<User?>, qi zhong null biao shi「mei zhao dao」, Failure biao shi「cuowu」,ran hou User li hai you name: String?「yi fang wan yi」. Jieguo ni bi xu jiancha san ci. Tongchang geng hao de shi xuan yi ge qingchu de model: yao me sealed Found/Missing, yao me Result<User>, er domain model li ze yong yange de non-null zi duan.

1
任務
Kotlin SELF, 等級 41, 課堂 1
上鎖
收銀員折扣
收銀員折扣
1
任務
Kotlin SELF, 等級 41, 課堂 1
上鎖
登入名稱的輸入
登入名稱的輸入
1
任務
Kotlin SELF, 等級 41, 課堂 1
上鎖
商品搜尋
商品搜尋
1
任務
Kotlin SELF, 等級 41, 課堂 1
上鎖
透過 Result 的解析器
透過 Result 的解析器
留言
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION