Ktor Client 中的基本驗證
必要相依性: io.ktor:ktor-client-auth
程式碼範例: client-auth-basic
基本驗證配置可用於使用者登入。在此配置中,使用者憑據會以 Base64 編碼的使用者名稱/密碼配對形式傳輸。
在伺服器端,Ktor 提供了 Authentication 外掛程式來處理基本驗證。
新增相依性
若要啟用驗證,請在組建指令碼中包含 ktor-client-auth 產物:
implementation(ktorLibs.client.auth)implementation ktorLibs.client.auth<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-client-auth-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>基本驗證流程
基本驗證流程如下:
用戶端向伺服器應用程式中的受保護資源發出請求,且未包含
Authorization標頭。伺服器回應
401 Unauthorized回應狀態,並使用WWW-Authenticate回應標頭指出需要基本驗證 (Basic authentication)。典型的WWW-Authenticate標頭如下所示:WWW-Authenticate: Basic realm="Access to the '/' path", charset="UTF-8"Ktor 用戶端允許你透過使用
sendWithoutRequest()函式,預先傳送憑據——無需等待WWW-Authenticate標頭。用戶端通常會提示使用者輸入憑據。接著發出帶有
Authorization標頭的請求,其中包含使用 Base64 編碼的使用者名稱和密碼配對,例如:Authorization: Basic amV0YnJhaW5zOmZvb2Jhcg伺服器驗證用戶端傳送的憑據,並回應所請求的內容。
設定基本驗證
若要使用 Basic 配置在 Authorization 標頭中傳送使用者憑據,你需要設定 basic 驗證提供者:
在
install(Auth)區塊內呼叫basic函式。使用
BasicAuthCredentials提供所需的憑據,並將此物件傳遞給credentials函式。使用
realm屬性設定領域 (realm)。kotlinval client = HttpClient(CIO) { install(Auth) { basic { credentials { BasicAuthCredentials(username = "jetbrains", password = "foobar") } realm = "Access to the '/' path" } } }(選用)使用
sendWithoutRequest函式啟用預先驗證,該函式會檢查請求參數並決定是否在初始請求中附加憑據。kotlininstall(Auth) { basic { // ... sendWithoutRequest { request -> request.url.host == "0.0.0.0" } } }(選用)停用憑據快取。預設情況下,
credentials {}提供者回傳的憑據會被快取,以便跨請求重複使用。你可以使用cacheTokens選項停用快取:kotlinbasic { cacheTokens = false // Reloads credentials for every request // ... }當憑據在用戶端工作階段期間可能變更,或必須反映最新儲存的狀態時,停用快取將非常有用。
如需透過程式化方式清除快取憑據的詳細資訊,請參閱通用的權杖快取與快取控制章節。
如需 Ktor Client 中基本驗證的完整範例,請參閱 client-auth-basic。
