1. Jie shao
Refactoring jiu shi: ni gai bian cheng shi de jie gou,dan jin liang bu gai bian ta de yi yi(xing wei)。Ting qi lai hen jian dan,dan shi zai xian shi li,da nao hen xi huan “ji ran dou dong le — shun bian zai you hua yi dian…”. Ran hou ni jiu hui tong shi yi dong dang an、chong ming ming ming、gai xun xi de shu chu ge shi、hai ba suan fa ye chong xie le. Zhe jiu xiang da sao chu fang shi tu ran jue ding “shun bian ba qiang chai le” — ran hou ni jiu tu ran zhu zai gong di li.
“Suo wei da bao zha” de wen ti zai yu ni hui shi qu kong zhi: dang mou ge dong xi huai le,ni bu zhi dao dao di shi 37 ge bian geng li de na yi ge zao cheng de. Suo yi zai zhe tang ke li,wo men hui xue xi ru he rang bian geng bao chi ke kong: zai ren he shi ke ni dou neng cheng shi di shuo: “cheng shi ke yi bian yi,ke yi qi dong,er qie wo zhi dao wo gang gang gai le shen me”.
Wei le geng zhi guan,wo men xian xiang xiang yi ge dian xing de “qi dian” — yi duan yi jing neng yong dan kan qi lai xiang “re mian tiao” yi yang luan de CLI cheng shi:
fun main() {
val items = mutableListOf<Pair<String, Int>>() // "biaoti" dui ying jine
while (true) {
print("> ")
val line = readln().trim()
if (line == "exit") break
if (line.startsWith("add ")) {
val rest = line.removePrefix("add ")
val parts = rest.split(" ")
val title = parts.dropLast(1).joinToString(" ").trim()
val amount = parts.last().toIntOrNull() ?: 0
if (title.isNotEmpty() && amount > 0) {
items.add(title to amount)
println("Added: $title ($amount)") // Added: Coffee (200)
} else {
println("Bad input")
}
} else if (line == "list") {
for ((t, a) in items) println("$t: $a")
} else {
println("Unknown command")
}
}
}
Ta “kan qi lai neng dong”,dan yao gai ta hui hen hai pa: ren he xiu gai dou ke neng nong huai parsing、shu chu ge shi huo zhe add de luo ji. Jie xia lai wo men hui ba ta bian cheng geng qing xi de jie gou — yong xiao bu zhou,bu yong xi ju hua de da gai zao.
2. Xiao bu zhou de ji lv
Dang bie ren shuo “zuo xiao bu zhou”,ting qi lai xiang “duo he shui” yi yang — dui,dan dao di zen me zuo? Wo men ba ta bian cheng yi ge ni ke yi zhen zheng yong shou qu zhi xing de gui ze. Mei zuo wan yi ge bian geng,ni dou ying gai neng gou: (1) wu cuo wu di build, (2) qi dong cheng shi, (3) kuai su que ren ji ben chang jing mei you kan qi lai “huai diao”.
Bian yi invariant
Di yi ge — bian yi invariant: bu yao lei ji “ban cheng pin” zhuang tai. Dai ma bu shi neng bian yi,jiu bu yao jie shu zhe yi bu.
Yi yi invariant
Di er ge — yi yi invariant: zai refactoring de bu zhou li,jin liang bu gai bian xing wei. Ru guo ni que shi yao gai bian xing wei — qing you yi shi di dan du zuo. Bu ran jiu hui chu xian jing dian ju qing: “wo zhi shi chong ming ming bian liang,dan wei shen me xian zai "add" hui jia jin fu shu jin e…”.
Hai you yi ge hen shi yong de xi jie: zai he shi de di fang shi yong nei jian de qian zhi tiao jian jian cha (require, check),rang contract geng ming que. Zai Kotlin li,require() hen shi he yong lai yan zheng ru kou can shu(hui diu IllegalArgumentException),er check() shi yong yu jian cha zhuang tai(hui diu IllegalStateException)。Zhe bu shi “mo fa”,er shi rang cuo wu bian de geng da sheng、geng rong yi dong.
Mei you tests shi de zui xiao bao xian
Xian zai wo men ke yi you yi shi di bu tan test framework he unit test(na shi ling yi ge da zhu ti),dan wan quan mei you bao xian de refactoring hui bian cheng “cai cai kan shi na li huai le” de you xi. Suo yi zai console zhuan an li,bao liu ji ge wen ding de “shou dong” yan zheng chang jing hen fang bian — bu shi “zuo zuo ye”,er shi ni zi ji de zuo biao xi.
Fang fa shi zhe yang: ni zai nao zi li(huo bei wang lu)bao chi 3–4 ge mei bu dou neng kuai su pao yi bian de command,bi ru: add yi bi zhi chu、list lie biao、shi yi xia bu he fa shu ru、exit. Zhe zhi yao 15–30 miao,dan neng dai lai an xin gan: “wo mei you yi ci xing ba yi qie dou nong huai”. Zai zhen shi kai fa li zhe hui bei zi dong hua tests qu dai,dan zai na zhi qian,wo men yao xian xue hui zhe zhong “xiao yan zheng” de ji lv.
Zai refactoring li,“bu yao yi ci dong wan” de xi guan te bie you yong. Bi ru ni xiang ba command parsing chou chu cheng yi ge function,na jiu bu yao tong shi qu gai command ge shi. Xian chou chu — que ren hai neng yong — zai qu you hua ge shi.
Ru he gui hua bu zhou shun xu
Refactoring bu zhi shi “zuo de xiao”,ye shi “zuo de you shun xu”. Ru guo ni xian ba dong xi dou yi dong dao ge ge packages,ran hou kai shi gai signature,ran hou cai fa xian parsing hai mei chu li — ni hui de dao yi dui xiao wen ti,shou shi qi lai hen nao ren.
Yi ge hao ce lve shi: xian wen ding dong zuo bian jie(chou chu functions, yin ru ming que lei xing bi ru ParsedCommand),ran hou wen ding ze ren fen gong(router/handler),zui hou zai gai yi lai he contracts(repository, exporter deng)。Zhe yang mei yi ge bian geng dou geng rong yi “luo di”.
Xia mian shi yi ge xiao liu cheng tu(lei si “zen me zou bi jiao bu tong” de feng ge):
flowchart TD
A["Da main: quan bu hun zai yi qi"] --> B["Chou chu xiao functions: normalize/parse"]
B --> C["Yin ru ming que lei xing: ParsedCommand"]
C --> D["Chou chu command routing: CommandRouter/Handler"]
D --> E["An package chai fen: app.cli / domain / storage"]
E --> F["Ti huan yi lai: MutableList -> Repository"]
F --> G["Wen ding command jie guo ge shi (xia yi tang ke)"]
Zhu yi,mei yi bu dou ke yi ting xia lai: zhuan an reng ran neng bian yi、neng qi dong. Zhe hui rang ren hen fang xin — te bie shi ni yi jing jing li guo yi ci “quan bu chong xie le,ran hou shen me dou bu neng dong”.
3. Xiao bu zhou #1: ba chong fu de dong xi chou cheng functions
Dang dai ma kai shi “man yan” shi,zui xian shou ying xiang de shi yue du: ni da kai main,kan dao de bu shi “cheng shi zen me yun zuo de ju ben”,er shi yi dui zi fu chuan normalisation、jian cha、parsing、branching、print, hai you geng xin list de “za hui”. Zui wen he(tong chang ye zui an quan)de yi bu,shi ba yi xie hen xiao de dong zuo chou cheng functions: bu gai bian yi yi,zhi shi rang “ming zi” neng dui ying dao “dong zuo”.
Wo men cong zui bu rong yi chu shi de dong xi kai shi: normalisation command. Zhe zhi qian wo men zuo guo,dan xian zai zhong dian shi guo cheng: chou chu yi duan — qi dong — que ren mei bian.
private fun normalizeCommand(raw: String): String =
raw.trim().lowercase()
fun main() {
val line = readln()
val cmd = normalizeCommand(line)
println(cmd) // ru guo shu ru " LiSt ", hui kan dao "list"
}
Wei shen me zhe shi yi ge hao de refactoring bu zhou? Yin wei ta ji hu bu ke neng nong huai luo ji: ni zhi shi ba yi mo yi yang de biao da shi yi dong chu lai,ran hou gei ta yi ge ming zi. Ru guo zhen de chu wen ti — ni ye zhi dao gai cong na li zhao.
Jie xia lai ke yi zai chou chu “shi fou tui chu” de jian cha:
private fun isExitCommand(cmd: String): Boolean =
cmd == "exit" || cmd == "quit"
fun main() {
val cmd = normalizeCommand(readln())
if (isExitCommand(cmd)) return
println("Continue...") // Continue...
}
Zai zhe li ke du xing de “mo fa” jiu kai shi chu xian: main yi dian yi dian bian cheng “du qu → normalise → xuan ze branch”. Ye jiu shi shuo,ta zhong yu bian cheng na ge ke yi cong shang wang xia du de ju ben.
4. Xiao bu zhou #2: yong ParsedCommand qu dai “wu chu bu zai de zi fu chuan”
Yi ge rang “da main” hen nan refactoring de yuan yin shi: li mian dao chu dou shi String. String ji shi command, ye shi arguments, ye shi yuan shi shu ru, ye shi normalise hou de ban ben. Zhe jiu xiang guan li yi ge cang ku,mei ge xiang zi shang dou xie “dong xi”。Fang bian ma? Bu. Neng yong ma? Neng. Hen duo ren jiu zhe me guo.
Yi ge xiao bu zhou shi: wei parsing jie guo yin ru yi ge xiao xiao de data model. Zhe bu shi “wei le OOP er OOP”,zhi shi rang contract geng qing chu.
data class ParsedCommand(
val name: String,
val arg: String?
)
Xian zai ni ke yi xie yi ge parsing function,fan hui de shi jie gou,er bu shi “ni zi ji cai ba”:
private fun parseCommandLine(line: String): ParsedCommand {
val s = line.trim()
val space = s.indexOf(' ')
return if (space == -1) {
ParsedCommand(name = s.lowercase(), arg = null)
} else {
val name = s.substring(0, space).lowercase()
val arg = s.substring(space + 1).trim().takeIf { it.isNotEmpty() }
ParsedCommand(name = name, arg = arg)
}
}
Zhu yi takeIf: ta ke yi zai argument shi kong de shi hou fan hui null。Zhe hen fang bian,yin wei hou mian ni ke yi fen bian “mei you argument” he “you argument”。(Er qie,null zai zhe li hen he li: ta biao shi “que shi mei you zhi”,bu shi cuo wu。)
Xian zai main du qi lai ye geng ping jing:
fun main() {
print("> ")
val cmd = parseCommandLine(readln())
println("name=${cmd.name}, arg=${cmd.arg}") // li ru: name=add, arg=Coffee 200
}
Zhe shi yi ge zhong yao de refactoring ji qiao: ni bu shi yi kai shi jiu ba zheng ge cheng shi chong xie. Ni zhi shi ba zi liao de biao shi xing shi bian cheng geng hao yong de,ran hou zai zhe ge xing shi zhi shang zuo xia yi bu.
5. Xiao bu zhou #3: ba command routing chou chu dao CommandRouter
Dang parsing yi jing fan hui ParsedCommand zhi hou,jie xia lai de “re mian tiao” tong chang jiu shi: zai main li yong yi chang chuan if/else if huo zhe yi ge hen da de when lai zuo branching. Wo men de mu biao yi yang bu shi “xiang shu shang na yang piao liang”,er shi rang mei yi kuai dai ma dou zhi fu yi ge qing chu de ze ren.
Wo men jian yi ge class,zhi zuo yi jian shi: jie shou yi jing parsing hao de command,ran hou jue ding hou mian yao zuo shen me. Xian zai ta xian fan hui String(CLI de ti shi xun xi)。Zhe hen zhong yao: wo men bu ba console la jin lai,ye bu zai nei bu println. Fan hui zi fu chuan — CLI zai wai mian zi ji jue ding zen me xian shi.
class CommandRouter {
fun route(cmd: ParsedCommand): String =
when (cmd.name) {
"help" -> "Commands: help, add, list, exit"
else -> "Unknown command: ${cmd.name}"
}
}
Kotlin de when ke yi shi expression bing fan hui zhi,zhe rang zhe lei function neng xie de hen jing jian er qie hao du.
Ran hou main jiu bian cheng yi ge hen dan chun de ju ben:
fun main() {
val router = CommandRouter()
print("> ")
val cmd = parseCommandLine(readln())
val message = router.route(cmd)
println(message) // li ru: Commands: help, add, list, exit
}
Zai wang hou ni zai ba zhen zheng de dong zuo “jie” dao router shang("add"/"list"),dan ye yao yong xiao bu zhou: xian rang "list" yong yi ge stub tong guo,ran hou zai jie service,ran hou zai jia validation.
6. Xiao bu zhou #4: zai bu gai bian luo ji de qian ti xia yi dong dang an yu packages
Yi dong dao packages ting qi lai xiang “bu jiu shi mu lu ma”,dan xian shi zhong zhe shi xin shou hen rong yi ba zhuan an nong huai de di fang zhi yi. Hao xiao xi shi: IDE ji hu neng an quan di bang ni zuo(Move/Refactor),huai xiao xi shi: ru guo ni shou dong zuo、er qie yi ci ban dao di,hen rong yi bian cheng “wei shen me ta zhao bu dao class” de mi gong.
Zheng que de xiao bu zhou shi: ni mei ci zhi yi dong yi ge dang an,xiu hao imports,que ren neng bian yi,ran hou zai dong xia yi ge. Hen wu liao,dan hen you xiao.
Li ru,wo men ba command model yi dong dao CLI package.
// FILE: app/cli/ParsedCommand.kt
package app.cli
data class ParsedCommand(
val name: String,
val arg: String?
)
Ran hou zai Main.kt:
// FILE: app/cli/Main.kt
package app.cli
fun main() {
val cmd = ParsedCommand("help", null)
println(cmd) // ParsedCommand(name=help, arg=null)
}
Zai ba parser yi dong dao tong yi ge di fang:
// FILE: app/cli/CommandParsing.kt
package app.cli
fun parseCommandLine(line: String): ParsedCommand {
val s = line.trim()
val space = s.indexOf(' ')
return if (space == -1) ParsedCommand(s.lowercase(), null)
else ParsedCommand(s.substring(0, space).lowercase(), s.substring(space + 1).trim())
}
Zai zhe yi bu te bie yao zhu yi: bu yao “shun bian you hua parser”,zhi yao yi dong jiu hao. Bu ran ni hui ba liang ge bian geng hun zai yi qi: (1) zu zhi jie gou bian geng, (2) luo ji bian geng.
7. Xiao bu zhou #5: tong guo “zhuan jie ceng” ti huan dependencies
Refactoring zui tong ku de bu fen shi: ba zhi jie dependencies ti huan cheng interface. Bi ru,以 qian ni de ExpenseService zhi jie thao zuo list,xian zai an zhao jie gou ta ying gai tong guo ExpenseRepository lai thao zuo. Ru guo “yi kou qi” zuo wan,ni hui dong dao ban ge zhuan an: signatures、object creation、imports、storage logic.
Zhe li de xiao bu zhou shi: yong yi ge adapter ba xian you de dong xi bao qi lai,ran hou man man ba dai ma qian yi dao xin contract.
Jia she wo men yi jing you domain model:
// FILE: domain/model/Expense.kt
package domain.model
data class Expense(
val title: String,
val amount: Int
)
Yi qian wo men ke yi zhi jie zai main li yong MutableList<Expense> cun. Xian zai wo men zuo yi ge memory repository. Zhong dian shi: ni ke yi zai wan quan bu gai bian command luo ji de qian ti xia zuo dao zhe yi bu — zhi shi gai “shu ju fang zai na”.
// FILE: domain/service/ExpenseRepository.kt
package domain.service
import domain.model.Expense
interface ExpenseRepository {
fun add(expense: Expense)
fun all(): List<Expense>
}
Shi xian:
// FILE: storage/InMemoryExpenseRepository.kt
package storage
import domain.model.Expense
import domain.service.ExpenseRepository
class InMemoryExpenseRepository : ExpenseRepository {
private val items = mutableListOf<Expense>()
override fun add(expense: Expense) {
items.add(expense)
}
override fun all(): List<Expense> = items
}
Zhu yi: all() fan hui de shi List,er bu shi MutableList。Zhe shi yi ge hen xiao de xi jie,dan neng fang zhi “CLI bu xiao xin rao guo gui ze zhi jie gai storage”.
Xian zai shi service. Zhe li hen rong yi you chong dong “chong xie cheng geng piao liang”. Bu yao. Zhi zuo zui xiao bi yao bian geng: ba list ti huan cheng repository,qi ta luo ji jin liang bao chi yuan yang.
// FILE: domain/service/ExpenseService.kt
package domain.service
import domain.model.Expense
class ExpenseService(private val repo: ExpenseRepository) {
fun add(title: String, amount: Int) {
val normalizedTitle = title.trim()
require(normalizedTitle.isNotEmpty()) { "title must not be empty" }
require(amount > 0) { "amount must be > 0" } // require hui diu IllegalArgumentException
repo.add(Expense(normalizedTitle, amount))
}
fun all(): List<Expense> = repo.all()
}
Ran hou cai qu gai main li de assembly(zhi gai yi ge di fang,bu dong qi ta di fang):
// FILE: app/cli/Main.kt
package app.cli
import domain.service.ExpenseService
import storage.InMemoryExpenseRepository
fun main() {
val service = ExpenseService(InMemoryExpenseRepository())
service.add("Coffee", 200)
println(service.all()) // [Expense(title=Coffee, amount=200)]
}
Zhe jiu shi “xiao bu zhou refactoring”: ni jia le yi ge xin layer(Repository),dan mei you “chong xie quan bu”. Jiu shi rang jiu de shi jie kai shi shi yong xin de contract.
8. Ru he gui hua bu zhou shun xu
Refactoring bu zhi shi “zuo de xiao”,ye shi “zuo de you shun xu”. Ru guo ni xian ba dong xi dou yi dong dao ge ge packages,ran hou kai shi gai signature,ran hou cai fa xian parsing hai mei chu li — ni hui de dao yi dui xiao wen ti,shou shi qi lai hen nao ren.
Yi ge hao ce lve shi: xian wen ding dong zuo bian jie(chou chu functions, yin ru ming que lei xing bi ru ParsedCommand),ran hou wen ding ze ren fen gong(router/handler),zui hou zai gai yi lai he contracts(repository, exporter deng)。Zhe yang mei yi ge bian geng dou geng rong yi “luo di”.
Xia mian shi yi ge xiao liu cheng tu(lei si “zen me zou bi jiao bu tong” de feng ge):
flowchart TD
A["Da main: quan bu hun zai yi qi"] --> B["Chou chu xiao functions: normalize/parse"]
B --> C["Yin ru ming que lei xing: ParsedCommand"]
C --> D["Chou chu command routing: CommandRouter/Handler"]
D --> E["An package chai fen: app.cli / domain / storage"]
E --> F["Ti huan yi lai: MutableList -> Repository"]
F --> G["Wen ding command jie guo ge shi (xia yi tang ke)"]
Zhu yi,mei yi bu dou ke yi ting xia lai: zhuan an reng ran neng bian yi、neng qi dong. Zhe hui rang ren hen fang xin — te bie shi ni yi jing jing li guo yi ci “quan bu chong xie le,ran hou shen me dou bu neng dong”.
9. Yi xiao bu zhou refactoring de chang jian cuo wu
Cuo wu #1: “wo zhi shi xiao xiao refactor yi xia” dan que bu xiao xin gai le xing wei.
Zhe shi zui chang jian de gu shi: ni chou chu le yi ge function,shun bian “you hua” le tiao jian,ran hou fa xian command "add" kai shi jie shou kong zi fu chuan,huo zhe fan guo lai kai shi ju jue yi qian neng tong guo de shu ru. Jie fa hen wu liao dan hen you xiao: zai refactoring bu zhou li bu yao you hua luo ji. You hua — ling wai dan du yi bu,deng jie gou qing chu le zai zuo.
Cuo wu #2: yi dong dang an dao packages de tong shi,hai yi qi ba yi qie dou gai ming.
Dang ni yi bian yi dong dang an、yi bian chong ming ming classes,IDE/compiler hui “si mian ba fang” dou zai bao yuan,ran hou ni bu zhi dao dao di na yi bu chu cuo: package? import? name? Geng hao de fang fa shi chai cheng liang ge xiao bian geng: xian yi dong(rang ta neng bian yi),zai chong ming ming(zai rang ta neng bian yi)。Dui,shi liang ge commit,dan bu yong zuo zhen tan.
Cuo wu #3: function “chou chu” le,dan dependency hai shi yin cang zhe(tou tou yong wai bu var huo global state)。
Xin shou hen chang ba yi ge fun addExpense() chou chu lai,ran hou zai li mian du/qu xie wai bu de list,na ge list hai zhu zai main li. Biao mian shang dai ma “an dang an geng piao liang” le,dan shi shi ji shang dependency reng ran bu ming que. Yi ge hao de zhi biao shi: function yong parameters jie shou xu yao de shu ju、bing fan hui jie guo,er bu shi “pa” dao wai mian qu zhao dong xi.
Cuo wu #4: xiang yi ci zai quan bu di fang dou shang interfaces,mei you guo du ceng。
Interfaces(Repository, Exporter)hen you yong,dan ru guo ni yi xia zi ba “quan bu” dou ti huan le,ni bi xu tong shi gai constructors、signatures、object creation di fang、hai you imports de shun xu. Zhe jiu shi “da bao zha”。Geng an ding de fang fa shi tong guo guo du ceng lai zuo adaptation: xian jia repository bing zhi zai service li jie shang,ran hou zai qian yi CLI,zui hou zai shan diao jiu de zhi jie dependencies.
Cuo wu #5: guo zao zhui qiu “wan mei architecture”。
Dang ni you le yi dian cheng gong jing yan,hen rong yi xiang yi kou qi zuo dao “xiang da zhuan an na yang”: 20 ge packages、15 ge interfaces、factory, hai you zai duo yi ceng abstraction,“yin wei cheng shu de ren dou zhe me zuo”。Wen ti zai yu,cheng shu de ren zhe me zuo shi yin wei zhen de xu yao. Zai xue xi zhuan an he zao qi v1,geng zhong yao de shi: dai ma yao hao du、hao kuo zhan,er bu shi kan qi lai xiang shu li de diagram.
Cuo wu #6: mei zuo wan yi bu dou wang le kuai su qi dong yan zheng。
Dang ni chen jin zai yi dong dai ma shi,hen rong yi lian xu zuo 10 ge bian geng,ran hou cai an Run。Ru guo ta bu neng qi dong — ni jiu de zai nao zi li tui hui ban xiao shi,kai shi “hui xiang wo gang gang zuo le shen me”。Geng bian yi(shi jian he jing shen dou geng sheng)de fang fa shi: geng pin fan di qi dong — mei zuo wan yi ge ming xian de bu zhou jiu yan zheng yi xia.
GO TO FULL VERSION