如何在SignalR Java客户端中处理set-cookie响应头？

核心思路 #

SignalR Java客户端底层基于OkHttp实现网络请求，官方未直接暴露Cookie处理配置，但支持传入自定义OkHttpClient实例，可通过拦截器或预请求的方式手动处理Cookie逻辑。

方案1：自定义OkHttp拦截器自动处理Cookie #

该方案可自动实现Cookie的存储、请求携带、响应更新，适配Cookie动态更新的场景：

1. 实现Cookie拦截器，完成请求Cookie注入、响应Set-Cookie存储逻辑
2. 将自定义配置的OkHttpClient传入SignalR的HubConnectionBuilder

拦截器实现代码 #

import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;
import org.jetbrains.annotations.NotNull;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class CookieInterceptor implements Interceptor {
    // 可替换为SharedPreferences实现Cookie持久化，此处用内存存储示例
    private final Map<String, String> cookieStore = new HashMap<>();

    @NotNull
    @Override
    public Response intercept(@NotNull Chain chain) throws IOException {
        Request originalRequest = chain.request();
        Request.Builder requestBuilder = originalRequest.newBuilder();

        // 给当前请求注入已存储的Cookie
        if (!cookieStore.isEmpty()) {
            StringBuilder cookieSb = new StringBuilder();
            for (Map.Entry<String, String> entry : cookieStore.entrySet()) {
                cookieSb.append(entry.getKey()).append("=").append(entry.getValue()).append("; ");
            }
            if (cookieSb.length() > 2) {
                cookieSb.setLength(cookieSb.length() - 2);
                requestBuilder.addHeader("Cookie", cookieSb.toString());
            }
        }

        Response response = chain.proceed(requestBuilder.build());

        // 读取响应的Set-Cookie头更新存储
        List<String> setCookieHeaders = response.headers("Set-Cookie");
        for (String setCookie : setCookieHeaders) {
            String[] keyValue = setCookie.split(";", 2)[0].split("=", 2);
            if (keyValue.length == 2) {
                cookieStore.put(keyValue[0].trim(), keyValue[1].trim());
            }
        }

        return response;
    }
}

构造SignalR连接 #

import okhttp3.OkHttpClient;
import com.microsoft.signalr.HubConnection;
import com.microsoft.signalr.HubConnectionBuilder;

// 构造带Cookie拦截器的OkHttpClient
OkHttpClient httpClient = new OkHttpClient.Builder()
        .addInterceptor(new CookieInterceptor())
        .build();

// 传入自定义HttpClient创建Hub连接
HubConnection hubConnection = HubConnectionBuilder.create("你的Hub服务地址")
        .withHttpClient(httpClient)
        .build();

方案2：预请求获取Cookie手动注入 #

如果Cookie仅需一次获取、会话内有效，可使用更简单的预请求方案：

1. 提前发起一次普通HTTP请求到SignalR的协商端点，拿到Set-Cookie头
2. 构造Hub连接时手动将Cookie注入请求头

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import com.microsoft.signalr.HubConnection;
import com.microsoft.signalr.HubConnectionBuilder;

String cookieValue = "";
OkHttpClient preClient = new OkHttpClient();
// 请求SignalR的协商端点获取Cookie
Request preRequest = new Request.Builder()
        .url("你的Hub服务地址/negotiate?negotiateVersion=1")
        .build();

try (Response preResponse = preClient.newCall(preRequest).execute()) {
    List<String> setCookies = preResponse.headers("Set-Cookie");
    StringBuilder cookieSb = new StringBuilder();
    for (String cookie : setCookies) {
        cookieSb.append(cookie.split(";", 2)[0]).append("; ");
    }
    if (cookieSb.length() > 2) {
        cookieValue = cookieSb.substring(0, cookieSb.length() - 2);
    }
} catch (IOException e) {
    e.printStackTrace();
}

// 构造连接时注入Cookie
HubConnection hubConnection = HubConnectionBuilder.create("你的Hub服务地址")
        .withHeader("Cookie", cookieValue)
        .build();

服务端兼容配置注意事项 #

.NET Core 3服务端需要做CORS适配，否则Cookie会被安全策略拦截：

// Startup.cs配置CORS策略
services.AddCors(options =>
{
    options.AddPolicy("SignalRCors", builder =>
    {
        // 明确指定允许的客户端源，禁止使用AllowAnyOrigin
        builder.WithOrigins("你的安卓端合法源地址")
            .AllowAnyHeader()
            .AllowAnyMethod()
            .AllowCredentials(); // 必须开启允许携带凭证
    });
});

// 中间件配置注意顺序
app.UseRouting();
app.UseCors("SignalRCors"); // 需放在Routing之后，Endpoints之前
app.UseEndpoints(endpoints =>
{
    endpoints.MapHub<你的Hub类>("/hub路径").RequireCors("SignalRCors");
});

内容的提问来源于stack exchange，提问作者Ami Bidar