Android持久化Cookie

康弟弟2024-11-262025-09-03

0. 引言

还是那个老项目，在安卓设备中获得数据，当时后端觉得方便直接在后端中讲数据写在了session中，想着试试在Android中会不会应为跨域问题导致cookie不一致导致数据无法持久化，果真一试发现每次提交的Cookie值都不一样。

1. 项目依赖

在build.gradle.kts中导入下列依赖：

1 2	implementation("com.squareup.okhttp3:okhttp:4.9.0") implementation ("com.google.code.gson:gson:2.8.8")

2. 持久化Cookie

直接将下面的实现类导入即可

package com.example.getsession;

import okhttp3.Cookie;
import okhttp3.CookieJar;
import okhttp3.HttpUrl;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public class MyCookieJar implements CookieJar {
    private final List<Cookie> cookies = new CopyOnWriteArrayList<>();

    @Override
    public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
        this.cookies.clear();  // 清空现有的 cookies
        this.cookies.addAll(cookies);  // 保存新的 cookies
    }

    @Override
    public List<Cookie> loadForRequest(HttpUrl url) {
        return cookies;  // 加载 cookies
    }
}

3. 访问实现

3.1 layout数据展示

随意编写一个能将获取的session展示出来的

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="16dp">

    <!-- 登录按钮 -->
    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/login"
        android:text="登录"
        android:layout_marginBottom="20dp" />

    <!-- 显示登录返回信息的 TextView -->
    <TextView
        android:id="@+id/returnTextView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="登录返回信息将显示在这里"
        android:textSize="18sp"
        android:layout_marginBottom="20dp" />

    <!-- 获取 session 按钮 -->
    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/getsession"
        android:text="获取 Session" />

    <!-- 显示 session 数据的 TextView -->
    <TextView
        android:id="@+id/sessionTextView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Session 数据将显示在这里"
        android:textSize="18sp"
        android:layout_marginTop="20dp" />
</LinearLayout>

3.2 获取实现

package com.example.getsession;

import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import androidx.appcompat.app.AppCompatActivity;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
import okhttp3.FormBody;

import java.io.IOException;

public class MainActivity extends AppCompatActivity {
    private OkHttpClient client;
    private TextView returnTextView, sessionTextView;
    private Button loginButton, getSessionButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        MyCookieJar cookieJar = new MyCookieJar();
        // 初始化视图组件
        loginButton = findViewById(R.id.login);
        getSessionButton = findViewById(R.id.getsession);
        returnTextView = findViewById(R.id.returnTextView);
        sessionTextView = findViewById(R.id.sessionTextView); // 新增 TextView 用于显示 session 数据

        // 初始化 OkHttpClient
        client = new OkHttpClient.Builder()
                .cookieJar(cookieJar)
                .build();

        // 设置登录按钮的点击事件
        loginButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                sendLoginRequest(); // 调用发送登录请求的方法
            }
        });

        // 设置获取 session 按钮的点击事件
        getSessionButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                getSession(); // 调用获取 session 的方法
            }
        });
    }

    // 发送登录请求
    private void sendLoginRequest() {
        // 创建 POST 请求的请求体
        RequestBody body = new FormBody.Builder().build();

        // 构建请求
        Request request = new Request.Builder()
                .url("https://99hu34ro6897.vicp.fun/login") // 服务器 URL
                .post(body)
                .build();

        // 发送请求
        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                runOnUiThread(() -> {
                    returnTextView.setText("登录失败: " + e.getMessage()); // 显示登录失败的消息
                    Toast.makeText(MainActivity.this, "登录失败: " + e.getMessage(), Toast.LENGTH_SHORT).show();
                });
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (response.isSuccessful()) {
                    runOnUiThread(() -> {
                        returnTextView.setText("登录成功！"); // 显示登录成功的消息
                        Toast.makeText(MainActivity.this, "登录成功", Toast.LENGTH_SHORT).show();
                    });
                } else {
                    runOnUiThread(() -> {
                        returnTextView.setText("登录失败"); // 显示登录失败的消息
                        Toast.makeText(MainActivity.this, "登录失败", Toast.LENGTH_SHORT).show();
                    });
                }
            }
        });
    }

    // 获取 session 数据
    private void getSession() {
        // 创建 GET 请求
        Request request = new Request.Builder()
                .url("https://99hu34ro6897.vicp.fun/getsession") // 服务器 URL
                .build();

        // 发送请求
        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                runOnUiThread(() -> {
                    sessionTextView.setText("获取 session 失败: " + e.getMessage()); // 显示获取 session 失败的消息
                    Toast.makeText(MainActivity.this, "获取 session 失败: " + e.getMessage(), Toast.LENGTH_SHORT).show();
                });
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (response.isSuccessful()) {
                    String responseData = response.body().string();
                    runOnUiThread(() -> {
                        sessionTextView.setText("Session 数据: " + responseData); // 显示获取到的 session 数据
                    });
                } else {
                    runOnUiThread(() -> {
                        sessionTextView.setText("错误: " + response.message()); // 显示错误消息
                    });
                }
            }
        });
    }
}

这里https://www.kangdd.top/i/2024/11/26/6745c470e8c01.png在登入提交后，再次点击获取session可以得到后端发送来的数据。

4.项目截图

可以看到每次提交和获取的session都是保持一致的

5. 扩展

如果后续的页面也需要使用到这个Cookie的话，就可以把这个Cookie定义为全局静态变量，后面的页面直接引用就可以，步骤为：

public class MyApplication extends Application {

    private static OkHttpClient client;

    @Override
    public void onCreate() {
        super.onCreate();

        // 初始化 CookieJar
        PersistentCookieJar cookieJar = new PersistentCookieJar(
                new SetCookieCache(),
                new SharedPrefsCookiePersistor(this)
        );

        // 初始化 OkHttpClient
        client = new OkHttpClient.Builder()
                .cookieJar(cookieJar) // 设置 CookieJar
                .build();
    }

    public static OkHttpClient getOkHttpClient() {
        return client;
    }
}

在其他 Activity 或页面中使用相同的 OkHttpClient 实例

public class AnotherActivity extends AppCompatActivity {

    private OkHttpClient client;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_another);

        // 获取全局的 OkHttpClient 实例
        client = MyApplication.getOkHttpClient();

        // 使用 OkHttpClient 发送请求时，会自动带上 Cookie
        Request request = new Request.Builder()
                .url("http://localhost:8080/getsession")
                .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                runOnUiThread(() -> {
                    Toast.makeText(AnotherActivity.this, "请求失败", Toast.LENGTH_SHORT).show();
                });
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (response.isSuccessful()) {
                    String responseBody = response.body().string();
                    runOnUiThread(() -> {
                        // 处理服务器返回的数据
                        Log.d("Response", responseBody);
                    });
                }
            }
        });
    }
}