NetMock 簡介：簡化 Java、Android 和 Kotlin 多平臺中的 HTTP 請求測試
NetMock可讓我們擺脫在測試環(huán)境中模擬請求和響應(yīng)的復(fù)雜性。
NetMock是一個功能強(qiáng)大、用戶友好的庫，旨在簡化模擬HTTP請求和響應(yīng)的過程。
對開發(fā)者來說，測試HTTP請求經(jīng)常會帶來一些挑戰(zhàn)，因為要在測試環(huán)境中模擬請求和響應(yīng)的復(fù)雜性很高。這樣就會增加手動測試的時間和精力投入。我自己曾經(jīng)也遇到過使用其他HTTP庫和繁瑣的模擬工具時的困擾，于是決定引入一個極好的解決方案：NetMock。
NetMock與Java、Android和Kotlin Multiplatform集成非常方便。只需要進(jìn)行簡單的設(shè)置，就可以輕松創(chuàng)建模擬，準(zhǔn)確模仿客戶端請求和真實終端點的響應(yīng)。NetMock的一個關(guān)鍵優(yōu)勢是對模擬HTTP請求和響應(yīng)采用了統(tǒng)一的方法。這在使用不同庫的項目上或者考慮從一種庫轉(zhuǎn)換到另一種庫時特別有用。
NetMock還有一個值得注意的特點，就是用戶友好的設(shè)計。與其他許多HTTP模擬工具不同，NetMock更注重易用性。這個庫提供了直觀的界面和簡單的設(shè)置過程，方便開發(fā)者更好地掌握HTTP庫的知識。
不管您是資深開發(fā)者還是剛剛起步，NetMock都是簡化工作流程、減少創(chuàng)建可靠軟件所需的時間和精力的完美解決方案。
如果您想進(jìn)一步了解NetMock，可以在GitHub上找到NetMock的代碼庫，網(wǎng)址是https://github.com/DenisBronx/NetMock。
提升HTTP相關(guān)代碼的測試策略
作為一名專業(yè)軟件工程師，我堅信對于所有代碼的全面單元測試非常重要。然而，我發(fā)現(xiàn)許多開發(fā)人員在網(wǎng)絡(luò)層的單元測試方面存在一個常見問題，就是因為模擬和測試這個領(lǐng)域比較困難，所以他們往往忽視了該部分的單元測試。相反，他們更傾向于依賴端到端自動化測試或手動測試。
在多個項目中，我發(fā)現(xiàn)一種解決方法是將與HTTP相關(guān)的代碼分離出來，以便能夠獨立測試系統(tǒng)的其他部分。雖然這種方法可以使代碼庫和測試類更加簡潔，但也往往導(dǎo)致忽視對HTTP代碼本身的測試，因為大家覺得這部分很難測試。然而，這樣會導(dǎo)致與HTTP請求和JSON解析有關(guān)的關(guān)鍵邏輯沒有得到充分驗證。
這個問題在使用Retrofit庫的項目中特別突出，該庫通過接口抽象了與HTTP相關(guān)的邏輯。以下是一個代碼片段的例子：
interface GitHubService {
@GET("users/{user}/repos")
suspend fun listRepos(@Path("user") user: String): List<RepoDto>
}
class GitHubRepositoryImpl(
private val githubService: GitHubService,
private val repoMapper: RepoMapper
): GitHubRepository {
override suspend fun listRepos(user: String): List<Repo> {
val repoDtos = githubService.listRepos(user)
return repoMapper.map(repoDtos)
}
}
雖然這種方法可以簡化存儲庫和測試類，但它通常會忽略與HTTP相關(guān)的重要測試。此外，開發(fā)人員可能會為了簡化存儲庫的單元測試而創(chuàng)造一些不必要的組件。
單元測試的目的是為了防止和發(fā)現(xiàn)開發(fā)人員犯的錯誤，并確保代碼按照預(yù)期的功能運(yùn)行。如果沒有充分的測試，即使是一些簡單的錯誤，比如將路徑從users/{user}/repos改為user/{user}/repos，或者在RepoDto中修改一個字段的名稱，都可能會被忽視掉。這在專業(yè)的項目中是不能接受的。
我并沒有針對Retrofit庫本身提出批評。
相反，我認(rèn)為它是一款非常出色且易于理解的庫。
此外，我也認(rèn)識到將與HTTP相關(guān)的代碼分離到獨立的組件中對于組織和可維護(hù)性是很有價值的。
然而，我想著重指出我在很多項目中觀察到的一個有缺陷的測試策略。這個策略往往沒有充分關(guān)注對HTTP代碼進(jìn)行全面的測試，導(dǎo)致一些潛在問題被忽視掉。通過強(qiáng)調(diào)這個問題，我希望鼓勵開發(fā)人員優(yōu)先考慮對與HTTP相關(guān)的邏輯進(jìn)行全面的測試，從而確保項目的整體質(zhì)量和可靠性。
使用NetMock來Mocking請求與響應(yīng)
@Test
fun `your test`() = runTest {
val user = "some_user"
netMock.addMock(
request = {
method = Method.Get
requestUrl = "https://api.github.com/users/$user/repos"
},
response = {
code = 200
body = readFromResources("responses/repo_list.json")
}
)
val result = sut.listRepos(user)
//...
}
為了模擬請求和響應(yīng)，您可以使用NetMock提供的簡單API。
通過將模擬項添加到預(yù)期請求和響應(yīng)的隊列中，在測試期間可以攔截和控制HTTP交互的行為。
創(chuàng)建一個NetMock實例
NetMock提供了兩種版本：netmock-server和netmock-engine。
netmock-server版本適用于Java、Kotlin和Android，它不依賴于任何庫。通過將網(wǎng)絡(luò)請求重定向到本地Web服務(wù)器（MockWebServer），可以模擬網(wǎng)絡(luò)請求。該版本非常適合在非多平臺項目上工作的開發(fā)人員，他們希望在不需要設(shè)置獨立服務(wù)器的情況下測試網(wǎng)絡(luò)請求。
另一方面，netmock-engine版本專門為使用Ktor或Kotlin Multiplatform的開發(fā)人員設(shè)計。它使用MockEngine代替本地服務(wù)器，在使用Ktor的開發(fā)人員中具有輕量級和多平臺的優(yōu)勢。
使用NetMockServer
要將netmock-server添加到項目中，請將以下內(nèi)容添加到build.gradle文件的依賴項中：
dependencies {
testImplementation "io.github.denisbronx.netmock:netmock-server:0.4.0"
}
接下來，按照以下方式創(chuàng)建一個NetMockServer實例：
@get:Rule
val netMock = NetMockServerRule()
NetMockServer啟動了一個本地服務(wù)器，使用MockWebServer來攔截您的請求。NetMockServerRule處理了服務(wù)器的生命周期，在每個測試中自動啟動和關(guān)閉它。
一旦服務(wù)器開始運(yùn)行，您可以使用netmock.baseUrl配置您的代碼，將其指向localhost的基本URL。以下是Retrofit和Ktor的示例：
使用localhost的Retrofit示例：
@get:Rule
val netMock = NetMockServerRule()
private val service = Retrofit.Builder()
.baseUrl(netMock.baseUrl)
.build()
.create(GitHubService::class.java)
使用localhost的Ktor示例：
@get:Rule
val netMock = NetMockServerRule()
private val client = HttpClient(OkHttp) {
defaultRequest {
url(netMock.baseUrl)
}
}
或者，您可以通過使用netmock.interceptor來添加一個攔截器，該攔截器會自動將請求重定向到本地主機(jī)：
下面是一個使用真實URL的Retrofit示例：
@get:Rule
val netMock = NetMockServerRule()
private val service = Retrofit.Builder()
.baseUrl("https://api.github.com/")
.client(OkHttpClient.Builder().addInterceptor(netMock.interceptor).build())
.build()
.create(GitHubService::class.java)
下面是一個使用真實URL的Ktor示例：
@get:Rule
val netMock = NetMockServerRule()
private val client = HttpClient(OkHttp) {
engine {
addInterceptor(netMock.interceptor)
}
}
建議使用攔截器，因為它可以讓您處理真實和動態(tài)的URL。
不過要注意，您需要使用與OkHttp攔截器兼容的庫，比如OkHttp本身、Retrofit或Ktor。
結(jié)論
除了初始化過程外，NetMock的兩個版本基本相同。這意味著在netmock-server和netmock-engine之間切換時，只需要做一些小的修改。這種靈活性使您能夠無需改動測試代碼，順利地在不同的庫之間切換，比如從Retrofit切換到Ktor，或者反過來。
將測試框架與底層庫解耦會增強(qiáng)您重構(gòu)代碼時的自信心。進(jìn)行修改時，您只需修改生產(chǎn)代碼，而測試代碼保持不變。這種方法大大降低了在重構(gòu)過程中產(chǎn)生意外副作用的風(fēng)險，并確保您的測試準(zhǔn)確反映了代碼的行為。
總的來說，NetMock的靈活性使您能夠輕松適應(yīng)不同的庫，并且方便地進(jìn)行代碼重構(gòu)，從而增強(qiáng)代碼的可靠性和可維護(hù)性。
最后，我要衷心感謝那些抽出時間閱讀本文的讀者們。我希望所提供的見解能夠增進(jìn)大家對于在網(wǎng)絡(luò)層進(jìn)行全面測試的重要性的理解。
再次感謝大家的關(guān)注，請在使用NetMock進(jìn)行愉快測試時保持關(guān)注！文章來源：http://www.zghlxwxcb.cn/news/detail-500069.html
GitHub
https://github.com/square/okhttp/tree/master/mockwebserver
https://github.com/DenisBronx/NetMock文章來源地址http://www.zghlxwxcb.cn/news/detail-500069.html
到了這里，關(guān)于NetMock 簡介：簡化 Java、Android 和 Kotlin 多平臺中的 HTTP 請求測試的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
